XYRTC

介绍

XYRTC模块是小鱼易连Web SDK提供的全局总入口，提供如下能力：

1. 创建会议客户端Client模块/日志模块；
2. 浏览器兼容检测；
3. 设置国际化语言；
4. 获取SDK版本信息；

属性

logger

SDK内部的日志模块，可通过浏览器控制台调用对应日志方法；

XYRTC.logger: Logger;

version

小鱼易连Web SDK的版本和构建时间；

XYRTC.version: string;

方法

createClient

创建会议客户端 XYRTCClient 模块，提供实时音视频通话框架能力，一次会议创建一次即可；

XYRTC.createClient(config: IClientConfig, logger?: Logger): XYRTCClient

兼容

v1.0.0+

参数

返回值

​​XYRTCClient​​

详情

返回XYRTCClient实例，用于调用客户端提供的各种方法和事件；

• 使用场景：1、创建多人会议客户端；2、实现会中和会外设备设置、会前预览画面等功能
• 调用时机：初始化SDK时

createLogger

创建自定义日志Logger实例

XYRTC.createLogger(config: ILoggerConfig): Logger;

兼容

v4.0.0+

参数

返回值

​​Logger​​

详情

返回日志模块实例，可调用日志方法、上传日志、下载日志等Logger模块方法；

• 使用场景：1、SDK内部日志模块；2、会前设置功能、会前预览功能等写入独立日志
• 调用时机：初始化SDK之前
• 关联内容：​​Logger​​ 模块

checkSupportWebRTC

检测浏览器是否支持WebRTC能力；

XYRTC.checkSupportWebRTC(): Promise<ICheckSystemRequirements>;

返回值

​​ICheckSystemRequirements​​

详情

返回浏览器是否支持WebRTC能力结果及检测详情；

• 使用场景：会前检查浏览器是否支持WebRTC能力，针对不支持的浏览器限制入会操作
• 调用时机：初始化SDK之前
• 关联内容：​​浏览器平台支持​​

checkSupportShareContent

检测浏览器是否支持共享内容能力；

XYRTC.checkSupportShareContent(): boolean;

返回值

boolean

详情

返回浏览器是否支持共享内容结果；

• 使用场景：检查浏览器是否支持共享内容，针对不支持的浏览器限制共享内容操作
• 调用时机：初始化SDK之前或共享操作之前

setLocale

设置Web SDK国际化语言；

XYRTC.setLocale(language: TLocale): void;

参数

详情

设置完成后，SDK将会根据所设置的语言类型上报相应的文案，包含错误信息、提示信息等；

• 使用场景：如果项目支持国际化，可在语言变化时，调用此方法
• 调用时机：任意时刻