class bytertc::IRTCRoomEventHandler
cpp

音视频房间事件回调接口

virtual void bytertc::IRTCRoomEventHandler::onRoomStateChanged(
    const char* room_id,
    const char* uid,
    int state,
    const char* extra_info)
cpp

房间状态改变回调，加入房间、异常退出房间、发生房间相关的警告或错误时会收到此回调。

传入参数

virtual void bytertc::IRTCRoomEventHandler::onStreamStateChanged(
    const char* room_id,
    const char* uid,
    int state,
    const char* extra_info)
cpp

流状态改变回调，发生流相关的警告或错误时会收到此回调。

传入参数

virtual void bytertc::IRTCRoomEventHandler::onLeaveRoom(
    const RtcRoomStats& stats)
cpp

离开房间成功回调。

用户调用 leaveRoom 方法后，SDK 会停止所有的发布订阅流，并在释放所有与通话相关的音视频资源后，通过此回调通知用户离开房间成功。

传入参数

注意

• 用户调用 leaveRoom 方法离开房间后，若立即调用 destroyRTCVideo 方法销毁 RTC 引擎，则将无法收到此回调事件。
• 离开房间后，如果 App 需要使用系统音视频设备，则建议收到此回调后再初始化音视频设备，否则可能由于 SDK 占用音视频设备而导致初始化失败。

virtual void bytertc::IRTCRoomEventHandler::onRoomWarning(
    int warn)
cpp

Deprecated since 3.41 and will be deleted in 3.51, use onRoomStateChanged and onStreamStateChanged instead.

SDK 发生警告回调。

SDK 内部遇到可恢复错误时，在尝试自动恢复的同时，会通过此回调通知用户。此回调事件仅用作通知。

传入参数

virtual void bytertc::IRTCRoomEventHandler::onRoomError(
    int err)
cpp

Deprecated since 3.41 and will be deleted in 3.51, use onRoomStateChanged and onStreamStateChanged instead.

SDK 发生错误回调。

SDK 内部遇到不可恢复错误时，会通过此回调通知 App，需要 App 根据错误码进行操作或提示用户。

传入参数

virtual void bytertc::IRTCRoomEventHandler::onTokenWillExpire()
cpp

Token 进房权限过期前 30 秒将触发该回调。

收到该回调后，你需调用 updateToken 更新 Token 进房权限。

注意
若未能及时更新 Token 进房权限导致其过期实效： + 用户此时尝试进房会收到 onRoomStateChanged 回调，提示错误码为 -1000 Token 过期；

• 用户已在房间内则会被移出房间，本地用户会收到 onRoomStateChanged 回调，提示错误码为 -1009 Token 过期，同时远端用户会收到 onUserLeave 回调，提示原因为 2 Token 进房权限过期。

virtual void bytertc::IRTCRoomEventHandler::onPublishPrivilegeTokenWillExpire()
cpp

Token 发布权限过期前 30 秒将触发该回调。

收到该回调后，你需调用 updateToken 更新 Token 发布权限。

注意
若收到该回调后未及时更新 Token，Token 发布权限过期后： + 此时尝试发布流会收到 onStreamStateChanged 回调，提示错误码为 -1002 没有发布权限；

• 已在发布中的流会停止发布，发布端会收到 onStreamStateChanged 回调，提示错误码为 -1002 没有发布权限，同时远端用户会收到 onUserUnpublishStream/onUserUnpublishScreen 回调，提示原因为 6 发流端发布权限过期。

virtual void bytertc::IRTCRoomEventHandler::onSubscribePrivilegeTokenWillExpire()
cpp

Token 订阅权限过期前 30 秒将触发该回调。

收到该回调后，你需调用 updateToken 更新 Token 订阅权限有效期。

注意
若收到该回调后未及时更新 Token，Token 订阅权限过期后，尝试新订阅流会失败，已订阅的流会取消订阅，并且会收到 onStreamStateChanged 回调，提示错误码为 -1003 没有订阅权限。

virtual void bytertc::IRTCRoomEventHandler::onRoomStats(
    const RtcRoomStats& stats)
cpp

房间内通话统计信息回调。

用户进房开始通话后，每 2s 收到一次本回调。

传入参数

virtual void bytertc::IRTCRoomEventHandler::onRemoteStreamStats(
    const RemoteStreamStats& stats)
cpp

本地订阅的远端音/视频流数据统计以及网络质量回调。

本地用户订阅流成功后，SDK 会周期性（2s）的通过此回调事件通知用户订阅的流在此次统计周期内的质量统计信息，包括：发送音视频比特率、发送帧率、编码帧率，网络质量等。

传入参数

virtual void bytertc::IRTCRoomEventHandler::onUserJoined(
    const UserInfo& user_info,
    int elapsed)
cpp

远端可见用户加入房间，或房内隐身用户切换为可见的回调。

1. 远端用户调用 setUserVisibility 方法将自身设为可见后加入房间时，房间内其他用户将收到该事件。
   
2. 远端可见用户断网后重新连入房间时，房间内其他用户将收到该事件。
   
3. 房间内隐身远端用户调用 setUserVisibility 方法切换至可见时，房间内其他用户将收到该事件。
   
4. 新进房用户会收到进房前已在房内的可见用户的进房回调通知。
   

传入参数

