IAgoraRtcEngineEventHandler - 语音通话 (Legacy) - 文档中心

OnActiveSpeaker

监测到最活跃用户回调。

public virtual void OnActiveSpeaker(uint uid)

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

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

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

参数

uid: 远端最活跃用户的 ID。

OnApiCallExecuted

API 方法已执行回调。

public virtual void OnApiCallExecuted(int err, string api, string result)

参数

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

OnAudioDeviceStateChanged

音频设备变化回调。

public virtual void OnAudioDeviceStateChanged(string deviceId, int deviceType, int deviceState)

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

注意：该方法仅适用于 Windows 和 macOS 平台。

参数

deviceId

设备 ID。

deviceType

设备类型定义。详见 MEDIA_DEVICE_TYPE 。

deviceState

设备状态定义。

Windows 平台：详见 MEDIA_DEVICE_STATE_TYPE 。

OnAudioDeviceTestVolumeIndication

音频设备测试回调。

public virtual void OnAudioDeviceTestVolumeIndication(AudioDeviceTestVolumeType volumeType, int volume)

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

参数

volumeType: 音量类型。详见 AudioDeviceTestVolumeType。
volume: 音量大小，范围为 [0,255]。

OnAudioDeviceVolumeChanged

回放、音频采集设备或 App 的音量发生改变。

public virtual void OnAudioDeviceVolumeChanged(MEDIA_DEVICE_TYPE deviceType, int volume, bool muted)

参数

deviceType

设备类型定义。详见 MEDIA_DEVICE_TYPE。

volume

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

muted

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

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

OnAudioEffectFinished

本地音效文件播放已结束回调。

public virtual void OnAudioEffectFinished(int soundId)

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

参数

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

OnAudioMixingStateChanged

音乐文件的播放状态已改变回调。

public virtual void OnAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason)

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

参数

state: 音乐文件播放状态。详见 AUDIO_MIXING_STATE_TYPE。
reason: 音乐文件播放状态改变的原因。详见 AUDIO_MIXING_REASON_TYPE。

OnAudioPublishStateChanged

音频发布状态改变回调。

public virtual void OnAudioPublishStateChanged(string channel, STREAM_PUBLISH_STATE oldState,
            STREAM_PUBLISH_STATE newState, int elapseSinceLastState)

参数

channel: 频道名。
oldState: 之前的发布状态，详见 STREAM_PUBLISH_STATE。
newState: 当前的发布状态，详见 STREAM_PUBLISH_STATE。
elapseSinceLastState: 两次状态变化时间间隔（毫秒）。

OnAudioQuality

远端声音质量回调。

public virtual void OnAudioQuality(uint uid, int quality, ushort delay, ushort lost)

弃用：: 请改用 OnRemoteAudioStats。

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

参数

uid: 用户 ID，指定是谁发的音频流。
quality: 语音质量。详见 QUALITY_TYPE。
delay: 音频包从发送端到接收端的延迟（毫秒），包括声音采样前处理、网络传输、网络抖动缓冲引起的延迟。
lost: 音频包从发送端到接收端的丢包率 (%)。

OnAudioSubscribeStateChanged

音频订阅状态发生改变回调。

public virtual void OnAudioSubscribeStateChanged(string channel, uint uid, STREAM_SUBSCRIBE_STATE oldState,
            STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)

参数

channel: 频道名。
uid: 远端用户的 ID。
oldState: 之前的订阅状态，详见 STREAM_SUBSCRIBE_STATE。
newState: 当前的订阅状态，详见 STREAM_SUBSCRIBE_STATE。
elapseSinceLastState: 两次状态变化时间间隔（毫秒）。

OnAudioVolumeIndication

用户音量提示回调。

public virtual void OnAudioVolumeIndication(AudioVolumeInfo[] speakers, uint speakerNumber, int totalVolume)

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

注意：启用该功能后，如果有用户将自己静音（调用了 MuteLocalAudioStream），SDK 行为会受如下影响：

本地用户静音后，SDK 立即停止报告本地用户的音量提示回调。
瞬时音量最高的远端用户静音后 20 秒，远端的音量提示回调中将不再包含该用户；如果远端所有用户都将自己静音，20 秒后 SDK 停止报告远端用户的音量提示回调。

参数

speakers

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

speakerNumber

用户数量。

