• 文档中心 /
• RTC 实时音视频 /
• 音视频SDK /
• Electron /
• RtcChannelEvent /

CloudHubSDK Electron

• 概览
• RtcEngine
• RtcEngineEvent
• RtcChannel
• RtcChannelEvent
• 枚举

频道事件

onConnectionStateChanged

网络连接状态已改变回调。

rtcChannel.on("onConnectionStateChanged",data=>{});

详情

该回调在网络连接状态发生改变的时候触发，并告知用户当前的网络连接状态。

onJoinChannel

加入频道成功。

rtcChannel.on("onJoinChannel",data=>{});

详情

该回调方法表示该客户端成功加入了指定的频道。

onRejoinChannel

重新加入频道成功回调。

rtcChannel.on("onRejoinChannel",data=>{});

详情

有时候由于网络原因，客户端可能会和服务器失去连接，SDK 会进行自动重连，自动重连成功后触发此回调方法。

onLeaveChannel

离开频道回调。

rtcChannel.on("onLeaveChannel",data=>{});

详情

当用户调用 leaveChannel 离开频道后，SDK 会触发该回调。

onServerTime

服务器当前时间通知。

rtcChannel.on(onServerTime,data=>{});

onRequestToken

token 已经过期，需要更新。

rtcChannel.on("onRequestToken",data=>{});

详情

在调用 joinChannel 时如果指定了 Token，由于 Token 具有一定的时效，在通话过程中如果 Token 已经失效，SDK 会立刻触发该回调，提醒应用程序更新 Token。 当收到该回调时，用户需要重新在服务端生成新的 Token，然后调用 renewToken 将新生成的 Token 传给 SDK。

onTokenPrivilegeWillExpire

token即将过期

rtcChannel.on("onTokenPrivilegeWillExpire",data=>{});

详情

收到该回调代表着 token 即将过期 需要重新生成 token 并调用 rtcChannel.renewToken 方法 传入新的 token

onUserJoined

远端用户（通信场景）/主播（直播场景）加入当前频道回调。

rrtcChannel.on("onUserJoined",data=>{});

详情

• 通信场景下，该回调提示有远端用户加入了频道，并返回新加入用户的 ID；如果加入之前，已经有其他用户在频道中了，新加入的用户也会收到这些已有用户加入频道的回调，此时 isHistory 为 true。
• 直播场景下，该回调提示有主播加入了频道，并返回该主播的 ID。如果在加入之前，已经有主播在频道中了，新加入的用户也会收到已有主播加入频道的回调。

该回调在如下情况下会被触发：

• 远端用户/主播调用 JoinChannel 方法加入频道
• 远端用户加入频道后调用 setClientRole 将用户角色改变为主播
• 远端用户/主播网络中断后重新加入频道

Note:

直播场景下，

• 主播间能相互收到新主播加入频道的回调，并能获得该主播的 uid
• 观众也能收到新主播加入频道的回调，并能获得该主播的 uid

onUserLeaved

远端用户（通信场景）/主播（直播场景）离开当前频道回调。

rtcChannel.on("onUserLeaved",data=>{});

详情

提示有远端用户/主播离开了频道（或掉线）。用户离开频道有两个原因，即正常离开和超时掉线（超过30秒无法与服务器正常通信）。

onRecordMsg

录制状态发生改变。

rtcChannel.on("onRecordMsg",data=>{});

onLocaluserPerssionChanged

用户收到此事件，返回 type（发布1/订阅2）和 hasPermission（有无权限0/1）.

rtcChannel.on(onLocaluserPerssionChanged,data=>{});

Note：

• type：1 和 hasPermission：0 表示 没有权限发布
• type：1 和 hasPermission：1 表示 有权限发布
• type：2 和 hasPermission：0 表示 没有权限订阅
• type：2 和 hasPermission：1 表示 有权限订阅

onServerForceCloseChannel

频道被强制关闭

rtcChannel.on(onServerForceCloseChannel,data=>{});

视频事件

onLocalVideoStateChanged

本地视频状态改变回调。

rtcChannel.on("onLocalVideoStateChanged",data=>{});

详情

本地视频的状态发生改变时，SDK 会触发该回调报告当前的本地视频状态。在本地视频出现故障时，该回调可以帮助了解当前视频的状态以及出现故障的原因。

onFirstLocalVideoFrame

本地视频首帧回调。

rtcChannel.on("onFirstLocalVideoFrame",data=>{});

onRemoteVideoStateChanged

远端视频流状态已变化回调。

rtcChannel.on("onRemoteVideoStateChanged",data=>{});

详情

远端用户/主播视频状态发生改变时，SDK 会触发该回调向本地用户报告当前的远端视频流状态。每个用户可能有多个视频流，每路视频都有其类型（type）。

onFirstRemoteVideoFrame

已接收远端视频首帧回调。

rtcChannel.on("onFirstRemoteVideoFrame",data=>{});

详情

本地收到远端第一个视频帧并解码成功后，会触发该回调。有两种情况：

• 远端用户首次上线后发送视频
• 远端用户视频离线再上线发送视频。视频离线指本地在 15 秒内没有收到视频包，可能有如下原因：
  • 远端用户离开频道
  • 远端用户掉线
  • 远端用户停止发送视频流（调用了 muteLocalVideoStream）
  • 远端用户关闭视频（调用了 enableLocalVideo(false)）

onFirstLocalMovieFrame

本地媒体文件首帧回调。

rtcChannel.on("onFirstLocalMovieFrame",data=>{});

localMovieStateChanged

本地媒体文件播放状态改变回调。

rtcChannel.on(localMovieStateChanged,data=>{});

跨频道媒体流转发事件

onChannelMediaRelayStateChanged

本地媒体文件播放状态改变回调。

