初始化 init
描述：初始化 SDK
示例
await YlinkMeeting.init({
clientId: CLIENT_ID,
accessToken: accessToken,
baseURL: 'https://meetings.ylyun.com',
leaveURL: 'https://meetings.ylyun.com',
meetingNum: '866666666666',
pwd: '',
displayName: 'WebAPP SDK',
viewMode: 'client',
onJoined: () => {
console.log('onJoined');
},
onReady: () => {
console.log('onReady');
},
onClose: () => {
console.log('onClose');
},
});
参数
| 名称 |
类型 |
是否必须 |
默认值 |
备注 |
| clientId |
string |
是 |
- |
clientId 与 clientSecret（联系亿联销售人员获取） |
| accessToken |
string |
是 |
- |
accessToken 由 clientId 与 clientSecret 请求接口获取，详情可查看 demo |
| baseURL |
string |
是 |
- |
服务器地址 |
| videoSDKLibDir |
string |
是 |
- |
媒体资源文件地址 |
| meetingNum |
string |
是 |
- |
会议号 |
| pwd |
string |
是 |
- |
会议密码 |
| displayName |
string |
是 |
- |
入会名称 |
| leaveURL |
string |
否 |
- |
退会后跳转地址，viewMode 为 Client 时生效 |
| viewMode |
ViewMode |
否 |
client |
SDK 视图显示模式 |
| themeColor |
string |
否 |
- |
自定义主题色 |
| custom |
Custom |
否 |
- |
显示自定义 |
| componentCustom |
ComponentCustom |
否 |
- |
组件模式显示自定义 |
| i18n |
I18n |
否 |
- |
国际化自定义 |
| disableAutoCloseVideoWhenBusy |
boolean |
否 |
false |
系统负载较高时，禁用自动关闭摄像头 |
| reduceVideoResolution |
boolean |
否 |
false |
降低视频订阅分辨率 |
| onJoined |
(): void |
否 |
- |
信令链接成功回调方法 |
| onReady |
(): void |
否 |
- |
入会成功回调方法 |
| onClose |
(reason?: { bizCode?: number; reasonCode?: number; message?: string }) => void |
否 |
- |
退会回调方法 |
ViewMode
| 枚举值 |
描述 |
| client |
客户端模式 |
| component |
组件模式 |
Custom
| 名称 |
类型 |
是否必须 |
默认值 |
描述 |
| showPreview |
boolean |
否 |
true |
预览页面显示/隐藏 |
| showMeetingHeader |
boolean |
否 |
true |
顶部栏显示/隐藏 |
| showMeetingControlBar |
boolean |
否 |
true |
底部控制栏显示/隐藏 |
| showAudioButton |
boolean |
否 |
true |
控制栏音频按钮显示/隐藏 |
| showVideoButton |
boolean |
否 |
true |
控制栏视频按钮显示/隐藏 |
| showShareContentButton |
boolean |
否 |
true |
共享屏幕显示/隐藏 |
| showFeedbackButton |
boolean |
否 |
true |
问题反馈显示/隐藏 |
| showMoreButton |
boolean |
否 |
true |
更多按钮显示/隐藏 |
| showLeaveMeetingButton |
boolean |
否 |
true |
退会按钮显示/隐藏 |
| showInviteButton |
boolean |
否 |
true |
邀请入口显示/隐藏 |
| showMemberListButton |
boolean |
否 |
true |
成员列表入口显示/隐藏 |
| showChatButton |
boolean |
否 |
true |
聊天入口显示/隐藏 |
| showHeaderMeetingStatus |
boolean |
否 |
true |
会议状态显示/隐藏 |
| showHeaderMeetingNumber |
boolean |
否 |
true |
会议信息显示/隐藏 |
| showLayoutTypeButton |
boolean |
否 |
true |
布局切换按钮显示/隐藏 |
| showFullscreenButton |
boolean |
否 |
true |
切换全屏显示/隐藏 |
| fixedMeetingHeader |
boolean |
否 |
true |
顶部栏固定显示/10s 无操作时隐藏 |
| fixedMeetingControlBar |
boolean |
否 |
true |
底部栏固定显示/10s 无操作时隐藏 |
| showInterpretationButton |
boolean |
否 |
true |
同声传译按钮显示/隐藏 |
| showQaButton |
boolean |
否 |
true |
问答按钮显示/隐藏 |
| showVoteButton |
boolean |
否 |
true |
投票按钮显示/隐藏 |
| showLiveCaptionButton |
boolean |
否 |
true |
语音转写按钮显示/隐藏 |
ComponentCustom
| 名称 |
类型 |
是否必须 |
默认值 |
描述 |
| moveable |
boolean |
否 |
true |
是否可移动 |
| mainWindowOptions |
MainWindowOptions |
否 |
- |
主窗口位置大小配置 |
MainWindowOptions
| 名称 |
类型 |
是否必须 |
默认值 |
描述 |
| width |
number |
是 |
1024 |
窗口宽度，取值范围（520 - 1920） |
| height |
number |
是 |
672 |
窗口高度，取值范围（320 - 1080） |
| top |
number |
是 |
20 |
窗口与 body 上边界之间的偏移 |
| left |
number |
是 |
20 |
窗口与 body 左边界之间的偏移 |
I18n
| 名称 |
类型 |
是否必须 |
描述 |
| zh |
I18nCustom |
否 |
国际化中文 |
I18nCustom
| 名称 |
类型 |
是否必须 |
默认值 |
描述 |
| join.title |
string |
否 |
加入会议 |
预览页面标题（最大长度：10） |
| join.button.text |
string |
否 |
立即加入 |
预览页面入会按钮文本(最大长度：10) |
返回数据
Promise