virtual void bytertc::IRTCRoomEventHandler::onUserLeave(
    const char* uid,
    UserOfflineReason reason)
cpp

远端用户离开房间，或切至不可见时，本地用户会收到此事件

传入参数

virtual void bytertc::IRTCRoomEventHandler::onStreamRemove(
    const MediaStreamInfo& stream,
    StreamRemoveReason reason)
cpp

Deprecated since 3.36 and will be deleted in 3.51, use onUserUnpublishStream and onUserUnpublishScreen instead.

房间内的远端用户停止发布音视频流时，本地用户会收到此回调。

传入参数

virtual void bytertc::IRTCRoomEventHandler::onStreamAdd(
    const MediaStreamInfo& stream)
cpp

Deprecated since 3.36 and will be deleted in 3.51, use onUserPublishStream and onUserPublishScreen instead.

房间内的用户发布新的音视频流时，房间内的其他用户会收到此回调。包括移除后又重新发布的流。

传入参数

virtual void bytertc::IRTCRoomEventHandler::onUserPublishStream(
    const char* uid,
    MediaStreamType type)
cpp

房间内新增远端摄像头/麦克风采集的媒体流的回调。

传入参数

注意
当房间内的远端用户调用 publishStream 成功发布由摄像头/麦克风采集的媒体流时，本地用户会收到该回调，此时本地用户可以自行选择是否调用 subscribeStream 订阅此流。

virtual void bytertc::IRTCRoomEventHandler::onUserUnpublishStream(
    const char* uid,
    MediaStreamType type,
    StreamRemoveReason reason)
cpp

房间内远端摄像头/麦克风采集的媒体流移除的回调。

传入参数

注意
收到该回调通知后，你可以自行选择是否调用 unsubscribeStream 取消订阅此流。

virtual void bytertc::IRTCRoomEventHandler::onUserPublishScreen(
    const char* uid,
    MediaStreamType type)
cpp

房间内新增远端屏幕共享音视频流的回调。

传入参数

注意
当房间内的远端用户调用 publishScreen 成功发布来自屏幕共享的音视频流时，本地用户会收到该回调，此时本地用户可以自行选择是否调用 subscribeScreen 订阅此流。（Linux 不支持）

virtual void bytertc::IRTCRoomEventHandler::onUserUnpublishScreen(
    const char* uid,
    MediaStreamType type,
    StreamRemoveReason reason)
cpp

房间内远端屏幕共享音视频流移除的回调。

传入参数

注意
收到该回调通知后，你可以自行选择是否调用 unsubscribeScreen 取消订阅此流。

virtual void bytertc::IRTCRoomEventHandler::onStreamSubscribed(
    SubscribeState state_code,
    const char* user_id,
    const SubscribeConfig& info)
cpp

关于订阅媒体流状态改变的回调

传入参数

注意
本地用户收到该回调的时机包括：

• 调用 subscribeStream 或 unsubscribeStream 订阅/取消订阅指定远端摄像头音视频流后；
• 调用 subscribeScreen 或 unsubscribeScreen 订阅/取消订阅指定远端屏幕共享流后。

virtual void bytertc::IRTCRoomEventHandler::onRoomMessageReceived(
    const char* uid,
    const char* message)
cpp

接收到房间内广播消息的回调。

传入参数

注意
同一房间内其他用户调用 sendRoomMessage 发送广播消息时会收到该回调。

virtual void bytertc::IRTCRoomEventHandler::onRoomBinaryMessageReceived(
    const char* uid,
    int size,
    const uint8_t* message)
cpp

收到房间内广播二进制消息的回调。

房间内其他用户调用 sendRoomBinaryMessage 发送广播二进制消息时，收到此回调。

传入参数

注意
同一房间内其他用户调用 sendRoomBinaryMessage 发送二进制广播消息时会收到该回调。

virtual void bytertc::IRTCRoomEventHandler::onUserMessageReceived(
    const char* uid,
    const char* message)
cpp

收到来自房间中其他用户通过 sendUserMessage 发来的点对点文本消息时，会收到此回调。

传入参数

注意

• 你必须先调用 sendUserMessage 方法，才能收到该回调。

virtual void bytertc::IRTCRoomEventHandler::onUserBinaryMessageReceived(
    const char* uid,
    int size,
    const uint8_t* message)
cpp

收到来自房间中其他用户通过 sendUserBinaryMessage 发来的点对点二进制消息时，会收到此回调。

传入参数

virtual void bytertc::IRTCRoomEventHandler::onUserMessageSendResult(
    int64_t msgid,
    int error)
cpp

向房间内单个用户发送文本或二进制消息后（P2P），消息发送方会收到该消息发送结果回调。

传入参数

注意

• 你必须先调用 sendUserMessage 或 sendUserBinaryMessage 接口，才能收到此回调。

virtual void bytertc::IRTCRoomEventHandler::onRoomMessageSendResult(
    int64_t msgid,
    int error)
cpp

调用 sendRoomMessage 或 sendRoomBinaryMessage 向房间内群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。

传入参数

virtual void bytertc::IRTCRoomEventHandler::onVideoStreamBanned(
    const char* uid,
    bool banned)
cpp

通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户视频流的发送时，触发此回调。

传入参数

注意

