RtcEngineEventHandler

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

返回值

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

uid

远端最活跃用户的 ID。

返回值

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

error

当方法调用失败时 SDK 返回的错误码。详细的错误信息及排查方法请参考错误码和警告码。如果该方法调用成功，SDK 会返回 0。

api

SDK 执行的 API 方法。

result

SDK 调用 API 的结果。

提示系统音频设备状态发生改变，比如耳机被拔出。

返回值

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

deviceId

设备 ID。

deviceType

设备类型定义。详见 MediaDeviceType 。

deviceState

设备状态定义。

• macOS 平台：
  • 0: 设备就绪。
  • 8: 设备被拔出。
• Windows 平台：详见 MediaDeviceStateType 。

返回值

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

deviceType

设备类型定义。详见 MediaDeviceType。

volume

音量。范围为 [0,255]。

muted

音频设备是否为静音状态：

• true: 音频设备已静音。
• false: 音频设备未被静音。

成功调用 startAudioRecordingDeviceTest、startAudioPlaybackDeviceTest 或 startAudioDeviceLoopbackTest 方法开启音频设备测试后， SDK 会按设置的时间间隔触发 audioDeviceTestVolumeIndication 回调，报告被测试音频设备的音量信息。

参数

volumeType

音量类型。详见 AudioDeviceTestVolumeType。

volume

音量大小，范围为 [0,255]。

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

返回值

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

soundId

指定音效的 ID。每个音效均有唯一的 ID。

弃用：

请改用 audioMixingStateChanged。

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

返回值

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

state

音乐文件播放状态。详见 AudioMixingStateCode。

reason

音乐文件播放状态改变的原因。详见 AudioMixingReason。

返回值

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

channel

频道名。

oldState

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

newState

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

elapseSinceLastState

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

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

返回值

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

用户 ID，指定是谁发的音频流。

quality

语音质量。

delay

音频包从发送端到接收端的延迟（毫秒），包括声音采样前处理、网络传输、网络抖动缓冲引起的延迟。

lost

音频包从发送端到接收端的丢包率 (%)。

返回值

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

routing

当前的音频路由。详见 AudioOutputRouting。

返回值

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

channel

频道名。

uid

远端用户的 ID。

oldState

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

newState

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

elapseSinceLastState

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

该回调默认禁用，你可以通过 enableAudioVolumeIndication 开启。 开启后，只要频道内有发流用户，SDK 会在加入频道后按 enableAudioVolumeIndication 中设置的时间间隔触发 audioVolumeIndication 回调。每次会触发两个 audioVolumeIndication 回调，一个报告本地发流用户的音量相关信息，另一个报告 瞬时音量最高的远端用户（最多 3 位）的音量相关信息。

返回值

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

speakers

用户音量信息，详见 AudioVolumeInfo 数组。如果 speakers 为空，则表示远端用户不发流或没有远端用户。

totalVolume

混音后的总音量，取值范围为 [0,255]。

• 在本地用户的回调中，totalVolume 为本地发流用户的音量。
• 在远端用户的回调中，totalVolume 为瞬时音量最高的远端用户（最多 3 位）混音后的总音量。

返回值

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

rect

镜头内表示曝光的区域。

返回值

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

rect

镜头内表示对焦的区域。

弃用:

请改用 localVideoStateChanged 中的 Capturing(1)。

该回调提示已成功打开摄像头，可以开始捕获视频。

返回值

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

code

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

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

返回值

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

state

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

code

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

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

返回值

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

oldRole

切换前的角色：ClientRole。

newRole

切换后的角色：ClientRole。

弃用:

请改用 connectionStateChanged。

弃用:

请改用 connectionStateChanged 回调。

SDK 在调用 joinChannel 后，无论是否加入成功，只要 10 秒和服务器无法连接就会触发该回调。如果 SDK 在断开连接后，20 分钟内还是没能重新加入频道，SDK 会停止尝试重连。

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

返回值

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

state

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

reason

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

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

返回值

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

err

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

msg

错误描述。

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

返回值

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

摄像头采集画面的宽度 (px)。

摄像头采集画面的高度 (px)。

faces

检测到的人脸信息，详见 FacePositionInfo。检测到几张人脸，就会报告几个 FacePositionInfo 数组。数组长度可以为 0，表示没有检测到摄像头前出现人脸。

弃用：

请改用 firstLocalAudioFramePublished 回调。

返回值

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

elapsed

从调用 joinChannel 方法直至该回调被触发的时间。

返回值

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