在本地用户的回调中，只要本地用户在发流，speakerNumber 始终为 1。
在远端用户的回调中，speakerNumber 取值范围为 [0,3]。如果远端发流用户数量大于 3，则此回调中 speakerNumber 值为 3。

totalVolume

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

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

OnCameraReady

摄像头就绪回调。

public virtual void OnCameraReady()

弃用:: 请改用 OnLocalVideoStateChanged 中的 LOCAL_VIDEO_STREAM_STATE_CAPTURING(1)。

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

OnChannelMediaRelayEvent

跨频道媒体流转发事件回调。

public virtual void OnChannelMediaRelayEvent(CHANNEL_MEDIA_RELAY_EVENT code)

参数

code: 跨频道媒体流转发事件码。详见 CHANNEL_MEDIA_RELAY_EVENT。

OnChannelMediaRelayStateChanged

跨频道媒体流转发状态发生改变回调。

public virtual void OnChannelMediaRelayStateChanged(CHANNEL_MEDIA_RELAY_STATE state,
            CHANNEL_MEDIA_RELAY_ERROR code)

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

参数

state: 跨频道媒体流转发状态。详见 CHANNEL_MEDIA_RELAY_STATE。
code: 跨频道媒体流转发出错的错误码。详见 CHANNEL_MEDIA_RELAY_ERROR。

OnClientRoleChanged

直播场景下用户角色切换成功回调。

public virtual void OnClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)

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

参数

oldRole: 切换前的角色：CLIENT_ROLE_TYPE。
newRole: 切换后的角色：CLIENT_ROLE_TYPE。

OnConnectionBanned

网络连接已被服务器禁止回调。

public virtual void OnConnectionBanned()

弃用:: 请改用 OnConnectionStateChanged。

参数

OnConnectionInterrupted

网络连接中断回调。

public virtual void OnConnectionInterrupted()

弃用:: 请改用 OnConnectionStateChanged 回调。

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

OnConnectionInterrupted 回调一定是发生在成功加入频道后，且 SDK 刚失去和服务器连接超过 4 秒时触发。
OnConnectionLost 回调是无论是否成功加入频道，只要 10 秒内和服务器无法建立连接都会触发。

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

参数

OnConnectionLost

网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。

public virtual void OnConnectionLost()

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

参数

OnConnectionStateChanged

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

public virtual void OnConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)

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

参数

state: 当前网络连接状态。详见 CONNECTION_STATE_TYPE。
reason: 引起当前网络连接状态改变的原因。详见 CONNECTION_CHANGED_REASON_TYPE。

OnError

发生错误回调。

public virtual void OnError(int err, string msg)

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

参数

err: 错误代码。详见错误码和警告码。
msg: 错误描述。

OnFirstLocalAudioFrame

已发送本地音频首帧回调。

public virtual void OnFirstLocalAudioFrame(int elapsed)

弃用：: 请改用 OnFirstLocalAudioFramePublished 回调。

参数

elapsed: 从调用 JoinChannel [2/2] 方法直至该回调被触发的时间。

OnFirstLocalAudioFramePublished

已发布本地音频首帧回调。

public virtual void OnFirstLocalAudioFramePublished(int elapsed)

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

开启本地音频的情况下，调用 JoinChannel [2/2] 成功加入频道后。
调用 MuteLocalAudioStream(true)，再调用 MuteLocalAudioStream(false) 后。
调用 DisableAudio，再调用 EnableAudio 后。

参数

elapsed: 从调用 JoinChannel [2/2] 方法到触发该回调的时间间隔（毫秒）。

OnFirstLocalVideoFrame

已显示本地视频首帧回调。

public virtual void OnFirstLocalVideoFrame(int width, int height, int elapsed)

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

参数

width: 本地渲染视频的宽 (px) 。
height: 本地渲染视频的高 (px)。
elapsed: 从调用 JoinChannel [2/2] 到发生此事件过去的时间（毫秒）。如果在 JoinChannel [2/2] 前调用了 StartPreview，则是从 StartPreview 到发生此事件过去的时间。

OnFirstLocalVideoFramePublished

已发布本地视频首帧回调。

public virtual void OnFirstLocalVideoFramePublished(int elapsed)

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

