React Native API Reference

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

Note

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

当调用 playEffect 播放音效结束后，会触发该回调。

当调用 startAudioMixing 播放伴奏音乐结束后，会触发该回调。

如果该方法调用失败，会在 Warning 回调里，返回 警告码 AudioMixingOpenError。

自从 v3.4.2

该回调在音乐文件播放状态发生改变时触发，并报告当前的播放状态和播放状态改变的原因。

自从 v3.1.2。

deprecated

该回调已废弃。请改用 RemoteAudioStats 方法。

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

该回调返回当前的音频路由已切换至听筒、扬声器、耳机或蓝牙。

自从 v3.1.2。

该回调提示频道内瞬时音量最高的几个用户（最多三个）的用户 ID、他们的音量及本地用户是否在说话。

该回调默认禁用。可以通过启用说话者音量提示 enableAudioVolumeIndication 方法开启； 开启后，无论频道内是否有人说话，都会按方法中设置的时间间隔返回提示音量。

每次触发，用户会收到两个独立的 AudioVolumeIndication 回调，其中一个包含本地用户的音量信息，另一个包含远端所有用户的音量信息，详见下方参数描述。

Note

• 若需使用该回调 speakers 数组中的 vad 参数（即本地人声检测功能），请在 enableAudioVolumeIndication 方法中设置 report_vad 为 true。
• 用户调用 muteLocalAudioStream 方法会对 SDK 行为产生影响：
  • 本地用户调用该方法后 SDK 即不再返回本地用户的音量提示回调。
  • 远端用户调用该方法后 20 秒，远端说话者的音量提示回调将不再包含该用户；如果所有远端用户调用该方法后 20 秒， SDK 即不再返回远端说话者的音量提示回调。

该回调是由本地用户调用 setCameraExposurePosition 方法改变曝光位置触发的。

该回调是由本地用户调用 setCameraFocusPositionInPreview 方法改变对焦位置触发的。

deprecated

该回调已废弃。请改用 LocalVideoStateChanged 回调中的 Capturing。 提示已成功打开摄像头，可以开始捕获视频。如果摄像头打开失败，可在 Error 中处理相应错误。

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

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

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

deprecated

该回调已废弃。请改用 ConnectionStateChanged 回调。

当你被服务端禁掉连接的权限时，会触发该回调。

deprecated

该回调已经废弃。请改用 ConnectionStateChanged 回调。

SDK 在和服务器建立连接后，失去了网络连接超过 4 秒，会触发该回调。在触发事件后，SDK 会主动重连服务器，所以该事件可以用于 UI 提示。 与 ConnectionLost 回调的区别是：

• ConnectionInterrupted 回调一定是发生在 joinChannel 成功后，且 SDK 刚失去和服务器连接超过 4 秒时触发。
• ConnectionLost 回调是无论之前 joinChannel 是否连接成功，只要 10 秒内和服务器无法建立连接都会触发。

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

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

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

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

表示 SDK 运行时出现了（网络或媒体相关的）错误。通常情况下，SDK 上报的错误意味着 SDK 无法自动恢复， 需要 App 干预或提示用户。例如启动通话失败时，SDK 会上报 StartCall 错误。 App 可以提示用户启动通话失败，并调用 leaveChannel 退出频道。

调用 enableFaceDetection 开启本地人脸检测后，你可以通过该回调实时获取以下人脸检测的信息：

• 摄像头采集的画面大小。
• 人脸在画面中的位置。
• 人脸距设备屏幕的距离。

其中，人脸距设备屏幕的距离由 SDK 通过摄像头采集的画面大小和人脸在画面中的位置拟合计算得出。

Note

• 当检测到摄像头前没有人脸时，该回调触发频率会降低，以节省设备耗能。
• 当人脸距离设备屏幕过近时，SDK 不会触发该回调。
• Android 平台上，人脸距设备屏幕的距离（distance）值有一定误差，请不要用它进行精确计算。

deprecated

自 v3.1.2 起废弃。请改用 FirstLocalAudioFramePublished。

自从 v3.1.2。

SDK 会在以下三种时机触发该回调：

• 开启本地音频的情况下，调用 joinChannel 成功加入频道后。
• 调用 muteLocalAudioStream(true)，再调用 muteLocalAudioStream(false) 后。
• 调用 disableAudio，再调用 enableAudio 后。

第一帧本地视频显示在本地视图上时，触发此回调。

自从 v3.1.2。

SDK 会在以下三种时机触发该回调：

• 开启本地视频的情况下，调用 joinChannel 成功加入频道后。
• 调用 muteLocalVideoStream(true)，再调用muteLocalVideoStream(false)后。
• 调用 disableVideo，再调用enableVideo后。

deprecated

该回调已废弃，请改用 RemoteAudioStateChanged 中的 Decoding。

SDK 完成远端音频首帧解码，并发送给音频模块用以播放时，会触发此回调。有两种情况：

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

deprecated

该回调已废弃。请改用 RemoteAudioStateChanged 中的 Starting。

deprecated

该回调已废弃。请改用 RemoteVideoStateChanged 回调中的 Starting 或 Decoding。

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