elapsed

从调用 joinChannel 方法到触发该回调的时间间隔（毫秒）。

本地视频首帧显示在本地视图上时，SDK 会触发此回调。

返回值

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

elapsed

从调用 joinChannel 到发生此事件过去的时间（毫秒）。如果在 joinChannel 前调用了 startPreview，则是从 startPreview 到发生此事件过去的时间。

返回值

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

elapsed

从调用 joinChannel 方法到触发该回调的时间间隔（毫秒）。

弃用：

请改用 remoteAudioStateChanged 。

返回值

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

uid

远端用户 ID。

elapsed

从本地用户调用 joinChannel 直至该回调触发的延迟，单位为毫秒。

弃用：

请改用 remoteAudioStateChanged 。

返回值

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

uid

发送音频帧的远端用户的用户 ID。

elapsed

从本地用户调用 joinChannel 直至该回调触发的延迟，单位为毫秒。

弃用：

请改用 remoteVideoStateChanged 回调中的：

• Starting (1)。
• Decoding (2)。

返回值

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

elapsed

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

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

返回值

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

uid

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

width

视频流宽（px）。

height

视频流高（px）。

elapsed

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

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

返回值

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

elapsed

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

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

返回值

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

result

上下行 Last mile 质量探测结果。 详见: LastmileProbeResult。

该回调描述本地用户在加入频道前的 last mile 网络探测的结果，其中 last mile 是指设备到声网边缘服务器的网络状态。

加入频道前，调用 startLastmileProbeTest 之后，SDK 触发该回调报告本地用户在加入频道前的 last mile 网络探测的结果。

返回值

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

quality

Last mile 网络质量。

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

返回值

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

stats

通话的统计数据: RtcStats。

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

返回值

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

state

当前的本地音频状态。详见 AudioLocalState。

error

本地音频出错原因。详见 AudioLocalError。

SDK 每 2 秒触发该回调一次。

返回值

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

stats

本地音频统计数据。详见 LocalAudioStats。

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

返回值

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

isFallbackOrRecover

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

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

返回值

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

uid

本地用户的 ID。

userAccount

本地用户的 User Account。

本地视频的状态发生改变时，SDK 会触发该回调返回当前的本地视频状态。你可以通过该回调了解当前视频的状态以及出现故障的原因，方便排查问题。

摄像头输出采集的视频帧时，如果连续 15 帧中，所有视频帧都一样，SDK 触发 localVideoStateChanged 回调，状态为 Capturing，错误码为 CaptureFailure。注意，帧重复检测仅针对分辨率大于 200 × 200、帧率大于等于 10 fps、码率小于 20 Kbps 的视频帧。

返回值

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

localVideoState

本地视频状态，详见 LocalVideoStreamState。

error

本地视频出错原因，详见 LocalVideoStreamError。

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

返回值

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

stats

本地视频流统计信息。详见 LocalVideoStats。

开启本地音频采集并调用 enableLocalVoicePitchCallback 后，SDK 会按 enableLocalVoicePitchCallback 中设置的时间间隔触发 localVoicePitchInHz 回调，报告本地用户的语音音调。

返回值

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

pitchInHz

本地用户的语音音调，单位为 Hz。

参数

弃用：

请改用 localAudioStateChanged 回调的：

• Stopped(0)。
• Recording(1)。

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

返回值

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

enabled

麦克风状态：

• true：麦克风已启用。
• false：麦克风已禁用。

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

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

返回值

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

uid

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

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

txQuality

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

rxQuality

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

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

参数

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

channel

频道名称。

uid

用户 ID

proxyType

连接上的代理类型。详见 CloudProxyType

localProxyIp

本地代理的 IP 地址。当 proxyType 的值不为 3 时，该参数的值为空。

elapsed

从调用 joinChannel 到 SDK 触发该回调的经过的时间（毫秒）。

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

返回值

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

type

本地网络连接类型。详见 NetworkType。

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

返回值

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

channel

频道名。

uid

重新加入频道的用户 ID。

elapsed

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

当远端有用户调用 startAudioMixing 播放本地音乐文件，会触发该回调。

当远端有用户播放本地音乐文件结束，会触发该回调。

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

返回值

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

uid

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

state

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

reason

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

elapsed

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

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

返回值

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

stats

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

该回调描述远端用户通话中端到端的网络统计信息，通过音频包计算，用客观的数据，如丢包、 网络延迟等，展示当前网络状态。通话中，当用户收到远端用户/主播发送的音频数据包后 ，会每 2 秒触发一次该回调。