开启本地视频的情况下，调用 JoinChannel [2/2] 成功加入频道后。
调用 MuteLocalVideoStream(true)，再调用 MuteLocalVideoStream(false) 后。
调用 DisableVideo，再调用 EnableVideo 后。

参数

elapsed: 从调用 JoinChannel [2/2] 方法到触发该回调的时间间隔（毫秒）。

OnFirstRemoteAudioDecoded

已解码远端音频首帧的回调。

public virtual void OnFirstRemoteAudioDecoded(uint uid, int elapsed)

弃用：: 请改用 OnRemoteAudioStateChanged 。

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

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

参数

uid: 远端用户 ID。
elapsed: 从本地用户调用 JoinChannel [2/2] 直至该回调触发的延迟，单位为毫秒。

OnFirstRemoteAudioFrame

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

public virtual void OnFirstRemoteAudioFrame(uint uid, int elapsed)

弃用：: 请改用 OnRemoteAudioStateChanged 。

参数

uid: 发送音频帧的远端用户的用户 ID。
elapsed: 从本地用户调用 JoinChannel [2/2] 直至该回调触发的延迟，单位为毫秒。

OnFirstRemoteVideoDecoded

已接收到远端视频并完成解码回调。

public virtual void OnFirstRemoteVideoDecoded(uint uid, int width, int height, int elapsed)

弃用：

请改用 OnRemoteVideoStateChanged 回调中的：

REMOTE_VIDEO_STATE_STARTING (1)。
REMOTE_VIDEO_STATE_DECODING (2)。

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

远端用户首次上线后发送视频。
远端用户视频离线再上线后发送视频。出现这种中断的可能原因包括：
- 远端用户离开频道。
- 远端用户掉线。
- 远端用户调用 MuteLocalVideoStream 方法停止发送本地视频流。
- 远端用户调用 DisableVideo 方法关闭视频模块。

参数

uid: 用户 ID，指定是哪个用户的视频流。
width: 视频流宽（px）。
height: 视频流高（px）。
elapsed: 从本地调用 JoinChannel [2/2] 开始到该回调触发的延迟（毫秒)。

OnFirstRemoteVideoFrame

已显示首帧远端视频回调。

public virtual void OnFirstRemoteVideoFrame(uint uid, int width, int height, int elapsed)

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

参数

uid: 用户 ID，指定是哪个用户的视频流。
width: 视频流宽（px）。
height: 视频流高（px）。
elapsed: 从本地调用 JoinChannel [2/2] 到发生此事件过去的时间（毫秒)。

OnJoinChannelSuccess

成功加入频道回调。

public virtual void OnJoinChannelSuccess(string channel, uint uid, int elapsed)

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

参数

channel: 频道名。
uid: 加入频道的用户 ID。
elapsed: 从本地调用 JoinChannel [2/2] 开始到发生此事件过去的时间（毫秒）。

OnLastmileProbeResult

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

public virtual void OnLastmileProbeResult(LastmileProbeResult result)

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

参数

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

OnLastmileQuality

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

public virtual void OnLastmileQuality(int quality)

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

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

参数

quality: Last mile 网络质量。详见 QUALITY_TYPE 。

OnLeaveChannel

离开频道回调。

public virtual void OnLeaveChannel(RtcStats stats)

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

参数

stats: 通话的统计数据: RtcStats。

OnLocalAudioStateChanged

本地音频状态发生改变回调。

public virtual void OnLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error)

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

注意：当状态为 LOCAL_AUDIO_STREAM_STATE_FAILED (3) 时，你可以在 error 参数中查看返回的错误信息。

参数

state: 当前的本地音频状态。详见 LOCAL_AUDIO_STREAM_STATE。
error: 本地音频出错原因。详见 LOCAL_AUDIO_STREAM_ERROR。

OnLocalAudioStats

通话中本地音频流的统计信息回调。

public virtual void OnLocalAudioStats(LocalAudioStats stats)

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

参数

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

OnLocalPublishFallbackToAudioOnly

本地发布流已回退为音频流回调。

public virtual void OnLocalPublishFallbackToAudioOnly(bool isFallbackOrRecover)

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

注意：如果本地发流已回退为音频流，远端的 App 上会收到 OnUserMuteVideo 的回调事件。

参数

isFallbackOrRecover

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

OnLocalUserRegistered

本地用户成功注册 User Account 回调。

