跳转到主要内容

IRTCEngine

创建IRTCEngine

参数 注:日志开关和日志路径原先在 IRTCSetting 上(enable_stream_log / sdk_log_path),现已移到这里 —— 它们在引擎自身初始化阶段就被消费,那时还没有任何频道对象。

释放IRTCEngine

参数

获取版本号信息

参数 注:需要传入的时候需要外面分配内存,至少100长度

获取错误码描述

参数 注:msg 需要传参时由外部分配内存,至少 100 长度。内容为 UTF-8,语言由 RTCEngine_SetLanguage() 决定,默认英文(不要用文案做分支判断,用错误码)。

设置语言

参数 注:进程级设置,随时可调。影响 srtc 自己的错误文案,并转发给底层 RTC_SetLanguage (后续后端请求会带上 Accept-Language)。不调用时为英文;旧版本固定返回中文, 依赖中文文案的调用方升级后需显式设置。

获取最后一次错误信息

参数 注:把上一次 srtc 接口返回的错误码对应的文案写入缓冲区(UTF-8,语言同 RTCEngine_SetLanguage(),默认英文)。该错误码由 srtc 自己维护、不取自底层库, 在任一接口返回非 OK 时更新,建议在同步调用失败后立即读取;无错误时为空。 多线程下读的是进程内最后一次错误码,可能被其它线程覆盖。

基础函数

设置消息回调

参数

频道相关函数

支持同时加入多个频道。每个频道对应一个 IRTCChannel 对象,频道级的接口和回调都在那个对象上, 不再像旧版一样在 IRTCEngine 上用 channelId 首参来区分。 关于 channelId
  • channelId 就是 token 中 channel 字段的值,由 SDK 内部解析,通过 IRTCChannel::getChannelId() 取得
  • channelId 只用于 leaveChannel 和 getChannelIds,其余接口都直接调频道对象

创建频道对象

参数 注:只创建对象,不进入频道。拿到对象后设置好配置和事件回调,再调用 IRTCChannel::join()。 重复创建同一频道返回 Conflict;token 解析不出频道返回 SdkTokenInvalid。

离开频道

参数

离开所有频道

获取已加入的频道列表

参数

流媒体相关函数

网络测速

参数 注:测速结果将在回调内返回

获取摄像头信息

参数

获取屏幕信息

参数

获取麦克风信息

参数

获取扬声器信息

参数

其他

添加上传日志

参数 添加后的日志会上传到日志服务器上。