返回值

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

uid

用户 ID，指定是哪个用户/主播的音频包。

delay

音频包从发送端到接收端的延时（毫秒）。

lost

音频包从发送端到接收端的丢包率 (%)。

rxKBitrate

远端音频包的接收码率（Kbps）。

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

返回值

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

uid

远端用户的用户 ID。

isFallbackOrRecover

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

返回值

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

uid

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

state

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

reason

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

elapsed

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

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

返回值

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

stats

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

弃用：

该回调已被废弃，请改用 remoteVideoStats。

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

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

返回值

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

uid

用户 ID，指定是哪个用户/主播的视频包。

delay

视频包从发送端到接收端的延时（毫秒）。

lost

视频包从发送端到接收端的丢包率 (%)。

rxKBitRate

远端视频包的接收码率（Kbps）。

返回值

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

info

音频文件信息。详见 AudioFileInfo。

error

信息获取状态。详见 AudioFileInfoError。

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

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

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

返回值

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

stats

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

返回值

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

url

旁路推流 URL。

eventCode

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

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

返回值

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

url

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

state

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

errCode

推流错误信息，详见 RtmpStreamingErrorCode。

调用 startScreenCaptureByDisplayId 或 startScreenCaptureByScreenRect 开启屏幕共享，并通过 excludeWindowList 屏蔽指定窗口时，如果窗口屏蔽失败，SDK 会触发该回调。

参数

info

屏幕共享信息。详见 ScreenCaptureInfo。

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

返回值

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

channel

频道名。

uid

用户 ID。如果 uid 为 0，表示本地用户。

filePath

截图的本地保存路径。

width

图片宽度（px）。

height

图片高度（px）。

errCode

截图成功的提示或失败的原因。

• 0：截图成功。
• < 0: 截图失败。
  • -1：写入文件失败或 JPEG 编码失败。
  • -2：takeSnapshot 方法调用成功后 1 秒内没有发现指定用户的视频流。

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

返回值

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

uid

发送消息的用户 ID。

streamId

接收到的消息的 Stream ID。

data

接收到的数据。

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

返回值

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

uid

发送消息的用户 ID。

streamId

接收到的消息的 Stream ID。

error

发生错误的错误码。

missed

丢失的消息数量。

cached

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

弃用：

请改用 rtmpStreamingStateChanged。

该回调用于通知主播推流状态。

返回值

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

url

主播推流的 URL 地址。

error

推流错误码。

• ERR_OK (0): 推流成功。
• ERR_FAILED (1): 推流失败。
• ERR_INVALID_ARGUMENT (2): 参数错误。如果你在调用 addPublishStreamUrl 前没有调用 setLiveTranscoding 配置 LiveTranscoding ，SDK 会回调 ERR_INVALID_ARGUMENT。
• ERR_TIMEDOUT (10): 推流超时未成功。
• ERR_ALREADY_IN_USE (19): 推流地址已推流。
• ERR_ENCRYPTED_STREAM_NOT_ALLOWED_PUBLISH (130): 推流已加密不能推流。
• ERR_PUBLISH_STREAM_CDN_ERROR (151): CDN 相关错误。请调用 removePublishStreamUrl 方法删除原来的推流地址，然后调用 addPublishStreamUrl 方法重新推流到新地址。
• ERR_PUBLISH_STREAM_NUM_REACH_LIMIT (152): 单个主播的推流地址数目达到上限 10。请删掉一些不用的推流地址再增加推流地址。
• ERR_PUBLISH_STREAM_NOT_AUTHORIZED (153): 操作不属于主播自己的流，如更新其他主播的流参数、停止其他主播的流。请检查应用业务逻辑。
• ERR_PUBLISH_STREAM_INTERNAL_SERVER_ERROR (154): 推流服务器出现错误。请调用 removePublishStreamUrl 重新推流。
• ERR_PUBLISH_STREAM_FORMAT_NOT_SUPPORTED (156): 推流地址格式有错误。请检查推流地址格式是否正确。

弃用：

请改用 rtmpStreamingStateChanged。

返回值

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

url

被删除的旁路推流地址。

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

当收到该回调时，你需要重新在服务端生成新的 Token，然后调用 renewToken 将新生成的 Token 传给 SDK。

返回值

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

token

即将服务失效的 Token。

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

自从

v3.3.0

调用 uploadLogFile 后，SDK 会触发该回调报告日志文件上传的结果。如果上传失败，请参考 reason 排查问题。

