RtcChannelEventHandler

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

返回值

一个 Callback 对象，包含以下参数：

uid

远端最活跃用户的 ID。

返回值

一个 Callback 对象，包含以下参数：

oldState

之前的发布状态，详见 StreamPublishState。

newState

当前的发布状态，详见 StreamPublishState。

elapseSinceLastState

两次状态变化时间间隔（毫秒）。

返回值

一个 Callback 对象，包含以下参数：

uid

远端用户的 ID。

oldState

之前的订阅状态，详见 StreamSubscribeState。

newState

当前的订阅状态，详见 StreamSubscribeState。

elapseSinceLastState

两次状态变化时间间隔（毫秒）。

返回值

一个 Callback 对象，包含以下参数：

err

错误码，详见错误码和警告码。

msg

错误信息

返回值

一个 Callback 对象，包含以下参数：

code

跨频道媒体流转发事件码。详见 ChannelMediaRelayEvent。

当跨频道媒体流转发状态发生改变时，SDK 会触发该回调，并报告当前的转发状态以及相关的错误信息。

返回值

一个 Callback 对象，包含以下参数：

state

跨频道媒体流转发状态。详见 ChannelMediaRelayState。

code

跨频道媒体流转发出错的错误码。详见 ChannelMediaRelayError。

返回值

一个 Callback 对象，包含以下参数：

warn

警告码，详见错误码和警告码。

msg

警告信息

直播场景下，本地用户加入频道后调用 setClientRole 成功改变用户角色时，例如主播切换为观众，或观众切换为主播，SDK 会触发该回调，报告切换前和切换后的角色。

返回值

一个 Callback 对象，包含以下参数：

oldRole

切换前的角色：ClientRole。

newRole

切换后的角色：ClientRole。

SDK 在调用 joinChannel 后无论是否加入成功，只要 10 秒和服务器无法连接就会触发该回调。

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

返回值

一个 Callback 对象，包含以下参数：

state

当前网络连接状态。详见 ConnectionStateType。

reason

引起当前网络连接状态改变的原因。详见 ConnectionChangedReason。

远端视频首帧显示在视图上时，触发此回调。App 可在此回调中获知出图时间（ elapsed ）。

返回值

一个 Callback 对象，包含以下参数：

uid

用户 ID，指定是哪个用户的视频流。

width

视频流宽（px）。

height

视频流高（px）。

elapsed

从本地调用 joinChannel 到发生此事件过去的时间（毫秒)。

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

返回值

一个 Callback 对象，包含以下参数：

uid

用户 ID。如果 joinChannel 中指定了用户 ID，则此处返回该 ID；否则使用声网服务器自动分配的 ID。

elapsed

从 joinChannel 开始到发生此事件过去的时间（毫秒）。

调用 leaveChannel 方法离开频道后，SDK 会出发该回调提示 app 用户已成功离开频道。在该回调中，app 可以得到此次通话的总通话时长、SDK 收发数据的流量等信息。

返回值

一个 Callback 对象，包含以下参数：

stats

通话的统计数据: RtcStats。

如果你调用了 setLocalPublishFallbackOption 接口并将 option 设置为 AudioOnly ，当上行网络环境不理想、本地发布的媒体流回退为音频流时，或当上行网络改善、媒体流恢复为音视频流时，会触发该回调。

返回值

一个 Callback 对象，包含以下参数：

isFallbackOrRecover

• true: 由于网络环境不理想，本地发布的媒体流已回退为音频流。
• false: 由于网络环境改善，发布的音频流已恢复为音视频流。

参数

metadata

接收到的媒体附属信息。详见 Metadata。

该回调描述每个用户在通话中的 last mile 网络状态，其中 last mile 是指设备到声网边缘服务器的网络状态。

该回调每 2 秒触发一次。如果远端有多个用户，该回调每 2 秒会被触发多次。

返回值

一个 Callback 对象，包含以下参数：

uid

用户 ID。表示该回调报告的是持有该 ID 的用户的网络质量。

当 uid 为 0 时，返回的是本地用户的网络质量。

txQuality

该用户的上行网络质量，基于发送码率、上行丢包率、平均往返时延和网络抖动计算。该值代表当前的上行网络质量，帮助判断是否可以支持当前设置的视频编码属性。假设上行码率是 1000 Kbps，那么支持直播场景下 640 × 480 的分辨率、15 fps 的帧率没有问题，但是支持 1280 × 720 的分辨率就会有困难。

rxQuality

该用户的下行网络质量，基于下行网络的丢包率、平均往返延时和网络抖动计算。

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

返回值

一个 Callback 对象，包含以下参数：

uid

重新加入频道的用户 ID。

elapsed

从本地开始重连到发生此事件过去的时间（毫秒）。

远端用户（通信场景）或主播（直播场景）的音频状态发生改变时，SDK 会触发该回调向本地用户报告当前的远端音频流状态。

返回值

一个 Callback 对象，包含以下参数：

uid

发生音频状态改变的远端用户 ID。

state

远端音频流状态，详见 AudioRemoteState。

reason

远端音频流状态改变的具体原因，详见 AudioRemoteStateReason。

elapsed

从本地用户调用 joinChannel 方法到发生本事件经历的时间，单位为 ms。

该回调针对每个发送音频流的远端用户/主播每 2 秒触发一次。如果远端有多个用户/主播发送音频流，该回调每 2 秒会被触发多次。