• 房间内指定用户被禁止/解禁视频流发送时，房间内所有用户都会收到该回调。
• 若被封禁用户断网或退房后再进房，则依然是封禁状态，且房间内所有人会再次收到该回调。
• 指定用户被封禁后，房间内其他用户退房后再进房，会再次收到该回调。
• 同一房间解散后再次创建，房间内状态清空。

virtual void bytertc::IRTCRoomEventHandler::onAVSyncStateChange(
    AVSyncState state)
cpp

发布端调用 setMultiDeviceAVSync 后音视频同步状态发生改变时，会收到此回调。

传入参数

virtual void bytertc::IRTCRoomEventHandler::onAudioStreamBanned(
    const char* uid,
    bool banned)
cpp

通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户音频流的发送时，触发此回调。

传入参数

注意

• 房间内指定用户被禁止/解禁音频流发送时，房间内所有用户都会收到该回调。
• 若被封禁用户断网或退房后再进房，则依然是封禁状态，且房间内所有人会再次收到该回调。
• 指定用户被封禁后，房间内其他用户退房后再进房，会再次收到该回调。
• 在控制台开启大会模式后，只有被封禁/解禁用户会收到该回调。
• 同一房间解散后再次创建，房间内状态清空。

virtual void bytertc::IRTCRoomEventHandler::onForwardStreamStateChanged(
    ForwardStreamStateInfo* infos,
    int info_count)
cpp

跨房间媒体流转发状态和错误回调

传入参数

virtual void bytertc::IRTCRoomEventHandler::onForwardStreamEvent(
    ForwardStreamEventInfo* infos,
    int info_count)
cpp

跨房间媒体流转发事件回调

传入参数

virtual void bytertc::IRTCRoomEventHandler::onNetworkQuality(
    const NetworkQualityStats& localQuality,
    const NetworkQualityStats* remoteQualities,
    int remoteQualityNum)
cpp

加入房间并发布或订阅流后， 以每 2 秒一次的频率，报告本地用户和已订阅的远端用户的上下行网络质量信息。

传入参数

注意
更多通话中的监测接口，详见通话中质量监测。

class bytertc::IRTCVideoEventHandler
cpp

音视频引擎事件回调接口

virtual void bytertc::IRTCVideoEventHandler::onWarning(
    int warn)
cpp

发生警告回调。

SDK 运行时出现了警告。SDK 通常会自动恢复，警告信息可以忽略。

你可能需要干预.

传入参数

virtual void bytertc::IRTCVideoEventHandler::onError(
    int err)
cpp

发生错误回调。

SDK 运行时出现了网络或媒体相关的错误，且无法自动恢复时触发此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onAudioMixingStateChanged(
    int mix_id,
    bytertc::AudioMixingState state,
    bytertc::AudioMixingError error)
cpp

音频混音文件播放状态改变时回调

传入参数

注意
此回调会被触发的时机汇总如下：

• 1. 音乐文件类型：
• 当调用 startAudioMixing 方法成功后，会触发 state 值为 kAudioMixingStatePlaying 回调；否则触发 state 值为 kAudioMixingStateFailed 的回调。
• 当使用相同的 ID 重复调用 startAudioMixing 后，后一次会覆盖前一次，且本回调会以 kAudioMixingStateStopped 通知前一次混音已停止。
• 当调用 pauseAudioMixing 方法暂停播放成功后，会触发 state 值为 kAudioMixingStatePaused 回调；否则触发 state 值为 kAudioMixingStateFailed 的回调。
• 当调用 resumeAudioMixing 方法恢复播放成功后，会触发 state 值为 kAudioMixingStatePlaying 回调；否则触发 state 值为 kAudioMixingStateFailed 的回调。
• 当调用 stopAudioMixing 方法暂停止播放成功后，会触发 state 值为 kAudioMixingStateStopped 回调；否则触发 state 值为 kAudioMixingStateFailed 的回调。
• 播放结束会触发 state 值为 kAudioMixingStateFinished 回调。
• 2. PCM 流类型：
• 当调用 enableAudioMixingFrame 方法成功后，会触发 state 值为 kAudioMixingStatePCMEnabled 回调；否则触发 state 值为 kAudioMixingStateFailed 的回调。（Linux 不支持）
• 当调用 disableAudioMixingFrame 方法成功后，会触发 state 值为 kAudioMixingStatePCMDisabled 回调；否则触发 state 值为 kAudioMixingStateFailed 的回调。

virtual void bytertc::IRTCVideoEventHandler::onAudioMixingPlayingProgress(
    int mix_id,
    int64_t progress)
cpp

混音音频文件播放进度回调

传入参数

注意
调用 setAudioMixingProgressInterval 将时间间隔设为大于 0 的值后，或调用 startAudioMixing 将 AudioMixingConfig 中的时间间隔设为大于 0 的值后，SDK 会按照设置的时间间隔回调该事件。

virtual void bytertc::IRTCVideoEventHandler::onLogReport(
    const char* log_type,
    const char* log_content)
cpp

上报日志时回调该事件。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onConnectionStateChanged(
    bytertc::ConnectionState state)
cpp

SDK 与信令服务器连接状态改变回调。连接状态改变时触发。

传入参数

注意
更多信息参见 连接状态提示。

virtual void bytertc::IRTCVideoEventHandler::onNetworkTypeChanged(
    bytertc::NetworkType type)
cpp

SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onSimulcastSubscribeFallback(
    const RemoteStreamSwitch& event)
cpp

音视频流因网络环境变化等原因发生回退，或从回退中恢复时，触发该回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onPerformanceAlarms(
    bytertc::PerformanceAlarmMode mode,
    const char* room_id,
    bytertc::PerformanceAlarmReason reason,
    const bytertc::SourceWantedData& data)
cpp

本地未开启发布性能回退，检测到设备性能不足时，收到此回调。

本地开启发布性能回退，因设备性能/网络原因，造成发布性能回退/恢复时，收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onMediaDeviceStateChanged(
    const char* device_id,
    bytertc::MediaDeviceType device_type,
    bytertc::MediaDeviceState device_state,
    bytertc::MediaDeviceError device_error)
cpp

Deprecated since 3.37 and will be deleted in 3.51, use onAudioDeviceStateChanged and onVideoDeviceStateChanged instead.

媒体设备状态回调。提示音频采集、音频播放、摄像头视频采集、屏幕视频采集四种媒体设备的状态。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onAudioDeviceStateChanged(
    const char* device_id,
    bytertc::RTCAudioDeviceType device_type,
    bytertc::MediaDeviceState device_state,
    bytertc::MediaDeviceError device_error)
cpp

音频设备状态回调。提示音频采集、音频播放等设备设备的状态。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onVideoDeviceStateChanged(
    const char* device_id,
    bytertc::RTCVideoDeviceType device_type,
    bytertc::MediaDeviceState device_state,
    bytertc::MediaDeviceError device_error)
cpp

视频频设备状态回调。提示摄像头视频采集、屏幕视频采集等设备的状态。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onMediaDeviceWarning(
    const char* device_id,
    bytertc::MediaDeviceType device_type,
    bytertc::MediaDeviceWarning device_warning)
cpp

Deprecated since 3.37 and will be deleted in 3.51, use onAudioDeviceWarning and onVideoDeviceWarning instead.

媒体设备警告回调。媒体设备包括：音频采集设备、音频渲染设备、和视频采集设备。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onAudioDeviceWarning(
    const char* device_id,
    bytertc::RTCAudioDeviceType device_type,
    bytertc::MediaDeviceWarning device_warning)
cpp

音频设备警告回调。音频设备包括音频采集设备和音频渲染设备。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onVideoDeviceWarning(
    const char* device_id,
    bytertc::RTCVideoDeviceType device_type,
    bytertc::MediaDeviceWarning device_warning)
cpp

视频设备警告回调，包括视频采集设备等。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onSysStats(
    const bytertc::SysStats& stats)
cpp

周期性（2s）发出回调，报告当前 CPU 与内存的相关信息。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onCreateRoomStateChanged(
    const char* room_id,
    int error_code)
cpp

创建房间失败回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onHttpProxyState(
    int state)
cpp

HTTP 代理连接状态改变时，收到该回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onHttpsProxyState(
    int state)
cpp

HTTPS 代理连接状态改变时，收到该回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onSocks5ProxyState(
    int state,
    const char* cmd,
    const char* proxy_address,
    const char* local_address,
    const char* remote_address)
cpp

SOCKS5 代理状态改变时，收到该回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onRecordingStateUpdate(
    StreamIndex type,
    RecordingState state,
    RecordingErrorCode error_code,
    RecordingInfo info)
cpp

获取本地录制状态回调。

该回调由 startFileRecording 或 stopFileRecording 触发。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onRecordingProgressUpdate(
    StreamIndex type,
    RecordingProgress process,
    RecordingInfo info)
cpp

本地录制进度回调。

该回调由 startFileRecording 触发，录制状态正常时，系统每秒钟都会通过该回调提示录制进度。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onAudioRecordingStateUpdate(
    AudioRecordingState state,
    AudioRecordingErrorCode error_code)
cpp

调用 startAudioRecording 或 stopAudioRecording 改变音频文件录制状态时，收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onLoginResult(
    const char* uid,
    int error_code,
    int elapsed)
cpp

登录结果回调

传入参数

注意
调用 login 后，会收到此回调。

virtual void bytertc::IRTCVideoEventHandler::onLogout()
cpp

登出结果回调

注意
调用 logout 后，会收到此回调。

virtual void bytertc::IRTCVideoEventHandler::onServerParamsSetResult(
    int error)
cpp

设置应用服务器参数的返回结果

传入参数

注意
调用 setServerParams 后，会收到此回调。

virtual void bytertc::IRTCVideoEventHandler::onGetPeerOnlineStatus(
    const char* peer_user_id,
    int status)
cpp

查询对端或本端用户登录状态的返回结果

传入参数

注意
必须先调用 getPeerOnlineStatus，才能收到此回调。

virtual void bytertc::IRTCVideoEventHandler::onUserMessageReceivedOutsideRoom(
    const char* uid,
    const char* message)
cpp

收到房间外用户调用 sendUserMessageOutsideRoom 发来的文本消息时，会收到此回调

传入参数

virtual void bytertc::IRTCVideoEventHandler::onUserBinaryMessageReceivedOutsideRoom(
    const char* uid,
    int size,
    const uint8_t* message)
cpp

收到房间外用户调用 sendUserBinaryMessageOutsideRoom 发来的二进制消息时，会收到此回调

传入参数