返回值

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

requestId

请求 ID。该请求 ID 与 uploadLogFile 中返回的 requestId 一致。你可以通过 requestId 将特定的上传和回调对应起来。

success

是否成功上传日志文件:

• true: 日志文件上传成功。
• false: 日志文件上传失败。失败的原因详见 reason 参数。

reason

日志文件上传失败的原因。详见 UploadErrorReason。

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

返回值

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

uid

用户 ID，提示是哪个用户的视频流。

enabled

远端用户是否启用视频采集：

• true: 该用户已启用视频功能。启用后，其他用户可以接收到该用户的视频流。
• false: 该用户已关闭视频功能。关闭后，该用户仍然可以接收其他用户的视频流，但其他用户接收不到该用户的视频流。

关闭视频功能是指该用户只能进行语音通话，不能显示、发送自己的视频，也不能接收、显示别人的视频。

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

返回值

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

uid

用户 ID，提示是哪个用户的视频流。

enabled

• true: 该用户已启用视频功能。
• false: 该用户已关闭视频功能。

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

返回值

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

uid

远端用户 ID。

userInfo

标识用户信息的 UserInfo 对象，包含用户 UID 和 User Account。详见 UserInfo 类。

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

返回值

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

uid

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

elapsed

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

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

返回值

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

uid

用户 ID。

muted

该用户是否静音：

• true: 该用户已将音频静音。
• false: 该用户取消了音频静音。

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

返回值

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

uid

远端用户 ID。

muted

该用户是否暂停发送其视频流

• true: 该用户已暂停发送其视频流。
• false: 该用户已恢复发送其视频流。

返回值

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

uid

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

reason

离线原因: UserOfflineReason。

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

参数

uid

远端用户 ID。

enabled

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

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

reason

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

该回调提示系统视频设备状态发生改变，比如被拔出或移除。如果设备已使用外接摄像头采集，外接摄像头被拔开后，视频会中断。

返回值

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

deviceId

设备 ID。

deviceType

设备类型。详见 MediaDeviceType。

deviceState

设备状态。详见 MediaDeviceStateType。

返回值

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

channel

频道名。

oldState

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

newState

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

elapseSinceLastState

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

返回值

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

uid

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

width

视频流的宽度（像素）。

height

视频流的高度（像素）。

rotation

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

弃用：

请改用 localVideoStateChanged 回调中的 Stopped(0)。

App 如需在停止视频后对 view 做其他处理（比如显示其他画面），可以在这个回调中进行。

返回值

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

channel

频道名。

uid

远端用户的 ID。

oldState

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

newState

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

elapseSinceLastState

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

调用 enableVirtualBackground 后，SDK 触发该回调报告虚拟背景是否成功开启。

参数

enabled

是否成功开启虚拟背景：

• true: 成功开启虚拟背景。
• false: 未成功开启虚拟背景。

reason

虚拟背景开启出错的原因或开启成功的提示。详见 VirtualBackgroundSourceStateReason。

调用 enableWirelessAccelerate (true) 开启 Wi-Fi 加速功能后，SDK 每隔两秒触发一次该回调，报告当前的 Wi-Fi 加速效果和自加入频道后平均的 Wi-Fi 加速效果。Wi-Fi 加速效果用端到端延时、丢包率和音视频卡顿率三个指标下降的百分比来衡量。

参数

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

currentStats

当前的 Wi-Fi 加速效果。详见 WlAccStats。

averageStats

自加入频道后平均的 Wi-Fi 加速效果。详见 WlAccStats 。

调用 enableWirelessAccelerate(true) 开启 Wi-Fi 加速功能后，当 Wi-Fi 连接质量不佳时，SDK 会触发该回调，报告 Wi-Fi 连接质量不佳的原因和改善 Wi-Fi 连接的操作建议。

参数

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

reason

Wi-Fi 连接质量不佳的原因。详见 WlaccMessageReason 。

action

改善 Wi-Fi 连接质量的操作建议。详见 WlaccSuggestAction 。

wlAccMsg

根据 action 的值提供的详细帮助信息：

• 当 action 为 ，该参数的值为 NULL。
• 当 action 为 ConnectSsid，该参数的值为推荐用户连接的网络名称（SSID）。
• 当 action 为 Check5g，该参数的值为开启路由器 5G 频道的操作步骤的链接。
• 当 action 为 ModifySsid，该参数的值为修改网络名称（SSID）的操作步骤的链接。

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

返回值

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

warn

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

msg

警告描述。