rtcChannel.on(onChannelMediaRelayStateChanged,(targetChannelId: string, state: number, code: number)=>{});

音频事件

onLocalAudioStateChanged

本地音频状态改变回调。

rtcChannel.on("onLocalAudioStateChanged",data=>{});

详情

本地音频的状态发生改变时（包括本地麦克风录制状态和音频编码状态），SDK 会触发该回调报告当前的本地音频状态。在本地音频出现故障时，该回调可以帮助了解当前音频的状态以及出现故障的原因。

onFirstLocalAudioFrame

本地音频首帧回调。

rtcChannel.on("onFirstLocalAudioFrame",data=>{});

onRemoteAudioStateChanged

远端音频流状态已变化回调。

rtcChannel.on("onRemoteAudioStateChanged",data=>{});

详情

远端用户/主播音频状态发生改变时，SDK 会触发该回调向本地用户报告当前的远端音频流状态。

onFirstRemoteAudioFrame

已接收远端音频首帧回调。

rtcChannel.on("onFirstRemoteAudioFrame",data=>{});

onAudioVolumeIndication

说话者音量提示回调。

rtcChannel.on("onAudioVolumeIndication",data=>{});

详情

该回调报告频道内每个发布音频数据的用户的音量。

onActiveSpeaker

监测到远端最活跃用户回调

rtcChannel.on("onActiveSpeaker",data=>{});

参数

详情 成功调用 enableAudioVolumeIndication 后，SDK 会持续监测音量 最大的远端用户，并统计该用户被判断为音量最大者的次数。当前时间段内，该次数累积最多的远端用户为最活跃的用户。

当频道内用户数量大于或等于 2 且有活跃用户时，SDK 会触发该回调并报告最活跃用户的 uid。

• 如果最活跃用户一直是同一位用户，则 SDK 不会再次触发 onActiveSpeaker 回调。
• 如果最活跃用户有变化，则 SDK 会再次触发该回调并报告新的最活跃用户的 uid。

音乐文件播放事件

onMovieProgress

本地用户的音乐文件播放进度回调。

rtcChannel.on("onMovieProgress",data=>{});

通话前网络测试

onLastmileQuality

通话前网络上下行 last mile 质量报告回调。

rtcChannel.on("onLastmileQuality", data=>{});

详情

该回调描述本地用户在加入频道前的 last mile 网络探测的结果，其中 last mile 是指设备到边缘服务器的网络状态。
在调用 enableLastmileTest 之后，该回调函数每 2 秒触发一次。如果远端有多个用户/主播，该回调每 2 秒会被触发多次。

数据统计事件

onLocalVideoStats

本地视频流统计信息回调。

rtcChannel.on("onLocalVideoStats",data=>{});

详情

该回调描述本地设备发送视频流的统计信息。SDK 每 2 秒触发该回调一次。

onRemoteVideoStats

通话中远端视频流的统计信息回调

rrtcChannel.on("onRemoteVideoStats",data=>{});

详情

该回调描述远端用户在通话中端到端的视频流统计信息，针对每个远端用户/主播每 2 秒触发一次。
如果远端同时存在多个用户/主播，该回调每 2 秒会被触发多次。

onLocalAudioStats

本地音频流统计信息回调。

rtcChannel.on("onLocalAudioStats",data=>{});

详情

该回调描述本地设备发送音频流的统计信息。SDK 每 2 秒触发该回调一次。

onRemoteAudioStats

通话中远端音频流的统计信息回调

rrtcChannel.on("onRemoteAudioStats",data=>{});

onNetworkQuality

网络上下行质量报告回调。

rtcChannel.on("onNetworkQuality",data=>{});

onRtcStats

当前通话统计。

rtcChannel.on("onRtcStats",data=>{});

高级信令事件

onSetProperty

用户自定义属性变化回调。

rtcChannel.on("onSetProperty",data=>{});

Note：

仅当本地用户在调用 setProperty 时指定的通知范围内（不指定即通知频道内所有人）时，本地用户才会收到该回调。

onChatMsg

聊天消息回调。

rtcChannel.on("onChatMsg",data=>{});

Note：

仅当本地用户在调用 sendChatMsg 时指定的通知范围内（不指定即通知频道内所有人）时，本地用户才会收到该回调。

onPubMsg

自定义消息发布回调。

rtcChannel.on("onPubMsg",data=>{});

Note：

仅当本地用户在调用 pubMsg 时指定的通知范围内（不指定即通知频道内所有人）时，本地用户才会收到该回调。

onDelMsg

自定义消息删除回调。

rrtcChannel.on("onDelMsg",data=>{});

Note：

仅当本地用户在调用 delMsg 时指定的通知范围内（不指定即通知频道内所有人）时，本地用户才会收到该回调。

onLocalUserEvicted

本地用户被踢出房间回调。

rtcChannel.on("onLocalUserEvicted",data=>{});

详情

当收到该条回调时，可能有两种原因：

• 有另一个用户调用 joinChannel 时，使用了和本地用户相同的 uid，服务器认为二者身份相同，将旧的用户踢出房间，此时 reason 为0。
• 有用户调用了 evictUser 接口将本地用户踢出房间，此时 reason 为对方调用时传入的 reason 值。

设备监听

onVideoDeviceStateChanged

视频设备状态变化

rtcChannel.on(onVideoDeviceStateChanged,data=>{});

onAudioDeviceStateChanged

音频设备状态变化

rtcChannel.on(onAudioDeviceStateChanged,data=>{});

其他事件

onError

发生错误事件回调。

rtcChannel.on("onError",data=>{});

Note：

该回调发生表示SDK 运行时出现了（网络或媒体相关的）错误。通常情况下，SDK 上报的错误意味着 SDK 无法自动恢复，需要 App 干预或提示用户。