小鱼易连Web UI MeetingKit API,提供了一个完整的会议解决方案,包括音视频通话、屏幕共享、白板互动等功能,需要与 XYMeetingKitComp 组件一起使用,详细的API内容如下;
初始化 XYRTCClient 实例,为 MeetingKit 提供实时音视频通话能力;
uiMeetingKit.createClient(config?: XYMeetingKitConfig):Promise<XYRTCClient>;
参数
参数 | 类型 | 描述 | 兼容 |
config | uiMeetingKit 配置参数 | - |
详情
返回XYRTCClient实例,用于调用客户端提供的各种方法和事件;
销毁当前的 XYRTCClient 实例
uiMeetingKit.destroy():Promise<void>;
详情
销毁当前的 XYRTCClient 实例,调用此方法会销毁当前的客户端实例,断开与会议的连接,并释放相关资源;
获取 XYRTCClient 实例,可调用 Web SDK 相关方法。
uiMeetingKit.getClient():XYRTCClient;
详情
返回XYRTCClient实例,用于调用客户端提供的各种方法和事件;
离开当前会议。
uiMeetingKit.hangup():Promise<void>;
详情
手动离开当前会议;
退出登录。
uiMeetingKit.logout(): void;
详情
用此方法会退出当前登录状态,并断开与会议的连接;
发起会议呼叫、采集音视频流入会
uiMeetingKit.makeCall(params: IMakeCall): Promise<IReturnResult>
参数
参数 | 类型 | 描述 | 兼容 |
data | 加入会议配置参数,包含会议号、入会昵称、是否开启或关闭摄像头/麦克风等 | - |
返回值
Promise<IReturnResult>
详情
发起会议呼叫并采集音视频流入会,需要携带会议号、入会密码、入会用户名、是否开启、关闭摄像头/麦克风等配置信息加入会议操作;
注册监听事件
uiMeetingKit.on(key: XYMeetingEventKey, listener: Function, total?: number): void
参数
参数 | 类型 | 描述 | 兼容 |
key | 监听注册的事件Key值 | - | |
listener | Function | 监听事件的回调函数,详细见事件模块 | - |
total | number | 可选,回调函数触发次数,默认是-1,表示无限制 | - |
详情
通过事件的形式上报会议状态,开发者根据自身业务自行决定需要注册监听相应的事件,通过回调方式获取对应的数据;
取消注册监听事件
uiMeetingKit.off(key: XYMeetingEventKey, listener?: Function): void
参数
参数 | 类型 | 描述 | 兼容 |
key | 取消监听注册的事件Key值 | - | |
listener | Function | 可选,如果提供,则仅取消该特定回调的监听;如果未提供,则取消该事件的所有监听器 | - |
详情
通过事件的形式上报会议状态,开发者根据自身业务自行决定需要注册监听相应的事件,再使用完成后,需要及时取消注册事件;
呼叫时,播放背景音乐
uiMeetingKit.playBgmAudio(): Promise<void>;
详情
呼叫页面:播放背景音乐,防止浏览器策略限制无法播放音频;
设置MeetingKit 功能可见性配置;
uiMeetingKit.setFeatureVisible(config: XYFeatureVisibilityConfig): void;
参数
参数 | 类型 | 描述 | 兼容 |
config | 必填,功能可见性配置 | - |
详情
设置完成后,MeetingKit 会根据配置自动隐藏或显示相关功能;
设置MeetingKit国际化语言;
uiMeetingKit.setLocale(language: TLocale): void;
参数
参数 | 类型 | 描述 | 兼容 |
language | 必填,国际化语言,支持英文、中文简体、中文繁体 | - |
详情
设置完成后,MeetingKit将会根据所设置的语言类型显示对应的文案;
无登录模式调用,需要在调用makeCall前配置已登录用户和网关信息,用于网关签名计算和接口安全校验
uiMeetingKit.setLoginTokenInfo(info: LoginTokenInfo): Promise<IReturnResult>
参数
参数 | 类型 | 描述 | 兼容 |
info | 配置登录用户/网关信息 | 4.0.0+ |
返回值
Promise<IReturnResult>
详情
无登录模式下(即不调用SDK的登录方法),需要入会之前,调用此方法,传递用户登录相关信息,包含Token、clientId、clientSecret等信息;
挂断会议消息,收到此消息时,可根据需要更新UI,提示用户会议已结束。
uiMeetingKit.on("disconnected", (e: XYMeetingDisconnectedResult)=> {});
回调参数
参数 | 类型 | 描述 | 兼容 |
e | 消息内容,包含退会原因、错误码、账号是否失效等,详细见错误码 | - |
详情
离开会议,包含以下几种情况:
登录状态变更事件
uiMeetingKit.on('login-state', (e: XYLoginStateData) => {});
回调参数
参数 | 类型 | 描述 | 兼容 |
e | 登录状态、用户信息、刷新token信息等; | - |
详情
该事件用于监听登录状态的变化,包括用户的登录状态、用户信息以及 token 刷新信息等。当登录状态发生变化时,系统会触发此事件并传递相关数据;