# IKTVPlayerEventHandler ```cpp class bytertc::IKTVPlayerEventHandler ``` KTV 播放器回调接口。注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onPlayProgress](#IKTVPlayerEventHandler-onplayprogress) | | virtual void | [onPlayStateChanged](#IKTVPlayerEventHandler-onplaystatechanged) | ## 函数说明 ### onPlayProgress ```cpp virtual void bytertc::IKTVPlayerEventHandler::onPlayProgress( const char* music_id, int64_t progress ) ``` 音乐播放进度回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | music_id | const char * | 音乐 ID。 | | progress | int64_t | 音乐播放进度，单位为毫秒。 | ### onPlayStateChanged ```cpp virtual void bytertc::IKTVPlayerEventHandler::onPlayStateChanged( const char* music_id, PlayState play_state, bytertc::KTVPlayerErrorCode error_code ) ``` 音乐播放状态改变回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | music_id | const char * | 音乐 ID。 | | play_state | PlayState | 音乐播放状态，参看 [PlayState](70098#PlayState)。 | | error_code | bytertc::KTVPlayerErrorCode | 错误码，参看 [KTVPlayerErrorCode](70098#KTVPlayerErrorCode)。 | **注意** 此回调被触发的时机汇总如下： - 调用 [playMusic](70095#IKTVPlayer-playmusic) 成功后，会触发 playState 值为 PlayStatePlaying 的回调；否则会触发 playState 值为 PlayStateFailed 的回调。 - 使用相同的音乐 ID 重复调用 [playMusic](70095#IKTVPlayer-playmusic) 后，后一次播放会覆盖前一次，且会触发 playState 值为 PlayStatePlaying 的回调，表示后一次音乐播放已开始。 - 调用 [pauseMusic](70095#IKTVPlayer-pausemusic) 方法暂停播放成功后，会触发 playState 值为 PlayStatePaused 的回调；否则触发 playState 值为 PlayStateFailed 的回调。 - 调用 [resumeMusic](70095#IKTVPlayer-resumemusic) 方法恢复播放成功后，会触发 playState 值为 PlayStatePlaying 的回调；否则触发 playState 值为 PlayStateFailed 的回调。 - 调用 [stopMusic](70095#IKTVPlayer-stopmusic) 方法停止播放成功后，会触发 playState 值为 PlayStateStoped 的回调；否则触发 playState 值为 PlayStateFailed 的回调。 - 音乐播放结束会触发 playState 值为 PlayStateFinished 的回调。 # ISnapshotResultCallback ```cpp class bytertc::ISnapshotResultCallback ``` 截图的回调。注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onTakeLocalSnapshotResult](#ISnapshotResultCallback-ontakelocalsnapshotresult) | | virtual void | [onTakeRemoteSnapshotResult](#ISnapshotResultCallback-ontakeremotesnapshotresult) | ## 函数说明 ### onTakeLocalSnapshotResult ```cpp virtual void bytertc::ISnapshotResultCallback::onTakeLocalSnapshotResult( long task_id, StreamIndex stream_index, IVideoFrame* image, int error_code )=0 ``` 调用 [takeLocalSnapshot](70095#IRTCVideo-takelocalsnapshot) 截取视频画面时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | task_id | long | 本地截图任务的编号。和 [takeLocalSnapshot](70095#IRTCVideo-takelocalsnapshot) 的返回值一致。 | | stream_index | StreamIndex | 截图的视频流的属性，参看 [StreamIndex](70098#StreamIndex)。 | | image | IVideoFrame * | 截图。你可以保存为文件，或对其进行二次处理。截图失败时，为空。 | | error_code | int | 截图错误码：

0: 成功
-1: 截图错误。生成图片数据失败或 RGBA 编码失败
-2: 截图错误。流无效。
-3: 截图错误。截图超时,超时时间 1 秒。

| ### onTakeRemoteSnapshotResult ```cpp virtual void bytertc::ISnapshotResultCallback::onTakeRemoteSnapshotResult( long task_id, RemoteStreamKey stream_key, IVideoFrame* image, int error_code )=0 ``` 调用 [takeRemoteSnapshot](70095#IRTCVideo-takeremotesnapshot) 截取视频画面时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | task_id | long | 远端截图任务的编号。和 [takeRemoteSnapshot](70095#IRTCVideo-takeremotesnapshot) 的返回值一致。 | | stream_key | RemoteStreamKey | 截图的视频流，参看 [RemoteStreamKey](70098#RemoteStreamKey)。 | | image | IVideoFrame * | 截图。你可以保存为文件，或对其进行二次处理。截图失败时，为空。 | | error_code | int | 截图错误码：

0: 成功
-1: 截图错误。生成图片数据失败或 RGBA 编码失败
-2: 截图错误。流无效。
-3: 截图错误。截图超时,超时时间 1 秒。

| # IRemoteEncodedVideoFrameObserver ```cpp class bytertc::IRemoteEncodedVideoFrameObserver ``` 远端编码后视频数据监测器注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onRemoteEncodedVideoFrame](#IRemoteEncodedVideoFrameObserver-onremoteencodedvideoframe) | ## 函数说明 ### onRemoteEncodedVideoFrame ```cpp virtual void bytertc::IRemoteEncodedVideoFrameObserver::onRemoteEncodedVideoFrame( const RemoteStreamKey &stream_info, const IEncodedVideoFrame &video_stream )=0 ``` 调用 [registerRemoteEncodedVideoFrameObserver](70095#IRTCVideo-registerremoteencodedvideoframeobserver) 后，SDK 监测到远端编码后视频数据时，触发该回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream_info | const RemoteStreamKey & | 收到的远端流信息，参看 [RemoteStreamKey](70098#RemoteStreamKey) | | video_stream | const IEncodedVideoFrame & | 收到的远端视频帧信息，参看 [IEncodedVideoFrame](70098#IEncodedVideoFrame) | # IAudioEffectPlayerEventHandler ```cpp class bytertc::IAudioEffectPlayerEventHandler ``` [IAudioEffectPlayer](70095#IAudioEffectPlayer) 对应的回调句柄。你必须调用 [setEventHandler](70095#IAudioEffectPlayer-seteventhandler) 完成设置后，才能收到对应回调。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual | [~IAudioEffectPlayerEventHandler](#IAudioEffectPlayerEventHandler-~iaudioeffectplayereventhandler) | | virtual void | [onAudioEffectPlayerStateChanged](#IAudioEffectPlayerEventHandler-onaudioeffectplayerstatechanged) | ## 函数说明 ### ~IAudioEffectPlayerEventHandler ```cpp virtual bytertc::IAudioEffectPlayerEventHandler::~IAudioEffectPlayerEventHandler() ``` ### onAudioEffectPlayerStateChanged ```cpp virtual void bytertc::IAudioEffectPlayerEventHandler::onAudioEffectPlayerStateChanged( int effect_id, PlayerState state, PlayerError error )=0 ``` 播放状态改变时回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | effect_id | int | [IAudioEffectPlayer](70095#IAudioEffectPlayer) 的 ID。通过 [getAudioEffectPlayer](70095#IRTCVideo-getaudioeffectplayer) 设置。 | | state | PlayerState | 混音状态。参考 [PlayerState](70098#PlayerState)。 | | error | PlayerError | 错误码。参考 [PlayerError](70098#PlayerError)。 | # IEncryptHandler ```cpp class bytertc::IEncryptHandler ``` 加密/解密处理函数注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual unsigned int | [onEncryptData](#IEncryptHandler-onencryptdata) | | virtual unsigned int | [onDecryptData](#IEncryptHandler-ondecryptdata) | ## 函数说明 ### onEncryptData ```cpp virtual unsigned int bytertc::IEncryptHandler::onEncryptData( const unsigned char* data, unsigned int length, unsigned char* buf, unsigned int buf_len )=0 ``` 自定义加密。使用设定的自定义加密方式，对编码后传输前的音视频帧数据进行加密。暂不支持对原始音视频帧进行加密。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | const unsigned char * | 原始音视频帧数据 | | length | unsigned int | 原始音视频帧数据的长度 | | buf | unsigned char * | 可供写入的加密后数据缓冲区 | | buf_len | unsigned int | 可供写入的加密后数据缓冲区大小 | **返回值** 加密后的数据 - ≥ 0：加密后实际写入缓冲区的数据大小 - 0：丢弃该帧 **注意** - 使用此接口进行自定义加密前，你必须先设置自定义加密方式，参看 `setCustomizeEncryptHandler`。 - 使用 [onDecryptData](#IEncryptHandler-ondecryptdata) 对已加密的音视频帧数据进行解密。 - 返回的数据大小应控制在原始数据的 90% ~ 120% 范围以内，不然将被丢弃。 ### onDecryptData ```cpp virtual unsigned int bytertc::IEncryptHandler::onDecryptData( const unsigned char* data, unsigned int length, unsigned char* buf, unsigned int buf_len )=0 ``` 自定义解密。对自定义加密后的音视频帧数据进行解密。关于自定义加密，参看 [onEncryptData](#IEncryptHandler-onencryptdata)。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | data | const unsigned char * | 原始音视频帧数据 | | length | unsigned int | 原始音视频帧数据的长度 | | buf | unsigned char * | 可供写入的加密后数据缓冲区 | | buf_len | unsigned int | 可供写入的加密后数据缓冲区大小 | **返回值** 加密后的数据 - ≥ 0：加密后实际写入缓冲区的数据大小 - 0：丢弃该帧 **注意** - 使用此接口进行解密前，你必须先设定解密方式，参看 `setCustomizeEncryptHandler`。 - 返回的数据大小应控制在原始数据的 90% ~ 120% 范围以内，不然将被丢弃。 # IKTVManagerEventHandler ```cpp class bytertc::IKTVManagerEventHandler ``` KTV 事件回调接口。注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onMusicListResult](#IKTVManagerEventHandler-onmusiclistresult) | | virtual void | [onSearchMusicResult](#IKTVManagerEventHandler-onsearchmusicresult) | | virtual void | [onHotMusicResult](#IKTVManagerEventHandler-onhotmusicresult) | | virtual void | [onMusicDetailResult](#IKTVManagerEventHandler-onmusicdetailresult) | | virtual void | [onDownloadSuccess](#IKTVManagerEventHandler-ondownloadsuccess) | | virtual void | [onDownloadFailed](#IKTVManagerEventHandler-ondownloadfailed) | | virtual void | [onDownloadMusicProgress](#IKTVManagerEventHandler-ondownloadmusicprogress) | | virtual void | [onClearCacheResult](#IKTVManagerEventHandler-onclearcacheresult) | ## 函数说明 ### onMusicListResult ```cpp virtual void bytertc::IKTVManagerEventHandler::onMusicListResult( MusicInfo* music_infos, int music_count, int total_musics_size, KTVErrorCode error_code ) ``` 歌曲列表回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | music_infos | MusicInfo * | 歌曲数据数组，参看 [MusicInfo](70098#MusicInfo)。 | | music_count | int | 当前查询的数据条目数。 | | total_musics_size | int | 数据条目总数。 | | error_code | KTVErrorCode | 错误码，成功时返回 0，其余值参看 [KTVErrorCode](70097#KTVErrorCode)。 | ### onSearchMusicResult ```cpp virtual void bytertc::IKTVManagerEventHandler::onSearchMusicResult( MusicInfo* music_infos, int music_count, int total_musics_size, KTVErrorCode error_code ) ``` 搜索歌曲结果回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | music_infos | MusicInfo * | 歌曲数据数组，参看 [MusicInfo](70098#MusicInfo)。 | | music_count | int | 当前查询的数据条目数。 | | total_musics_size | int | 数据条目总数。 | | error_code | KTVErrorCode | 错误码，成功时返回 0，其余值参看 [KTVErrorCode](70097#KTVErrorCode)。 | ### onHotMusicResult ```cpp virtual void bytertc::IKTVManagerEventHandler::onHotMusicResult( HotMusicInfo* hot_infos, int hot_count, KTVErrorCode error_code ) ``` 热榜歌曲结果回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | hot_infos | HotMusicInfo * | 热榜歌曲数据数组，参看 [HotMusicInfo](70098#HotMusicInfo)。 | | hot_count | int | 当前查询的热榜歌曲数据条目数。 | | error_code | KTVErrorCode | 错误码，成功时返回 0，其余值参看 [KTVErrorCode](70097#KTVErrorCode)。 | ### onMusicDetailResult ```cpp virtual void bytertc::IKTVManagerEventHandler::onMusicDetailResult( MusicInfo* music_info, KTVErrorCode error_code ) ``` 歌曲详细信息回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | music_info | MusicInfo * | 歌曲数据，参看 [MusicInfo](70098#MusicInfo)。 | | error_code | KTVErrorCode | 错误码，成功时返回 0，其余值参看 [KTVErrorCode](70097#KTVErrorCode)。
| ### onDownloadSuccess ```cpp virtual void bytertc::IKTVManagerEventHandler::onDownloadSuccess( int download_id, DownloadResult* download_info ) ``` 下载成功回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | download_id | int | 下载任务 ID。 | | download_info | DownloadResult * | 下载信息，参看 [DownloadResult](70098#DownloadResult)。 | ### onDownloadFailed ```cpp virtual void bytertc::IKTVManagerEventHandler::onDownloadFailed( int download_id, KTVErrorCode error_code ) ``` 下载失败回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | download_id | int | 下载任务 ID。 | | error_code | KTVErrorCode | 错误码，参看 [KTVErrorCode](70097#KTVErrorCode)。 | ### onDownloadMusicProgress ```cpp virtual void bytertc::IKTVManagerEventHandler::onDownloadMusicProgress( int download_id, int download_percentage ) ``` 歌曲文件下载进度回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | download_id | int | 下载任务 ID。 | | download_percentage | int | 下载进度百分比，取值范围 [0,100]。 | ### onClearCacheResult ```cpp virtual void bytertc::IKTVManagerEventHandler::onClearCacheResult(KTVErrorCode error_code) ``` 清理文件缓存结果回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | error_code | KTVErrorCode | 错误码，非 0 为失败，参看 [KTVErrorCode](70097#KTVErrorCode)。 | # IMixedStreamObserver ```cpp class bytertc::IMixedStreamObserver ``` 合流推流 Observer 注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual bool | [isSupportClientPushStream](#IMixedStreamObserver-issupportclientpushstream) | | virtual void | [onMixingEvent](#IMixedStreamObserver-onmixingevent) | | virtual void | [onMixingVideoFrame](#IMixedStreamObserver-onmixingvideoframe) | | virtual void | [onMixingAudioFrame](#IMixedStreamObserver-onmixingaudioframe) | | virtual void | [onMixingDataFrame](#IMixedStreamObserver-onmixingdataframe) | ## 函数说明 ### isSupportClientPushStream ```cpp virtual bool bytertc::IMixedStreamObserver::isSupportClientPushStream()=0 ``` 是否具有推流能力。 - false：不具备推流能力（默认值） - true：具备推流能力 **注意** - 如果需要开启端云一体转推直播功能，你必须确保你的 App 包含 librtmp，具有推流能力。此时，设置该回调为 true。 ### onMixingEvent ```cpp virtual void bytertc::IMixedStreamObserver::onMixingEvent( StreamMixingEvent event, const char* task_id, StreamMixingErrorCode error, MixedStreamType mix_type )=0 ``` 转推直播状态回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | event | StreamMixingEvent | 转推直播任务状态，参看 [StreamMixingEvent](70098#StreamMixingEvent) | | task_id | const char * | 转推直播任务 ID | | error | StreamMixingErrorCode | 转推直播错误码，参看 [StreamMixingErrorCode](70097#StreamMixingErrorCode)。 | | mix_type | MixedStreamType | 转推直播类型，参看 [MixedStreamType](70098#MixedStreamType) | ### onMixingVideoFrame ```cpp virtual void bytertc::IMixedStreamObserver::onMixingVideoFrame( const char* task_id, IVideoFrame* video_frame )=0 ``` 合流视频回调，运行在视频回调线程 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | task_id | const char * | 合流任务 ID | | video_frame | IVideoFrame * | 视频帧，参看 [IVideoFrame](70098#IVideoFrame)。 | **注意** 收到该回调的周期与视频的帧间隔一致。 ### onMixingAudioFrame ```cpp virtual void bytertc::IMixedStreamObserver::onMixingAudioFrame( const char* task_id, IAudioFrame* audio_frame )=0 ``` 合流音频回调，运行在音频回调线程 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | task_id | const char * | 转推直播任务 ID | | audio_frame | IAudioFrame * | 音频帧，参看 [IAudioFrame](70098#IAudioFrame)。 | **注意** 收到该回调的周期为每 10 毫秒一次，并且每次的音频数据量为 10 毫秒数据量。 ### onMixingDataFrame ```cpp virtual void bytertc::IMixedStreamObserver::onMixingDataFrame( const char* task_id, IDataFrame* data_frame )=0 ``` 视频 SEI 帧回调，运行在视频回调线程 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | task_id | const char * | 转推直播任务 ID | | data_frame | IDataFrame * | SEI 数据 | # IRTCRoomEventHandler ```cpp class bytertc::IRTCRoomEventHandler ``` 音视频房间事件回调接口注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onRoomStateChanged](#IRTCRoomEventHandler-onroomstatechanged) | | virtual void | [onStreamStateChanged](#IRTCRoomEventHandler-onstreamstatechanged) | | virtual void | [onLeaveRoom](#IRTCRoomEventHandler-onleaveroom) | | virtual void | [onTokenWillExpire](#IRTCRoomEventHandler-ontokenwillexpire) | | virtual void | [onPublishPrivilegeTokenWillExpire](#IRTCRoomEventHandler-onpublishprivilegetokenwillexpire) | | virtual void | [onSubscribePrivilegeTokenWillExpire](#IRTCRoomEventHandler-onsubscribeprivilegetokenwillexpire) | | virtual void | [onRoomStats](#IRTCRoomEventHandler-onroomstats) | | virtual void | [onLocalStreamStats](#IRTCRoomEventHandler-onlocalstreamstats) | | virtual void | [onRemoteStreamStats](#IRTCRoomEventHandler-onremotestreamstats) | | virtual void | [onUserJoined](#IRTCRoomEventHandler-onuserjoined) | | virtual void | [onUserLeave](#IRTCRoomEventHandler-onuserleave) | | virtual void | [onUserPublishStream](#IRTCRoomEventHandler-onuserpublishstream) | | virtual void | [onUserUnpublishStream](#IRTCRoomEventHandler-onuserunpublishstream) | | virtual void | [onUserPublishScreen](#IRTCRoomEventHandler-onuserpublishscreen) | | virtual void | [onUserUnpublishScreen](#IRTCRoomEventHandler-onuserunpublishscreen) | | virtual void | [onStreamSubscribed](#IRTCRoomEventHandler-onstreamsubscribed) | | virtual void | [onRoomMessageReceived](#IRTCRoomEventHandler-onroommessagereceived) | | virtual void | [onRoomBinaryMessageReceived](#IRTCRoomEventHandler-onroombinarymessagereceived) | | virtual void | [onUserMessageReceived](#IRTCRoomEventHandler-onusermessagereceived) | | virtual void | [onUserBinaryMessageReceived](#IRTCRoomEventHandler-onuserbinarymessagereceived) | | virtual void | [onUserMessageSendResult](#IRTCRoomEventHandler-onusermessagesendresult) | | virtual void | [onRoomMessageSendResult](#IRTCRoomEventHandler-onroommessagesendresult) | | virtual void | [onVideoStreamBanned](#IRTCRoomEventHandler-onvideostreambanned) | | virtual void | [onAVSyncStateChange](#IRTCRoomEventHandler-onavsyncstatechange) | | virtual void | [onAudioStreamBanned](#IRTCRoomEventHandler-onaudiostreambanned) | | virtual void | [onForwardStreamStateChanged](#IRTCRoomEventHandler-onforwardstreamstatechanged) | | virtual void | [onForwardStreamEvent](#IRTCRoomEventHandler-onforwardstreamevent) | | virtual void | [onNetworkQuality](#IRTCRoomEventHandler-onnetworkquality) | | virtual void | [onSetRoomExtraInfoResult](#IRTCRoomEventHandler-onsetroomextrainforesult) | | virtual void | [onRoomExtraInfoUpdate](#IRTCRoomEventHandler-onroomextrainfoupdate) | | virtual void | [onUserVisibilityChanged](#IRTCRoomEventHandler-onuservisibilitychanged) | | virtual void | [onSubtitleStateChanged](#IRTCRoomEventHandler-onsubtitlestatechanged) | | virtual void | [onSubtitleMessageReceived](#IRTCRoomEventHandler-onsubtitlemessagereceived) | | virtual void | [deprecated] [onRoomWarning](#IRTCRoomEventHandler-onroomwarning) | | virtual void | [deprecated] [onRoomError](#IRTCRoomEventHandler-onroomerror) | | virtual void | [deprecated] [onStreamRemove](#IRTCRoomEventHandler-onstreamremove) | | virtual void | [deprecated] [onStreamAdd](#IRTCRoomEventHandler-onstreamadd) | ## 函数说明 ### onRoomStateChanged ```cpp virtual void bytertc::IRTCRoomEventHandler::onRoomStateChanged( const char* room_id, const char* uid, int state, const char* extra_info ) ``` 房间状态改变回调，加入房间、异常退出房间、发生房间相关的警告或错误时会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 房间 ID。 | | uid | const char * | 用户 ID。 | | state | int | 房间状态码。