virtual void bytertc::IRTCVideoEventHandler::onUserMessageSendResultOutsideRoom(
    int64_t msgid,
    int error)
cpp

给房间外指定的用户发送消息的回调

传入参数

注意
当调用 sendUserMessageOutsideRoom 或 sendUserBinaryMessageOutsideRoom 发送消息后，会收到此回调。

virtual void bytertc::IRTCVideoEventHandler::onServerMessageSendResult(
    int64_t msgid,
    int error,
    const bytertc::ServerACKMsg& msg)
cpp

给应用服务器发送消息的回调。

传入参数

注意
本回调为异步回调。当调用 sendServerMessage 或 sendServerBinaryMessage 接口发送消息后，会收到此回调。

virtual void bytertc::IRTCVideoEventHandler::onSEIMessageReceived(
    RemoteStreamKey stream_key,
    const uint8_t* message,
    int length)
cpp

收到通过调用 sendSEIMessage 发送带有 SEI 消息的视频帧时，收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onSEIStreamUpdate(
    const RemoteStreamKey& key,
    SEIStreamEventType type)
cpp

黑帧视频流发布状态回调。

在语音通话场景下，本地用户调用 sendSEIMessage 通过黑帧视频流发送 SEI 数据时，流的发送状态会通过该回调通知远端用户。

你可以通过此回调判断携带 SEI 数据的视频帧为黑帧，从而不对该视频帧进行渲染。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onRemoteAudioPropertiesReport(
    const RemoteAudioPropertiesInfo* audio_properties_infos,
    int audio_properties_info_number,
    int total_remote_volume)
cpp

远端用户进房后，本地调用 enableAudioPropertiesReport，根据设置的 interval 值，本地会周期性地收到此回调，了解订阅的远端用户的音频信息。

远端用户的音频包括使用 RTC SDK 内部机制/自定义机制采集的麦克风音频和屏幕音频。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onLocalAudioPropertiesReport(
    const LocalAudioPropertiesInfo * audio_properties_infos,
    int audio_properties_info_number)
cpp

调用 enableAudioPropertiesReport 后，根据设置的 interval 值，你会周期性地收到此回调，了解本地音频的相关信息。

本地音频包括使用 RTC SDK 内部机制采集的麦克风音频，屏幕音频和本地混音音频信息。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onAudioPlaybackDeviceTestVolume(
    int volume)
cpp

回调音频设备测试时的播放音量

传入参数

注意
调用 startAudioPlaybackDeviceTest 或 startAudioDeviceRecordTest，开始播放音频文件或录音时，将开启该回调。本回调为周期性回调，回调周期由上述接口的 interval 参数指定。

virtual void bytertc::IRTCVideoEventHandler::onAudioDeviceVolumeChanged(
    bytertc::RTCAudioDeviceType device_type,
    int volume,
    bool muted)
cpp

音频设备音量改变回调。当通过系统设置，改变音频设备音量或静音状态时，触发本回调。本回调无需手动开启。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onLocalAudioStateChanged(
    LocalAudioStreamState state,
    LocalAudioStreamError error)
cpp

Deprecated since 3.50 and will be deleted in 3.55, use onAudioDeviceStateChanged instead.

本地音频流的状态发生改变时，收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onUserStartAudioCapture(
    const char* room_id,
    const char* user_id)
cpp

房间内的用户调用 startAudioCapture 开启音频采集时，房间内其他用户会收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onUserStopAudioCapture(
    const char* room_id,
    const char* user_id)
cpp

房间内的用户调用 stopAudioCapture 关闭音频采集时，房间内其他用户会收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onActiveSpeaker(
    const char* room_id,
    const char* uid)
cpp

调用 enableAudioPropertiesReport 后，根据设置的 config.interval，你会周期性地收到此回调，获取房间内的最活跃用户信息。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onStreamSyncInfoReceived(
    RemoteStreamKey stream_key,
    SyncInfoStreamType stream_type,
    const uint8_t* data,
    int32_t length)
cpp

音频流同步信息回调。可以通过此回调，在远端用户调用 sendStreamSyncInfo 发送音频流同步消息后，收到远端发送的音频流同步信息。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onNetworkDetectionResult(
    NetworkDetectionLinkType type,
    NetworkQuality quality,
    int rtt,
    double lost_rate,
    int bitrate,
    int jitter)
cpp

通话前网络探测结果。

成功调用 startNetworkDetection 接口开始探测后，会在 3s 内首次收到该回调，之后每 2s 收到一次该回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onNetworkDetectionStopped(
    NetworkDetectionStopReason reason)
cpp

通话前网络探测结束
以下情况将停止探测并收到本一次本回调：

1. 当调用 stopNetworkDetection 接口停止探测后，会收到一次该回调；
2. 当收到远端/本端音频首帧后，停止探测；
3. 当探测超过3分钟后，停止探测；
4. 当探测链路断开一定时间之后，停止探测。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onPlayPublicStreamResult(
    const char* public_stream_id,
    PublicStreamErrorCode errorCode)
cpp

订阅公共流的结果回调

通过 startPlayPublicStream 订阅公共流后，可以通过本回调获取订阅结果。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onPublicStreamSEIMessageReceived(
    const char* public_stream_id,
    const uint8_t* message,
    int message_length,
    SEIMessageSourceType source_type)
cpp