public virtual void OnLocalUserRegistered(uint uid, string userAccount)

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

参数

uid: 本地用户的 ID。
userAccount: 本地用户的 User Account。

OnLocalVideoStateChanged

本地视频状态发生改变回调。

public virtual void OnLocalVideoStateChanged(LOCAL_VIDEO_STREAM_STATE localVideoState,
            LOCAL_VIDEO_STREAM_ERROR error)

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

SDK 会在如下情况触发 OnLocalVideoStateChanged 回调，状态为 LOCAL_VIDEO_STREAM_STATE_FAILED，错误码为 LOCAL_VIDEO_STREAM_ERROR_CAPTURE_FAILURE：

应用退到后台，系统回收摄像头。
摄像头正常启动，但连续 4 秒都没有输出采集的视频。

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

注意：对某些机型而言，当本地视频采集设备正在使用中时，SDK 不会在本地视频状态发生改变时触发该回调，你需要自行做超时判断。

参数

localVideoState: 本地视频状态，详见 LOCAL_VIDEO_STREAM_STATE。
error: 本地视频出错原因，详见 LOCAL_VIDEO_STREAM_ERROR。

OnLocalVideoStats

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

public virtual void OnLocalVideoStats(LocalVideoStats stats)

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

参数

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

OnMediaEngineLoadSuccess

媒体引擎成功加载的回调。

public virtual void OnMediaEngineLoadSuccess()

OnMediaEngineStartCallSuccess

媒体引擎成功启动的回调。

public virtual void OnMediaEngineStartCallSuccess()

OnMetadataReceived

接收端已收到 metadata。

public virtual void OnMetadataReceived(Metadata metadata)

参数

metadata: 接收到的 metadata。

OnMicrophoneEnabled

麦克风状态已改变回调。

public virtual void OnMicrophoneEnabled(bool enabled)

弃用：

请改用 OnLocalAudioStateChanged 回调的：

LOCAL_AUDIO_STREAM_STATE_STOPPED(0)。
LOCAL_AUDIO_STREAM_STATE_RECORDING(1)。

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

参数

enabled

麦克风状态：

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

OnNetworkQuality

通话中每个用户的网络上下行 last mile 质量报告回调。

public virtual void OnNetworkQuality(uint uid, int txQuality, int rxQuality)

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

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

参数

uid

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

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

txQuality

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

rxQuality

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

OnNetworkTypeChanged

本地网络类型发生改变回调。

public virtual void OnNetworkTypeChanged(NETWORK_TYPE type)

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

参数

type: 本地网络连接类型。详见 NETWORK_TYPE。

OnReadyToSendMetadata

发送端已准备好发送 metadata。

public virtual bool OnReadyToSendMetadata(Metadata metadata)
        {
            return true;
        }

当 SDK 准备好发送 metadata 时，会触发该回调。

收到该回调后，你可以调用 SendMetadata 发送媒体附属信息。

参数

metadata: 用户想要发送的 metadata。详见 Metadata。

返回值

true: 发送
false: 不发送

OnRejoinChannelSuccess

成功重新加入频道回调。

public virtual void OnRejoinChannelSuccess(string channel, uint uid, int elapsed)

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

参数

channel: 频道名。
uid: 重新加入频道的用户 ID。
elapsed: 从本地开始重连到发生此事件过去的时间（毫秒）。

OnRemoteAudioMixingBegin

远端音乐文件播放已开始回调。

public virtual void OnRemoteAudioMixingBegin()

当远端有用户调用 StartAudioMixing [2/2] 播放本地音乐文件，会触发该回调。

OnRemoteAudioMixingEnd

远端音乐文件播放已结束回调。

public virtual void OnRemoteAudioMixingEnd()

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

OnRemoteAudioStateChanged

远端音频流状态发生改变回调。

public virtual void OnRemoteAudioStateChanged(uint uid, REMOTE_AUDIO_STATE state,
            REMOTE_AUDIO_STATE_REASON reason, int elapsed)

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

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

参数

uid: 发生音频状态改变的远端用户 ID。
state: 远端音频流状态，详见 REMOTE_AUDIO_STATE。
reason: 远端音频流状态改变的具体原因，详见 REMOTE_AUDIO_STATE_REASON。
elapsed: 从本地用户调用 JoinChannel [2/2] 方法到发生本事件经历的时间，单位为毫秒。