0: 加入房间成功。
!0: 加入房间失败、异常退房、发生房间相关的警告或错误。具体原因参看 [ErrorCode](70097#ErrorCode) 及 [WarningCode](70097#WarningCode)。

| | extra_info | const char * | 额外信息，如 `{"elapsed":1187,"join_type":0}`。
`join_type`表示加入房间的类型，`0`为首次进房，`1`为重连进房。
`elapsed`表示加入房间耗时，即本地用户从调用 [joinRoom](70095#IRTCRoom-joinroom) 到加入房间成功所经历的时间间隔，单位为 ms。 | ### onStreamStateChanged ```cpp virtual void bytertc::IRTCRoomEventHandler::onStreamStateChanged( const char* room_id, const char* uid, int state, const char* extra_info ) ``` 流状态改变回调，发生流相关的警告或错误时会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 房间 ID。 | | uid | const char * | 用户 ID。 | | state | int | 流状态码，参看 [ErrorCode](70097#ErrorCode) 及 [WarningCode](70097#WarningCode)。 | | extra_info | const char * | 附加信息，目前为空。 | ### onLeaveRoom ```cpp virtual void bytertc::IRTCRoomEventHandler::onLeaveRoom(const RtcRoomStats &stats) ``` 离开房间成功回调。用户调用 [leaveRoom](70095#IRTCRoom-leaveroom) 方法后，SDK 会停止所有的发布订阅流，并在释放所有与通话相关的音视频资源后，通过此回调通知用户离开房间成功。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stats | const RtcRoomStats & | 保留参数，目前为空。 | **注意** - 用户调用 [leaveRoom](70095#IRTCRoom-leaveroom) 方法离开房间后，如果立即调用 [destroy](70095#IRTCRoom-destroy) 销毁房间实例或 [destroyRTCVideo](70095#destroyrtcvideo) 方法销毁 RTC 引擎，则将无法收到此回调事件。 - 离开房间后，如果 App 需要使用系统音视频设备，则建议收到此回调后再初始化音视频设备，否则可能由于 SDK 占用音视频设备而导致初始化失败。 ### onTokenWillExpire ```cpp virtual void bytertc::IRTCRoomEventHandler::onTokenWillExpire() ``` 当 SDK 检测到 Token 的进房权限将在 30 秒内过期时，触发该回调。收到该回调后，你需调用 [updateToken](70095#IRTCRoom-updatetoken) 更新 Token 进房权限。 **注意** 若未能及时更新 Token 进房权限导致其过期实效： - 用户此时尝试进房会收到 [onRoomStateChanged](#IRTCRoomEventHandler-onroomstatechanged) 回调，提示错误码为 `-1000` Token 过期； - 用户已在房间内则会被移出房间，本地用户会收到 [onRoomStateChanged](#IRTCRoomEventHandler-onroomstatechanged) 回调，提示错误码为 `-1009` Token 过期，同时远端用户会收到 [onUserLeave](#IRTCRoomEventHandler-onuserleave) 回调，提示原因为 `2` Token 进房权限过期。 ### onPublishPrivilegeTokenWillExpire ```cpp virtual void bytertc::IRTCRoomEventHandler::onPublishPrivilegeTokenWillExpire() ``` Token 发布权限过期前 30 秒将触发该回调。收到该回调后，你需调用 [updateToken](70095#IRTCRoom-updatetoken) 更新 Token 发布权限。 **注意** 若收到该回调后未及时更新 Token，Token 发布权限过期后： - 此时尝试发布流会收到 [onStreamStateChanged](#IRTCRoomEventHandler-onstreamstatechanged) 回调，提示错误码为 `-1002` 没有发布权限； - 已在发布中的流会停止发布，发布端会收到 [onStreamStateChanged](#IRTCRoomEventHandler-onstreamstatechanged) 回调，提示错误码为 `-1002` 没有发布权限，同时远端用户会收到 [onUserUnpublishStream](#IRTCRoomEventHandler-onuserunpublishstream)/ [onUserUnpublishScreen](#IRTCRoomEventHandler-onuserunpublishscreen) 回调，提示原因为 `6` 发流端发布权限过期。 ### onSubscribePrivilegeTokenWillExpire ```cpp virtual void bytertc::IRTCRoomEventHandler::onSubscribePrivilegeTokenWillExpire() ``` Token 订阅权限过期前 30 秒将触发该回调。收到该回调后，你需调用 [updateToken](70095#IRTCRoom-updatetoken) 更新 Token 订阅权限有效期。 **注意** 若收到该回调后未及时更新 Token，Token 订阅权限过期后，尝试新订阅流会失败，已订阅的流会取消订阅，并且会收到 [onStreamStateChanged](#IRTCRoomEventHandler-onstreamstatechanged) 回调，提示错误码为 `-1003` 没有订阅权限。 ### onRoomStats ```cpp virtual void bytertc::IRTCRoomEventHandler::onRoomStats(const RtcRoomStats &stats) ``` 房间内通话统计信息回调。用户进房开始通话后，每 2s 收到一次本回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stats | const RtcRoomStats & | 当前 RtcEngine 统计数据，详见 [RtcRoomStats](70098#RtcRoomStats) | ### onLocalStreamStats ```cpp virtual void bytertc::IRTCRoomEventHandler::onLocalStreamStats(const LocalStreamStats &stats) ``` 本地流数据统计以及网络质量回调。本地用户发布流成功后，SDK 会周期性（2s）的通过此回调事件通知用户发布的流在此次统计周期内的质量统计信息。统计信息通过 [LocalStreamStats](70098#LocalStreamStats) 类型的回调参数传递给用户，其中包括发送音视频比特率、发送帧率、编码帧率，网络质量等。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stats | const LocalStreamStats & | 当前 RtcEngine 统计数据，详见 [LocalStreamStats](70098#LocalStreamStats)。 | ### onRemoteStreamStats ```cpp virtual void bytertc::IRTCRoomEventHandler::onRemoteStreamStats(const RemoteStreamStats &stats) ``` 本地订阅的远端音/视频流数据统计以及网络质量回调。本地用户订阅流成功后，SDK 会周期性（2s）的通过此回调事件通知用户订阅的流在此次统计周期内的质量统计信息，包括：发送音视频比特率、发送帧率、编码帧率，网络质量等。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stats | const RemoteStreamStats & | 当前 RtcEngine 统计数据，详见 [RemoteStreamStats](70098#RemoteStreamStats) | ### onUserJoined ```cpp virtual void bytertc::IRTCRoomEventHandler::onUserJoined( const UserInfo &user_info, int elapsed ) ``` 远端可见用户加入房间，或房内不可见用户切换为可见的回调。 1. 远端用户调用 [setUserVisibility](70095#IRTCRoom-setuservisibility) 方法将自身设为可见后加入房间时，房间内其他用户将收到该事件。 2. 远端可见用户断网后重新连入房间时，房间内其他用户将收到该事件。 3. 房间内隐身远端用户调用 [setUserVisibility](70095#IRTCRoom-setuservisibility) 方法切换至可见时，房间内其他用户将收到该事件。 4. 新进房用户会收到进房前已在房内的可见用户的进房回调通知。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | user_info | const UserInfo & | 用户信息，详见 [UserInfo](70098#UserInfo) | | elapsed | int | 保留字段，无意义。 | ### onUserLeave ```cpp virtual void bytertc::IRTCRoomEventHandler::onUserLeave( const char* uid, UserOfflineReason reason ) ``` 远端用户离开房间，或切至不可见时，本地用户会收到此事件 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * | 离开房间，或切至不可见的的远端用户 ID。 | | reason | UserOfflineReason | 用户离开房间的原因，详见 [UserOfflineReason](70098#UserOfflineReason)。

0: 远端用户调用 [leaveRoom](70095#IRTCRoom-leaveroom) 主动退出房间。
1: 远端用户因 Token 过期或网络原因等掉线。详细信息请参看[连接状态提示](https://www.volcengine.com/docs/6348/95376)
2: 远端用户调用 [setUserVisibility](70095#IRTCRoom-setuservisibility) 切换至不可见状态。
3: 服务端调用 OpenAPI 将远端用户踢出房间。

| ### onUserPublishStream ```cpp virtual void bytertc::IRTCRoomEventHandler::onUserPublishStream( const char* uid, MediaStreamType type ) ``` 房间内新增远端摄像头/麦克风采集的媒体流的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * | 远端流发布用户的用户 ID。 | | type | MediaStreamType | 远端媒体流的类型，参看 [MediaStreamType](70098#MediaStreamType)。 | **注意** 当房间内的远端用户调用 [publishStream](70095#IRTCRoom-publishstream) 成功发布由摄像头/麦克风采集的媒体流时，本地用户会收到该回调，此时本地用户可以自行选择是否调用 [subscribeStream](70095#IRTCRoom-subscribestream) 订阅此流。 ### onUserUnpublishStream ```cpp virtual void bytertc::IRTCRoomEventHandler::onUserUnpublishStream( const char* uid, MediaStreamType type, StreamRemoveReason reason ) ``` 房间内远端摄像头/麦克风采集的媒体流移除的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * | 移除的远端流发布用户的用户 ID。 | | type | MediaStreamType | 移除的远端流类型，参看 [MediaStreamType](70098#MediaStreamType)。 | | reason | StreamRemoveReason | 远端流移除的原因，参看 [StreamRemoveReason](70098#StreamRemoveReason)。 | **注意** 收到该回调通知后，你可以自行选择是否调用 [unsubscribeStream](70095#IRTCRoom-unsubscribestream) 取消订阅此流。 ### onUserPublishScreen ```cpp virtual void bytertc::IRTCRoomEventHandler::onUserPublishScreen( const char* uid, MediaStreamType type ) ``` 房间内新增远端屏幕共享音视频流的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * | 远端流发布用户的用户 ID。 | | type | MediaStreamType | 远端媒体流的类型，参看 [MediaStreamType](70098#MediaStreamType)。 | **注意** 当房间内的远端用户调用 [publishScreen](70095#IRTCRoom-publishscreen) 成功发布来自屏幕共享的音视频流时，本地用户会收到该回调，此时本地用户可以自行选择是否调用 [subscribeScreen](70095#IRTCRoom-subscribescreen) 订阅此流。（Linux 不支持） ### onUserUnpublishScreen ```cpp virtual void bytertc::IRTCRoomEventHandler::onUserUnpublishScreen( const char* uid, MediaStreamType type, StreamRemoveReason reason ) ``` 房间内远端屏幕共享音视频流移除的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * | 移除的远端流发布用户的用户 ID。 | | type | MediaStreamType | 移除的远端流类型，参看 [MediaStreamType](70098#MediaStreamType)。 | | reason | StreamRemoveReason | 远端流移除的原因，参看 [StreamRemoveReason](70098#StreamRemoveReason)。 | **注意** 收到该回调通知后，你可以自行选择是否调用 [unsubscribeScreen](70095#IRTCRoom-unsubscribescreen) 取消订阅此流。 ### onStreamSubscribed ```cpp virtual void bytertc::IRTCRoomEventHandler::onStreamSubscribed( SubscribeState state_code, const char* user_id, const SubscribeConfig &info ) ``` 关于订阅媒体流状态改变的回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state_code | SubscribeState | 订阅媒体流状态，参看 [SubscribeState](70098#SubscribeState) | | user_id | const char * | 流发布用户的用户 ID | | info | const SubscribeConfig & | 流的属性，参看 [SubscribeConfig](70098#SubscribeConfig) | **注意** 本地用户收到该回调的时机包括： - 调用 [subscribeStream](70095#IRTCRoom-subscribestream) 或 [unsubscribeStream](70095#IRTCRoom-unsubscribestream) 订阅/取消订阅指定远端摄像头音视频流后； - 调用 [subscribeScreen](70095#IRTCRoom-subscribescreen) 或 [unsubscribeScreen](70095#IRTCRoom-unsubscribescreen) 订阅/取消订阅指定远端屏幕共享流后。 ### onRoomMessageReceived ```cpp virtual void bytertc::IRTCRoomEventHandler::onRoomMessageReceived( const char* uid, const char* message ) ``` 接收到房间内广播消息的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * |
消息发送者 ID | | message | const char * |
收到的消息内容 | **注意** 同一房间内其他用户调用 [sendRoomMessage](70095#IRTCRoom-sendroommessage) 发送广播消息时会收到该回调。 ### onRoomBinaryMessageReceived ```cpp virtual void bytertc::IRTCRoomEventHandler::onRoomBinaryMessageReceived( const char* uid, int size, const uint8_t* message ) ``` 收到房间内广播二进制消息的回调。房间内其他用户调用 [sendRoomBinaryMessage](70095#IRTCRoom-sendroombinarymessage) 发送广播二进制消息时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * |
消息发送者 ID | | size | int |
收到的二进制消息长度 | | message | const uint8_t * |
收到的二进制消息内容 | **注意** 同一房间内其他用户调用 [sendRoomBinaryMessage](70095#IRTCRoom-sendroombinarymessage) 发送二进制广播消息时会收到该回调。 ### onUserMessageReceived ```cpp virtual void bytertc::IRTCRoomEventHandler::onUserMessageReceived( const char* uid, const char* message ) ``` 收到来自房间中其他用户通过 [sendUserMessage](70095#IRTCRoom-sendusermessage) 发来的点对点文本消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * |
消息发送者 ID 。 | | message | const char * |
收到的文本消息内容。 | **注意** - 你必须先调用 [sendUserMessage](70095#IRTCRoom-sendusermessage) 方法，才能收到该回调。 ### onUserBinaryMessageReceived ```cpp virtual void bytertc::IRTCRoomEventHandler::onUserBinaryMessageReceived( const char* uid, int size, const uint8_t* message ) ``` 收到来自房间中其他用户通过 [sendUserBinaryMessage](70095#IRTCRoom-senduserbinarymessage) 发来的点对点二进制消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * | 消息发送者 ID 。 | | size | int | 消息长度 | | message | const uint8_t * | 收到的二进制消息内容。 | ### onUserMessageSendResult ```cpp virtual void bytertc::IRTCRoomEventHandler::onUserMessageSendResult( int64_t msgid, int error ) ``` 向房间内单个用户发送文本或二进制消息后（P2P），消息发送方会收到该消息发送结果回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | int64_t |
本条消息的 ID。 | | error | int |
文本或二进制消息发送结果，详见 [UserMessageSendResult](70097#UserMessageSendResult) | **注意** - 你必须先调用 [sendUserMessage](70095#IRTCRoom-sendusermessage) 或 [sendUserBinaryMessage](70095#IRTCRoom-senduserbinarymessage) 接口，才能收到此回调。 ### onRoomMessageSendResult ```cpp virtual void bytertc::IRTCRoomEventHandler::onRoomMessageSendResult( int64_t msgid, int error ) ``` 调用 [sendRoomMessage](70095#IRTCRoom-sendroommessage) 或 [sendRoomBinaryMessage](70095#IRTCRoom-sendroombinarymessage) 向房间内群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | int64_t |
本条消息的 ID | | error | int |
消息发送结果
详见 [RoomMessageSendResult](70098#RoomMessageSendResult) | ### onVideoStreamBanned ```cpp virtual void bytertc::IRTCRoomEventHandler::onVideoStreamBanned( const char* uid, bool banned ) ``` 通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户视频流的发送时，触发此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * | 被禁用/解禁的视频流用户 ID | | banned | bool | 视频流发送状态

true: 视频流发送被禁用
false: 视频流发送被解禁

| **注意** - 房间内指定用户被禁止/解禁视频流发送时，房间内所有用户都会收到该回调。 - 若被封禁用户断网或退房后再进房，则依然是封禁状态，且房间内所有人会再次收到该回调。 - 指定用户被封禁后，房间内其他用户退房后再进房，会再次收到该回调。 - 同一房间解散后再次创建，房间内状态清空。 ### onAVSyncStateChange ```cpp virtual void bytertc::IRTCRoomEventHandler::onAVSyncStateChange(AVSyncState state) ``` 发布端调用 [setMultiDeviceAVSync](70095#IRTCRoom-setmultideviceavsync) 后音视频同步状态发生改变时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | AVSyncState | 音视频同步状态，参看 [AVSyncState](70098#AVSyncState)。 | ### onAudioStreamBanned ```cpp virtual void bytertc::IRTCRoomEventHandler::onAudioStreamBanned( const char* uid, bool banned ) ``` 通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户音频流的发送时，触发此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * | 被禁用/解禁的音频流用户 ID | | banned | bool | 音频流发送状态

true: 音频流发送被禁用
false: 音频流发送被解禁

| **注意** - 房间内指定用户被禁止/解禁音频流发送时，房间内所有用户都会收到该回调。 - 若被封禁用户断网或退房后再进房，则依然是封禁状态，且房间内所有人会再次收到该回调。 - 指定用户被封禁后，房间内其他用户退房后再进房，会再次收到该回调。 - 在控制台开启音频选路后，只有被封禁/解禁用户会收到该回调。 - 同一房间解散后再次创建，房间内状态清空。 ### onForwardStreamStateChanged ```cpp virtual void bytertc::IRTCRoomEventHandler::onForwardStreamStateChanged( ForwardStreamStateInfo* infos, int info_count ) ``` 跨房间媒体流转发状态和错误回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | infos | ForwardStreamStateInfo * | 跨房间媒体流转发目标房间信息数组，详见 [ForwardStreamStateInfo](70098#ForwardStreamStateInfo) | | info_count | int | 数组长度，代表目标房间数 | ### onForwardStreamEvent ```cpp virtual void bytertc::IRTCRoomEventHandler::onForwardStreamEvent( ForwardStreamEventInfo* infos, int info_count ) ``` 跨房间媒体流转发事件回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | infos | ForwardStreamEventInfo * | 跨房间媒体流转发目标房间事件数组，详见 [ForwardStreamEventInfo](70098#ForwardStreamEventInfo) | | info_count | int | 数组长度，代表目标房间数 | ### onNetworkQuality ```cpp virtual void bytertc::IRTCRoomEventHandler::onNetworkQuality( const NetworkQualityStats &local_quality, const NetworkQualityStats* remote_qualities, int remote_quality_num ) ``` 加入房间并发布或订阅流后，以每 2 秒一次的频率，报告本地用户和已订阅的远端用户的上下行网络质量信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | local_quality | const NetworkQualityStats & | 本端网络质量，详见 [NetworkQualityStats](70098#NetworkQualityStats)。 | | remote_qualities | const NetworkQualityStats * | 已订阅用户的网络质量，详见 [NetworkQualityStats](70098#NetworkQualityStats)。 | | remote_quality_num | int | `remoteQualities` 数组长度 | **注意** 更多通话中的监测接口，详见[通话中质量监测](https://www.volcengine.com/docs/6348/106866)。 ### onSetRoomExtraInfoResult ```cpp virtual void bytertc::IRTCRoomEventHandler::onSetRoomExtraInfoResult( int64_t task_id, SetRoomExtraInfoResult error_code ) ``` > Available since 3.52. 调用 [setRoomExtraInfo](70095#IRTCRoom-setroomextrainfo) 设置房间附加信息结果的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | task_id | int64_t | 调用 setRoomExtraInfo 的任务编号。 | | error_code | SetRoomExtraInfoResult | 设置房间附加信息的结果，详见 [SetRoomExtraInfoResult](70098#SetRoomExtraInfoResult) | ### onRoomExtraInfoUpdate ```cpp virtual void bytertc::IRTCRoomEventHandler::onRoomExtraInfoUpdate( const char* key, const char* value, const char* last_update_user_id, int64_t last_update_time_ms ) ``` > Available since 3.52. 接收同一房间内，其他用户调用 [setRoomExtraInfo](70095#IRTCRoom-setroomextrainfo) 设置的房间附加信息的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | const char * | 房间附加信息的键值 | | value | const char * | 房间附加信息的内容 | | last_update_user_id | const char * | 最后更新本条信息的用户 ID。 | | last_update_time_ms | int64_t | 最后更新本条信息的 Unix 时间，单位：毫秒。 | **注意** 新进房的用户会收到进房前房间内已有的全部附加信息通知。 ### onUserVisibilityChanged ```cpp virtual void bytertc::IRTCRoomEventHandler::onUserVisibilityChanged( bool current_user_visibility, UserVisibilityChangeError error_code ) ``` > Available since 3.54 用户调用 [setUserVisibility](70095#IRTCRoom-setuservisibility) 设置用户可见性的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | current_user_visibility | bool | 当前用户的可见性。

true: 可见，用户可以在房间内发布音视频流，房间中的其他用户将收到用户的行为通知，例如进房、开启视频采集和退房。
false: 不可见，用户不可以在房间内发布音视频流，房间中的其他用户不会收到用户的行为通知，例如进房、开启视频采集和退房。

| | error_code | UserVisibilityChangeError | 设置用户可见性错误码，参看 [UserVisibilityChangeError](70098#UserVisibilityChangeError)。 | ### onSubtitleStateChanged ```cpp virtual void bytertc::IRTCRoomEventHandler::onSubtitleStateChanged( SubtitleState state, SubtitleErrorCode error_code, const char* error_message ) ``` 字幕状态发生改变回调。当用户调用 [startSubtitle](70095#IRTCRoom-startsubtitle) 和 [stopSubtitle](70095#IRTCRoom-stopsubtitle) 使字幕状态发生改变或出现错误时，触发该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | SubtitleState | 字幕状态。参看 [SubtitleState](70098#SubtitleState)。 | | error_code | SubtitleErrorCode | 字幕任务错误码。参看 [SubtitleErrorCode](70097#SubtitleErrorCode)。 | | error_message | const char * | 与第三方服务有关的错误信息。 | ### onSubtitleMessageReceived ```cpp virtual void bytertc::IRTCRoomEventHandler::onSubtitleMessageReceived( const SubtitleMessage* subtitles, int cnt ) ``` 字幕相关内容回调。当用户调用 [startSubtitle](70095#IRTCRoom-startsubtitle) 后会收到此回调，通知字幕的相关信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | subtitles | const SubtitleMessage * | 字幕消息内容。参看 [SubtitleMessage](70098#SubtitleMessage)。 | | cnt | int | 字幕消息个数。 | ### onRoomWarning ```cpp virtual void bytertc::IRTCRoomEventHandler::onRoomWarning(int warn) ``` > Deprecated since 3.41 and will be deleted in 3.51, use [onRoomStateChanged](#IRTCRoomEventHandler-onroomstatechanged) and [onStreamStateChanged](#IRTCRoomEventHandler-onstreamstatechanged) instead. SDK 发生警告回调。 SDK 内部遇到可恢复错误时，在尝试自动恢复的同时，会通过此回调通知用户。此回调事件仅用作通知。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | warn | int | 警告码，参看 [WarningCode](70097#WarningCode)。 | ### onRoomError ```cpp virtual void bytertc::IRTCRoomEventHandler::onRoomError(int err) ``` > Deprecated since 3.41 and will be deleted in 3.51, use [onRoomStateChanged](#IRTCRoomEventHandler-onroomstatechanged) and [onStreamStateChanged](#IRTCRoomEventHandler-onstreamstatechanged) instead. SDK 发生错误回调。 SDK 内部遇到不可恢复错误时，会通过此回调通知 App，需要 App 根据错误码进行操作或提示用户。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | err | int | 错误码，参看 [ErrorCode](70097#ErrorCode)。 | ### onStreamRemove ```cpp virtual void bytertc::IRTCRoomEventHandler::onStreamRemove( const MediaStreamInfo &stream, StreamRemoveReason reason ) ``` > Deprecated since 3.36 and will be deleted in 3.51, use [onUserUnpublishStream](#IRTCRoomEventHandler-onuserunpublishstream) and [onUserUnpublishScreen](#IRTCRoomEventHandler-onuserunpublishscreen) instead. 房间内的远端用户停止发布音视频流时，本地用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream | const MediaStreamInfo & | 流的属性。参看 [MediaStreamInfo](70098#MediaStreamInfo) 。 | | reason | StreamRemoveReason | 远端流移除的原因。参看 [StreamRemoveReason](70098#StreamRemoveReason)。 | ### onStreamAdd ```cpp virtual void bytertc::IRTCRoomEventHandler::onStreamAdd(const MediaStreamInfo &stream) ``` > Deprecated since 3.36 and will be deleted in 3.51, use [onUserPublishStream](#IRTCRoomEventHandler-onuserpublishstream) and [onUserPublishScreen](#IRTCRoomEventHandler-onuserpublishscreen) instead. 房间内的用户发布新的音视频流时，房间内的其他用户会收到此回调。包括移除后又重新发布的流。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream | const MediaStreamInfo & | 流属性，参看 [MediaStreamInfo](70098#MediaStreamInfo) 。 | # IStreamingRTCEventHandler ```cpp class bytertc::streamingrtc::IStreamingRTCEventHandler ``` 串流引擎事件回调接口。调用 [createStreamingRTCEngine](70095#createstreamingrtcengine) 创建 [IStreamingRTCEngine](70095#IStreamingRTCEngine) 实例时，传入该回调实例。注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onLogReport](#IStreamingRTCEventHandler-onlogreport) | | virtual void | [onWarning](#IStreamingRTCEventHandler-onwarning) | | virtual void | [onError](#IStreamingRTCEventHandler-onerror) | | virtual void | [onExtensionAccessError](#IStreamingRTCEventHandler-onextensionaccesserror) | | virtual void | [onP2PConnectionStateChanged](#IStreamingRTCEventHandler-onp2pconnectionstatechanged) | | virtual void | [onP2PConnectionStats](#IStreamingRTCEventHandler-onp2pconnectionstats) | | virtual void | [onP2PLocalStreamStats](#IStreamingRTCEventHandler-onp2plocalstreamstats) | | virtual void | [onP2PRemoteStreamStats](#IStreamingRTCEventHandler-onp2premotestreamstats) | | virtual void | [onP2PMessageSendResult](#IStreamingRTCEventHandler-onp2pmessagesendresult) | | virtual void | [onP2PMessageReceived](#IStreamingRTCEventHandler-onp2pmessagereceived) | | virtual void | [onP2PBinaryMessageReceived](#IStreamingRTCEventHandler-onp2pbinarymessagereceived) | | virtual bool | [onP2PRemoteVideoFrame](#IStreamingRTCEventHandler-onp2premotevideoframe) | | virtual bool | [onP2PRemoteEncodedVideoFrame](#IStreamingRTCEventHandler-onp2premoteencodedvideoframe) | | virtual void | [onP2PLocalExternalEncoderStart](#IStreamingRTCEventHandler-onp2plocalexternalencoderstart) | | virtual void | [onP2PLocalExternalEncoderStop](#IStreamingRTCEventHandler-onp2plocalexternalencoderstop) | | virtual void | [onP2PSuggestLocalExternalEncoderRateUpdate](#IStreamingRTCEventHandler-onp2psuggestlocalexternalencoderrateupdate) | | virtual void | [onP2PRequestLocalExternalEncoderKeyFrame](#IStreamingRTCEventHandler-onp2prequestlocalexternalencoderkeyframe) | | virtual void | [onP2PLocalExternalEncoderActiveVideoLayer](#IStreamingRTCEventHandler-onp2plocalexternalencoderactivevideolayer) | | virtual void | [onLicenseWillExpire](#IStreamingRTCEventHandler-onlicensewillexpire) | ## 函数说明 ### onLogReport ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onLogReport( const char* log_type, const char* log_content ) ``` 端监控日志回调。当产生一个端监控事件时触发该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | log_type | const char * | 事件类型。目前类型固定为 `live_webrtc_monitor_log`。 | | log_content | const char * | 端监控日志内容。 | ### onWarning ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onWarning(int code) ``` 当内部发生警告事件时触发该回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | code | int | 警告标识码，详见: [WarningCode](70097#WarningCode) | ### onError ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onError(int code) ``` 当 SDK 内部发生不可逆转错误时触发该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | code | int | 错误标识码，参看 [ErrorCode](70097#ErrorCode) | ### onExtensionAccessError ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onExtensionAccessError( const char* extensionName, const char* msg ) ``` > Available since 3.52 当访问插件失败时，收到此回调。 RTC SDK 将一些功能封装成插件。当使用这些功能时，如果插件不存在，功能将无法使用。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | extensionName | const char * | 插件名字 | | msg | const char * | 失败说明 | ### onP2PConnectionStateChanged ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PConnectionStateChanged(ConnectionState state) ``` 串流引擎连接状态改变回调。连接状态改变时触发。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | ConnectionState | 当前 SDK 与对端的连接状态，详见 [ConnectionState](70098#ConnectionState) | ### onP2PConnectionStats ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PConnectionStats(const ConnectionStats &stats) ``` P2P 通话统计信息回调。串流引擎启动后，每 2s 收到一次本回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stats | const ConnectionStats & | 当前 StreamingRtcEngine 统计数据，详见 [ConnectionStats](70098#connectionstats) | ### onP2PLocalStreamStats ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PLocalStreamStats(const LocalStreamStats &stats) ``` 串流引擎启动后，每隔 2s 收到此回调，了解本端发布的流在此周期内的网络质量信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stats | const LocalStreamStats & | 当前 StreamingRtcEngine 统计数据，详见 [LocalStreamStats](70098#LocalStreamStats) | ### onP2PRemoteStreamStats ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PRemoteStreamStats(const RemoteStreamStats &stats) ``` 每隔 2s 收到此回调，了解远端用户发布的流在此周期内的网络质量信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stats | const RemoteStreamStats & | 当前 StreamingRtcEngine 统计数据，详见 [RemoteStreamStats](70098#RemoteStreamStats) | ### onP2PMessageSendResult ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PMessageSendResult( int64_t msg_id, int error ) ``` 调用 [sendP2PMessage](70095#IStreamingRTCEngine-sendp2pmessage) 或 [sendP2PBinaryMessage](70095#IStreamingRTCEngine-sendp2pbinarymessage)，向远端用户发送文本或二进制消息后，消息发送方会收到本次发送的结果回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msg_id | int64_t | 本条消息的 ID。 | | error | int | 错误码
0: 成功
102: 失败，未建立连接 | ### onP2PMessageReceived ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PMessageReceived(const char* message) ``` 收到远端用户发来的文本消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | message | const char * | 收到的文本消息内容。 | **注意** 关于发送点对点消息，参看 [sendP2PMessage](70095#IStreamingRTCEngine-sendp2pmessage)。 ### onP2PBinaryMessageReceived ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PBinaryMessageReceived( const uint8_t* message, int size ) ``` 收到远端用户发来的二进制消息时，会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | message | const uint8_t * | 收到的二进制消息内容。 | | size | int | 收到的二进制消息内容的大小，单位为 byte. | **注意** 关于发送二进制点对点消息，参看 [sendP2PBinaryMessage](70095#IStreamingRTCEngine-sendp2pbinarymessage)。 ### onP2PRemoteVideoFrame ```cpp virtual bool bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PRemoteVideoFrame( IVideoFrame* video_frame, streamingrtc::StreamIndex stream_index ) ``` 获取远端用户发送的视频帧。关于推送视频帧，参看 [pushVideoFrame](70095#IStreamingRTCEngine-pushvideoframe) 关于推送已编码的视频流，参看 [pushEncodedVideoFrame](70095#IStreamingRTCEngine-pushencodedvideoframe) 关于编码设置，参看 [setVideoDecoderConfig](70095#IStreamingRTCEngine-setvideodecoderconfig) **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | video_frame | IVideoFrame * | 视频数据，参看 [IVideoFrame](70098#IVideoFrame) | | stream_index | streamingrtc::StreamIndex | 视频流序号参看 [StreamIndex](70098#StreamIndex-2) | **返回值** - `True`：成功 - `False`：失败 ### onP2PRemoteEncodedVideoFrame ```cpp virtual bool bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PRemoteEncodedVideoFrame( const IEncodedVideoFrame &encoded_video_frame, streamingrtc::StreamIndex stream_index ) ``` 获取远端用户解码前的视频数据。获取数据后传入自定义解码器进行解码。关于推送视频帧，参看 [pushVideoFrame](70095#IStreamingRTCEngine-pushvideoframe) 关于推送已编码的视频流，参看 [pushEncodedVideoFrame](70095#IStreamingRTCEngine-pushencodedvideoframe) 关于编码设置，参看 [setVideoDecoderConfig](70095#IStreamingRTCEngine-setvideodecoderconfig) **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | encoded_video_frame | const IEncodedVideoFrame & | 解码前的视频数据，参看 [IEncodedVideoFrame](70098#IEncodedVideoFrame) | | stream_index | streamingrtc::StreamIndex | 视频流序号参看 [StreamIndex](70098#StreamIndex-2) | **返回值** - `True`：成功 - `False`：失败 ### onP2PLocalExternalEncoderStart ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PLocalExternalEncoderStart(streamingrtc::StreamIndex stream_index) ``` 提醒外部视频编码器开始工作。关于编码设置，参看 [setVideoSourceType](70095#IStreamingRTCEngine-setvideosourcetype) **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream_index | streamingrtc::StreamIndex | 视频流序号参看 [StreamIndex](70098#StreamIndex-2) | ### onP2PLocalExternalEncoderStop ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PLocalExternalEncoderStop(streamingrtc::StreamIndex stream_index) ``` 提醒外部视频编码器停止工作。关于编码设置，参看 [setVideoSourceType](70095#IStreamingRTCEngine-setvideosourcetype) **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream_index | streamingrtc::StreamIndex | 视频流序号参看 [StreamIndex](70098#StreamIndex-2) | ### onP2PSuggestLocalExternalEncoderRateUpdate ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PSuggestLocalExternalEncoderRateUpdate( streamingrtc::StreamIndex stream_index, int32_t video_index, VideoRateInfo info ) ``` 提醒外部视频编码器调整编码码率。关于编码设置，参看 [setVideoSourceType](70095#IStreamingRTCEngine-setvideosourcetype) **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream_index | streamingrtc::StreamIndex | 视频流序号。参看 [StreamIndex](70098#StreamIndex-2) | | video_index | int32_t | video solution 序号。 | | info | VideoRateInfo | 建议调整的码率信息。参看 [VideoRateInfo](70098#VideoRateInfo) | ### onP2PRequestLocalExternalEncoderKeyFrame ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PRequestLocalExternalEncoderKeyFrame( streamingrtc::StreamIndex stream_index, int32_t video_index ) ``` 提醒外部视频编码器发送关键帧。关于编码设置，参看 [setVideoSourceType](70095#IStreamingRTCEngine-setvideosourcetype) **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream_index | streamingrtc::StreamIndex | 视频流序号。参看 [StreamIndex](70098#StreamIndex-2) | | video_index | int32_t | video solution 序号。 | ### onP2PLocalExternalEncoderActiveVideoLayer ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onP2PLocalExternalEncoderActiveVideoLayer( streamingrtc::StreamIndex stream_index, int32_t video_index, bool active ) ``` 作为自定义编码视频流的发送端，你会在视频流可发送状态发生变化时，收到此回调。你可以根据此回调的提示，仅对可发送的视频流进行编码，以降低本端视频编码性能消耗。此回调会根据多个因素综合判断触发，包括：本端设备性能和本端网络性能，以及按需订阅场景下，远端用户是否订阅。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream_index | streamingrtc::StreamIndex | 远端编码流的属性，参看 [StreamIndex](70098#StreamIndex-2)。 | | video_index | int32_t | 对应编码流的下标 | | active | bool | 该路流可发送状态 | ### onLicenseWillExpire ```cpp virtual void bytertc::streamingrtc::IStreamingRTCEventHandler::onLicenseWillExpire(int days) ``` license 过期提醒。在剩余天数低于 30 天时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | days | int | license 剩余有效天数 | # ISingScoringEventHandler ```cpp class bytertc::ISingScoringEventHandler ``` K 歌评分事件回调类。注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onCurrentScoringInfo](#ISingScoringEventHandler-oncurrentscoringinfo) | ## 函数说明 ### onCurrentScoringInfo ```cpp virtual void bytertc::ISingScoringEventHandler::onCurrentScoringInfo(const SingScoringRealtimeInfo &info)=0 ``` 实时评分信息回调。调用 [startSingScoring](70095#ISingScoringManager-startsingscoring) 后，会收到该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | info | const SingScoringRealtimeInfo & | 实时评分信息。 | # IExternalVideoEncoderEventHandler ```cpp class bytertc::IExternalVideoEncoderEventHandler ``` 自定义编码帧回调类注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onStart](#IExternalVideoEncoderEventHandler-onstart) | | virtual void | [onStop](#IExternalVideoEncoderEventHandler-onstop) | | virtual void | [onRateUpdate](#IExternalVideoEncoderEventHandler-onrateupdate) | | virtual void | [onRequestKeyFrame](#IExternalVideoEncoderEventHandler-onrequestkeyframe) | | virtual void | [onActiveVideoLayer](#IExternalVideoEncoderEventHandler-onactivevideolayer) | ## 函数说明 ### onStart ```cpp virtual void bytertc::IExternalVideoEncoderEventHandler::onStart(StreamIndex index)=0 ``` 提示自定义编码帧可以开始推送的回调。收到该回调后，你即可调用 [pushExternalEncodedVideoFrame](70095#IRTCVideo-pushexternalencodedvideoframe) 向 SDK 推送自定义编码视频帧 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | StreamIndex | 可以推送的编码流的属性，参看 [StreamIndex](70098#StreamIndex) | ### onStop ```cpp virtual void bytertc::IExternalVideoEncoderEventHandler::onStop(StreamIndex index)=0 ``` 当收到该回调时，你需停止向 SDK 推送自定义编码视频帧 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | StreamIndex | 需停止推送的编码流的属性，参看 [StreamIndex](70098#StreamIndex) | ### onRateUpdate ```cpp virtual void bytertc::IExternalVideoEncoderEventHandler::onRateUpdate( StreamIndex index, int32_t video_index, VideoRateInfo info )=0 ``` 当自定义编码流的帧率或码率发生变化时，触发该回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | StreamIndex | 发生变化的编码流的属性，参看 [StreamIndex](70098#StreamIndex) | | video_index | int32_t | 对应编码流的下标 | | info | VideoRateInfo | 变化后的编码流信息，参看 [VideoRateInfo](70098#VideoRateInfo) | ### onRequestKeyFrame ```cpp virtual void bytertc::IExternalVideoEncoderEventHandler::onRequestKeyFrame( StreamIndex index, int32_t video_index )=0 ``` 提示流发布端需重新生成关键帧的回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | StreamIndex | 远端编码流的属性，参看 [StreamIndex](70098#StreamIndex) | | video_index | int32_t | 对应编码流的下标 | ### onActiveVideoLayer ```cpp virtual void bytertc::IExternalVideoEncoderEventHandler::onActiveVideoLayer( StreamIndex index, int32_t video_index, bool active )=0 ``` > Available since 3.56 作为自定义编码视频流的发送端，你会在视频流可发送状态发生变化时，收到此回调。你可以根据此回调的提示，仅对可发送的视频流进行编码，以降低本端视频编码性能消耗。此回调会根据多个因素综合判断触发，包括：本端设备性能和本端网络性能，以及按需订阅场景下，远端用户是否订阅。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | StreamIndex | 远端编码流的属性，参看 [StreamIndex](70098#StreamIndex)。 | | video_index | int32_t | 对应编码流的下标 | | active | bool | 该路流可发送状态 | **注意** 要收到此回调，必须调用 [setVideoSourceType](70095#IRTCVideo-setvideosourcetype) 设置视频源是自定义编码，且通过 [setExternalVideoEncoderEventHandler](70095#IRTCVideo-setexternalvideoencodereventhandler) 设置了回调句柄。 # IMediaPlayerAudioFrameObserver ```cpp class bytertc::IMediaPlayerAudioFrameObserver ``` 本地音频文件混音的音频帧观察者。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onFrame](#IMediaPlayerAudioFrameObserver-onframe) | ## 函数说明 ### onFrame ```cpp virtual void bytertc::IMediaPlayerAudioFrameObserver::onFrame( int player_id, const IAudioFrame &frame )=0 ``` 当本地音频文件混音时，回调播放的音频帧。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | player_id | int | 播放器 ID | | frame | const IAudioFrame & | 参看 [IAudioFrame](70098#IAudioFrame)。 | # IFaceDetectionObserver ```cpp class bytertc::IFaceDetectionObserver ``` 人脸检测结果回调观察者注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onFaceDetectResult](#IFaceDetectionObserver-onfacedetectresult) | ## 函数说明 ### onFaceDetectResult ```cpp virtual void bytertc::IFaceDetectionObserver::onFaceDetectResult(const FaceDetectResult &result)=0 ``` 特效 SDK 进行人脸检测结果的回调。调用 [enableFaceDetection](70095#IVideoEffect-enablefacedetection) 注册了 [IFaceDetectionObserver](#IFaceDetectionObserver)，并使用 RTC SDK 中包含的特效 SDK 进行视频特效处理时，你会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | result | const FaceDetectResult & | 人脸检测结果, 参看 [FaceDetectResult](70098#FaceDetectResult)。 | # IMetadataObserver ```cpp class bytertc::IMetadataObserver ``` > Deprecated since 3.26 and will be deleted in 3.51, use [sendSEIMessage](70095#IRTCVideo-sendseimessage) instead. metadata 观察者，可以接收媒体流中的 metadata，或者向媒体流中添加 metadata 注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual bool | [onReadyToSendMetadata](#IMetadataObserver-onreadytosendmetadata) | | virtual void | [onMetadataReceived](#IMetadataObserver-onmetadatareceived) | ## 函数说明 ### onReadyToSendMetadata ```cpp virtual bool bytertc::IMetadataObserver::onReadyToSendMetadata(VideoMetadataBuffer* metadata)=0 ``` 当 SDK 准备发送一个视频帧时，会回调该事件，以确定是否需要在该视频帧中添加 metadata。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | metadata | VideoMetadataBuffer * | 待发送的数据，把数据拷贝到 data 字段中，并将 size 设置为真实的大小。 | **返回值** - true：需要向视频帧中添加 metadata - false：不需要向视频帧中添加 metadata **注意** - metadata 的大小不能超过 1024 字节 - metadata 中的 timestampUs 是输入字段，代表视频帧的时间戳，做同步使用，不需要修改。 - 回调中不能有耗时操作，以免影响视频卡顿 ### onMetadataReceived ```cpp virtual void bytertc::IMetadataObserver::onMetadataReceived( const char* roomid, const char* uid, const VideoMetadataBuffer &metadata )=0 ``` 当 SDK 收到一个视频帧时，并且其中包含 medatada 时，会回调该事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | roomid | const char * | 当前帧所属的房间 ID。 | | uid | const char * | 当前帧所属的用户 ID。 | | metadata | const VideoMetadataBuffer & | 视频帧中包含的 metadata 信息。参看 [VideoMetadataBuffer](70098#VideoMetadataBuffer)。 | **注意** 回调中不能有耗时操作，以免影响视频卡顿。 # IMediaPlayerCustomSourceProvider ```cpp class bytertc::IMediaPlayerCustomSourceProvider ``` 内存播放数据源回调 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual int | [onReadData](#IMediaPlayerCustomSourceProvider-onreaddata) | | virtual int64_t | [onSeek](#IMediaPlayerCustomSourceProvider-onseek) | | virtual | [~IMediaPlayerCustomSourceProvider](#IMediaPlayerCustomSourceProvider-~imediaplayercustomsourceprovider) | ## 函数说明 ### onReadData ```cpp virtual int bytertc::IMediaPlayerCustomSourceProvider::onReadData( uint8_t* buffer, int buffer_size )=0 ``` > Available since 3.53 调用 [openWithCustomSource](70095#IMediaPlayer-openwithcustomsource) 接口播放用户传入的内存音频数据时，会触发此回调，用户需要写入音频数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | buffer | uint8_t * | 内存地址。在该地址中写入音频数据，写入音频数据的大小不超过 bufferSize 中填入的数值。支持的音频数据格式有: mp3，aac，m4a，3gp，wav。 | | buffer_size | int | 音频数据大小，单位为字节。如果你想停止播放内存音频数据，可在 bufferSize 中填入小于或等于 0 的数，此时 SDK 会停止调用此接口。 | **返回值** 返回实际读取的音频数据大小。 **注意** 若 [openWithCustomSource](70095#IMediaPlayer-openwithcustomsource) 接口调用失败，请在 buffer 和 bufferSize 两个参数中填入 0。此时 SDK 会停止调用此接口。 ### onSeek ```cpp virtual int64_t bytertc::IMediaPlayerCustomSourceProvider::onSeek( int64_t offset, MediaPlayerCustomSourceSeekWhence whence )=0 ``` > Available since 3.53 根据设置好的内存音频数据的读取位置和读取偏移量对音频数据进行偏移，以便 SDK 读取和分析音频数据。在调用 [openWithCustomSource](70095#IMediaPlayer-openwithcustomsource) 接口传入内存音频数据，或者调用 [setPosition](70095#IMediaPlayer-setposition) 设置了音频数据的起始播放位置后，SDK 会对音频数据进行读取和分析，此时会触发该回调，你需要根据参数中设置的起始读取位置和偏移量进行操作。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | offset | int64_t | 音频数据读取偏移量，单位为字节，取值可正可负。 | | whence | MediaPlayerCustomSourceSeekWhence | 音频数据的起始读取位置。参看 [MediaPlayerCustomSourceSeekWhence](70098#MediaPlayerCustomSourceSeekWhence) | **返回值** 定位成功，返回偏移后的位置信息，或返回音频数据的大小。定位失败，返回 -1。 ### ~IMediaPlayerCustomSourceProvider ```cpp virtual bytertc::IMediaPlayerCustomSourceProvider::~IMediaPlayerCustomSourceProvider() ``` # IAudioFrameObserver ```cpp class bytertc::IAudioFrameObserver ``` 音频数据回调观察者注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。本接口类中的单个回调的数据量为 20 ms 的数据量。回调周期在 20 ms 上下浮动。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onRecordAudioFrame](#IAudioFrameObserver-onrecordaudioframe) | | virtual void | [onPlaybackAudioFrame](#IAudioFrameObserver-onplaybackaudioframe) | | virtual void | [onRemoteUserAudioFrame](#IAudioFrameObserver-onremoteuseraudioframe) | | virtual void | [onMixedAudioFrame](#IAudioFrameObserver-onmixedaudioframe) | | virtual void | [onRecordScreenAudioFrame](#IAudioFrameObserver-onrecordscreenaudioframe) | ## 函数说明 ### onRecordAudioFrame ```cpp virtual void bytertc::IAudioFrameObserver::onRecordAudioFrame(const IAudioFrame &audio_frame)=0 ``` 返回麦克风录制的音频数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audio_frame | const IAudioFrame & | 音频数据, 详见： [IAudioFrame](70098#IAudioFrame) | ### onPlaybackAudioFrame ```cpp virtual void bytertc::IAudioFrameObserver::onPlaybackAudioFrame(const IAudioFrame &audio_frame)=0 ``` 返回订阅的所有远端用户混音后的音频数据。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audio_frame | const IAudioFrame & | 音频数据, 详见： [IAudioFrame](70098#IAudioFrame) | ### onRemoteUserAudioFrame ```cpp virtual void bytertc::IAudioFrameObserver::onRemoteUserAudioFrame( const RemoteStreamKey &stream_info, const IAudioFrame &audio_frame )=0 ``` 返回远端单个用户的音频数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream_info | const RemoteStreamKey & | 远端流信息，参看 [RemoteStreamKey](70098#RemoteStreamKey)。 | | audio_frame | const IAudioFrame & | 音频数据, 参看 [IAudioFrame](70098#IAudioFrame)。 | **注意** 此回调在播放线程调用。不要在此回调中做任何耗时的事情，否则可能会影响整个音频播放链路。 ### onMixedAudioFrame ```cpp virtual void bytertc::IAudioFrameObserver::onMixedAudioFrame(const IAudioFrame &audio_frame)=0 ``` 返回本地麦克风录制和订阅的所有远端用户混音后的音频数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audio_frame | const IAudioFrame & | 音频数据, 详见： [IAudioFrame](70098#IAudioFrame) | ### onRecordScreenAudioFrame ```cpp virtual void bytertc::IAudioFrameObserver::onRecordScreenAudioFrame(const IAudioFrame &audio_frame) ``` 返回本地屏幕录制的音频数据 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audio_frame | const IAudioFrame & | 音频数据, 详见： [IAudioFrame](70098#IAudioFrame) | # ITranscoderObserver ```cpp class bytertc::ITranscoderObserver ``` > Deprecated since 3.52, use [IMixedStreamObserver](#IMixedStreamObserver) instead. 推流 Observer 注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual bool | [isSupportClientPushStream](#ITranscoderObserver-issupportclientpushstream) | | virtual void | [onStreamMixingEvent](#ITranscoderObserver-onstreammixingevent) | | virtual void | [onMixingVideoFrame](#ITranscoderObserver-onmixingvideoframe) | | virtual void | [onMixingAudioFrame](#ITranscoderObserver-onmixingaudioframe) | | virtual void | [onMixingDataFrame](#ITranscoderObserver-onmixingdataframe) | ## 函数说明 ### isSupportClientPushStream ```cpp virtual bool bytertc::ITranscoderObserver::isSupportClientPushStream() ``` 是否具有推流能力。 - false：不具备推流能力（默认值） - true：具备推流能力 **注意** 如果需要开启端云一体转推直播功能，你必须确保你的 App 包含 librtmp，具有推流能力。此时，设置该回调为 true。 ### onStreamMixingEvent ```cpp virtual void bytertc::ITranscoderObserver::onStreamMixingEvent( StreamMixingEvent event, const char* task_id, StreamMixingErrorCode error, StreamMixingType mix_type )=0 ``` 转推直播状态回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | event | StreamMixingEvent | 转推直播任务状态，参看 [StreamMixingEvent](70098#StreamMixingEvent) | | task_id | const char * | 转推直播任务 ID | | error | StreamMixingErrorCode | 转推直播错误码，参看 [StreamMixingErrorCode](70097#StreamMixingErrorCode)。 | | mix_type | StreamMixingType | 转推直播类型，参看 [StreamMixingType](70098#StreamMixingType) | ### onMixingVideoFrame ```cpp virtual void bytertc::ITranscoderObserver::onMixingVideoFrame( const char* task_id, IVideoFrame* video_frame )=0 ``` 合流视频回调，运行在视频回调线程 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | task_id | const char * | 合流任务 ID | | video_frame | IVideoFrame * | 视频帧，参看 [IVideoFrame](70098#IVideoFrame)。 | **注意** 收到该回调的周期与视频的帧间隔一致。 ### onMixingAudioFrame ```cpp virtual void bytertc::ITranscoderObserver::onMixingAudioFrame( const char* task_id, IAudioFrame* audio_frame )=0 ``` 合流音频回调，运行在音频回调线程 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | task_id | const char * | 转推直播任务 ID | | audio_frame | IAudioFrame * | 音频帧，参看 [IAudioFrame](70098#IAudioFrame)。 | **注意** 收到该回调的周期为每 10 毫秒一次，并且每次的音频数据量为 10 毫秒数据量。 ### onMixingDataFrame ```cpp virtual void bytertc::ITranscoderObserver::onMixingDataFrame( const char* task_id, IDataFrame* data_frame )=0 ``` 视频 SEI 帧回调，运行在视频回调线程 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | task_id | const char * | 转推直播任务 ID | | data_frame | IDataFrame * | SEI 数据 | # IMediaPlayerEventHandler ```cpp class bytertc::IMediaPlayerEventHandler ``` [IMediaPlayer](70095#IMediaPlayer) 对应的回调句柄。你必须调用 [setEventHandler](70095#IMediaPlayer-seteventhandler) 完成设置后，才能收到对应回调。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual | [~IMediaPlayerEventHandler](#IMediaPlayerEventHandler-~imediaplayereventhandler) | | virtual void | [onMediaPlayerStateChanged](#IMediaPlayerEventHandler-onmediaplayerstatechanged) | | virtual void | [onMediaPlayerPlayingProgress](#IMediaPlayerEventHandler-onmediaplayerplayingprogress) | ## 函数说明 ### ~IMediaPlayerEventHandler ```cpp virtual bytertc::IMediaPlayerEventHandler::~IMediaPlayerEventHandler() ``` ### onMediaPlayerStateChanged ```cpp virtual void bytertc::IMediaPlayerEventHandler::onMediaPlayerStateChanged( int player_id, PlayerState state, PlayerError error )=0 ``` 播放状态改变时回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | player_id | int | [IMediaPlayer](70095#IMediaPlayer) 的 ID。通过 [getMediaPlayer](70095#IRTCVideo-getmediaplayer) 设置。 | | state | PlayerState | 混音状态。参考 [PlayerState](70098#PlayerState)。 | | error | PlayerError | 错误码。参考 [PlayerError](70098#PlayerError)。 | ### onMediaPlayerPlayingProgress ```cpp virtual void bytertc::IMediaPlayerEventHandler::onMediaPlayerPlayingProgress( int player_id, int64_t progress )=0 ``` 播放进度周期性回调。回调周期通过 [setProgressInterval](70095#IMediaPlayer-setprogressinterval) 设置。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | player_id | int | [IMediaPlayer](70095#IMediaPlayer) 的 ID。通过 [getMediaPlayer](70095#IRTCVideo-getmediaplayer) 设置。 | | progress | int64_t | 进度。单位 ms。 | # IAudioFileFrameObserver ```cpp class bytertc::IAudioFileFrameObserver ``` 本地音频文件混音的音频帧观察者。注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onAudioFileFrame](#IAudioFileFrameObserver-onaudiofileframe) | ## 函数说明 ### onAudioFileFrame ```cpp virtual void bytertc::IAudioFileFrameObserver::onAudioFileFrame( int mix_id, const IAudioFrame &audio_frame )=0 ``` 当本地音频文件混音时，回调播放的音频帧。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mix_id | int | 混音 ID。 | | audio_frame | const IAudioFrame & | 参看 [IAudioFrame](70098#IAudioFrame)。 | # IRemoteAudioFrameObserver ```cpp class bytertc::IRemoteAudioFrameObserver ``` > Deprecated since 3.37 and will be deleted in 3.51. 音频数据回调观察者注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onRemoteAudioFrame](#IRemoteAudioFrameObserver-onremoteaudioframe) | ## 函数说明 ### onRemoteAudioFrame ```cpp virtual void bytertc::IRemoteAudioFrameObserver::onRemoteAudioFrame( const IAudioFrame &audio_frame, const RemoteStreamKey &stream_info )=0 ``` 获得单个流的音频数据，此回调通过调用 [registerAudioFrameObserver](70095#IRTCVideo-registeraudioframeobserver) 触发。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audio_frame | const IAudioFrame & | 音频数据, 详见： [IAudioFrame](70098#IAudioFrame) | | stream_info | const RemoteStreamKey & | 该音频流的业务信息, 详见： [RemoteStreamKey](70098#RemoteStreamKey) | # IAudioFrameProcessor ```cpp class bytertc::IAudioFrameProcessor ``` 自定义音频处理器。注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual int | [onProcessRecordAudioFrame](#IAudioFrameProcessor-onprocessrecordaudioframe) | | virtual int | [onProcessPlayBackAudioFrame](#IAudioFrameProcessor-onprocessplaybackaudioframe) | | virtual int | [onProcessRemoteUserAudioFrame](#IAudioFrameProcessor-onprocessremoteuseraudioframe) | | virtual int | [onProcessScreenAudioFrame](#IAudioFrameProcessor-onprocessscreenaudioframe) | ## 函数说明 ### onProcessRecordAudioFrame ```cpp virtual int bytertc::IAudioFrameProcessor::onProcessRecordAudioFrame(IAudioFrame &audio_frame)=0 ``` 回调本地采集的音频帧地址，供自定义音频处理。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audio_frame | IAudioFrame & | 音频帧地址，参看 [IAudioFrame](70098#IAudioFrame) | **注意** - 完成自定义音频处理后，SDK 会对处理后的音频帧进行编码，并传输到远端。 - 调用 `enableAudioProcessor`，并在参数中选择本地采集的音频时，每 10 ms 收到此回调。 ### onProcessPlayBackAudioFrame ```cpp virtual int bytertc::IAudioFrameProcessor::onProcessPlayBackAudioFrame(IAudioFrame &audio_frame)=0 ``` 回调远端音频混音的音频帧地址，供自定义音频处理。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audio_frame | IAudioFrame & | 音频帧地址，参看 [IAudioFrame](70098#IAudioFrame) | **注意** 调用 `enableAudioProcessor`，并在参数中选择远端音频流的的混音音频时，每 10 ms 收到此回调。 ### onProcessRemoteUserAudioFrame ```cpp virtual int bytertc::IAudioFrameProcessor::onProcessRemoteUserAudioFrame( const RemoteStreamKey &stream_info, IAudioFrame &audio_frame )=0 ``` 回调单个远端用户的音频帧地址，供自定义音频处理。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream_info | const RemoteStreamKey & | 音频流信息，参看 [RemoteStreamKey](70098#RemoteStreamKey) | | audio_frame | IAudioFrame & | 音频帧地址，参看 [IAudioFrame](70098#IAudioFrame) | **注意** 调用 `enableAudioProcessor`，并在参数中选择各个远端音频流时，每 10 ms 收到此回调。 ### onProcessScreenAudioFrame ```cpp virtual int bytertc::IAudioFrameProcessor::onProcessScreenAudioFrame(IAudioFrame &audio_frame)=0 ``` 屏幕共享的音频帧地址回调。你可根据此回调自定义处理音频。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audio_frame | IAudioFrame & | 音频帧地址，参看 [IAudioFrame](70098#IAudioFrame)。 | **注意** 调用 `enableAudioProcessor`，把返回给音频处理器的音频类型设置为屏幕共享音频后，每 10 ms 收到此回调。 # IRTCVideoEventHandler ```cpp class bytertc::IRTCVideoEventHandler ``` 音视频引擎事件回调接口注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onWarning](#IRTCVideoEventHandler-onwarning) | | virtual void | [onError](#IRTCVideoEventHandler-onerror) | | virtual void | [onDeadLockError](#IRTCVideoEventHandler-ondeadlockerror) | | virtual void | [onExtensionAccessError](#IRTCVideoEventHandler-onextensionaccesserror) | | virtual void | [onAudioMixingPlayingProgress](#IRTCVideoEventHandler-onaudiomixingplayingprogress) | | virtual void | [onLogReport](#IRTCVideoEventHandler-onlogreport) | | virtual void | [onConnectionStateChanged](#IRTCVideoEventHandler-onconnectionstatechanged) | | virtual void | [onNetworkTypeChanged](#IRTCVideoEventHandler-onnetworktypechanged) | | virtual void | [onSimulcastSubscribeFallback](#IRTCVideoEventHandler-onsimulcastsubscribefallback) | | virtual void | [onPerformanceAlarms](#IRTCVideoEventHandler-onperformancealarms) | | virtual void | [onAudioDeviceStateChanged](#IRTCVideoEventHandler-onaudiodevicestatechanged) | | virtual void | [onVideoDeviceStateChanged](#IRTCVideoEventHandler-onvideodevicestatechanged) | | virtual void | [onAudioDeviceWarning](#IRTCVideoEventHandler-onaudiodevicewarning) | | virtual void | [onVideoDeviceWarning](#IRTCVideoEventHandler-onvideodevicewarning) | | virtual void | [onSysStats](#IRTCVideoEventHandler-onsysstats) | | virtual void | [onCreateRoomStateChanged](#IRTCVideoEventHandler-oncreateroomstatechanged) | | virtual void | [onRecordingStateUpdate](#IRTCVideoEventHandler-onrecordingstateupdate) | | virtual void | [onRecordingProgressUpdate](#IRTCVideoEventHandler-onrecordingprogressupdate) | | virtual void | [onAudioRecordingStateUpdate](#IRTCVideoEventHandler-onaudiorecordingstateupdate) | | virtual void | [onLoginResult](#IRTCVideoEventHandler-onloginresult) | | virtual void | [onLogout](#IRTCVideoEventHandler-onlogout) | | virtual void | [onServerParamsSetResult](#IRTCVideoEventHandler-onserverparamssetresult) | | virtual void | [onGetPeerOnlineStatus](#IRTCVideoEventHandler-ongetpeeronlinestatus) | | virtual void | [onUserMessageReceivedOutsideRoom](#IRTCVideoEventHandler-onusermessagereceivedoutsideroom) | | virtual void | [onUserBinaryMessageReceivedOutsideRoom](#IRTCVideoEventHandler-onuserbinarymessagereceivedoutsideroom) | | virtual void | [onUserMessageSendResultOutsideRoom](#IRTCVideoEventHandler-onusermessagesendresultoutsideroom) | | virtual void | [onServerMessageSendResult](#IRTCVideoEventHandler-onservermessagesendresult) | | virtual void | [onSEIMessageReceived](#IRTCVideoEventHandler-onseimessagereceived) | | virtual void | [onSEIStreamUpdate](#IRTCVideoEventHandler-onseistreamupdate) | | virtual void | [onRemoteAudioPropertiesReport](#IRTCVideoEventHandler-onremoteaudiopropertiesreport) | | virtual void | [onLocalAudioPropertiesReport](#IRTCVideoEventHandler-onlocalaudiopropertiesreport) | | virtual void | [onAudioPlaybackDeviceTestVolume](#IRTCVideoEventHandler-onaudioplaybackdevicetestvolume) | | virtual void | [onAudioDeviceVolumeChanged](#IRTCVideoEventHandler-onaudiodevicevolumechanged) | | virtual void | [onLocalAudioStateChanged](#IRTCVideoEventHandler-onlocalaudiostatechanged) | | virtual void | [onUserStartAudioCapture](#IRTCVideoEventHandler-onuserstartaudiocapture) | | virtual void | [onUserStopAudioCapture](#IRTCVideoEventHandler-onuserstopaudiocapture) | | virtual void | [onActiveSpeaker](#IRTCVideoEventHandler-onactivespeaker) | | virtual void | [onStreamSyncInfoReceived](#IRTCVideoEventHandler-onstreamsyncinforeceived) | | virtual void | [onNetworkDetectionResult](#IRTCVideoEventHandler-onnetworkdetectionresult) | | virtual void | [onNetworkDetectionStopped](#IRTCVideoEventHandler-onnetworkdetectionstopped) | | virtual void | [onPlayPublicStreamResult](#IRTCVideoEventHandler-onplaypublicstreamresult) | | virtual void | [onPublicStreamSEIMessageReceived](#IRTCVideoEventHandler-onpublicstreamseimessagereceived) | | virtual void | [onPublicStreamDataMessageReceived](#IRTCVideoEventHandler-onpublicstreamdatamessagereceived) | | virtual void | [onFirstPublicStreamVideoFrameDecoded](#IRTCVideoEventHandler-onfirstpublicstreamvideoframedecoded) | | virtual void | [onUserStartVideoCapture](#IRTCVideoEventHandler-onuserstartvideocapture) | | virtual void | [onUserStopVideoCapture](#IRTCVideoEventHandler-onuserstopvideocapture) | | virtual void | [onLocalVideoSizeChanged](#IRTCVideoEventHandler-onlocalvideosizechanged) | | virtual void | [onRemoteVideoSizeChanged](#IRTCVideoEventHandler-onremotevideosizechanged) | | virtual void | [onFirstLocalVideoFrameCaptured](#IRTCVideoEventHandler-onfirstlocalvideoframecaptured) | | virtual void | [onFirstRemoteAudioFrame](#IRTCVideoEventHandler-onfirstremoteaudioframe) | | virtual void | [onRemoteAudioStateChanged](#IRTCVideoEventHandler-onremoteaudiostatechanged) | | virtual void | [onLocalVideoStateChanged](#IRTCVideoEventHandler-onlocalvideostatechanged) | | virtual void | [onRemoteVideoStateChanged](#IRTCVideoEventHandler-onremotevideostatechanged) | | virtual void | [onAudioFrameSendStateChanged](#IRTCVideoEventHandler-onaudioframesendstatechanged) | | virtual void | [onScreenAudioFrameSendStateChanged](#IRTCVideoEventHandler-onscreenaudioframesendstatechanged) | | virtual void | [onVideoFrameSendStateChanged](#IRTCVideoEventHandler-onvideoframesendstatechanged) | | virtual void | [onFirstRemoteVideoFrameRendered](#IRTCVideoEventHandler-onfirstremotevideoframerendered) | | virtual void | [onFirstRemoteVideoFrameDecoded](#IRTCVideoEventHandler-onfirstremotevideoframedecoded) | | virtual void | [onScreenVideoFrameSendStateChanged](#IRTCVideoEventHandler-onscreenvideoframesendstatechanged) | | virtual void | [onAudioFramePlayStateChanged](#IRTCVideoEventHandler-onaudioframeplaystatechanged) | | virtual void | [onScreenAudioFramePlayStateChanged](#IRTCVideoEventHandler-onscreenaudioframeplaystatechanged) | | virtual void | [onVideoFramePlayStateChanged](#IRTCVideoEventHandler-onvideoframeplaystatechanged) | | virtual void | [onScreenVideoFramePlayStateChanged](#IRTCVideoEventHandler-onscreenvideoframeplaystatechanged) | | virtual void | [onFirstLocalAudioFrame](#IRTCVideoEventHandler-onfirstlocalaudioframe) | | virtual void | [onPushPublicStreamResult](#IRTCVideoEventHandler-onpushpublicstreamresult) | | virtual void | [onFirstPublicStreamAudioFrame](#IRTCVideoEventHandler-onfirstpublicstreamaudioframe) | | virtual void | [onCloudProxyConnected](#IRTCVideoEventHandler-oncloudproxyconnected) | | virtual void | [onEchoTestResult](#IRTCVideoEventHandler-onechotestresult) | | virtual void | [onNetworkTimeSynchronized](#IRTCVideoEventHandler-onnetworktimesynchronized) | | virtual void | [onExternalScreenFrameUpdate](#IRTCVideoEventHandler-onexternalscreenframeupdate) | | virtual void | [onHardwareEchoDetectionResult](#IRTCVideoEventHandler-onhardwareechodetectionresult) | | virtual void | [onLocalProxyStateChanged](#IRTCVideoEventHandler-onlocalproxystatechanged) | | virtual void | [deprecated] [onAudioMixingStateChanged](#IRTCVideoEventHandler-onaudiomixingstatechanged) | | virtual void | [deprecated] [onMediaDeviceStateChanged](#IRTCVideoEventHandler-onmediadevicestatechanged) | | virtual void | [deprecated] [onMediaDeviceWarning](#IRTCVideoEventHandler-onmediadevicewarning) | | virtual void | [deprecated] [onHttpProxyState](#IRTCVideoEventHandler-onhttpproxystate) | | virtual void | [deprecated] [onHttpsProxyState](#IRTCVideoEventHandler-onhttpsproxystate) | | virtual void | [deprecated] [onSocks5ProxyState](#IRTCVideoEventHandler-onsocks5proxystate) | | virtual void | [deprecated] [onUserMuteAudio](#IRTCVideoEventHandler-onusermuteaudio) | | virtual void | [deprecated] [onUserMuteVideo](#IRTCVideoEventHandler-onusermutevideo) | ## 函数说明 ### onWarning ```cpp virtual void bytertc::IRTCVideoEventHandler::onWarning(int warn) ``` 发生警告回调。 SDK 运行时出现了警告。SDK 通常会自动恢复，警告信息可以忽略。你可能需要干预. **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | warn | int | 警告标识码，详见: [WarningCode](70097#WarningCode) | ### onError ```cpp virtual void bytertc::IRTCVideoEventHandler::onError(int err) ``` 发生错误回调。 SDK 运行时出现了网络或媒体相关的错误，且无法自动恢复时触发此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | err | int | 错误标识码，参看 [ErrorCode](70097#ErrorCode) | ### onDeadLockError ```cpp virtual void bytertc::IRTCVideoEventHandler::onDeadLockError(const DeadLockMsg &msg) ``` > Available since 3.57 当内部线程发生 block 时，将收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msg | const DeadLockMsg & | block 线程的线程名和 block 检测次数。参看 DeadLockMsg{#DeadLockMsg}。 | ### onExtensionAccessError ```cpp virtual void bytertc::IRTCVideoEventHandler::onExtensionAccessError( const char* extension_name, const char* msg ) ``` > Available since 3.52 当访问插件失败时，收到此回调。 RTC SDK 将一些功能封装成插件。当使用这些功能时，如果插件不存在，功能将无法使用。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | extension_name | const char * | 插件名字 | | msg | const char * | 失败说明 | ### onAudioMixingPlayingProgress ```cpp virtual void bytertc::IRTCVideoEventHandler::onAudioMixingPlayingProgress( int mix_id, int64_t progress ) ``` 混音音频文件播放进度回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mix_id | int | 混音 ID | | progress | int64_t | 当前混音音频文件播放进度，单位毫秒 | **注意** 调用 [setAudioMixingProgressInterval](70095#IAudioMixingManager-setaudiomixingprogressinterval) 将时间间隔设为大于 0 的值后，或调用 [startAudioMixing](70095#IAudioMixingManager-startaudiomixing) 将 [AudioMixingConfig](70098#AudioMixingConfig) 中的时间间隔设为大于 0 的值后，SDK 会按照设置的时间间隔回调该事件。 ### onLogReport ```cpp virtual void bytertc::IRTCVideoEventHandler::onLogReport( const char* log_type, const char* log_content ) ``` 上报日志时回调该事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | log_type | const char * |
事件类型。目前类型固定为 "live_webrtc_monitor_log"。 | | log_content | const char * |
端监控日志内容。 | ### onConnectionStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onConnectionStateChanged(bytertc::ConnectionState state) ``` SDK 与信令服务器连接状态改变回调。连接状态改变时触发。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | bytertc::ConnectionState | 当前 SDK 与信令服务器的连接状态，详见 [ConnectionState](70098#ConnectionState)。 | **注意** 更多信息参见 [连接状态提示](https://www.volcengine.com/docs/6348/95376)。 ### onNetworkTypeChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onNetworkTypeChanged(bytertc::NetworkType type) ``` SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | bytertc::NetworkType |
SDK 当前的网络连接类型，详见： [NetworkType](70098#NetworkType)。 | ### onSimulcastSubscribeFallback ```cpp virtual void bytertc::IRTCVideoEventHandler::onSimulcastSubscribeFallback(const RemoteStreamSwitch &event) ``` 音视频流因网络环境变化等原因发生回退，或从回退中恢复时，触发该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | event | const RemoteStreamSwitch & | 音视频流发生变化的信息。参看 [RemoteStreamSwitch](70098#RemoteStreamSwitch)。 | ### onPerformanceAlarms ```cpp virtual void bytertc::IRTCVideoEventHandler::onPerformanceAlarms( bytertc::PerformanceAlarmMode mode, const char* room_id, bytertc::PerformanceAlarmReason reason, const bytertc::SourceWantedData &data ) ``` 本地未通过 [setPublishFallbackOption](70095#IRTCVideo-setpublishfallbackoption) 开启发布性能回退，检测到设备性能不足时，收到此回调。本地通过 [setPublishFallbackOption](70095#IRTCVideo-setpublishfallbackoption) 开启发布性能回退，因设备性能/网络原因，造成发布性能回退/恢复时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mode | bytertc::PerformanceAlarmMode | 指示本地是否开启发布回退功能。参看 [PerformanceAlarmMode](70098#PerformanceAlarmMode)

当发布端未开启发布性能回退时，mode 值为 kPerformanceAlarmModeNormal。
当发布端开启发布性能回退时，mode 值为 kPerformanceAlarmModeSimulcast。

| | room_id | const char * |

未开启发布性能回退时，room_id 为空
开启发布性能回退时，room_id 是告警影响的房间 ID。

| | reason | bytertc::PerformanceAlarmReason | 告警原因，参看 [PerformanceAlarmReason](70098#PerformanceAlarmReason) | | data | const bytertc::SourceWantedData & | 性能回退相关数据，详见 [SourceWantedData](70098#SourceWantedData)。 | ### onAudioDeviceStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onAudioDeviceStateChanged( const char* device_id, bytertc::RTCAudioDeviceType device_type, bytertc::MediaDeviceState device_state, bytertc::MediaDeviceError device_error ) ``` 音频设备状态回调。提示音频采集、音频播放等设备设备的状态。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | device_id | const char * | 设备 ID。 | | device_type | bytertc::RTCAudioDeviceType | 设备类型，详见 [RTCAudioDeviceType](70098#RTCAudioDeviceType) | | device_state | bytertc::MediaDeviceState | 设备状态，详见 [MediaDeviceState](70098#MediaDeviceState) | | device_error | bytertc::MediaDeviceError | 设备错误类型，详见 [MediaDeviceError](70098#MediaDeviceError) | ### onVideoDeviceStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onVideoDeviceStateChanged( const char* device_id, bytertc::RTCVideoDeviceType device_type, bytertc::MediaDeviceState device_state, bytertc::MediaDeviceError device_error ) ``` 视频设备状态回调。提示摄像头视频采集、屏幕视频采集等设备的状态。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | device_id | const char * | 设备 ID。采集屏幕共享流时，设备 ID 为固定字符串 `screen_capture_video` | | device_type | bytertc::RTCVideoDeviceType | 设备类型，详见 [RTCVideoDeviceType](70098#RTCVideoDeviceType) | | device_state | bytertc::MediaDeviceState | 设备状态，详见 [MediaDeviceState](70098#MediaDeviceState) | | device_error | bytertc::MediaDeviceError | 设备错误类型，详见 [MediaDeviceError](70098#MediaDeviceError) | ### onAudioDeviceWarning ```cpp virtual void bytertc::IRTCVideoEventHandler::onAudioDeviceWarning( const char* device_id, bytertc::RTCAudioDeviceType device_type, bytertc::MediaDeviceWarning device_warning ) ``` 音频设备警告回调。音频设备包括音频采集设备和音频渲染设备。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | device_id | const char * | 设备 ID | | device_type | bytertc::RTCAudioDeviceType | 详见 [RTCAudioDeviceType](70098#RTCAudioDeviceType) | | device_warning | bytertc::MediaDeviceWarning | 详见 [MediaDeviceWarning](70098#MediaDeviceWarning) | ### onVideoDeviceWarning ```cpp virtual void bytertc::IRTCVideoEventHandler::onVideoDeviceWarning( const char* device_id, bytertc::RTCVideoDeviceType device_type, bytertc::MediaDeviceWarning device_warning ) ``` 视频设备警告回调，包括视频采集设备等。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | device_id | const char * | 设备 ID | | device_type | bytertc::RTCVideoDeviceType | 详见 [RTCVideoDeviceType](70098#RTCVideoDeviceType) | | device_warning | bytertc::MediaDeviceWarning | 详见 [MediaDeviceWarning](70098#MediaDeviceWarning) | ### onSysStats ```cpp virtual void bytertc::IRTCVideoEventHandler::onSysStats(const bytertc::SysStats &stats) ``` 周期性（2s）发出回调，报告当前 CPU 与内存的相关信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stats | const bytertc::SysStats & | 包含当前 CPU 与内存相关信息的结构体。详见 [SysStats](70098#SysStats)。 | ### onCreateRoomStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onCreateRoomStateChanged( const char* room_id, int error_code ) ``` 创建房间失败回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 房间 ID。 | | error_code | int | 创建房间错误码，具体原因参看 [ErrorCode](70097#ErrorCode)。 | ### onRecordingStateUpdate ```cpp virtual void bytertc::IRTCVideoEventHandler::onRecordingStateUpdate( StreamIndex type, RecordingState state, RecordingErrorCode error_code, RecordingInfo info ) ``` 获取本地录制状态回调。该回调由 [startFileRecording](70095#IRTCVideo-startfilerecording) 或 [stopFileRecording](70095#IRTCVideo-stopfilerecording) 触发。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | StreamIndex | 录制流的流属性，参看 [StreamIndex](70098#StreamIndex) | | state | RecordingState | 录制状态，参看 [RecordingState](70098#RecordingState) | | error_code | RecordingErrorCode | 录制错误码，参看 [RecordingErrorCode](70098#RecordingErrorCode) | | info | RecordingInfo | 录制文件的详细信息，参看 [RecordingInfo](70098#RecordingInfo) | ### onRecordingProgressUpdate ```cpp virtual void bytertc::IRTCVideoEventHandler::onRecordingProgressUpdate( StreamIndex type, RecordingProgress process, RecordingInfo info ) ``` 本地录制进度回调。该回调由 [startFileRecording](70095#IRTCVideo-startfilerecording) 触发，录制状态正常时，系统每秒钟都会通过该回调提示录制进度。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | StreamIndex | 录制流的流属性，参看 [StreamIndex](70098#StreamIndex) | | process | RecordingProgress | 录制进度，参看 [RecordingProgress](70098#RecordingProgress) | | info | RecordingInfo | 录制文件的详细信息，参看 [RecordingInfo](70098#RecordingInfo) | ### onAudioRecordingStateUpdate ```cpp virtual void bytertc::IRTCVideoEventHandler::onAudioRecordingStateUpdate( AudioRecordingState state, AudioRecordingErrorCode error_code ) ``` 调用 [startAudioRecording](70095#IRTCVideo-startaudiorecording) 或 [stopAudioRecording](70095#IRTCVideo-stopaudiorecording) 改变音频文件录制状态时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | AudioRecordingState | 录制状态，参看 [AudioRecordingState](70098#AudioRecordingState) | | error_code | AudioRecordingErrorCode | 录制错误码，参看 [AudioRecordingErrorCode](70097#AudioRecordingErrorCode) | ### onLoginResult ```cpp virtual void bytertc::IRTCVideoEventHandler::onLoginResult( const char* uid, int error_code, int elapsed ) ``` 登录结果回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * |
登录用户 ID | | error_code | int |
登录结果
详见 [LoginErrorCode](70097#LoginErrorCode)。 | | elapsed | int |
从调用 [login](70095#IRTCVideo-login) 接口开始到返回结果所用时长
单位为 ms。 | **注意** 调用 [login](70095#IRTCVideo-login) 后，会收到此回调。 ### onLogout ```cpp virtual void bytertc::IRTCVideoEventHandler::onLogout(LogoutReason reason) ``` 登出结果回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | reason | LogoutReason | 用户登出的原因，参看 [LogoutReason](70098#LogoutReason) | **注意** 在以下两种情况下会收到此回调：调用 [logout](70095#IRTCVideo-logout) 接口主动退出；或其他用户以相同 UserId 进行 `login` 导致本地用户被动登出。 ### onServerParamsSetResult ```cpp virtual void bytertc::IRTCVideoEventHandler::onServerParamsSetResult(int error) ``` 设置应用服务器参数的返回结果 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | error | int |
设置结果

返回 200，设置成功
返回其他，设置失败，详见 [UserMessageSendResult](70097#UserMessageSendResult)

| **注意** 调用 [setServerParams](70095#IRTCVideo-setserverparams) 后，会收到此回调。 ### onGetPeerOnlineStatus ```cpp virtual void bytertc::IRTCVideoEventHandler::onGetPeerOnlineStatus( const char* peer_user_id, int status ) ``` 查询对端或本端用户登录状态的返回结果 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | peer_user_id | const char * |
需要查询的用户 ID | | status | int |
查询的用户登录状态
详见 [UserOnlineStatus](70098#UserOnlineStatus). | **注意** 必须先调用 [getPeerOnlineStatus](70095#IRTCVideo-getpeeronlinestatus)，才能收到此回调。 ### onUserMessageReceivedOutsideRoom ```cpp virtual void bytertc::IRTCVideoEventHandler::onUserMessageReceivedOutsideRoom( const char* uid, const char* message ) ``` 收到房间外用户调用 [sendUserMessageOutsideRoom](70095#IRTCVideo-sendusermessageoutsideroom) 发来的文本消息时，会收到此回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * |
消息发送者 ID | | message | const char * |
收到的文本消息内容 | ### onUserBinaryMessageReceivedOutsideRoom ```cpp virtual void bytertc::IRTCVideoEventHandler::onUserBinaryMessageReceivedOutsideRoom( const char* uid, int size, const uint8_t* message ) ``` 收到房间外用户调用 [sendUserBinaryMessageOutsideRoom](70095#IRTCVideo-senduserbinarymessageoutsideroom) 发来的二进制消息时，会收到此回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | uid | const char * |
消息发送者 ID | | size | int |
二进制消息长度 | | message | const uint8_t * |
收到的二进制消息内容 | ### onUserMessageSendResultOutsideRoom ```cpp virtual void bytertc::IRTCVideoEventHandler::onUserMessageSendResultOutsideRoom( int64_t msgid, int error ) ``` 给房间外指定的用户发送消息的回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | int64_t |
本条消息的 ID
所有的 P2P 和 P2Server 消息共用一个 ID 序列。 | | error | int |
消息发送结果
详见 [UserMessageSendResult](70097#UserMessageSendResult)。 | **注意** 当调用 [sendUserMessageOutsideRoom](70095#IRTCVideo-sendusermessageoutsideroom) 或 [sendUserBinaryMessageOutsideRoom](70095#IRTCVideo-senduserbinarymessageoutsideroom) 发送消息后，会收到此回调。 ### onServerMessageSendResult ```cpp virtual void bytertc::IRTCVideoEventHandler::onServerMessageSendResult( int64_t msgid, int error, const bytertc::ServerACKMsg &msg ) ``` 给应用服务器发送消息的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | msgid | int64_t | 本条消息的 ID。
所有的 P2P 和 P2Server 消息共用一个 ID 序列。 | | error | int | 消息发送结果，详见 [UserMessageSendResult](70097#UserMessageSendResult)。 | | msg | const bytertc::ServerACKMsg & | 应用服务器收到 HTTP 请求后，在 ACK 中返回的信息。消息不超过 64 KB。 | **注意** 本回调为异步回调。当调用 [sendServerMessage](70095#IRTCVideo-sendservermessage) 或 [sendServerBinaryMessage](70095#IRTCVideo-sendserverbinarymessage) 接口发送消息后，会收到此回调。 ### onSEIMessageReceived ```cpp virtual void bytertc::IRTCVideoEventHandler::onSEIMessageReceived( RemoteStreamKey stream_key, const uint8_t* message, int length ) ``` 收到通过调用 [sendSEIMessage](70095#IRTCVideo-sendseimessage) 发送带有 SEI 消息的视频帧时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream_key | RemoteStreamKey | 包含 SEI 发送者的用户名，所在的房间名和媒体流，参看 [RemoteStreamKey](70098#RemoteStreamKey) | | message | const uint8_t * | 收到的 SEI 消息内容 | | length | int | 收到的 SEI 消息长度 | ### onSEIStreamUpdate ```cpp virtual void bytertc::IRTCVideoEventHandler::onSEIStreamUpdate( const RemoteStreamKey &key, SEIStreamEventType type ) ``` 黑帧视频流发布状态回调。在语音通话场景下，本地用户调用 [sendSEIMessage](70095#IRTCVideo-sendseimessage) 通过黑帧视频流发送 SEI 数据时，流的发送状态会通过该回调通知远端用户。你可以通过此回调判断携带 SEI 数据的视频帧为黑帧，从而不对该视频帧进行渲染。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | const RemoteStreamKey & | 远端流信息，参看 [RemoteStreamKey](70098#RemoteStreamKey)。 | | type | SEIStreamEventType | 黑帧视频流状态，参看 [SEIStreamEventType](70098#SEIStreamEventType) | ### onRemoteAudioPropertiesReport ```cpp virtual void bytertc::IRTCVideoEventHandler::onRemoteAudioPropertiesReport( const RemoteAudioPropertiesInfo* audio_properties_infos, int audio_properties_info_number, int total_remote_volume ) ``` 远端用户进房后，本地调用 [enableAudioPropertiesReport](70095#IRTCVideo-enableaudiopropertiesreport)，根据设置的 interval 值，本地会周期性地收到此回调，了解订阅的远端用户的瞬时音频信息。远端用户的音频包括使用 RTC SDK 内部机制/自定义机制采集的麦克风音频和屏幕音频。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audio_properties_infos | const RemoteAudioPropertiesInfo * | 远端音频信息，其中包含音频流属性、房间 ID、用户 ID ，详见 [RemoteAudioPropertiesInfo](70098#RemoteAudioPropertiesInfo)。 | | audio_properties_info_number | int | 数组长度 | | total_remote_volume | int | 订阅的所有远端流混音后的总音量，范围是 [0,255]。

[0,25] 接近无声；
[25,75] 为低音量；
[76,204] 为中音量；
[205,255] 为高音量。

| ### onLocalAudioPropertiesReport ```cpp virtual void bytertc::IRTCVideoEventHandler::onLocalAudioPropertiesReport( const LocalAudioPropertiesInfo* audio_properties_infos, int audio_properties_info_number ) ``` 调用 [enableAudioPropertiesReport](70095#IRTCVideo-enableaudiopropertiesreport) 后，根据设置的 interval 值，你会周期性地收到此回调，了解本地音频的相关信息。本地音频包括使用 RTC SDK 内部机制采集的麦克风音频，屏幕音频和本地混音音频信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | audio_properties_infos | const LocalAudioPropertiesInfo * | 本地音频信息，详见 [LocalAudioPropertiesInfo](70098#LocalAudioPropertiesInfo) 。 | | audio_properties_info_number | int | 数组长度 | ### onAudioPlaybackDeviceTestVolume ```cpp virtual void bytertc::IRTCVideoEventHandler::onAudioPlaybackDeviceTestVolume(int volume) ``` 回调音频设备测试时的播放音量 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | volume | int | 音频设备测试播放音量。取值范围：[0,255] | **注意** 调用 [startAudioPlaybackDeviceTest](70095#IAudioDeviceManager-startaudioplaybackdevicetest) 或 [startAudioDeviceRecordTest](70095#IAudioDeviceManager-startaudiodevicerecordtest)，开始播放音频文件或录音时，将开启该回调。本回调为周期性回调，回调周期由上述接口的 `interval` 参数指定。 ### onAudioDeviceVolumeChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onAudioDeviceVolumeChanged( bytertc::RTCAudioDeviceType device_type, int volume, bool muted ) ``` 音频设备音量改变回调。当通过系统设置，改变音频设备音量或静音状态时，触发本回调。本回调无需手动开启。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | device_type | bytertc::RTCAudioDeviceType | 设备类型，包括麦克风和扬声器，参阅 [RTCAudioDeviceType](70098#RTCAudioDeviceType)。 | | volume | int | 音量值，[0, 255]。当 volume 变为 0 时，muted 会变为 True。注意：在 Windows 端，当麦克风 volume 变为 0 时，muted 值不变。 | | muted | bool | 是否禁音状态。扬声器被设置为禁音时，muted 为 True，但 volume 保持不变。 | ### onLocalAudioStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onLocalAudioStateChanged( LocalAudioStreamState state, LocalAudioStreamError error ) ``` 本地音频流的状态发生改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | LocalAudioStreamState | 本地音频设备的状态，详见： [LocalAudioStreamState](70098#LocalAudioStreamState) | | error | LocalAudioStreamError | 本地音频状态改变时的错误码，详见： [LocalAudioStreamError](70098#LocalAudioStreamError) | ### onUserStartAudioCapture ```cpp virtual void bytertc::IRTCVideoEventHandler::onUserStartAudioCapture( const char* room_id, const char* user_id ) ``` 房间内的用户调用 [startAudioCapture](70095#IRTCVideo-startaudiocapture) 开启音频采集时，房间内其他用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 开启音频采集的远端用户所在的房间 ID | | user_id | const char * | 开启音频采集的远端用户 ID | ### onUserStopAudioCapture ```cpp virtual void bytertc::IRTCVideoEventHandler::onUserStopAudioCapture( const char* room_id, const char* user_id ) ``` 房间内的用户调用 [stopAudioCapture](70095#IRTCVideo-stopaudiocapture) 关闭音频采集时，房间内其他用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 关闭音频采集的远端用户所在的房间 ID | | user_id | const char * | 关闭音频采集的远端用户 ID | ### onActiveSpeaker ```cpp virtual void bytertc::IRTCVideoEventHandler::onActiveSpeaker( const char* room_id, const char* uid ) ``` 调用 [enableAudioPropertiesReport](70095#IRTCVideo-enableaudiopropertiesreport) 后，根据设置的 `config.interval`，你会周期性地收到此回调，获取房间内的最活跃用户信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 房间 ID | | uid | const char * | 最活跃用户（ActiveSpeaker）的用户 ID | ### onStreamSyncInfoReceived ```cpp virtual void bytertc::IRTCVideoEventHandler::onStreamSyncInfoReceived( RemoteStreamKey stream_key, SyncInfoStreamType stream_type, const uint8_t* data, int32_t length ) ``` 音频流同步信息回调。可以通过此回调，在远端用户调用 [sendStreamSyncInfo](70095#IRTCVideo-sendstreamsyncinfo) 发送音频流同步消息后，收到远端发送的音频流同步信息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | stream_key | RemoteStreamKey | 远端流信息，详见 [RemoteStreamKey](70098#RemoteStreamKey) 。 | | stream_type | SyncInfoStreamType | 媒体流类型，详见 [SyncInfoStreamType](70098#SyncInfoStreamType)。 | | data | const uint8_t * | 消息内容。 | | length | int32_t | 消息长度。 | ### onNetworkDetectionResult ```cpp virtual void bytertc::IRTCVideoEventHandler::onNetworkDetectionResult( NetworkDetectionLinkType type, NetworkQuality quality, int rtt, double lost_rate, int bitrate, int jitter ) ``` 通话前网络探测结果。成功调用 [startNetworkDetection](70095#IRTCVideo-startnetworkdetection) 接口开始探测后，会在 3s 内首次收到该回调，之后每 2s 收到一次该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | NetworkDetectionLinkType | 探测网络类型为上行/下行 | | quality | NetworkQuality | 探测网络的质量，参看 [NetworkQuality](70098#NetworkQuality)。 | | rtt | int | 探测网络的 RTT，单位：ms | | lost_rate | double | 探测网络的丢包率 | | bitrate | int | 探测网络的带宽，单位：kbps | | jitter | int | 探测网络的抖动,单位：ms | ### onNetworkDetectionStopped ```cpp virtual void bytertc::IRTCVideoEventHandler::onNetworkDetectionStopped(NetworkDetectionStopReason reason) ``` 通话前网络探测结束以下情况将停止探测并收到本一次本回调： 1. 当调用 [stopNetworkDetection](70095#IRTCVideo-stopnetworkdetection) 接口停止探测后，会收到一次该回调； 2. 当收到远端/本端音频首帧后，停止探测； 3. 当探测超过 3 分钟后，停止探测； 4. 当探测链路断开一定时间之后，停止探测。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | reason | NetworkDetectionStopReason |
停止探测的原因类型,参考 [NetworkDetectionStopReason](70098#NetworkDetectionStopReason) | ### onPlayPublicStreamResult ```cpp virtual void bytertc::IRTCVideoEventHandler::onPlayPublicStreamResult( const char* public_stream_id, PublicStreamErrorCode error_code ) ``` 订阅公共流的结果回调通过 [startPlayPublicStream](70095#IRTCVideo-startplaypublicstream) 订阅公共流后，可以通过本回调获取订阅结果。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | public_stream_id | const char * | 公共流的 ID | | error_code | PublicStreamErrorCode | 公共流订阅结果状态码。详见 [PublicStreamErrorCode](70097#PublicStreamErrorCode)。 | ### onPublicStreamSEIMessageReceived ```cpp virtual void bytertc::IRTCVideoEventHandler::onPublicStreamSEIMessageReceived( const char* public_stream_id, const uint8_t* message, int message_length, DataMessageSourceType source_type ) ``` 回调公共流中包含的 SEI 信息。调用 [startPlayPublicStream](70095#IRTCVideo-startplaypublicstream) 接口启动拉公共流功能后，通过此回调收到公共流中的 SEI 消息。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | public_stream_id | const char * | 公共流 ID。 | | message | const uint8_t * | 收到的 SEI 消息内容。
通过调用客户端 `sendSEIMessage` 插入的 SEI 信息。
当公共流中的多路视频流均包含有 SEI 信息：SEI 不互相冲突时，将通过多次回调分别发送；SEI 在同一帧有冲突时，则只有一条流中的 SEI 信息被透传并融合到公共流中。 | | message_length | int | SEI 信息的长度。 | | source_type | DataMessageSourceType | SEI 消息类型，自 3.52.1 版本后固定为 `0`，自定义消息。参看 [DataMessageSourceType](70098#DataMessageSourceType)。 | **注意** 通过 Open API 插入的自定义信息，应通过回调 [onPublicStreamDataMessageReceived](#IRTCVideoEventHandler-onpublicstreamdatamessagereceived) 获取。 ### onPublicStreamDataMessageReceived ```cpp virtual void bytertc::IRTCVideoEventHandler::onPublicStreamDataMessageReceived( const char* public_stream_id, const uint8_t* message, int message_length, DataMessageSourceType source_type ) ``` > Available since 3.52 回调公共流中包含的数据信息。通过 [startPlayPublicStream](70095#IRTCVideo-startplaypublicstream) 订阅公共流后，通过监听本回调获取公共流中的数据消息，包括调用 Open API 发送的 SEI 消息和音量回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | public_stream_id | const char * | 公共流 ID | | message | const uint8_t * | 收到的数据消息内容，如下：

调用公共流 OpenAPI 发送的自定义消息。
媒体流音量变化，需要通过公共流 OpenAPI 开启回调。JSON 格式说明如下： {
"Type":"VolumeIndication", //具体业务类型
"VolumeInfos"[// 业务类型对应信息
{
"RoomId":"1000001", // 房间 ID
"UserId":"1000001", // 用户 ID
"StreamType":0, // 0:摄像头流；1:屏幕流
"LinearVolume":1 // 线性音量大小
}
]
}

| | message_length | int | 消息的长度 | | source_type | DataMessageSourceType | 数据消息来源，参看 [DataMessageSourceType](70098#DataMessageSourceType)。 | **注意** 通过调用客户端 API 插入的 SEI 信息，应通过回调 [onPublicStreamSEIMessageReceived](#IRTCVideoEventHandler-onpublicstreamseimessagereceived) 获取。 ### onFirstPublicStreamVideoFrameDecoded ```cpp virtual void bytertc::IRTCVideoEventHandler::onFirstPublicStreamVideoFrameDecoded( const char* public_stream_id, const VideoFrameInfo &info ) ``` 公共流的首帧视频解码成功关于订阅公共流，详见 [startPlayPublicStream](70095#IRTCVideo-startplaypublicstream)。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | public_stream_id | const char * | 公共流 ID | | info | const VideoFrameInfo & | 视频帧信息。详见 [VideoFrameInfo](70098#VideoFrameInfo)。 | ### onUserStartVideoCapture ```cpp virtual void bytertc::IRTCVideoEventHandler::onUserStartVideoCapture( const char* room_id, const char* user_id ) ``` 房间内的可见用户调用 [startVideoCapture](70095#IRTCVideo-startvideocapture) 开启内部视频采集时，房间内其他用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 开启视频采集的远端用户所在的房间 ID | | user_id | const char * | 开启视频采集的远端用户 ID | ### onUserStopVideoCapture ```cpp virtual void bytertc::IRTCVideoEventHandler::onUserStopVideoCapture( const char* room_id, const char* user_id ) ``` 房间内的可见用户调用 [stopVideoCapture](70095#IRTCVideo-stopvideocapture) 关闭内部视频采集时，房间内其他用户会收到此回调。若发布视频数据前未开启采集，房间内所有可见用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | ID of the room where the remote video stream stops being published. | | user_id | const char * | 关闭视频采集的远端用户 ID | ### onLocalVideoSizeChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onLocalVideoSizeChanged( StreamIndex index, const VideoFrameInfo &info ) ``` 本地视频大小或旋转信息发生改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | StreamIndex | 流属性。参看 [StreamIndex](70098#StreamIndex)。 | | info | const VideoFrameInfo & | 视频帧信息。参看 [VideoFrameInfo](70098#VideoFrameInfo)。 | ### onRemoteVideoSizeChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onRemoteVideoSizeChanged( RemoteStreamKey key, const VideoFrameInfo &info ) ``` 远端视频大小或旋转信息发生改变时，房间内订阅此视频流的用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | RemoteStreamKey | 远端流信息。参看 [RemoteStreamKey](70098#RemoteStreamKey)。 | | info | const VideoFrameInfo & | 视频帧信息。参看 [VideoFrameInfo](70098#VideoFrameInfo)。 | ### onFirstLocalVideoFrameCaptured ```cpp virtual void bytertc::IRTCVideoEventHandler::onFirstLocalVideoFrameCaptured( StreamIndex index, VideoFrameInfo info ) ``` RTC SDK 在本地完成第一帧视频帧或屏幕视频帧采集时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | StreamIndex | 流属性。参看 [StreamIndex](70098#StreamIndex)。 | | info | VideoFrameInfo | 视频信息。参看 [VideoFrameInfo](70098#VideoFrameInfo)。 | **注意** 对于采集到的本地视频帧，你可以调用 [setLocalVideoCanvas](70095#IRTCVideo-setlocalvideocanvas) 或 [setLocalVideoSink](70095#IRTCVideo-setlocalvideosink) 在本地渲染。 ### onFirstRemoteAudioFrame ```cpp virtual void bytertc::IRTCVideoEventHandler::onFirstRemoteAudioFrame(const RemoteStreamKey &key) ``` 接收到来自远端某音频流的第一帧时，收到该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | const RemoteStreamKey & | 远端音频流信息, 详见 [RemoteStreamKey](70098#RemoteStreamKey) | **注意** 用户刚收到房间内每一路音频流时，都会收到该回调。 ### onRemoteAudioStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onRemoteAudioStateChanged( const RemoteStreamKey &key, RemoteAudioState state, RemoteAudioStateChangeReason reason ) ``` 用户订阅来自远端的音频流状态发生改变时，会收到此回调，了解当前的远端音频流状态。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | const RemoteStreamKey & | 远端流信息, 参看 [RemoteStreamKey](70098#RemoteStreamKey) | | state | RemoteAudioState | 远端音频流状态，参看 [RemoteAudioState](70098#RemoteAudioState) | | reason | RemoteAudioStateChangeReason | 远端音频流状态改变的原因，参看 [RemoteAudioStateChangeReason](70098#RemoteAudioStateChangeReason) | ### onLocalVideoStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onLocalVideoStateChanged( StreamIndex index, LocalVideoStreamState state, LocalVideoStreamError error ) ``` 本地视频流的状态发生改变时，收到该事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | StreamIndex | 音/视频属性，参看 [StreamIndex](70098#StreamIndex) | | state | LocalVideoStreamState | 本地视频流状态，参看 [LocalVideoStreamState](70098#LocalVideoStreamState) | | error | LocalVideoStreamError | 本地视频状态改变时的错误码，参看 [LocalVideoStreamError](70097#LocalVideoStreamError) | ### onRemoteVideoStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onRemoteVideoStateChanged( RemoteStreamKey key, RemoteVideoState state, RemoteVideoStateChangeReason reason ) ``` 远端视频流的状态发生改变时，房间内订阅此流的用户会收到该事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | RemoteStreamKey | 远端视频流的信息，房间、用户 ID、流属性等。参看 [RemoteStreamKey](70098#RemoteStreamKey)。 | | state | RemoteVideoState | 远端视频流状态，参看 [RemoteVideoState](70098#RemoteVideoState)。 | | reason | RemoteVideoStateChangeReason | 远端视频流状态改变的原因，参看 [RemoteVideoStateChangeReason](70098#RemoteVideoStateChangeReason)。 | **注意** 本回调仅适用于主流，不适用于屏幕流。 ### onAudioFrameSendStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onAudioFrameSendStateChanged( const char* room_id, const RtcUser &user, FirstFrameSendState state ) ``` 本地音频首帧发送状态发生改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 音频发布用户所在的房间 ID | | user | const RtcUser & | 本地用户信息，详见 [RtcUser](70098#RtcUser) | | state | FirstFrameSendState | 首帧发送状态，详见 [FirstFrameSendState](70098#FirstFrameSendState) | ### onScreenAudioFrameSendStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onScreenAudioFrameSendStateChanged( const char* room_id, const RtcUser &user, FirstFrameSendState state ) ``` 屏幕音频首帧发送状态改变回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 音频发布用户所在的房间 ID | | user | const RtcUser & | 本地用户信息，详见 [RtcUser](70098#RtcUser) | | state | FirstFrameSendState | 首帧发送状态，详见 [FirstFrameSendState](70098#FirstFrameSendState) | ### onVideoFrameSendStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onVideoFrameSendStateChanged( const char* room_id, const RtcUser &user, FirstFrameSendState state ) ``` 本地视频首帧发送状态发生改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 视频发布用户所在的房间 ID | | user | const RtcUser & | 本地用户信息，详见 [RtcUser](70098#RtcUser) | | state | FirstFrameSendState | 首帧发送状态，详见 [FirstFrameSendState](70098#FirstFrameSendState) | ### onFirstRemoteVideoFrameRendered ```cpp virtual void bytertc::IRTCVideoEventHandler::onFirstRemoteVideoFrameRendered( const RemoteStreamKey key, const VideoFrameInfo &info ) ``` SDK 内部渲染成功远端视频流首帧后，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | const RemoteStreamKey | 远端流信息。参看 [RemoteStreamKey](70098#RemoteStreamKey)。 | | info | const VideoFrameInfo & | 视频帧信息。参看 [VideoFrameInfo](70098#VideoFrameInfo)。 | ### onFirstRemoteVideoFrameDecoded ```cpp virtual void bytertc::IRTCVideoEventHandler::onFirstRemoteVideoFrameDecoded( const RemoteStreamKey key, const VideoFrameInfo &info ) ``` SDK 接收并解码远端视频流首帧后，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | key | const RemoteStreamKey | 远端流信息。参看 [RemoteStreamKey](70098#RemoteStreamKey)。 | | info | const VideoFrameInfo & | 视频帧信息。参看 [VideoFrameInfo](70098#VideoFrameInfo)。 | **注意** - 对于主流，进入房间后，仅在发布端第一次发布的时候，订阅端会收到该回调，此后不受重新发布的影响，只要不重新加入房间，就不会再收到该回调。 - 对于屏幕流，用户每次重新发布屏幕视频流在订阅端都会重新触发一次该回调。 ### onScreenVideoFrameSendStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onScreenVideoFrameSendStateChanged( const char* room_id, const RtcUser &user, FirstFrameSendState state ) ``` 屏幕共享流的视频首帧发送状态发生改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 流的发布房间的 ID | | user | const RtcUser & | 本地用户信息，详见 [RtcUser](70098#RtcUser) | | state | FirstFrameSendState | 首帧发送状态，详见 [FirstFrameSendState](70098#FirstFrameSendState) | ### onAudioFramePlayStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onAudioFramePlayStateChanged( const char* room_id, const RtcUser &user, FirstFramePlayState state ) ``` 音频首帧播放状态发生改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 首帧播放状态发生改变的流所在的房间 ID | | user | const RtcUser & | 远端用户信息，详见 [RtcUser](70098#RtcUser) | | state | FirstFramePlayState | 首帧播放状态，详见 [FirstFramePlayState](70098#FirstFramePlayState) | ### onScreenAudioFramePlayStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onScreenAudioFramePlayStateChanged( const char* room_id, const RtcUser &user, FirstFramePlayState state ) ``` 屏幕音频首帧播放状态改变回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 首帧播放状态发生改变的流所在的房间 ID | | user | const RtcUser & | 远端用户信息，详见 [RtcUser](70098#RtcUser) | | state | FirstFramePlayState | 首帧播放状态，详见 [FirstFramePlayState](70098#FirstFramePlayState) | ### onVideoFramePlayStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onVideoFramePlayStateChanged( const char* room_id, const RtcUser &user, FirstFramePlayState state ) ``` 视频首帧播放状态改变回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 首帧播放状态发生改变的流所在的房间 ID | | user | const RtcUser & | 远端用户信息，详见 [RtcUser](70098#RtcUser) | | state | FirstFramePlayState | 首帧播放状态，详见 [FirstFramePlayState](70098#FirstFramePlayState) | ### onScreenVideoFramePlayStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onScreenVideoFramePlayStateChanged( const char* room_id, const RtcUser &user, FirstFramePlayState state ) ``` 屏幕共享流视频首帧播放状态发生改变时，收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 首帧播放状态发生改变的流所在的房间 ID | | user | const RtcUser & | 远端用户信息，详见 [RtcUser](70098#RtcUser) | | state | FirstFramePlayState | 首帧播放状态，详见 [FirstFramePlayState](70098#FirstFramePlayState) | ### onFirstLocalAudioFrame ```cpp virtual void bytertc::IRTCVideoEventHandler::onFirstLocalAudioFrame(StreamIndex index) ``` 发布音频流时，采集到第一帧音频帧，收到该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | index | StreamIndex | 音频流属性, 参看 [StreamIndex](70098#StreamIndex) | **注意** 如果发布音频流时，未开启本地音频采集，SDK 会推送静音帧，也会收到此回调。 ### onPushPublicStreamResult ```cpp virtual void bytertc::IRTCVideoEventHandler::onPushPublicStreamResult( const char* room_id, const char* public_streamid, PublicStreamErrorCode error_code ) ``` 公共流发布结果回调。调用 [startPushPublicStream](70095#IRTCVideo-startpushpublicstream) 接口发布公共流后，启动结果通过此回调方法通知用户。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 公共流的发布房间的 ID | | public_streamid | const char * | 公共流 ID | | error_code | PublicStreamErrorCode | 公共流发布结果状态码。详见 [PublicStreamErrorCode](70097#PublicStreamErrorCode) | ### onFirstPublicStreamAudioFrame ```cpp virtual void bytertc::IRTCVideoEventHandler::onFirstPublicStreamAudioFrame(const char* public_stream_id) ``` 公共流的音频首帧解码成功关于订阅公共流，详见 [startPlayPublicStream](70095#IRTCVideo-startplaypublicstream)。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | public_stream_id | const char * | 公共流 ID | ### onCloudProxyConnected ```cpp virtual void bytertc::IRTCVideoEventHandler::onCloudProxyConnected(int interval) ``` 调用 [startCloudProxy](70095#IRTCVideo-startcloudproxy) 开启云代理，SDK 首次成功连接云代理服务器时，回调此事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | interval | int | 从开启云代理到连接成功经过的时间，单位为 ms | ### onEchoTestResult ```cpp virtual void bytertc::IRTCVideoEventHandler::onEchoTestResult(EchoTestResult result) ``` 关于音视频回路测试结果的回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | result | EchoTestResult | 测试结果，参看 [EchoTestResult](70098#EchoTestResult) | **注意** 该回调触发的时机包括： - 检测过程中采集设备发生错误时； - 检测成功后； - 非设备原因导致检测过程中未接收到音/视频回放，停止检测后。 ### onNetworkTimeSynchronized ```cpp virtual void bytertc::IRTCVideoEventHandler::onNetworkTimeSynchronized() ``` 首次调用 [getNetworkTimeInfo](70095#IRTCVideo-getnetworktimeinfo) 后，SDK 内部启动网络时间同步，同步完成时会触发此回调。 ### onExternalScreenFrameUpdate ```cpp virtual void bytertc::IRTCVideoEventHandler::onExternalScreenFrameUpdate(FrameUpdateInfo frame_update_info) ``` 外部采集时，调用 [setOriginalScreenVideoInfo](70095#IRTCVideo-setoriginalscreenvideoinfo) 设置屏幕或窗口大小改变前的分辨率后，若屏幕采集模式为智能模式，你将收到此回调，根据 RTC 智能决策合适的帧率和分辨率积（宽*高）重新采集。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | frame_update_info | FrameUpdateInfo | RTC 智能决策后合适的帧率和分辨率积（宽*高）。参看 [FrameUpdateInfo](70098#FrameUpdateInfo)。 | ### onHardwareEchoDetectionResult ```cpp virtual void bytertc::IRTCVideoEventHandler::onHardwareEchoDetectionResult(HardwareEchoDetectionResult hardware_echo_detection_result) ``` 通话前回声检测结果回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | hardware_echo_detection_result | HardwareEchoDetectionResult | 参见 [HardwareEchoDetectionResult](70098#HardwareEchoDetectionResult) | **注意** - 通话前调用 [startHardwareEchoDetection](70095#IRTCVideo-starthardwareechodetection) 后，将触发本回调返回检测结果。 - 建议在收到检测结果后，调用 [stopHardwareEchoDetection](70095#IRTCVideo-stophardwareechodetection) 停止检测，释放对音频设备的占用。 - 如果 SDK 在通话中检测到回声，将通过 [onAudioDeviceWarning](#IRTCVideoEventHandler-onaudiodevicewarning) 回调 `kMediaDeviceWarningDetectLeakEcho`。 ### onLocalProxyStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onLocalProxyStateChanged( LocalProxyType local_proxy_type, LocalProxyState local_proxy_state, LocalProxyError local_proxy_error ) ``` 本地代理状态发生改变回调。调用 [setLocalProxy](70095#IRTCVideo-setlocalproxy) 设置本地代理后，SDK 会触发此回调，返回代理连接的状态。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | local_proxy_type | LocalProxyType | 本地代理类型。参看 [LocalProxyType](70098#LocalProxyType)。 | | local_proxy_state | LocalProxyState | 本地代理状态。参看 [LocalProxyState](70098#LocalProxyState)。 | | local_proxy_error | LocalProxyError | 本地代理错误。参看 [LocalProxyError](70098#LocalProxyError)。 | ### onAudioMixingStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onAudioMixingStateChanged( int mix_id, bytertc::AudioMixingState state, bytertc::AudioMixingError error ) ``` > Deprecated since 353. Use [IMediaPlayerEventHandler](#IMediaPlayerEventHandler) and [IAudioEffectPlayerEventHandler](#IAudioEffectPlayerEventHandler) instead. 音频混音文件播放状态改变时回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | mix_id | int | 混音 ID
使用 [IAudioMixingManager](70095#IAudioMixingManager) 相关接口时传入的唯一 ID。 | | state | bytertc::AudioMixingState |
混音状态
其混音状态可参考： [AudioMixingState](70098#AudioMixingState)。 | | error | bytertc::AudioMixingError |
错误码
详见 [AudioMixingError](70098#AudioMixingError) | **注意** 此回调会被触发的时机汇总如下： - 1. 音乐文件类型： - 当调用 [startAudioMixing](70095#IAudioMixingManager-startaudiomixing) 方法成功后，会触发 state 值为 kAudioMixingStatePlaying 回调；否则触发 state 值为 kAudioMixingStateFailed 的回调。 - 当使用相同的 ID 重复调用 [startAudioMixing](70095#IAudioMixingManager-startaudiomixing) 后，后一次会覆盖前一次，且本回调会以 kAudioMixingStateStopped 通知前一次混音已停止。 - 当调用 [pauseAudioMixing](70095#IAudioMixingManager-pauseaudiomixing) 方法暂停播放成功后，会触发 state 值为 kAudioMixingStatePaused 回调；否则触发 state 值为 kAudioMixingStateFailed 的回调。 - 当调用 [resumeAudioMixing](70095#IAudioMixingManager-resumeaudiomixing) 方法恢复播放成功后，会触发 state 值为 kAudioMixingStatePlaying 回调；否则触发 state 值为 kAudioMixingStateFailed 的回调。 - 当调用 [stopAudioMixing](70095#IAudioMixingManager-stopaudiomixing) 方法暂停止播放成功后，会触发 state 值为 kAudioMixingStateStopped 回调；否则触发 state 值为 kAudioMixingStateFailed 的回调。 - 播放结束会触发 state 值为 kAudioMixingStateFinished 回调。 - 2. PCM 流类型： - 当调用 [enableAudioMixingFrame](70095#IAudioMixingManager-enableaudiomixingframe) 方法成功后，会触发 state 值为 kAudioMixingStatePCMEnabled 回调；否则触发 state 值为 kAudioMixingStateFailed 的回调。（Linux 不支持） - 当调用 [disableAudioMixingFrame](70095#IAudioMixingManager-disableaudiomixingframe) 方法成功后，会触发 state 值为 kAudioMixingStatePCMDisabled 回调；否则触发 state 值为 kAudioMixingStateFailed 的回调。 ### onMediaDeviceStateChanged ```cpp virtual void bytertc::IRTCVideoEventHandler::onMediaDeviceStateChanged( const char* device_id, bytertc::MediaDeviceType device_type, bytertc::MediaDeviceState device_state, bytertc::MediaDeviceError device_error ) ``` > Deprecated since 3.37 and will be deleted in 3.51, use [onAudioDeviceStateChanged](#IRTCVideoEventHandler-onaudiodevicestatechanged) and [onVideoDeviceStateChanged](#IRTCVideoEventHandler-onvideodevicestatechanged) instead. 媒体设备状态回调。提示音频采集、音频播放、摄像头视频采集、屏幕视频采集四种媒体设备的状态。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | device_id | const char * | 设备 ID
采集屏幕视频流时，设备 ID 为固定字符串 `screen_capture_video` | | device_type | bytertc::MediaDeviceType | 设备类型，详见 [MediaDeviceType](70098#MediaDeviceType) | | device_state | bytertc::MediaDeviceState | 设备状态，详见 [MediaDeviceState](70098#MediaDeviceState) | | device_error | bytertc::MediaDeviceError | 设备错误类型，详见 [MediaDeviceError](70098#MediaDeviceError) | ### onMediaDeviceWarning ```cpp virtual void bytertc::IRTCVideoEventHandler::onMediaDeviceWarning( const char* device_id, bytertc::MediaDeviceType device_type, bytertc::MediaDeviceWarning device_warning ) ``` > Deprecated since 3.37 and will be deleted in 3.51, use [onAudioDeviceWarning](#IRTCVideoEventHandler-onaudiodevicewarning) and [onVideoDeviceWarning](#IRTCVideoEventHandler-onvideodevicewarning) instead. 媒体设备警告回调。媒体设备包括：音频采集设备、音频渲染设备、和视频采集设备。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | device_id | const char * | 设备 ID | | device_type | bytertc::MediaDeviceType | 详见 [MediaDeviceType](70098#MediaDeviceType) | | device_warning | bytertc::MediaDeviceWarning | 详见 [MediaDeviceWarning](70098#MediaDeviceWarning) | ### onHttpProxyState ```cpp virtual void bytertc::IRTCVideoEventHandler::onHttpProxyState(int state) ``` > Deprecated since 3.52, will be deleted at 3.57, use [onLocalProxyStateChanged](#IRTCVideoEventHandler-onlocalproxystatechanged) instead HTTP 代理连接状态改变时，收到该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | int | 当前 HTTP 代理连接状态，详见 [HttpProxyState](70098#HttpProxyState) | ### onHttpsProxyState ```cpp virtual void bytertc::IRTCVideoEventHandler::onHttpsProxyState(int state) ``` > Deprecated since 3.52, will be deleted at 3.57, use [onLocalProxyStateChanged](#IRTCVideoEventHandler-onlocalproxystatechanged) instead HTTPS 代理连接状态改变时，收到该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | int | 当前 HTTPS 代理连接状态，详见 [HttpProxyState](70098#HttpProxyState) | ### onSocks5ProxyState ```cpp virtual void bytertc::IRTCVideoEventHandler::onSocks5ProxyState( int state, const char* cmd, const char* proxy_address, const char* local_address, const char* remote_address ) ``` > Deprecated since 3.52, will be deleted at 3.57, use [onLocalProxyStateChanged](#IRTCVideoEventHandler-onlocalproxystatechanged) instead SOCKS5 代理状态改变时，收到该回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | state | int | SOCKS5 代理连接状态 | | cmd | const char * | 代理连接的每一步操作命令 | | proxy_address | const char * | 代理地址信息 | | local_address | const char * | 当前连接使用的本地地址 | | remote_address | const char * | 远端的连接地址 | ### onUserMuteAudio ```cpp virtual void bytertc::IRTCVideoEventHandler::onUserMuteAudio( const char* room_id, const char* user_id, MuteState mute_state ) ``` > Deprecated since 3.36 and will be deleted in 3.51, use [onUserPublishStream](#IRTCRoomEventHandler-onuserpublishstream), [onUserPublishScreen](#IRTCRoomEventHandler-onuserpublishscreen), [onUserUnpublishStream](#IRTCRoomEventHandler-onuserunpublishstream) and [onUserUnpublishScreen](#IRTCRoomEventHandler-onuserunpublishscreen) instead. 房间内用户暂停/恢复发送音频流时，房间内其他用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 房间 ID。 | | user_id | const char * | 改变本地音频发送状态的用户 ID | | mute_state | MuteState | 发送状态，参看 [MuteState](70098#MuteState) | ### onUserMuteVideo ```cpp virtual void bytertc::IRTCVideoEventHandler::onUserMuteVideo( const char* room_id, const char* uid, MuteState mute ) ``` > Deprecated since 3.36 and will be deleted in 3.51, use [onUserPublishStream](#IRTCRoomEventHandler-onuserpublishstream), [onUserPublishScreen](#IRTCRoomEventHandler-onuserpublishscreen), [onUserUnpublishStream](#IRTCRoomEventHandler-onuserunpublishstream) and [onUserUnpublishScreen](#IRTCRoomEventHandler-onuserunpublishscreen) instead. 房间内用户暂停/恢复发送视频流时，房间内其他用户会收到此回调。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | room_id | const char * | 房间 ID | | uid | const char * | 暂停/恢复发送视频流的用户 ID。 | | mute | MuteState | 视频流的发送状态。参看 [MuteState](70098#MuteState)。 | # IPushSingleStreamToCDNObserver ```cpp class bytertc::IPushSingleStreamToCDNObserver ``` 单流转推直播观察者。注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onStreamPushEvent](#IPushSingleStreamToCDNObserver-onstreampushevent) | ## 函数说明 ### onStreamPushEvent ```cpp virtual void bytertc::IPushSingleStreamToCDNObserver::onStreamPushEvent( SingleStreamPushEvent event, const char* task_id, int error )=0 ``` 单流转推直播状态回调 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | event | SingleStreamPushEvent | 任务状态, 参看 [SingleStreamPushEvent](70097#SingleStreamPushEvent) | | task_id | const char * | 任务 ID | | error | int | 错误码，参看 [StreamMixingErrorCode](70097#StreamMixingErrorCode) | # ILocalEncodedVideoFrameObserver ```cpp class bytertc::ILocalEncodedVideoFrameObserver ``` 本地视频帧监测器注意：回调函数是在 SDK 内部线程（非 UI 线程）同步抛出来的，请不要做耗时操作或直接操作 UI，否则可能导致 app 崩溃。 ## 成员函数 | 返回 | 名称 | | --- | --- | | virtual void | [onLocalEncodedVideoFrame](#ILocalEncodedVideoFrameObserver-onlocalencodedvideoframe) | ## 函数说明 ### onLocalEncodedVideoFrame ```cpp virtual void bytertc::ILocalEncodedVideoFrameObserver::onLocalEncodedVideoFrame( StreamIndex type, const IEncodedVideoFrame &video_stream )=0 ``` 调用 [registerLocalEncodedVideoFrameObserver](70095#IRTCVideo-registerlocalencodedvideoframeobserver) 后，SDK 每次使用内部采集，采集到一帧视频帧，或收到一帧外部视频帧时，都会回调该事件。 **传入参数** | 参数名 | 类型 | 说明 | | --- | --- | --- | | type | StreamIndex | 本地视频帧类型，参看 [StreamIndex](70098#StreamIndex) | | video_stream | const IEncodedVideoFrame & | 本地视频帧信息，参看 [IEncodedVideoFrame](70098#IEncodedVideoFrame) |

实时音视频