回调公共流中包含的 SEI 信息。
调用 startPlayPublicStream 接口启动拉公共流功能后，通过此回调收到公共流中的 SEI 消息。

传入参数

注意
当公共流中的多路视频流均包含有 SEI 信息：SEI 不互相冲突时，将通过多次回调分别发送；SEI 在同一帧有冲突时，则只有一条流中的 SEI 信息被透传并融合到公共流中。

virtual void bytertc::IRTCVideoEventHandler::onFirstPublicStreamVideoFrameDecoded(
    const char* public_stream_id,
    const VideoFrameInfo& info)
cpp

公共流的首帧视频解码成功

关于订阅公共流，详见 startPlayPublicStream。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onUserStartVideoCapture(
    const char* room_id,
    const char* user_id)
cpp

房间内的可见用户调用 startVideoCapture 开启内部视频采集时，房间内其他用户会收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onUserStopVideoCapture(
    const char* room_id,
    const char* user_id)
cpp

房间内的可见用户调用 stopVideoCapture 关闭内部视频采集时，房间内其他用户会收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onLocalVideoSizeChanged(
    StreamIndex index,
    const VideoFrameInfo& info)
cpp

本地视频大小或旋转信息发生改变时，收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onRemoteVideoSizeChanged(
    RemoteStreamKey key,
    const VideoFrameInfo& info)
cpp

远端视频大小或旋转信息发生改变时，房间内订阅此视频流的用户会收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onFirstLocalVideoFrameCaptured(
    StreamIndex index,
    VideoFrameInfo info)
cpp

RTC SDK 在本地完成第一帧视频帧或屏幕视频帧采集时，收到此回调。

传入参数

注意
对于采集到的本地视频帧，你可以调用 setLocalVideoCanvas 或 setLocalVideoSink 在本地渲染。

virtual void bytertc::IRTCVideoEventHandler::onUserMuteAudio(
    const char* room_id,
    const char* user_id,
    MuteState mute_state)
cpp

Deprecated since 3.36 and will be deleted in 3.51, use onUserPublishStream, onUserPublishScreen, onUserUnpublishStream and onUserUnpublishScreen instead.

房间内用户暂停/恢复发送音频流时，房间内其他用户会收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onFirstRemoteAudioFrame(
    const RemoteStreamKey& key)
cpp

接收到来自远端某音频流的第一帧时，收到该回调。

传入参数

注意
用户刚收到房间内每一路音频流时，都会收到该回调。

virtual void bytertc::IRTCVideoEventHandler::onUserMuteVideo(
    const char* room_id,
    const char* uid,
    MuteState mute)
cpp

Deprecated since 3.36 and will be deleted in 3.51, use onUserPublishStream, onUserPublishScreen, onUserUnpublishStream and onUserUnpublishScreen instead.

房间内用户暂停/恢复发送视频流时，房间内其他用户会收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onRemoteAudioStateChanged(
    const RemoteStreamKey& key,
    RemoteAudioState state,
    RemoteAudioStateChangeReason reason)
cpp

用户订阅来自远端的音频流状态发生改变时，会收到此回调，了解当前的远端音频流状态。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onLocalVideoStateChanged(
    StreamIndex index,
    LocalVideoStreamState state,
    LocalVideoStreamError error)
cpp

Deprecated since 3.50 and will be deleted in 3.55. Use onVideoDeviceStateChanged instead.

本地视频流的状态发生改变时，收到该事件。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onRemoteVideoStateChanged(
    RemoteStreamKey key,
    RemoteVideoState state,
    RemoteVideoStateChangeReason reason)
cpp

远端视频流的状态发生改变时，房间内订阅此流的用户会收到该事件。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onAudioFrameSendStateChanged(
    const char* room_id,
    const RtcUser& user,
    FirstFrameSendState state)
cpp

本地音频首帧发送状态发生改变时，收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onScreenAudioFrameSendStateChanged(
    const char* room_id,
    const RtcUser& user,
    FirstFrameSendState state)
cpp

屏幕音频首帧发送状态改变回调

传入参数

virtual void bytertc::IRTCVideoEventHandler::onVideoFrameSendStateChanged(
    const char* room_id,
    const RtcUser& user,
    FirstFrameSendState state)
cpp

本地视频首帧发送状态发生改变时，收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onFirstRemoteVideoFrameRendered(
    const RemoteStreamKey key,
    const VideoFrameInfo& info)
cpp

SDK 内部渲染成功远端视频流首帧后，收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onFirstRemoteVideoFrameDecoded(
    const RemoteStreamKey key,
    const VideoFrameInfo& info)
cpp

SDK 接收并解码远端视频流首帧后，收到此回调。

传入参数

注意

• 对于主流，进入房间后，仅在发布端第一次发布的时候，订阅端会收到该回调，此后不受重新发布的影响，只要不重新加入房间，就不会再收到该回调。
• 对于屏幕流，用户每次重新发布屏幕视频流在订阅端都会重新触发一次该回调。

virtual void bytertc::IRTCVideoEventHandler::onScreenVideoFrameSendStateChanged(
    const char* room_id,
    const RtcUser& user,
    FirstFrameSendState state)
cpp

屏幕共享流的视频首帧发送状态发生改变时，收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onAudioFramePlayStateChanged(
    const char* room_id,
    const RtcUser& user,
    FirstFramePlayState state)