• 远端用户首次上线后发送视频。
• 远端用户视频离线再上线后发送视频。

其中，视频离线与用户离线不同。视频离线指本地在 15 秒内没有收到视频包，可能有如下原因：

• 远端用户离开频道。
• 远端用户掉线。
• 远端用户停止发送本地视频流（调用了 muteLocalVideoStream）。
• 远端用户关闭本地视频模块（调用了 disableVideo）。

deprecated

该回调已废弃。请改用 RemoteVideoStateChanged 中的 Starting 和 Decoding 代替。

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

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

在调用 startLastmileProbeTest 之后，SDK 会在约 30 秒内返回该回调。

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

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

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

Note

当状态为 Failed 时，你可以在 error 参数中查看返回的错误信息。

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

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

如果本地推流已回退为音频流，远端的 App 上会收到 RemoteVideoStateChanged 的回调。

本地用户成功调用 registerLocalUserAccount 方法注册用户 User Account，或 调用 joinChannelWithUserAccount 加入频道后，SDK 会触发该回调， 并告知本地用户的 UID 和 User Account。

本地视频的状态发生改变时，SDK 会触发该回调返回当前的本地视频状态； 当状态为 Failed 时，你可以在 error 参数中查看返回的错误信息。 该接口在本地视频出现故障时，方便你了解当前视频的状态以及出现故障的原因，方便排查问题。

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

deprecated

该回调已废弃。请改用 LocalAudioStateChanged 回调中的 Stopped 或 Recording。

该回调由本地用户调用 enableLocalAudio 方法开启或关闭本地音频采集触发的。

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

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

本地网络连接类型发生改变时，SDK 会触发该回调，并在回调中明确当前的网络连接类型。 你可以通过该回调获取正在使用的网络类型；当连接中断时，该回调能辨别引起中断的原因是网络切换还是网络条件不好。

since

v3.6.2

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

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

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

Note

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

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

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

deprecated

该回调已废弃。请改用 RemoteAudioStats。

该回调描述远端用户通话中端到端的网络统计信息，通过音频包计算，用客观的数据，如丢包、网络延迟等，展示当前网络状态。

通话中，当用户收到远端用户/主播发送的音频数据包后，会每 2 秒触发一次该回调。

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

Note

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

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

deprecated

该回调已废弃。请改用 RemoteVideoStats。

该回调描述远端用户通话中端到端的网络统计信息，通过视频包计算，用客观的数据，如丢包、网络延迟等 ，展示当前网络状态。

通话中，当用户收到远端用户/主播发送的视频数据包后，会每 2 秒触发一次该回调。

自从 v3.5.2

成功调用 getAudioFileInfo 后，SDK 会触发该回调并报告音频文件的路径、时长等信息。

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

自从 v3.1.2。

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

自从 v3.5.2

成功调用 takeSnapshot 后，SDK 触发该回调报告截图是否成功和获取截图的详情。

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

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

deprecated

该回调已废弃。请改用 RtmpStreamingStateChanged。

该回调返回 addPublishStreamUrl 方法的调用结果。 用于通知主播是否推流成功。如果不成功，你可以在 error 参数中查看详细的错误信息。

deprecated

该回调已废弃。请改用 RtmpStreamingStateChanged。

该回调返回 removePublishStreamUrl 方法的调用结果。用于通知主播是否停止推流成功。

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

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

Note

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

提示有其他用户启用/关闭了本地视频功能。

该回调是由远端用户调用 enableLocalVideo 方法开启或关闭视频采集触发的。

提示有远端用户启用/关闭了视频功能。

该回调是由远端用户调用 enableVideo 或 disableVideo 方法 开启或关闭视频模块触发的。

Note

当频道内的用户（通信场景）或主播（直播场景）的人数超过 17 时，声网建议你不要使用该回调。

远端用户加入频道后， SDK 会获取到该远端用户的 UID 和 User Account，然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表， 并在本地触发该回调。

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

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

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

Note

直播场景下：

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

提示有其他用户将他的音频流静音/取消静音。

该回调是由远端用户调用 muteLocalAudioStream 方法关闭或开启音频发送触发的。

Note

当频道内的用户（通信场景）或主播（直播场景）的人数超过 17 时，声网建议你不要使用该回调。

该回调是由远端用户调用 muteLocalVideoStream 方法关闭或开启视频发送触发的。

Note

当频道内的用户（通信场景）或主播（直播场景）的人数超过 17 时，声网建议你不要使用该回调。

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

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

自从 v3.1.2。

deprecated

该回调已废弃。请改用 LocalVideoStateChanged 回调中的 Stopped。 提示视频功能已停止。 App 如需在停止视频后对 view 做其他处理（例如显示其他画面），可以在这个回调中进行。

自从 v3.1.2。

该回调方法表示 SDK 运行时出现了（网络或媒体相关的）警告。通常情况下， SDK 上报的警告信息 App 可以忽略，SDK 会自动恢复。 例如和服务器失去连接时，SDK 可能会 上报 LookupChannelTimeout 警告，同时自动尝试重连。