统一状态码： code: 0 表示成功，code: -1 表示失败

初始化

回调名称： onInit

调用签名：

onInit({ code, msg })

参数说明：

• code（String）: 初始化结果
• msg（String）: 初始化失败原因

返回码说明：

说明： 初始化回调。

start 调用成功

回调名称： onConnectSuccess

调用签名：

onConnectSuccess()

说明： 调用 start() 接口成功时触发。

start 调用失败

回调名称： onConnectFail

调用签名：

onConnectFail({ code })

参数说明：

• code: 错误码，详见错误码说明文档

说明： 调用 start() 接口失败时触发。

播放异常

回调名称： onErrorMessage

调用签名：

onErrorMessage({ code })

参数说明：

• code（Number）: 错误类型
  • 0: RTC 通道中断
  • 1: 获取统计信息时出错

说明： 当播放出现异常时触发。

无操作时间到期

回调名称： onAutoRecoveryTime

调用签名：

onAutoRecoveryTime()

说明： 无操作时间到期时触发。

自动播放失败

回调名称： onAutoplayFailed

调用签名：

onAutoplayFailed(event)

参数说明：

• userId（String）: 自动播放失败的流所属用户 ID（不带此参数时表示本地流播放失败）
• kind（String）: 自动播放失败的媒体类型（"video" 或 "audio"）
• streamIndex（Number）: 视频流属性
  • 0: 主流（默认摄像头/麦克风采集）
  • 1: 屏幕流（共享视频或音频流）
• mediaType（Number）: 远端媒体流类型
  • 1: audio
  • 2: video
  • 3: audio and video

说明： 自动播放音视频流失败时触发。

运行信息

回调名称： onRunInformation

调用签名：

onRunInformation(stats)

参数说明：

• stats: 远端媒体流统计信息（统计周期：2 秒）
  • userId（String）: 进房用户的 userId
  • audioStats（Object）: 远端音频流信息
  • videoStats（Object）: 远端视频流信息

audioStats

videoStats

说明： 回调当前运行信息。

分辨率变化

回调名称： onChangeResolution

调用签名：

onChangeResolution({ from, to })

参数说明：

• from（Object）: 旧分辨率对象
  • width: 旧宽度
  • height: 旧高度
• to（Object）: 新分辨率对象
  • width（Number）: 新宽度
  • height（Number）: 新高度

说明： 用于监听分辨率变化，返回旧（from）与新（to）分辨率。

云端透传消息

回调名称： onTransparentMsg

调用签名：

onTransparentMsg(type, msg)

参数说明：

• type（String）: 保留字段（当前默认填 0）
• msg（String）: 消息内容（字符串）

说明： 收到云端 app 透传消息时触发。

云机复制内容

回调名称： onOutputClipper

调用签名：

onOutputClipper(data)

参数说明：

• data（Object）: 复制对象
  • content（String）: 复制的内容

说明： 在云机复制内容时触发。

视频首帧渲染成功

回调名称： onRenderedFirstFrame

调用签名：

onRenderedFirstFrame()

说明： 视频首帧渲染成功时触发。

采集音频数据

回调名称： onAudioInit

调用签名：

onAudioInit(audioTrackSettings)

参数说明：

• audioTrackSettings（Object）: 参数的详细说明：MediaTrackSettings - MDN Web Docs

说明： 采集音频数据，开始收取麦克风声音。

采集音频数据错误

onAudioError(event)

参数说明：

• event.code（String）: 还可能返回如下错误码：
  • REPEAT_CAPTURE: 重复采集。
  • GET_AUDIO_TRACK_FAILED: 采集音频失败，请确认是否有可用的采集设备，或是否被其他 App 占用。
  • STREAM_TYPE_NOT_MATCH: 流类型不匹配

说明： 采集音频数据错误。

采集视频数据

回调名称： onVideoInit

调用签名：

onVideoInit(videoTrackSettings)

参数说明：

• videoTrackSettings（Object）: 参数的详细说明：MediaTrackSettings - MDN Web Docs

说明： 采集视频数据, 开始收取摄像头画面。

采集视频数据错误

onVideoError(event)

参数说明：

• event.code（String）: 还可能返回如下错误码：
  • REPEAT_CAPTURE: 重复采集。
  • GET_AUDIO_TRACK_FAILED: 采集音频失败，请确认是否有可用的采集设备，或是否被其他 App 占用。
  • STREAM_TYPE_NOT_MATCH: 流类型不匹配。

说明： 采集视频数据错误。

加载进度

回调名称： onProgress

调用签名：

onProgress({ code, msg })

参数说明：
示例数据：

