版本支持: v1.0.0+
接口概述: 获取sdk单例(请在同一线程中使用)
接口定义:
static getInstance(): XYRTCEngineIF;
返回值:
返回XYRTCEngineIF类型的SDK实例对象
版本支持: v1.0.0+
接口概述: 初始化SDK
接口定义:
init(configs: XYSDKConfig): XYSDKError;
接口参数:
参数名 | 类型 | 必填 | 默认值 | 描述 |
configs | 是 | 无 | SDK配置参数 |
返回值:
返回XYSDKError类型 (返回值当前版本直接忽略, 不影响SDK后续业务)
版本支持: v3-10-20-202607231
接口概述: 初始化SDK
接口定义:
initSDK(context: common.Context | undefined, configs: XYSDKInitConfig): XYSDKError;
接口参数:
名称 | 类型 | 必填 | 默认值 | 描述 |
cloudServer | string | 是 | 空 | 服务器地址 |
logFolder | string | 是 | 空 | 日志目录 |
logFileName | string | 是 | 空 | 日志文件名 |
appVersion | string | 是 | 空 | app版本 |
ci | string | 是 | 空 | cliend id |
cc | string | 是 | 空 | client secret |
eid | string | 是 | 空 | 企业id |
sslOption | XYSDKSSlConfig | 是 | - | 证书配置 |
autoServerList | string[] | 否 | 无 | 服务器自动探测地址 |
customAudioCapture | boolean | 否 | 无 | 自定义音频采集 |
customAudioRender | boolean | 否 | 无 | 自定义音频播放 |
customVideoCapture | boolean | 否 | 无 | 自定义视频采集 |
返回值:
返回XYSDKError类型 (返回值当前版本直接忽略, 不影响SDK后续业务)
版本支持: v1.0.0+
接口概述: 获取sdk版本号
接口定义:
getVersion(): string;
返回值:
返回string类型的SDK版本号字符串