OnRemoteAudioStats

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

public virtual void OnRemoteAudioStats(RemoteAudioStats stats)

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

参数

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

OnRemoteAudioTransportStats

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

public virtual void OnRemoteAudioTransportStats(uint uid, ushort delay, ushort lost, ushort rxKBitRate)

弃用：: 请改用 OnRemoteAudioStats。

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

参数

uid: 用户 ID，指定是哪个用户/主播的音频包。
delay: 音频包从发送端到接收端的延时（毫秒）。
lost: 音频包从发送端到接收端的丢包率 (%)。
rxKBitrate: 远端音频包的接收码率（Kbps）。

OnRemoteSubscribeFallbackToAudioOnly

远端订阅流已回退为音频流回调。

public virtual void OnRemoteSubscribeFallbackToAudioOnly(uint uid, bool isFallbackOrRecover)

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

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

参数

uid

远端用户的用户 ID。

isFallbackOrRecover

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

OnRemoteVideoStateChanged

远端视频状态发生改变回调。

public virtual void OnRemoteVideoStateChanged(uint uid, REMOTE_VIDEO_STATE state,
            REMOTE_VIDEO_STATE_REASON reason, int elapsed)

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

参数

uid: 发生视频状态改变的远端用户 ID。
state: 远端视频流状态，详见 REMOTE_VIDEO_STATE。
reason: 远端视频流状态改变的具体原因，详见 REMOTE_VIDEO_STATE_REASON。
elapsed: 从本地用户调用 JoinChannel [2/2] 方法到发生本事件经历的时间，单位为毫秒。

OnRemoteVideoStats

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

public virtual void OnRemoteVideoStats(RemoteVideoStats stats)

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

参数

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

OnRemoteVideoTransportStats

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

public virtual void OnRemoteVideoTransportStats(uint uid, ushort delay, ushort lost, ushort rxKBitRate)

弃用：: 该回调已被废弃，请改用 OnRemoteVideoStats。

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

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

参数

uid: 用户 ID，指定是哪个用户/主播的视频包。
delay: 视频包从发送端到接收端的延时（毫秒）。
lost: 视频包从发送端到接收端的丢包率 (%)。
rxKBitRate: 远端视频包的接收码率（Kbps）。

OnRequestAudioFileInfo

音频文件信息回调。

public virtual void OnRequestAudioFileInfo(AudioFileInfo info, AUDIO_FILE_INFO_ERROR error)

参数

info: 音频文件信息。详见 AudioFileInfo。
error: 信息获取状态。详见 AUDIO_FILE_INFO_ERROR。

OnRequestToken

Token 已过期回调。

public virtual void OnRequestToken()

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

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

OnRtcStats

当前通话统计信息回调。

public virtual void OnRtcStats(RtcStats stats)

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

参数

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

OnRtmpStreamingEvent

旁路推流事件回调。

public virtual void OnRtmpStreamingEvent(string url, RTMP_STREAMING_EVENT eventCode)

参数

url: 旁路推流 URL。
eventCode: 旁路推流事件码。详见 RTMP_STREAMING_EVENT。

OnRtmpStreamingStateChanged

旁路推流状态发生改变回调。

public virtual void OnRtmpStreamingStateChanged(string url, RTMP_STREAM_PUBLISH_STATE state,
            RTMP_STREAM_PUBLISH_ERROR errCode)

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

参数

url: 推流状态发生改变的 URL 地址。
state: 当前的推流状态，详见 RTMP_STREAM_PUBLISH_STATE。当推流状态为 RTMP_STREAM_PUBLISH_STATE_FAILURE (4) 时，你可以在 errorCode 参数中查看返回的错误信息。
errCode: 推流错误信息，详见 RTMP_STREAM_PUBLISH_ERROR_TYPE。

OnProxyConnected

代理连接状态回调。

public virtual void OnProxyConnected(string channel, uint uid, PROXY_TYPE proxyType, string localProxyIp, int elapsed)

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

参数

channel: 频道名称。
uid: 用户 ID
proxyType: 连接上的代理类型。详见 CLOUD_PROXY_TYPE
localProxyIp: 本地代理的 IP 地址。当 proxyType 的值不为 3 时，该参数的值为空。
elapsed: 从调用 JoinChannel [1/2] 到 SDK 触发该回调的经过的时间（毫秒）。