返回值

一个 Callback 对象，包含以下参数：

stats

接收到的远端音频统计数据，详见 RemoteAudioStats。

如果你调用了 setRemoteSubscribeFallbackOption 并将 option 设置为 AudioOnly，当下行网络环境不理想、仅接收远端音频流时，或当下行网络改善、恢复订阅音视频流时，会触发该回调。

返回值

一个 Callback 对象，包含以下参数：

uid

远端用户的用户 ID。

isFallbackOrRecover

• true: 由于网络环境不理想，远端订阅流已回退为音频流；
• false: 由于网络环境改善，订阅的音频流已恢复为音视频流。

返回值

一个 Callback 对象，包含以下参数：

uid

发生视频状态改变的远端用户 ID。

state

远端视频流状态，详见 VideoRemoteState。

reason

远端视频流状态改变的具体原因，详见 VideoRemoteStateReason。

elapsed

从本地用户调用 joinChannel 方法到发生本事件经历的时间，单位为 ms。

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

返回值

一个 Callback 对象，包含以下参数：

stats

远端视频统计数据。详见 RemoteVideoStats。

在通话过程中如果 Token 已失效，SDK 会触发该回调，提醒 app 更新 Token。

当收到该回调时，你需要重新在服务端生成新的 Token，然后调用 joinChannel 重新加入频道。

SDK 定期向 App 报告当前通话的统计信息，每两秒触发一次。

返回值

一个 Callback 对象，包含以下参数：

stats

RTC 引擎统计数据，详见 RtcStats 。

返回值

一个 Callback 对象，包含以下参数：

url

旁路推流 URL。

eventCode

旁路推流事件码。详见 RtmpStreamingEvent。

RTMP/RTMPS 推流状态发生改变时，SDK 会触发该回调，并在回调中明确状态发生改变的 URL 地址及当前推流状态。该回调方便推流用户了解当前的推流状态；推流出错时，你可以通过返回的错误码了解出错的原因，方便排查问题。

返回值

一个 Callback 对象，包含以下参数：

url

推流状态发生改变的 URL 地址。

state

当前的推流状态，详见 RtmpStreamingState。 当推流状态为 Failure (4) 时，你可以在 errorCode 参数中查看返回的错误信息。

errCode

推流错误信息，详见 RtmpStreamingErrorCode。

该回调表示本地用户收到了远端用户调用 sendStreamMessage 方法发送的流消息。

返回值

一个 Callback 对象，包含以下参数：

uid

发送消息的用户 ID。

streamId

接收到的消息的 Stream ID。

data

接收到的数据。

该回调表示本地用户未收到远端用户调用 sendStreamMessage 方法发送的流消息。

返回值

一个 Callback 对象，包含以下参数：

uid

发送消息的用户 ID。

streamId

接收到的消息的 Stream ID。

error

发生错误的错误码。

missed

丢失的消息数量。

cached

数据流中断时，后面缓存的消息数量。

在通话过程中如果 Token 即将失效，SDK 会提前 30 秒触发该回调，提醒 app 更新 Token。当收到该回调时，你需要重新在服务端生成新的 Token，然后调用 renewToken 将新生成的 Token 传给 SDK。

返回值

一个 Callback 对象，包含以下参数：

token

即将服务失效的 Token。

setLiveTranscoding 方法中的直播参数 LiveTranscoding 更新时，transcodingUpdated 回调会被触发并向主播报告更新信息。

• 通信场景下，该回调提示有远端用户加入了频道。如果加入之前，已经有其他用户在频道中了，新加入的用户也会收到这些已有用户加入频道的回调。
• 直播场景下，该回调提示有主播加入了频道。如果加入之前，已经有主播在频道中了，新加入的用户也会收到已有主播加入频道的回调。声网建议连麦主播不超过 17 人。

返回值

一个 Callback 对象，包含以下参数：

uid

新加入频道的远端用户/主播 ID。

elapsed

从本地用户调用 joinChannel 到该回调触发的延迟（毫秒)。

返回值

一个 Callback 对象，包含以下参数：

uid

离线用户或主播的用户 ID。

reason

离线原因: UserOfflineReason。

调用 enableRemoteSuperResolution 后，SDK 触发该回调报告超分辨率是否成功开启。如果未成功开启，请通过 reason 排查问题。

参数

uid

远端用户 ID。

enabled

是否对远端视频成功开启超分辨率：

• true: 成功开启超分辨率。
• false: 未成功开启超分辨率。

reason

超分辨率功能未成功开启的原因，详见 SuperResolutionStateReason。

返回值

一个 Callback 对象，包含以下参数：

oldState

之前的发布状态，详见 StreamPublishState。

newState

当前的发布状态，详见 StreamPublishState。

elapseSinceLastState

两次状态变化时间间隔（毫秒）。

返回值

一个 Callback 对象，包含以下参数：

uid

图像尺寸和旋转信息发生变化的用户的用户 ID（本地用户的 uid 为 0）。

width

视频流的宽度（像素）。

height

视频流的高度（像素）。

rotation

旋转信息，取值范围 [0,360)。

返回值

一个 Callback 对象，包含以下参数：

uid

远端用户的 ID。

oldState

之前的订阅状态，详见 StreamSubscribeState。

newState

当前的订阅状态，详见 StreamSubscribeState。

elapseSinceLastState

两次状态变化时间间隔（毫秒）。