IRtcEngineEventHandler
IRtcEngineEventHandler 接口类用于 SDK 向 app 发送事件通知,app 通过继承该接口类的方法获取 SDK 的事件通知。
该接口类的所有方法都有缺省(空)实现, app 可以根据需要只继承关心的事件。
- 在回调方法中,app 不应该做耗时或者调用可能会引起阻塞的 API(如
sendMessage
),否则可能影响 SDK 的运行。 - SDK 不再捕获开发者在 IRtcEngineEventHandler 类回调中自行实现的代码逻辑中的异常。你需要自行处理该异常,否则异常出现时可能引起 app 崩溃。
onActiveSpeaker
监测到远端最活跃用户回调。
virtual void onActiveSpeaker(uid_t userId) { (void)userId; }
成功调用 enableAudioVolumeIndication 后,SDK 会持续监测音量最大的远端用户,并统计该用户被判断为音量最大者的次数。当前时间段内,该次数累积最多的远端用户为最活跃的用户。
- 如果远端最活跃用户一直是同一位用户,则 SDK 不会再次触发 onActiveSpeaker 回调。
- 如果远端最活跃用户有变化,则 SDK 会再次触发该回调并报告新的远端最活跃用户的 uid。
参数
- userId
- 远端最活跃用户的 ID。
onApiCallExecuted
API 方法已执行回调。
virtual void onApiCallExecuted(int err, const char* api, const char* result) { (void)err; (void)api; (void)result; }
参数
- err
- 当方法调用失败时 SDK 返回的错误码。如果该方法调用成功,SDK 会返回 0。
- api
- SDK 执行的 API 方法。
- result
- SDK 调用 API 的结果。
onAudioDeviceStateChanged
音频设备变化回调。
virtual void onAudioDeviceStateChanged(const char* deviceId, int deviceType, int deviceState) { (void)deviceId; (void)deviceType; (void)deviceState; }
提示系统音频设备状态发生改变,比如耳机被拔出。
参数
- deviceId
- 设备 ID。
- deviceType
- 设备类型定义。详见 MEDIA_DEVICE_TYPE。
- deviceState
- 设备状态定义。
- macOS 平台:
- 0: 设备就绪。
- 8: 设备被拔出。
- Windows 平台:详见 MEDIA_DEVICE_STATE_TYPE。
- macOS 平台:
onAudioEffectFinished
本地音效文件播放已结束回调。
virtual void onAudioEffectFinished(int soundId) { }
当播放音效结束后,会触发该回调。
参数
- soundId
- 指定音效的 ID。每个音效均有唯一的 ID。
onAudioMixingFinished
本地音乐文件播放已结束回调。
virtual void onAudioMixingFinished() { }
- 弃用:
- 请改用 onAudioMixingStateChanged。
当调用 startAudioMixing [2/2] 播放本地音乐文件结束后,会触发该回调。如果调用 startAudioMixing [2/2] 失败,会返回错误码 WARN_AUDIO_MIXING_OPEN_ERROR。
onAudioMixingStateChanged
音乐文件的播放状态已改变回调。
virtual void onAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason) { (void)state; (void)reason;
该回调在音乐文件播放状态发生改变时触发,并报告当前的播放状态和错误码。
参数
- state
- 音乐文件播放状态。详见 AUDIO_MIXING_STATE_TYPE。
- reason
- 错误码。详见 AUDIO_MIXING_REASON_TYPE。
onAudioPublishStateChanged
音频发布状态改变回调。
virtual void onAudioPublishStateChanged(const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { (void)channel; (void)oldState; (void)newState; (void)elapseSinceLastState; }
参数
- channel
- 频道名。
- oldState
- 之前的发布状态,详见 STREAM_PUBLISH_STATE。
- newState
- 当前的发布状态,详见 STREAM_PUBLISH_STATE。
- elapseSinceLastState
- 两次状态变化时间间隔(毫秒)。
onAudioQuality
远端声音质量回调。
virtual void onAudioQuality(uid_t uid, int quality, unsigned short delay, unsigned short lost) { (void)uid; (void)quality; (void)delay; (void)lost; }
- 弃用:
- 请改用 onRemoteAudioStats。
该回调描述远端用户在通话中的音频质量,针对每个远端用户/主播每 2 秒触发一次。如果远端同时存在多个用户/主播,该回调每 2 秒会被触发多次。
参数
- uid
- 用户 ID,指定是谁发的音频流。
- quality
- 语音质量。详见 QUALITY_TYPE。
- delay
- 音频包从发送端到接收端的延迟(毫秒),包括声音采样前处理、网络传输、网络抖动缓冲引起的延迟。
- lost
- 音频包从发送端到接收端的丢包率 (%)。
onAudioRoutingChanged
音频路由已发生变化回调。
virtual void onAudioRoutingChanged(int routing) { (void)routing; }
该回调仅适用于 Android、iOS 和 macOS 平台。
参数
- routing
-
当前的音频路由。详见 AudioRoute。
onAudioSubscribeStateChanged
音频订阅状态发生改变回调。
virtual void onAudioSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) { (void)channel; (void)uid; (void)oldState; (void)newState; (void)elapseSinceLastState; }
参数
- channel
- 频道名。
- uid
- 远端用户的 ID。
- oldState
- 之前的订阅状态,详见 STREAM_SUBSCRIBE_STATE。
- newState
- 当前的订阅状态,详见 STREAM_SUBSCRIBE_STATE。
- elapseSinceLastState
- 两次状态变化时间间隔(毫秒)。
onAudioVolumeIndication
用户音量提示回调。
virtual void onAudioVolumeIndication(const AudioVolumeInfo* speakers, unsigned int speakerNumber, int totalVolume) { (void)speakers; (void)speakerNumber; (void)totalVolume; }
该回调默认禁用,你可以通过 enableAudioVolumeIndication 开启。 开启后,只要频道内有发流用户,SDK 会在加入频道后按 enableAudioVolumeIndication 中设置的时间间隔触发 onAudioVolumeIndication 回调。每次会触发两个 onAudioVolumeIndication 回调,一个报告本地发流用户的音量相关信息,另一个报告瞬时音量最高的远端用户(最多 3 位)的音量相关信息。
启用该功能后,如果有用户将自己静音(调用了 muteLocalAudioStream),SDK 会继续报告本地用户的音量提示回调。
瞬时音量最高的远端用户静音后 20 秒,远端的音量提示回调中将不再包含该用户;如果远端所有用户都将自己静音,20 秒后 SDK 停止报告远端用户的音量提示回调。
参数
- speakers
- 用户音量信息,详见 AudioVolumeInfo 数组。如果 speakers 为空,则表示远端用户不发流或没有远端用户。
- speakerNumber
-
用户数量。
- 在本地用户的回调中,只要本地用户在发流,speakerNumber 始终为 1。
- 在远端用户的回调中,speakerNumber 取值范围为 [0,3]。如果远端发流用户数量大于 3,则此回调中 speakerNumber 值为 3。
- totalVolume
-
混音后的总音量,取值范围为 [0,255]。
- 在本地用户的回调中,totalVolume 为本地发流用户的音量。
- 在远端用户的回调中,totalVolume 为瞬时音量最高的远端用户(最多 3 位)混音后的总音量。 如果用户调用了 startAudioMixing [2/2],则 totalVolume 为音乐文件和用户声音的总音量。
onCameraExposureAreaChanged
摄像头曝光区域已改变回调。
virtual void onCameraExposureAreaChanged(int x, int y, int width, int height) { (void)x; (void)y; (void)width; (void)height; }
该回调是由本地用户调用 setCameraExposurePosition 方法改变曝光位置触发的。
参数
- x
- 发生改变的曝光区域的 x 坐标。
- y
- 发生改变的曝光区域的 y 坐标。
- width
- 发生改变的曝光区域的宽度。
- height
- 发生改变的曝光区域的高度。
onCameraFocusAreaChanged
相机对焦区域已改变回调。
virtual void onCameraFocusAreaChanged(int x, int y, int width, int height) { (void)x; (void)y; (void)width; (void)height; }
参数
- x
- 发生改变的对焦区域的 x 坐标。
- y
- 发生改变的对焦区域的 y 坐标。
- width
- 发生改变的对焦区域的宽度。
- height
- 发生改变的对焦区域的高度。
onCameraReady
摄像头就绪回调。
virtual void onCameraReady()
- 弃用:
-
请改用 onLocalVideoStateChanged 中的 LOCAL_VIDEO_STREAM_STATE_CAPTURING(1)。
该回调提示已成功打开摄像头,可以开始捕获视频。
onChannelMediaRelayEvent
跨频道媒体流转发事件回调。
virtual void onChannelMediaRelayEvent(int code) { (void)code; }
参数
- code
-
跨频道媒体流转发事件码。详见 CHANNEL_MEDIA_RELAY_EVENT。
onChannelMediaRelayStateChanged
跨频道媒体流转发状态发生改变回调。
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
直播场景下用户角色已切换回调。
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole)
该回调是由本地用户在加入频道后调用 setClientRole [1/2] 改变用户角色触发的。
参数
- oldRole
- 切换前的角色:CLIENT_ROLE_TYPE。
- newRole
- 切换后的角色:CLIENT_ROLE_TYPE。
onClientRoleChangeFailed
直播场景下切换用户角色失败回调。
virtual void onClientRoleChangeFailed(CLIENT_ROLE_CHANGE_FAILED_REASON reason, CLIENT_ROLE_TYPE currentRole) { (void)reason; (void)currentRole; }
直播场景下,本地用户加入频道后调用 setClientRole [1/2] 切换用户角色失败时,SDK 会触发该回调,报告切换失败的原因和当前的用户角色。
参数
- reason
- 切换用户角色失败的原因。详见 CLIENT_ROLE_CHANGE_FAILED_REASON。
- currentRole
- 当前用户角色。详见 CLIENT_ROLE_TYPE。
onConnectionBanned
onConnectionInterrupted
网络连接中断回调。
virtual void onConnectionInterrupted() {}
- 弃用:
- 请改用 onConnectionStateChanged 回调。
- onConnectionInterrupted 回调一定是发生在成功加入频道后,且 SDK 刚失去和服务器连接超过 4 秒时触发。
- onConnectionLost 回调是无论是否成功加入频道,只要 10 秒内和服务器无法建立连接都会触发。
onConnectionLost
网络连接中断,且 SDK 无法在 10 秒内连接服务器回调。
virtual void onConnectionLost()
SDK 在调用 joinChannel [2/2] 后,无论是否加入成功,只要 10 秒和服务器无法连接就会触发该回调。如果 SDK 在断开连接后,20 分钟内还是没能重新加入频道,SDK 会停止尝试重连。
onConnectionStateChanged
网络连接状态已改变回调。
virtual void onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason) { (void)state; (void)reason; }
该回调在网络连接状态发生改变的时候触发,并告知用户当前的网络连接状态和引起网络状态改变的原因。
参数
- state
-
当前网络连接状态。详见 CONNECTION_STATE_TYPE。
- reason
-
引起当前网络连接状态改变的原因。详见 CONNECTION_CHANGED_REASON_TYPE。
onEncryptionError
内置加密出错回调。
virtual void onEncryptionError(ENCRYPTION_ERROR_TYPE errorType) { (void)errorType; }
调用 enableEncryption 开启加密后, 如果发流端、收流端出现加解密出错,SDK 会触发该回调。
参数
- errorType
- 错误类型,详见 ENCRYPTION_ERROR_TYPE。
onError
发生错误回调。
virtual void onError(int err, const char* msg) { (void)err; (void)msg; }
该回调方法表示 SDK 运行时出现了网络或媒体相关的错误。通常情况下,SDK 上报的错误意味着 SDK 无法自动恢复,需要 app 干预或提示用户。
参数
- err
- 错误码。详见 ERROR_CODE_TYPE。
- msg
- 错误描述。
onExtensionError
插件出错回调。
virtual void onExtensionError(const char* provider, const char* extension, int error, const char* message) { (void)provider; (void)extension; (void)error; (void)message; }
当调用 enableExtension(
启用插件失败或者插件运行出错时, 插件会触发该回调并上报错误码和错误原因。true
)
参数
- provider
- 提供插件的服务商名称。
- extension
- 插件的名称。
- error
- 错误码。详见插件服务商提供的插件文档。
- message
- 错误原因。详见插件服务商提供的插件文档。
onExtensionEvent
插件事件回调。
virtual void onExtensionEvent(const char* provider, const char* extension, const char* key, const char* value) { (void)provider; (void)extension; (void)key; (void)value; }
为监听插件事件,你需要注册该回调。
参数
- provider
- 提供插件的服务商名称。
- extension
- 插件名称。
- key
- 插件属性的 Key。
- value
- 插件属性 Key 对应的值。
onExtensionStarted
插件启用回调。
virtual void onExtensionStarted(const char* provider, const char* extension) { (void)provider; (void)extension; }
当调用 enableExtension(
启用插件成功时,插件会触发该回调。true
)
参数
- provider
- 提供插件的服务商名称。
- extension
- 插件名称。
onExtensionStopped
插件禁用回调。
virtual void onExtensionStopped(const char* provider, const char* extension) { (void)provider; (void)extension; }
当调用 enableExtension(
禁用插件成功时,插件会触发该回调。false
)
参数
- provider
- 提供插件的服务商名称。
- extension
- 插件名称。
onFacePositionChanged
报告本地人脸检测结果。
virtual void onFacePositionChanged(int imageWidth, int imageHeight, const Rectangle* vecRectangle, const int* vecDistance, int numFaces) { (void) imageWidth; (void) imageHeight; (void) vecRectangle; (void) vecDistance; (void) numFaces; }
enableFaceDetection(true)
开启本地人脸检测后,你可以通过该回调实时获取以下人脸检测的信息:
- 摄像头采集的画面大小
- 人脸在 view 中的位置
- 人脸距设备屏幕的距离
其中,人脸距设备屏幕的距离由 SDK 通过摄像头采集的画面大小和人脸在 view 中的位置拟合计算得出。
- 该回调仅适用于 Android 和 iOS 平台。
- 当检测到摄像头前的人脸消失时,该回调会立刻触发;在无人脸的状态下,该回调触发频率会降低,以节省设备耗能。
- 当人脸距离设备屏幕过近时,SDK 不会触发该回调。
- Android 平台上,人脸距设备屏幕的距离(distance)值有一定误差,请不要用它进行精确计算。
参数
- imageWidth
- 摄像头采集画面的宽度 (px)。
- imageHeight
- 摄像头采集画面的高度 (px)。
- vecRectangle
-
检测到的人脸信息:
x
:人脸在 view 中的 x 坐标 (px)。以摄像头采集 view 的左上角为原点,x 坐标为人脸左上角相对于原点的横向位移。y
:人脸在 view 中的 y 坐标 (px)。以摄像头采集 view 的左上角为原点,y 坐标为人脸左上角相对原点的纵向位移。width
:人脸在 view 中的宽度 (px)。height
:人脸在 view 中的高度 (px)。
- vecDistance
- 人脸距设备屏幕的距离 (cm)。
- numFaces
- 检测的人脸数量。如果为 0,则表示没有检测到人脸。
onFirstLocalAudioFramePublished
已发布本地音频首帧回调。
virtual void onFirstLocalAudioFramePublished(int elapsed) { (void)elapsed; }
- 开启本地音频的情况下,调用 joinChannel [2/2] 成功加入频道后。
- 调用
muteLocalAudioStream(
,再调用true
)muteLocalAudioStream(
后。false
) - 调用 disableAudio,再调用 enableAudio 后。
- 调用 pushAudioFrame 成功向 SDK 推送音频帧后。
参数
- elapsed
- 从调用 joinChannel [2/2] 方法到触发该回调的时间间隔(毫秒)。
onFirstLocalVideoFrame
已显示本地视频首帧回调。
virtual void onFirstLocalVideoFrame(VIDEO_SOURCE_TYPE source, int width, int height, int elapsed) { (void)source; (void)width; (void)height; (void)elapsed; }
本地视频首帧显示在本地视图上时,SDK 会触发此回调。
参数
- source
- 视频源的类型。详见 VIDEO_SOURCE_TYPE。
- width
- 本地渲染视频的宽 (px) 。
- height
- 本地渲染视频的高 (px)。
- elapsed
- 从调用 joinChannel [2/2] 到发生此事件过去的时间(毫秒)。如果在 joinChannel [2/2] 前调用了 startPreview [1/2] ,则是从 startPreview [1/2] 到发生此事件过去的时间。
onFirstLocalVideoFramePublished
已发布本地视频首帧回调。
virtual void onFirstLocalVideoFramePublished(VIDEO_SOURCE_TYPE source, int elapsed) { (void)source; (void)elapsed; }
- 开启本地视频的情况下,调用 joinChannel [2/2] 成功加入频道后。
- 调用 muteLocalVideoStream(
true
),再调用 muteLocalVideoStream(false
) 后。 - 调用 disableVideo,再调用 enableVideo 后。
- 调用 pushVideoFrame 成功向 SDK 推送视频帧后。
参数
- source
- 视频源的类型。详见 VIDEO_SOURCE_TYPE。
- elapsed
- 从调用 joinChannel [2/2] 方法到触发该回调的时间间隔(毫秒)。
onFirstRemoteAudioFrame
已接收远端音频首帧回调。
virtual void onFirstRemoteAudioFrame(uid_t uid, int elapsed) AGORA_DEPRECATED_ATTRIBUTE { (void)uid; (void)elapsed; }
- 弃用:
- 请改用 onRemoteAudioStateChanged 。
参数
- uid
- 发送音频帧的远端用户的用户 ID。
- elapsed
- 从本地用户调用 joinChannel [2/2] 直至该回调触发的延迟,单位为毫秒。
onFirstRemoteAudioDecoded
已解码远端音频首帧的回调。
virtual void onFirstRemoteAudioDecoded(uid_t uid, int elapsed) { (void)uid; (void)elapsed; }
- 弃用:
- 请改用 onRemoteAudioStateChanged 。
- 远端用户首次上线后发送音频。
- 远端用户音频离线再上线发送音频。音频离线指本地在 15 秒内没有收到音频包,可能有如下原因:
- 远端用户离开频道
- 远端用户掉线
- 远端用户调用 muteLocalAudioStream 方法停止发送音频流
- 远端用户调用 disableAudio 方法关闭音频
参数
- uid
- 远端用户 ID。
- elapsed
- 从本地用户调用 joinChannel [2/2] 直至该回调触发的延迟,单位为毫秒。
onFirstRemoteVideoDecoded
已接收到远端视频并完成解码回调。
virtual void onFirstRemoteVideoDecoded(uid_t uid, int width, int height, int elapsed) { (void)uid; (void)width; (void)height; (void)elapsed; }
- 远端用户首次上线后发送视频。
- 远端用户视频离线再上线后发送视频。出现这种中断的可能原因包括:
- 远端用户离开频道。
- 远端用户掉线。
- 远端用户调用 muteLocalVideoStream 方法停止发送本地视频流。
- 远端用户调用 disableVideo 方法关闭视频模块。
参数
- uid
- 用户 ID,指定是哪个用户的视频流。
- width
- 视频流宽(px)。
- height
- 视频流高(px)。
- elapsed
- 从本地调用 joinChannel [2/2] 开始到该回调触发的延迟(毫秒)。
onFirstRemoteVideoFrame
渲染器已接收首帧远端视频回调。
virtual void onFirstRemoteVideoFrame(uid_t userId, int width, int height, int elapsed) { (void)userId; (void)width; (void)height; (void)elapsed; }
参数
- userId
- 用户 ID,指定是哪个用户的视频流。
- width
- 视频流宽(px)。
- height
- 视频流高(px)。
- elapsed
- 从本地调用 joinChannel [2/2] 到发生此事件过去的时间(毫秒)。
onJoinChannelSuccess
成功加入频道回调。
virtual void onJoinChannelSuccess(const char* channel, uid_t uid, int elapsed) { (void)channel; (void)uid; (void)elapsed; }
该回调方法表示该客户端成功加入了指定的频道。
参数
- channel
- 频道名。
- uid
- 加入频道的用户 ID。
- elapsed
- 从本地调用 joinChannel [2/2] 开始到发生此事件过去的时间(毫秒)。
onLastmileProbeResult
通话前网络上下行 Last mile 质量探测报告回调。
virtual void onLastmileProbeResult(const LastmileProbeResult& result) { (void)result; }
在调用 startLastmileProbeTest 之后,SDK 会在约 30 秒内返回该回调。
参数
- result
- 上下行 Last mile 质量探测结果。 详见: LastmileProbeResult。
onLastmileQuality
网络上下行 last mile 质量报告回调。
virtual void onLastmileQuality(int quality) { (void)quality; }
该回调描述本地用户在加入频道前的 last mile 网络探测的结果,其中 last mile 是指设备到 Agora 边缘服务器的网络状态。
加入频道前,调用 startLastmileProbeTest 之后,SDK 触发该回调报告本地用户在加入频道前的 last mile 网络探测的结果。
参数
- quality
- Last mile 网络质量。详见 QUALITY_TYPE 。
onLeaveChannel
离开频道回调。
virtual void onLeaveChannel(const RtcStats& stats) { (void)stats; }
App 调用 leaveChannel [1/2] 方法时,SDK 提示 app 离开频道成功。在该回调方法中,app 可以得到此次通话的总通话时长、SDK 收发数据的流量等信息。
参数
- stats
- 通话的统计数据: RtcStats。
onLocalAudioStateChanged
本地音频状态发生改变回调。
virtual void onLocalAudioStateChanged(LOCAL_AUDIO_STREAM_STATE state, LOCAL_AUDIO_STREAM_ERROR error) { (void)state; (void)error; }
本地音频的状态发生改变时(包括本地麦克风采集状态和音频编码状态),SDK 会触发该回调报告当前的本地音频状态。在本地音频出现故障时,该回调可以帮助你了解当前音频的状态以及出现故障的原因,方便你排查问题。
参数
- state
- 当前的本地音频状态。详见 LOCAL_AUDIO_STREAM_STATE。
- error
- 本地音频出错原因。详见 LOCAL_AUDIO_STREAM_ERROR。
onLocalAudioStats
通话中本地音频流的统计信息回调。
virtual void onLocalAudioStats(const LocalAudioStats& stats) { (void)stats; }
SDK 每 2 秒触发该回调一次。
参数
- stats
- 本地音频统计数据。详见 LocalAudioStats。
onLocalUserRegistered
本地用户成功注册 User Account 回调。
virtual void onLocalUserRegistered(uid_t uid, const char* userAccount) { (void)uid; (void)userAccount; }
本地用户成功调用 registerLocalUserAccount 方法注册用户 User Account,或调用 joinChannelWithUserAccount [2/2] 加入频道后,SDK 会触发该回调,并告知本地用户的 UID 和 User Account。
参数
- uid
- 本地用户的 ID。
- userAccount
- 本地用户的 User Account。
onLocalVideoStateChanged
本地视频状态发生改变回调。
virtual void onLocalVideoStateChanged(VIDEO_SOURCE_TYPE source, LOCAL_VIDEO_STREAM_STATE state, LOCAL_VIDEO_STREAM_ERROR error) { (void)source; (void)state; (void)error; }
本地视频的状态发生改变时,SDK 会触发该回调返回当前的本地视频状态。你可以通过该回调了解当前视频的状态以及出现故障的原因,方便排查问题。
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 的视频帧。
参数
- source
- 视频源的类型。详见 VIDEO_SOURCE_TYPE。
- state
-
本地视频状态,详见 LOCAL_VIDEO_STREAM_STATE。
- error
-
本地视频出错原因,详见 LOCAL_VIDEO_STREAM_ERROR。
onLocalVideoStats
本地视频流统计信息回调。
virtual void onLocalVideoStats(VIDEO_SOURCE_TYPE source, const LocalVideoStats& stats) { (void)source; (void)stats; }
该回调描述本地设备发送视频流的统计信息,每 2 秒触发一次。
参数
- source
- 视频源的类型。详见 VIDEO_SOURCE_TYPE。
- stats
- 本地视频流统计信息。详见 LocalVideoStats。
onNetworkQuality
通话中每个用户的网络上下行 last mile 质量报告回调。
virtual void onNetworkQuality(uid_t uid, int txQuality, int rxQuality) { (void)uid; (void)txQuality; (void)rxQuality; }
该回调描述每个用户在通话中的 last mile 网络状态,其中 last mile 是指设备到 Agora 边缘服务器的网络状态。
该回调每 2 秒触发一次。如果远端有多个用户,该回调每 2 秒会被触发多次。
UNKNOWN
;用户不收流时,rxQuality 为 UNKNOWN
。参数
- uid
-
用户 ID。表示该回调报告的是持有该 ID 的用户的网络质量。
- txQuality
- 该用户的上行网络质量,基于发送码率、上行丢包率、平均往返时延和网络抖动计算。 该值代表当前的上行网络质量,帮助判断是否可以支持当前设置的视频编码属性。 假设上行码率是 1000 Kbps,那么支持直播场景下 640 × 480 的分辨率、15 fps 的帧率没有问题,但是支持 1280 × 720 的分辨率就会有困难。 详见 QUALITY_TYPE。
- rxQuality
- 该用户的下行网络质量,基于下行网络的丢包率、平均往返延时和网络抖动计算。详见 QUALITY_TYPE。
onNetworkTypeChanged
本地网络类型发生改变回调。
virtual void onNetworkTypeChanged(NETWORK_TYPE type) { (void)type; }
本地网络连接类型发生改变时,SDK 会触发该回调,并在回调中明确当前的网络连接类型。你可以通过该回调获取正在使用的网络类型;当连接中断时,该回调能辨别引起中断的原因是网络切换还是网络条件不好。
参数
- type
-
本地网络连接类型。详见 NETWORK_TYPE。
onPermissionError
获取设备权限出错回调。
virtual void onPermissionError(PERMISSION_TYPE permissionType) { (void)permissionType; }
无法获取设备权限时,SDK 会触发该回调,报告哪个设备的权限无法获取。
参数
- permissionType
- 设备权限类型。详见 PERMISSION_TYPE。
onProxyConnected
代理连接状态回调。
virtual void onProxyConnected(const char* channel, uid_t uid, PROXY_TYPE proxyType, const char* localProxyIp, int elapsed) { (void)channel; (void)uid; (void)proxyType; (void)localProxyIp; (void)elapsed; }
通过该回调你可以监听 SDK 连接代理的状态。例如,当用户调用 setCloudProxy 设置代理并成功加入频道后, SDK 会触发该回调报告用户 ID、连接的代理类型和从调用 joinChannel [1/2] 到触发该回调经过的时间等。
参数
- channel
- 频道名称。
- uid
- 用户 ID
- proxyType
- 连接上的代理类型。详见 CLOUD_PROXY_TYPE。
- localProxyIp
- 预留参数,暂不支持。
- elapsed
- 从调用 joinChannel [1/2] 到 SDK 触发该回调的经过的时间(毫秒)。
onRejoinChannelSuccess
成功重新加入频道回调。
virtual void onRejoinChannelSuccess(const char* channel, uid_t uid, int elapsed) { (void)channel; (void)uid; (void)elapsed; }
有时候由于网络原因,客户端可能会和服务器失去连接,SDK 会进行自动重连,自动重连成功后触发此回调方法。
参数
- channel
- 频道名。
- uid
- 重新加入频道的用户 ID。
- elapsed
- 从调用 joinChannel [1/2] 或 joinChannel [2/2] 方法到触发该回调的时间间隔(毫秒)。
onRemoteAudioStateChanged
远端音频流状态发生改变回调。
virtual void onRemoteAudioStateChanged(uid_t uid, REMOTE_AUDIO_STATE state, REMOTE_AUDIO_STATE_REASON reason, int elapsed) { (void)uid; (void)state; (void)reason; (void)elapsed; }
远端用户(通信场景)或主播(直播场景)的音频状态发生改变时,SDK 会触发该回调向本地用户报告当前的远端音频流状态。
参数
- uid
- 发生音频状态改变的远端用户 ID。
- state
- 远端音频流状态,详见 REMOTE_AUDIO_STATE。
- reason
- 远端音频流状态改变的具体原因,详见 REMOTE_AUDIO_STATE_REASON。
- elapsed
- 从本地用户调用 joinChannel [2/2] 方法到发生本事件经历的时间,单位为毫秒。
onRemoteAudioStats
通话中远端音频流的统计信息回调。
virtual void onRemoteAudioStats(const RemoteAudioStats& stats) { (void)stats; }
该回调针对每个发送音频流的远端用户/主播每 2 秒触发一次。如果远端有多个用户/主播发送音频流,该回调每 2 秒会被触发多次。
参数
- stats
- 接收到的远端音频统计数据,详见 RemoteAudioStats。
onRemoteAudioTransportStats
通话中远端音频流传输的统计信息回调。
virtual void onRemoteAudioTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) { (void)uid; (void)delay; (void)lost; (void)rxKBitRate; }
- 弃用:
- 请改用 onRemoteAudioStats。
该回调描述远端用户通话中端到端的网络统计信息,通过音频包计算,用客观的数据,如丢包、 网络延迟等,展示当前网络状态。通话中,当用户收到远端用户/主播发送的音频数据包后 ,会每 2 秒触发一次该回调。
参数
- uid
- 用户 ID,指定是哪个用户/主播的音频包。
- delay
- 音频包从发送端到接收端的延时(毫秒)。
- lost
- 音频包从发送端到接收端的丢包率 (%)。
- rxKBitrate
- 远端音频包的接收码率(Kbps)。
onRemoteVideoStateChanged
远端视频状态发生改变回调。
virtual void onRemoteVideoStateChanged(uid_t uid, REMOTE_VIDEO_STATE state, REMOTE_VIDEO_STATE_REASON reason, int elapsed) { (void)uid; (void)state; (void)reason; (void)elapsed; }
参数
- uid
- 发生视频状态改变的远端用户 ID。
- state
-
远端视频流状态,详见 REMOTE_VIDEO_STATE。
- reason
-
远端视频流状态改变的具体原因,详见 REMOTE_VIDEO_STATE_REASON。
- elapsed
- 从本地用户调用 joinChannel [2/2] 方法到发生本事件经历的时间,单位为毫秒。
onRemoteVideoStats
通话中远端视频流的统计信息回调。
virtual void onRemoteVideoStats(const RemoteVideoStats& stats) { (void)stats; }
该回调描述远端用户在通话中端到端的视频流统计信息, 针对每个远端用户/主播每 2 秒触发一次。如果远端同时存在多个用户/主播, 该回调每 2 秒会被触发多次。
参数
- stats
- 远端视频统计数据。详见 RemoteVideoStats。
onRemoteVideoTransportStats
通话中远端视频流传输的统计信息回调。
virtual void onRemoteVideoTransportStats(uid_t uid, unsigned short delay, unsigned short lost, unsigned short rxKBitRate) { (void)uid; (void)delay; (void)lost; (void)rxKBitRate; }
- 弃用:
- 该回调已被废弃,请改用 onRemoteVideoStats。
该回调描述远端用户通话中端到端的网络统计信息,通过视频包计算,用客观的数据,如丢包、 网络延迟等,展示当前网络状态。
通话中,当用户收到远端用户/主播发送的视频数据包后,会每 2 秒触发一次该回调。
参数
- uid
- 用户 ID,指定是哪个用户/主播的视频包。
- delay
- 视频包从发送端到接收端的延时(毫秒)。
- lost
- 视频包从发送端到接收端的丢包率 (%)。
- rxKBitRate
- 远端视频包的接收码率(Kbps)。
onRequestToken
Token 已过期回调。
virtual void onRequestToken()
在通话过程中如果 Token 已失效,SDK 会触发该回调,提醒 app 更新 Token。
当收到该回调时,你需要重新在服务端生成新的 Token,然后调用 joinChannel [2/2] 重新加入频道。
参数
onRtcStats
当前通话统计信息回调。
virtual void onRtcStats(const RtcStats& stats) { (void)stats; }
SDK 定期向 App 报告当前通话的统计信息,每两秒触发一次。
参数
- stats
-
RTC 引擎统计数据,详见 RtcStats 。
onRtmpStreamingEvent
旁路推流事件回调。
virtual void onRtmpStreamingEvent(const char* url, RTMP_STREAMING_EVENT eventCode) { (void)url; (void)eventCode; }
参数
- url
- 旁路推流 URL。
- eventCode
- 旁路推流事件码。详见 RTMP_STREAMING_EVENT。
onRtmpStreamingStateChanged
旁路推流状态发生改变回调。
virtual void onRtmpStreamingStateChanged(const char* url, RTMP_STREAM_PUBLISH_STATE state, RTMP_STREAM_PUBLISH_ERROR_TYPE errCode) { (void)url; (void)state; (void)errCode; }
旁路推流状态发生改变时,SDK会触发该回调,并在回调中明确状态发生改变的 URL 地址及当前推流状态。该回调方便推流用户了解当前的推流状态;推流出错时,你可以通过返回的错误码了解出错的原因,方便排查问题。
参数
- url
-
推流状态发生改变的 URL 地址。
- state
- 当前的推流状态,详见 RTMP_STREAM_PUBLISH_STATE。
- errCode
- 推流错误信息,详见 RTMP_STREAM_PUBLISH_ERROR_TYPE。
onSnapshotTaken
视频截图结果回调。
virtual void onSnapshotTaken(uid_t uid, const char* filePath, int width, int height, int errCode) { (void)uid; (void)filePath; (void)width; (void)height; (void)errCode; }
成功调用 takeSnapshot 后,SDK 触发该回调报告截图是否成功和获取截图的详情。
参数
- uid
- 用户 ID。如果 uid 为 0,表示本地用户。
- filePath
- 截图的本地保存路径。
- width
- 图片宽度(px)。
- height
- 图片高度(px)。
- errCode
- 截图成功的提示或失败的原因。
- 0:截图成功。
- < 0: 截图失败。
- -1:写入文件失败或 JPEG 编码失败。
- -2:takeSnapshot 方法调用成功后 1 秒内没有发现指定用户的视频流。
- -3:takeSnapshot 方法调用过于频繁。
onStreamMessage
接收到对方数据流消息的回调。
virtual void onStreamMessage(uid_t userId, int streamId, const char* data, size_t length, uint64_t sentTs) { (void)userId; (void)streamId; (void)data; (void)length; (void)sentTs; }
该回调表示本地用户收到了远端用户调用 sendStreamMessage 方法发送的流消息。
参数
- userId
- 发送消息的用户 ID。
- streamId
- 接收到的消息的 Stream ID。
- data
- 接收到的数据。
- length
- 数据长度,单位为字节。
- sentTs
- 数据流发出的时间。
onStreamMessageError
接收对方数据流消息发生错误的回调。
virtual void onStreamMessageError(uid_t userId, int streamId, int code, int missed, int cached) { (void)userId; (void)streamId; (void)code; (void)missed; (void)cached; }
该回调表示本地用户未收到远端用户调用 sendStreamMessage 方法发送的流消息。
参数
- userId
- 发送消息的用户 ID。
- streamId
- 接收到的消息的 Stream ID。
- code
- 发生错误的错误码。
- missed
- 丢失的消息数量。
- cached
- 数据流中断时,后面缓存的消息数量。
onTokenPrivilegeWillExpire
Token 服务将在30s内过期回调。
virtual void onTokenPrivilegeWillExpire(const char* token) { (void)token; }
在通话过程中如果 Token 即将失效,SDK 会提前 30 秒触发该回调,提醒 app 更新 Token。
当收到该回调时,你需要重新在服务端生成新的 Token,然后调用 renewToken 将新生成的 Token 传给 SDK。
参数
- token
- 即将服务失效的 Token。
onTranscodingUpdated
旁路推流转码设置已被更新回调。
virtual void onTranscodingUpdated()
setLiveTranscoding 方法中的直播参数 LiveTranscoding 更新时,onTranscodingUpdated 回调会被触发并向主播报告更新信息。
onUplinkNetworkInfoUpdated
上行网络信息变化回调。
virtual void onUplinkNetworkInfoUpdated(const UplinkNetworkInfo& info) { (void)info; }
只有当上行网络信息发生变化时,SDK 才会触发该回调。
参数
- info
- 上行网络信息,详见 UplinkNetworkInfo。
onUserEnableLocalVideo
远端用户开/关本地视频采集回调。
virtual void onUserEnableLocalVideo(uid_t uid, bool enabled) { (void)uid; (void)enabled; }
该回调是由远端用户调用 enableLocalVideo 方法开启或关闭视频采集触发的。
参数
- uid
- 用户 ID,提示是哪个用户的视频流。
- enabled
-
远端用户是否启用视频采集:
-
true
: 该用户已启用视频功能。启用后,其他用户可以接收到该用户的视频流。 -
false
: 该用户已关闭视频功能。关闭后,该用户仍然可以接收其他用户的视频流,但其他用户接收不到该用户的视频流。
-
onUserEnableVideo
远端用户开/关视频模块回调。
virtual void onUserEnableVideo(uid_t uid, bool enabled) { (void)uid; (void)enabled; }
关闭视频功能是指该用户只能进行语音通话,不能显示、发送自己的视频,也不能接收、显示别人的视频。
该回调是由远端用户调用 enableVideo 或 disableVideo 方法开启或关闭视频模块触发的。
参数
- uid
- 用户 ID,提示是哪个用户的视频流。
- enabled
-
-
true
: 该用户已启用视频功能。 -
false
: 该用户已关闭视频功能。
-
onUserInfoUpdated
远端用户信息已更新回调。
virtual void onUserInfoUpdated(uid_t uid, const UserInfo& info) { (void)uid; (void)info; }
远端用户加入频道后, SDK 会获取到该远端用户的 UID 和 User Account,然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表,并在本地触发该回调。
参数
- uid
- 远端用户 ID。
- info
- 标识用户信息的 UserInfo 对象,包含用户 UID 和 User Account。详见 UserInfo 类。
onUserJoined
远端用户(通信场景)/主播(直播场景)加入当前频道回调。
virtual void onUserJoined(uid_t uid, int elapsed) { (void)uid; (void)elapsed; }
- 通信场景下,该回调提示有远端用户加入了频道。如果加入之前,已经有其他用户在频道中了,新加入的用户也会收到这些已有用户加入频道的回调。
- 直播场景下,该回调提示有主播加入了频道。如果加入之前,已经有主播在频道中了,新加入的用户也会收到已有主播加入频道的回调。Agora 建议连麦主播不超过 17 人。
- 远端用户/主播调用 joinChannel [2/2] 方法加入频道。
- 远端用户加入频道后将用户角色改变为主播。
- 远端用户/主播网络中断后重新加入频道。
参数
- uid
- 新加入频道的远端用户/主播 ID。
- elapsed
- 从本地用户调用 joinChannel [2/2] 到该回调触发的延迟(毫秒)。
onUserMuteAudio
远端用户(通信场景)/主播(直播场景)停止或恢复发送音频流回调。
virtual void onUserMuteAudio(uid_t uid, bool muted) { (void)uid; (void)muted; }
该回调是由远端用户调用 muteLocalAudioStream 方法关闭或开启音频发送触发的。
参数
- uid
- 用户 ID。
- muted
- 该用户是否静音:
true
: 该用户已将音频静音。false
: 该用户取消了音频静音。
onUserMuteVideo
远端用户取消或恢复发布视频流回调。
virtual void onUserMuteVideo(uid_t uid, bool muted) { (void)uid; (void)muted; }
当远端用户调用 muteLocalVideoStream 取消或恢复发布视频流时,SDK 会触发该回调向本地用户报告远端用户的发流状况。
参数
- uid
- 远端用户 ID。
- muted
- 远端用户是否取消发布视频流:
true
: 取消发布视频流。false
: 发布视频流。
onUserOffline
远端用户(通信场景)/主播(直播场景)离开当前频道回调。
virtual void onUserOffline(uid_t uid, USER_OFFLINE_REASON_TYPE reason) { (void)uid; (void)reason; }
- 正常离开:远端用户/主播会发送类似“再见”的消息。接收此消息后,判断用户离开频道。
- 超时掉线:在一定时间内(通信场景为 20 秒,直播场景稍有延时),用户没有收到对方的任何数据包,则判定为对方掉线。在网络较差的情况下,有可能会误报。我们建议使用 Agora 云信令 SDK 来做可靠的掉线检测。
参数
- uid
- 离线用户或主播的用户 ID。
- reason
-
离线原因: USER_OFFLINE_REASON_TYPE。
onVideoPublishStateChanged
视频发布状态改变回调。
virtual void onVideoPublishStateChanged(VIDEO_SOURCE_TYPE source, const char* channel, STREAM_PUBLISH_STATE oldState, STREAM_PUBLISH_STATE newState, int elapseSinceLastState) { (void)source; (void)channel; (void)oldState; (void)newState; (void)elapseSinceLastState; }
参数
- channel
- 频道名。
- source
- 视频源的类型。详见 VIDEO_SOURCE_TYPE。
- oldState
- 之前的发布状态,详见 STREAM_PUBLISH_STATE。
- newState
- 当前的发布状态,详见 STREAM_PUBLISH_STATE。
- elapseSinceLastState
- 两次状态变化时间间隔(毫秒)。
onVideoSizeChanged
本地或远端视频大小和旋转信息发生改变回调。
virtual void onVideoSizeChanged(uid_t uid, int width, int height, int rotation) { (void)uid; (void)width; (void)height; (void)rotation; }
参数
- uid
- 图像尺寸和旋转信息发生变化的用户 ID(本地用户的 uid 为 0。此时视频为本地用户的视频预览)。
- width
- 视频流的宽度(像素)。
- height
- 视频流的高度(像素)。
- rotation
- 旋转信息,取值范围 [0,360)。
onVideoStopped
视频功能已停止回调。
virtual void onVideoStopped()
- 弃用:
- 请改用 onLocalVideoStateChanged 回调中的 LOCAL_VIDEO_STREAM_STATE_STOPPED(0)。
App 如需在停止视频后对 view 做其他处理(比如显示其他画面),可以在这个回调中进行。
onVideoSubscribeStateChanged
视频订阅状态发生改变回调。
virtual void onVideoSubscribeStateChanged(const char* channel, uid_t uid, STREAM_SUBSCRIBE_STATE oldState, STREAM_SUBSCRIBE_STATE newState, int elapseSinceLastState) { (void)channel; (void)uid; (void)oldState; (void)newState; (void)elapseSinceLastState; }
参数
- channel
- 频道名。
- uid
- 远端用户的 ID。
- oldState
- 之前的订阅状态,详见 STREAM_SUBSCRIBE_STATE。
- newState
- 当前的订阅状态,详见 STREAM_SUBSCRIBE_STATE。
- elapseSinceLastState
- 两次状态变化时间间隔(毫秒)。