OnScreenCaptureInfoUpdated

屏幕共享信息更新回调。

public virtual void OnScreenCaptureInfoUpdated(ScreenCaptureInfo info)

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

参数

info: 屏幕共享信息。详见 ScreenCaptureInfo。

OnSnapshotTaken

视频截图结果回调。

public virtual void OnSnapshotTaken(string channel, uint uid, string filePath, int width, int height, int errCode)

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

参数

channel

频道名。

uid

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

filePath

截图的本地保存路径。

width

图片宽度（px）。

height

图片高度（px）。

errCode

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

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

OnStreamMessage

接收到对方数据流消息的回调。

public virtual void OnStreamMessage(uint uid, int streamId, byte[] data, uint length)

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

参数

uid: 发送消息的用户 ID。
streamId: 接收到的消息的 Stream ID。
data: 接收到的数据。
length: 数据长度，单位为字节。

OnStreamMessageError

接收对方数据流消息发生错误的回调。

public virtual void OnStreamMessageError(uint uid, int streamId, int code, int missed, int cached)

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

参数

uid: 发送消息的用户 ID。
streamId: 接收到的消息的 Stream ID。
code: 发生错误的错误码。
missed: 丢失的消息数量。
cached: 数据流中断时，后面缓存的消息数量。

OnStreamPublished

旁路推流已开启回调。

public virtual void OnStreamPublished(string url, int error)

弃用：: 请改用 OnRtmpStreamingStateChanged。

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

参数

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): 推流地址格式有错误。请检查推流地址格式是否正确。

OnStreamUnpublished

旁路推流已停止回调。

public virtual void OnStreamUnpublished(string url)

弃用：: 请改用 OnRtmpStreamingStateChanged。

参数

url: 被删除的旁路推流地址。

OnTokenPrivilegeWillExpire

Token 服务将在30s内过期回调。

public virtual void OnTokenPrivilegeWillExpire(string token)

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

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

参数

token: 即将服务失效的 Token。

OnTranscodingUpdated

旁路推流转码设置已被更新回调。

public virtual void OnTranscodingUpdated()

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

注意：首次调用 SetLiveTranscoding 方法设置转码参数 LiveTranscoding 时，不会触发此回调。

OnUploadLogResult

报告日志文件上传结果。

public virtual void OnUploadLogResult(string requestId, bool success, UPLOAD_ERROR_REASON reason)

自从: v3.3.0

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

参数

requestId

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

success

是否成功上传日志文件:

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

reason

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

OnUserEnableLocalVideo

远端用户开/关本地视频采集回调。

public virtual void OnUserEnableLocalVideo(uint uid, bool enabled)

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

参数

uid

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

enabled

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

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

OnUserEnableVideo

远端用户开/关视频模块回调。

public virtual void OnUserEnableVideo(uint uid, bool enabled)

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

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

参数

uid

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

enabled

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

OnUserInfoUpdated

远端用户信息已更新回调。

public virtual void OnUserInfoUpdated(uint uid, UserInfo info)

public virtual void OnUserInfoUpdated(uint uid, UserInfo info)

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

参数

uid: 远端用户 ID。
info: 标识用户信息的 UserInfo 对象，包含用户 UID 和 User Account。详见 UserInfo 类。

OnUserJoined

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

public virtual void OnUserJoined(uint uid, int elapsed)

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

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

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

参数

uid: 新加入频道的远端用户/主播 ID。
elapsed: 从本地用户调用 JoinChannel [2/2] 到该回调触发的延迟（毫秒)。

OnUserMuteAudio

远端用户（通信场景）/主播（直播场景）停止或恢复发送音频流回调。

public virtual void OnUserMuteAudio(uint uid, bool muted)

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

注意：频道内的用户（通信场景）或主播（直播场景）人数超过 17 人时，该回调不生效。

参数

uid

用户 ID。

muted

该用户是否静音：

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

OnUserMuteVideo

远端用户暂停/恢复发送视频流回调。

public virtual void OnUserMuteVideo(uint uid, bool muted)

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

注意：频道内的用户（通信场景）或主播（直播场景）人数超过 17 人时，该回调不生效。

参数

uid

远端用户 ID。

muted

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

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

OnUserOffline

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