cpp

音频首帧播放状态发生改变时，收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onScreenAudioFramePlayStateChanged(
    const char* room_id,
    const RtcUser& user,
    FirstFramePlayState state)
cpp

屏幕音频首帧播放状态改变回调

传入参数

virtual void bytertc::IRTCVideoEventHandler::onVideoFramePlayStateChanged(
    const char* room_id,
    const RtcUser& user,
    FirstFramePlayState state)
cpp

视频首帧播放状态改变回调

传入参数

virtual void bytertc::IRTCVideoEventHandler::onScreenVideoFramePlayStateChanged(
    const char* room_id,
    const RtcUser& user,
    FirstFramePlayState state)
cpp

屏幕共享流视频首帧播放状态发生改变时，收到此回调。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onFirstLocalAudioFrame(
    StreamIndex index)
cpp

发布音频流时，采集到第一帧音频帧，收到该回调。

传入参数

注意
如果发布音频流时，未开启本地音频采集，SDK 会推送静音帧，也会收到此回调。

virtual void bytertc::IRTCVideoEventHandler::onPushPublicStreamResult(
    const char* room_id,
    const char* public_streamid,
    PublicStreamErrorCode errorCode)
cpp

公共流发布结果回调。

调用 startPushPublicStream 接口发布公共流后，启动结果通过此回调方法通知用户。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onFirstPublicStreamAudioFrame(
    const char* public_stream_id)
cpp

公共流的音频首帧解码成功

关于订阅公共流，详见 startPlayPublicStream。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onCloudProxyConnected(
    int interval)
cpp

调用 startCloudProxy 开启云代理，SDK 首次成功连接云代理服务器时，回调此事件。

传入参数

virtual void bytertc::IRTCVideoEventHandler::onLicenseWillExpire(
    int days)
cpp

license过期时间提醒

传入参数

class bytertc::IAudioFrameObserver
cpp

音频数据回调观察者
注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。
本接口类中的回调周期均为 20 ms。

virtual void bytertc::IAudioFrameObserver::onRecordAudioFrame(
    const IAudioFrame& audio_frame)
cpp

返回麦克风录制的音频数据

传入参数

virtual void bytertc::IAudioFrameObserver::onPlaybackAudioFrame(
    const IAudioFrame& audio_frame)
cpp

返回订阅的所有远端用户混音后的音频数据。

传入参数

virtual void bytertc::IAudioFrameObserver::onRemoteUserAudioFrame(
    const RemoteStreamKey& stream_info,
    const IAudioFrame& audio_frame)
cpp

返回远端单个用户的音频数据

传入参数

注意
此回调在播放线程调用。不要在此回调中做任何耗时的事情，否则可能会影响整个音频播放链路。

virtual void bytertc::IAudioFrameObserver::onMixedAudioFrame(
    const IAudioFrame& audio_frame)
cpp

返回本地麦克风录制和订阅的所有远端用户混音后的音频数据

传入参数

virtual void bytertc::IAudioFrameObserver::onRecordScreenAudioFrame(
    const IAudioFrame& audio_frame)
cpp

返回本地屏幕录制的音频数据

传入参数

class bytertc::IAudioProcessor
cpp

自定义音频处理器

virtual int bytertc::IAudioProcessor::processAudioFrame(
    const IAudioFrame& audioFrame)
cpp

获取 RTC SDK 采集得到的音频帧，并进行自定义处理，最终将处理后的音频帧给到 RTC SDK 用于编码传输。

传入参数

返回值

0: 未处理
>0: 处理成功
< 0: 处理失败

注意
在进行音频自定义处理前，你需要调用 registerLocalAudioProcessor 设置音频自定义处理器。

class bytertc::IRemoteAudioFrameObserver
cpp

音频数据回调观察者

virtual void bytertc::IRemoteAudioFrameObserver::onRemoteAudioFrame(
    const IAudioFrame& audio_frame,
    const RemoteStreamKey& stream_info)
cpp

获得单个流的音频数据，此回调通过调用 registerRemoteAudioFrameObserver 触发。

传入参数

class bytertc::IEncryptHandler
cpp

加密/解密处理函数

virtual unsigned int bytertc::IEncryptHandler::onEncryptData(
    const unsigned char* data,
    unsigned int length,
    unsigned char* buf,
    unsigned int buf_len)
cpp

自定义加密。

使用设定的自定义加密方式，对编码后传输前的音视频帧数据进行加密。

暂不支持对原始音视频帧进行加密。

传入参数

返回值
加密后的数据

• ≥ 0：加密后实际写入缓冲区的数据大小
• 0：丢弃该帧

注意

• 使用此接口进行自定义加密前，你必须先设置自定义加密方式，参看 setCustomizeEncryptHandler。
• 使用 onDecryptData 对已加密的音视频帧数据进行解密。
• 返回的数据大小应控制在原始数据的 90% ~ 120% 范围以内，不然将被丢弃。

virtual unsigned int bytertc::IEncryptHandler::onDecryptData(
    const unsigned char* data,
    unsigned int length,
    unsigned char* buf,
    unsigned int buf_len)
cpp

自定义解密。

对自定义加密后的音视频帧数据进行解密。关于自定义加密，参看 onEncryptData。

传入参数

返回值
加密后的数据

• ≥ 0：加密后实际写入缓冲区的数据大小
• 0：丢弃该帧

