React Native API Reference

该回调获取当前时间段内累积音量最大者。 如果该用户开启了 enableAudioVolumeIndication 功能， 则当音量检测模块监测到频道内有新的活跃用户说话时，会通过本回调返回该用户的 uid。

Note

• 你需要开启 enableAudioVolumeIndication 方法才能收到该回调。
• uid 返回的是当前时间段内声音最大的用户 ID，而不是瞬时声音最大的用户 ID。

自从 v3.1.2。

自从 v3.1.2。

该回调报告跨频道媒体流转发过程中发生的事件。

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

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

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

如果 SDK 在断开连接后，20 分钟内还是没能重新加入频道，SDK 会停止尝试重连。

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

since

v3.7.0

This callback is triggered after the first frame of the remote video is rendered on the video window. The application can retrieve the data of the time elapsed from the user joining the channel until the first video frame is displayed.

表示客户端已经登入服务器，且分配了频道 ID 和用户 ID。频道 ID 的分配是 根据 joinChannel 方法中指定的频道名称。如果调用 joinChannel 时并未指定用户 ID，服务器就会分配一个。

App 调用 leaveChannel 方法时，SDK 提示 App 离开频道成功。

在该回调方法中，App 可以得到此次通话的总通话时长、SDK 收发数据的流量等信息。

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

该回调描述每个用户在通话中的 last mile 网络状态，其中 last mile 是指设备到声网边缘服务器的网络状态。 该回调每 2 秒触发一次。如果远端有多个用户/主播，该回调每 2 秒会被触发多次。

Note 用户不发流时，txQuality 为 Unknown ；用户不收流时，rxQuality 为 Unknown。

since

v3.6.2

通过该回调你可以监听 SDK 连接代理的状态。例如，当用户调用 setCloudProxy 设置代理 并成功加入频道后，SDK 会触发该回调报告用户 ID、连接的代理类型和从调用 joinChannel 到触发该回调经过的时间等。

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

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

Note

当频道内的用户（通信场景）或主播（直播场景）的人数超过 17 时，该回调可能不准确。

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

当网络发生丢包时，因 FEC（Forward Error Correction，向前纠错码）或重传恢复，最终的音频丢帧率不高，则可以认为整个质量较好。

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

Note

远端订阅流因弱网环境不能同时满足音视频而回退为小流时，你可以使用 RemoteVideoStats 来监控远端视频大小流的切换。

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

在调用 joinChannel 时如果指定了 Token， 由于 Token 具有一定的时效，在通话过程中 SDK 可能由于网络原因和服务器失去连接，重连时可能需要新的 Token。该回调通知 App 需要生成新的 Token， 并需调用 joinChannel 重新加入频道。

自从 v3.1.2。

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

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

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

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

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

Note

首次调用 setLiveTranscoding 方法设置转码参数时，不会触发该回调。

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

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

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

Note 直播场景下：

• 主播间能相互收到新主播加入频道的回调，并能获得该主播的用户 ID。
• 观众也能收到新主播加入频道的回调，并能获得该主播的用户 ID。
• 当 Web 端加入直播频道时，只要 Web 端有推流，SDK 会默认该 Web 端为主播，并触发该回调。

提示有远端用户/主播离开了频道（或掉线）。用户离开频道有两个原因，即正常离开和超时掉线：

• 正常离开的时候，远端用户/主播会收到类似“再见”的消息，接收此消息后，判断用户离开频道。
• 超时掉线的依据是，在一定时间内（约 20 秒），用户没有收到对方的任何数据包，则判定为对方掉线。在网络较差的情况下， 有可能会误报。声网建议使用声网实时消息 SDK 来做可靠的掉线检测。

自从 v3.1.2。

自从 v3.1.2。