public virtual void OnUserOffline(uint uid, USER_OFFLINE_REASON_TYPE reason)

用户离开频道有两个原因：

正常离开：远端用户/主播会发送类似“再见”的消息。接收此消息后，判断用户离开频道。
超时掉线：在一定时间内（通信场景为 20 秒，直播场景稍有延时），用户没有收到对方的任何数据包，则判定为对方掉线。在网络较差的情况下，有可能会误报。我们建议使用声网云信令 SDK 来做可靠的掉线检测。

参数

uid: 离线用户或主播的用户 ID。
reason: 离线原因: USER_OFFLINE_REASON_TYPE。

OnVideoDeviceStateChanged

视频设备变化回调。

public virtual void OnVideoDeviceStateChanged(string deviceId, int deviceType, int deviceState)

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

参数

deviceId: 设备 ID。
deviceType: 设备类型。详见 MEDIA_DEVICE_TYPE。
deviceState: 设备状态。详见 MEDIA_DEVICE_STATE_TYPE。

OnVideoPublishStateChanged

视频发布状态改变回调。

public virtual void OnVideoPublishStateChanged(string channel, STREAM_PUBLISH_STATE oldState,
            STREAM_PUBLISH_STATE newState, int elapseSinceLastState)

参数

channel: 频道名。
oldState: 之前的发布状态，详见 STREAM_PUBLISH_STATE。
newState: 当前的发布状态，详见 STREAM_PUBLISH_STATE。
elapseSinceLastState: 两次状态变化时间间隔（毫秒）。

OnVideoSizeChanged

本地或远端视频大小和旋转信息发生改变回调。

public virtual void OnVideoSizeChanged(uint uid, int width, int height, int rotation)

参数

uid: 图像尺寸和旋转信息发生变化的用户的用户 ID（本地用户的 uid 为 0）。
width: 视频流的宽度（像素）。
height: 视频流的高度（像素）。
rotation: 旋转信息，取值范围 [0,360)。

OnVideoStopped

视频功能已停止回调。

public virtual void OnVideoStopped()

弃用：: 请改用 OnLocalVideoStateChanged 回调中的 LOCAL_VIDEO_STREAM_STATE_STOPPED(0)。

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

OnVideoSubscribeStateChanged

视频订阅状态发生改变回调。

public virtual void OnVideoSubscribeStateChanged(string channel, uint uid, STREAM_SUBSCRIBE_STATE oldState,
            STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState)

参数

channel: 频道名。
uid: 远端用户的 ID。
oldState: 之前的订阅状态，详见 STREAM_SUBSCRIBE_STATE。
newState: 当前的订阅状态，详见 STREAM_SUBSCRIBE_STATE。
elapseSinceLastState: 两次状态变化时间间隔（毫秒）。

OnVirtualBackgroundSourceEnabled

报告虚拟背景是否成功开启。（beta 功能）

public virtual void OnVirtualBackgroundSourceEnabled(bool enabled,
            VIRTUAL_BACKGROUND_SOURCE_STATE_REASON reason)

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

注：如果虚拟背景中自定义的背景图为 PNG、JPG 格式的图片，该回调的触发时机会延迟到图片读取完毕。

参数

enabled

是否成功开启虚拟背景：

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

reason

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

OnWarning

发生警告回调。

public virtual void OnWarning(int warn, string msg)

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

参数

warn: 警告代码。详见错误码和警告码。
msg: 警告描述。

OnWlAccMessage

报告 Wi-Fi 连接质量不佳的原因和改善 Wi-Fi 连接的操作建议。

public virtual void OnWlAccMessage(WLACC_MESSAGE_REASON reason, WLACC_SUGGEST_ACTION action, string wlAccMsg)

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

注：

声网强烈建议你在 app 中展示将该回调报告的 action 和 wlAccMsg，提示用户采取网络优化措施，以获得更好的音视频体验。

参数

reason

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

action

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

wlAccMsg

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

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

OnWlAccStats

报告 Wi-Fi 加速效果。

ublic virtual void OnWlAccStats(WlAccStats currentStats, WlAccStats averageStats)

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

参数

currentStats: 当前的 Wi-Fi 加速效果。详见 WlAccStats。
averageStats: 自加入频道后平均的 Wi-Fi 加速效果。详见 WlAccStats 。