{
  "WS_CONNECT": {"code": 100, "msg": "WS开始连接"},
  "WS_SUCCESS": {"code": 101, "msg": "WS连接成功"},
  "WS_CLOSE": {"code": 102, "msg": "WS连接关闭"},
  "WS_ERROR": {"code": 103, "msg": "WS连接出错"},
  "OWN_JOIN_ROOM": {"code": 200, "msg": "收到加入房间信息"},
  "RECEIVE_OFFER": {"code": 201, "msg": "设置 offer 信息成功"},
  "RECEIVE_OFFER_ERR": {"code": 202, "msg": "设置 offer 信息失败"},
  "SEND_ANSWER": {"code": 203, "msg": "发送 answer 信息"},
  "SEND_ANSWER_ERR": {"code": 204, "msg": "发送 answer 信息失败"},
  "RECEIVE_ICE": {"code": 205, "msg": "添加 ICE 信息成功"},
  "RECEIVE_ICE_ERR": {"code": 206, "msg": "添加 ICE 信息失败"},
  "SEND_ICE": {"code": 207, "msg": "发送 ICE 信息"},
  "RTC_CONNECTING": {"code": 300, "msg": "RTC 正在连接"},
  "RTC_CONNECTED": {"code": 301, "msg": "RTC 连接成功"},
  "RTC_DISCONNECTED": {"code": 302, "msg": "RTC 断开连接"},
  "RTC_CLOSE": {"code": 303, "msg": "RTC 连接关闭"},
  "RTC_FAILED": {"code": 304, "msg": "RTC 连接失败"},
  "RTC_TRACK_VIDEO": {"code": 305, "msg": "RTC 接收 VIDEO 流"},
  "RTC_TRACK_VIDEO_LOAD": {"code": 306, "msg": "RTC 接收 VIDEO 流后在 VIDEO 中加载成功"},
  "RTC_CHANNEL_OPEN": {"code": 307, "msg": "RTC 消息通道连接成功"},
  "RTC_CHANNEL_ERR": {"code": 308, "msg": "RTC 消息通道连接失败"},
  "VIDEO_FIRST_FRAME": {"code": 309, "msg": "VIDEO 加载成功当未收到云机的 UI 信息"},
  "VIDEO_FIRST_FRAME": {"code": 310, "msg": "VIDEO 第一帧渲染成功"}
}

说明： 加载进度相关回调。

WebSocket 状态

回调名称： onSocketCallback

调用签名：

onSocketCallback({ code })

参数说明：

• code（Number）:
  • 0: 连接成功
  • 1: 连接关闭
  • -1: 连接失败

说明： WebSocket 状态信息回调。

用户进退房

回调名称： onUserLeaveOrJoin

调用签名：

onUserLeaveOrJoin({ type, userInfo })

参数说明：

• type（String）:
  • join: 加入房间
  • leave: 离开房间
• userInfo（Object）:
  • userId（String）: 用户 ID
  • extraInfo（Object）: 额外信息

说明： 用户加入或离开房间时触发。

群控错误

回调名称： onGroupControlError

调用签名：

onGroupControlError({ code, msg })

参数说明：

• code（String）: 错误码
  • TOKEN_ERR: 获取 token 接口失败
  • INVALID_TOKEN: token 无效或已过期
  • JOIN_ROOM_FAILED: 进房失败
  • REPEAT_JOIN: 重复进房
  • ROOM_FORBIDDEN: 房间被封禁
  • USER_FORBIDDEN: 用户被封禁
• msg（String）: 错误信息

说明： 群控相关错误回调。

远端指令异常

回调名称： onSendUserError

调用签名：

onSendUserError(error)

参数说明：

• error.code（String）：
  • USER_MESSAGE_TIMEOUT: 发送消息超时
  • USER_MESSAGE_BROKEN: 通道断开，发送失败
  • USER_MESSAGE_NO_RECEIVER: 未找到接收者
  • USER_MESSAGE_NOT_JOIN: 发送方未加入房间
  • USER_MESSAGE_UNKNOWN: 未知错误

说明： 发送远端指令时出现异常。

远端用户退出房间

回调名称： onUserLeave

调用签名：

onUserLeave(event)

参数说明：

• userId（String）: 离开房间的用户 ID
• reason（Number）: 离开原因
  • QUIT (0): 主动退出（调用 leaveRoom）
  • DROPPED (1): 掉线（如 token 过期、网络问题）
  • SWITCH_TO_INVISIBLE (2): 切换为不可见（调用 setUserVisibility）
  • KICKED_BY_ADMIN (3): 被管理员踢出

说明： 远端用户退出房间时触发。

ADB 命令结果

回调名称： onAdbOutput

调用签名：

onAdbOutput(event)

参数说明：

• isSuccess（Boolean）: 是否成功
• content（String）: 成功后的返回结果

说明： 执行 ADB 命令后返回结果。

横竖屏切换

回调名称： onChangeRotate

调用签名：

onChangeRotate(type, info)

参数说明：

• type（Number）:
  • 0: 竖屏
  • 1: 横屏
• info（Object）: 屏幕尺寸信息
  • width（Number）: VIDEO 宽度
  • height（Number）: VIDEO 容器高度

说明： 横竖屏切换时触发。

网络质量信息

回调名称： onNetworkQuality

调用签名：

onNetworkQuality(uplinkNetworkQuality, downlinkNetworkQuality)

参数说明：

• uplinkNetworkQuality（Number）: 上行网络质量
• downlinkNetworkQuality（Number）: 下行网络质量

取值范围：

说明： 加入房间后，每 2 秒返回一次本端上行与下行网络质量信息。

连接状态发生变化

回调名称： onConnectionStateChanged

调用签名：

onConnectionStateChanged(e)

参数说明：

• e.state（Number）: 连接状态

取值范围：

说明： start成功后连接状态出现变更时触发。

视频注入摄像头结果回调

回调名称: onInjectVideoResult

调用签名:

onInjectVideoResult(type, data)

参数说明:

• type（String）: 回调类型。可能的值为 startVideoInjection 或 stopVideoInjection，表示开始或停止视频注入。
• data（Object）: 包含操作结果的对象。
  • isSuccess（Boolean）: 表示操作是否成功。
  • content（String）: 如果操作失败，此字段提供失败的原因。

说明: 此回调函数用于通知视频注入摄像头的开始或停止的结果。