注意

• 使用此接口进行解密前，你必须先设定解密方式，参看 setCustomizeEncryptHandler。
• 返回的数据大小应控制在原始数据的 90% ~ 120% 范围以内，不然将被丢弃。

class bytertc::ITranscoderObserver
cpp

推流 Observer

virtual bool bytertc::ITranscoderObserver::isSupportClientPushStream()
cpp

是否具有推流能力。

• false：不具备推流能力（默认值）
  
• true：具备推流能力

注意
如果需要开启端云一体转推直播功能，你必须确保你的 App 包含 librtmp，具有推流能力。此时，设置该回调为 true。

virtual void bytertc::ITranscoderObserver::onMixingVideoFrame(
    const char* task_id,
    IVideoFrame* video_frame)
cpp

合流视频回调，运行在视频回调线程

传入参数

注意
收到该回调的周期与视频的帧间隔一致。

virtual void bytertc::ITranscoderObserver::onMixingAudioFrame(
    const char* task_id,
    IAudioFrame* audio_frame)
cpp

合流音频回调，运行在音频回调线程

传入参数

注意
收到该回调的周期为每 10 毫秒一次，并且每次的音频数据量为 10 毫秒数据量。

virtual void bytertc::ITranscoderObserver::onMixingDataFrame(
    const char* task_id,
    IDataFrame* data_frame)
cpp

视频 SEI 帧回调，运行在视频回调线程

传入参数

class bytertc::IPushSingleStreamToCDNObserver
cpp

单流转推直播观察者。

virtual void bytertc::IPushSingleStreamToCDNObserver::onStreamPushEvent(
    SingleStreamPushEvent event,
    const char *task_id,
    int error)
cpp

单流转推直播状态回调

传入参数

class bytertc::IExternalVideoEncoderEventHandler
cpp

自定义编码帧回调类

virtual void bytertc::IExternalVideoEncoderEventHandler::onStart(
    StreamIndex index)
cpp

提示自定义编码帧可以开始推送的回调。

收到该回调后，你即可调用 pushExternalEncodedVideoFrame 向 SDK 推送自定义编码视频帧

传入参数

virtual void bytertc::IExternalVideoEncoderEventHandler::onStop(
    StreamIndex index)
cpp

当收到该回调时，你需停止向 SDK 推送自定义编码视频帧

传入参数

virtual void bytertc::IExternalVideoEncoderEventHandler::onRateUpdate(
    StreamIndex index,
    int32_t video_index,
    VideoRateInfo info)
cpp

当自定义编码流的帧率或码率发生变化时，触发该回调

传入参数

virtual void bytertc::IExternalVideoEncoderEventHandler::onRequestKeyFrame(
    StreamIndex index,
    int32_t video_index)
cpp

提示流发布端需重新生成关键帧的回调

传入参数

class bytertc::ILocalEncodedVideoFrameObserver
cpp

本地视频帧监测器

virtual void bytertc::ILocalEncodedVideoFrameObserver::onLocalEncodedVideoFrame(
    StreamIndex type,
    const IEncodedVideoFrame& video_stream)
cpp

调用 registerLocalEncodedVideoFrameObserver 后，SDK 每次使用内部采集，采集到一帧视频帧，或收到一帧外部视频帧时，都会回调该事件。

传入参数

class bytertc::IRemoteEncodedVideoFrameObserver
cpp

远端编码后视频数据监测器

virtual void bytertc::IRemoteEncodedVideoFrameObserver::onRemoteEncodedVideoFrame(
    const RemoteStreamKey& stream_info,
    const IEncodedVideoFrame& video_stream)
cpp

调用 registerRemoteEncodedVideoFrameObserver 后，SDK 监测到远端编码后视频数据时，触发该回调

传入参数

class bytertc::IMetadataObserver
cpp

metadata 观察者，可以接收媒体流中的 metadata， 或者向媒体流中添加 metadata

virtual bool bytertc::IMetadataObserver::onReadyToSendMetadata(
    VideoMetadataBuffer* metadata)
cpp

当 SDK 准备发送一个视频帧时，会回调该事件，以确定是否需要在该视频帧中添加 metadata。

传入参数

返回值

• true：需要向视频帧中添加 metadata
• false：不需要向视频帧中添加 metadata

注意

• metadata 的大小不能超过1024字节
• metadata 中的 timestampUs 是输入字段，代表视频帧的时间戳，做同步使用，不需要修改。
• 回调中不能有耗时操作，以免影响视频卡顿

virtual void bytertc::IMetadataObserver::onMetadataReceived(
    const char* roomid,
    const char* uid,
    const VideoMetadataBuffer& metadata)
cpp

当 SDK 收到一个视频帧时，并且其中包含 medatada 时，会回调该事件。

传入参数

注意
回调中不能有耗时操作，以免影响视频卡顿。

class bytertc::IFaceDetectionObserver
cpp

人脸检测结果回调观察者

virtual void bytertc::IFaceDetectionObserver::onFaceDetectResult(
    const FaceDetectResult& result)
cpp

特效 SDK 进行人脸检测结果的回调。

调用 enableFaceDetection 注册了 IFaceDetectionObserver，并使用 RTC SDK 中包含的特效 SDK 进行视频特效处理时，你会收到此回调。

传入参数