IMetadataObserver

class bytertc::IMetadataObserver

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

Defined in : byte_rtc_engine_lite_interface.h

成员函数

函数说明

OnReadyToSendMetadata

virtual bool bytertc::IMetadataObserver::OnReadyToSendMetadata(
    ByteMetadataBuffer* metadata)

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

传入参数

返回值

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

注意

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

OnMetadataReceived

virtual void bytertc::IMetadataObserver::OnMetadataReceived(
    const char* roomid,
    const char* uid,
    const ByteMetadataBuffer& metadata)

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

传入参数

注意

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

IAudioDeviceObserver

class bytertc::IAudioDeviceObserver

音频外部设备事件监听，只用于自定义音频采集渲染的情况 SDK内部需要控制外部设备时，通过这个事件监听类通知上层应用

Defined in : byte_rtc_engine_lite_interface.h

成员函数

函数说明

OnAudioDeviceRecordStart

virtual void bytertc::IAudioDeviceObserver::OnAudioDeviceRecordStart()

通知上层应用开启音频采集设备

OnAudioDeviceRecordStop

virtual void bytertc::IAudioDeviceObserver::OnAudioDeviceRecordStop()

通知上层应用关闭音频采集设备

OnAudioDevicePlayoutStart

virtual void bytertc::IAudioDeviceObserver::OnAudioDevicePlayoutStart()

通知上层应用开启音频播放设备

OnAudioDevicePlayoutStop

virtual void bytertc::IAudioDeviceObserver::OnAudioDevicePlayoutStop()

通知上层应用关闭音频播放设备

IAudioFrameObserver

class bytertc::IAudioFrameObserver

音频数据回调观察者

Defined in : byte_rtc_engine_lite_interface.h

成员函数

函数说明

OnRecordAudioFrame

virtual void bytertc::IAudioFrameObserver::OnRecordAudioFrame(
    const AudioFrame& audio_frame)

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

传入参数

OnPlaybackAudioFrame

virtual void bytertc::IAudioFrameObserver::OnPlaybackAudioFrame(
    const AudioFrame& audio_frame)

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

传入参数

OnMixedAudioFrame

virtual void bytertc::IAudioFrameObserver::OnMixedAudioFrame(
    const AudioFrame& audio_frame)

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

传入参数

IVideoFrameObserver

class bytertc::IVideoFrameObserver

视频数据回调对象

Defined in : byte_rtc_engine_lite_interface.h

成员函数

函数说明

OnLocalScreenFrame

virtual bool bytertc::IVideoFrameObserver::OnLocalScreenFrame(
    IByteVideoFrame* videoFrame)

本地屏幕共享流数据回调

传入参数

返回值

true: SDK 不处理返回值 false: SDK 不处理返回值

OnLocalVideoFrame

virtual bool bytertc::IVideoFrameObserver::OnLocalVideoFrame(
    IByteVideoFrame* videoFrame)

本地视频流数据回调

传入参数

返回值

true: SDK 不处理返回值 false: SDK 不处理返回值

OnRemoteScreenFrame

virtual bool bytertc::IVideoFrameObserver::OnRemoteScreenFrame(
    const char* roomid,
    const char* uid,
    IByteVideoFrame* videoFrame)

远端屏幕共享流数据回调

传入参数

返回值

true: SDK 不处理返回值 false: SDK 不处理返回值

OnRemoteVideoFrame

virtual bool bytertc::IVideoFrameObserver::OnRemoteVideoFrame(
    const char* roomid,
    const char* uid,
    IByteVideoFrame* videoFrame)

远端视频数据回调

传入参数

返回值

true: SDK 不处理返回值 false: SDK 不处理返回值

IRemoteAudioFrameObserver

class bytertc::IRemoteAudioFrameObserver

音频数据回调观察者

Defined in : byte_rtc_engine_lite_interface.h

成员函数

函数说明

OnRemoteAudioFrame

virtual void bytertc::IRemoteAudioFrameObserver::OnRemoteAudioFrame(
    const IByteAudioFrame& audio_frame,
    const ByteStreamInfo& stream_info)

获得单个流的音频数据

传入参数

IByteEngineEncryptHandler

class bytertc::IByteEngineEncryptHandler

加密/解密处理函数

Defined in : byte_rtc_engine_defines.h

成员函数

函数说明

OnEncryptData

virtual unsigned int bytertc::IByteEngineEncryptHandler::OnEncryptData(
    const unsigned char* data,
    unsigned int length,
    unsigned char* buf,
    unsigned int buf_len)

自定义加密的方法接口
通过继承并实现该方法，可以扩展传输过程中的加密方法，详见 SetCustomizeEncryptHandler

传入参数

返回值

加密后实际写入缓冲区的数据大小，0表示丢弃该帧

注意

返回的数据大小应控制在原始数据的90%~120%范围以内，不然将被丢弃

OnDecryptData

virtual unsigned int bytertc::IByteEngineEncryptHandler::OnDecryptData(
    const unsigned char* data,
    unsigned int length,
    unsigned char* buf,
    unsigned int buf_len)

自定义解密的方法接口
通过继承并实现该方法，可以扩展传输过程中的解密方法，详见 SetCustomizeEncryptHandler

传入参数

返回值

解密后实际写入缓冲区的数据大小，0表示丢弃该帧

注意

返回的数据大小应控制在原始数据的90%~120%范围以内，不然将被丢弃

IVideoSink

class bytertc::IVideoSink

视频数据回调接口

Defined in : byte_rtc_engine_defines.h

成员函数

函数说明

OnStart

virtual void bytertc::IVideoSink::OnStart()

启动渲染器。

注意

在开启渲染功能的时候会回调这个方法。开发者可以在这个方法中启动渲染器。

OnFrame

virtual bool bytertc::IVideoSink::OnFrame(
    IByteVideoFrame* videoFrame)

视频帧回调

传入参数

返回值

返回值暂未使用

OnStop

virtual void bytertc::IVideoSink::OnStop()

停止渲染器。

注意

在停止渲染功能的时候会回调这个方法。开发者可以在这个方法中停止渲染。

Release

virtual void bytertc::IVideoSink::Release()

释放渲染器。

注意

通知开发者渲染器即将被废弃。在Release()返回之后，开发者就可以释放掉资源了。

IRTCRoomEventHandler

class bytertc::IRTCRoomEventHandler

音视频房间事件回调接口

Defined in : byte_rtc_room_event_handler_interface.h

成员函数

函数说明

OnJoinChannelSuccess

virtual void bytertc::IRTCRoomEventHandler::OnJoinChannelSuccess(
    const char* room_id,
    const char* uid,
    int elapsed)

加入房间成功回调。此回调事件表示本地用户成功加入了指定的房间。
用户调用 JoinChannel 方法加入房间，首次加入房间成功后 SDK 通过此回调事件通知用户加入房间成功。此回调事件在用户调用 JoinChannel 方法加入房间到用户调用 LeaveChannel 方法离开房间期间至多回调一次。

传入参数

OnRejoinChannelSuccess

virtual void bytertc::IRTCRoomEventHandler::OnRejoinChannelSuccess(
    const char* room_id,
    const char* uid,
    int elapsed)

重新加入房间成功回调。此回调事件表示本地用户成功重连入房间。
本地用户加入房间成功后，在本地网络状况不佳的情况下，SDK 可能会与服务器失去连接。此时 SDK 将会自动重连，并在重连成功通过此回调事件通知用户重连成功。

传入参数

OnLeaveChannel

virtual void bytertc::IRTCRoomEventHandler::OnLeaveChannel(
    const RtcStats& stats)

离开房间成功回调。
用户调用 LeaveChannel 方法后，SDK 会停止所有的发布订阅流，并释放所有通话相关的音视频资源。SDK 完成所有的资源释放后通过此回调通知用户。
离开房间结束通话后，如果 App 需要使用系统音视频设备，则建议在收到此回调后再初始化音视频设备，否则可能由于 SDK 占用了导致 App 初始化音视频设备失败。

传入参数

注意

• 用户调用 LeaveChannel 方法离开房间后，如果立即调用 DestroyByteRtcEngine 方法销毁 RTC 引擎，则将无法收到此回调事件。

OnChannelWarning

virtual void bytertc::IRTCRoomEventHandler::OnChannelWarning(
    int warn)

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

传入参数

OnChannelError

virtual void bytertc::IRTCRoomEventHandler::OnChannelError(
    int err)

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

传入参数

OnAudioQuality

virtual void bytertc::IRTCRoomEventHandler::OnAudioQuality(
    const char* uid,
    int quality,
    unsigned short delay,
    unsigned short lost)

当收到音频质量信息的时候回调该事件

传入参数

OnAudioVolumeIndication

virtual void bytertc::IRTCRoomEventHandler::OnAudioVolumeIndication(
    const AudioVolumeInfo* speakers,
    unsigned int speaker_number,
    int total_volume)

提示房间内谁正在说话以及说话者音量的回调

传入参数

注意

• 该回调提示房间内所有用户的用户ID及他们的音量。默认禁用。
• 可以通过启用说话者音量提示 EnableAudioVolumeIndication 方法开启。
• 开启后，无论房间内是否有人说话，都会按方法中设置的时间间隔返回提示音量。

OnRtcStats

virtual void bytertc::IRTCRoomEventHandler::OnRtcStats(
    const RtcStats& stats)

用户加入房间成功后，每 2s 会收到一次房间内统计信息的回调。

传入参数

OnNetworkQuality

virtual void bytertc::IRTCRoomEventHandler::OnNetworkQuality(
    const char* uid,
    NetworkQuality tx_quality,
    NetworkQuality rx_quality)

通话中用户的媒体流网络上下行质量报告回调。加入房间成功后，每隔 2 秒会触发此回调，通知房间内用户与媒体服务器之间数据交互的网络质量。

传入参数

注意

• 当 uid 为本地用户 ID 时，tx_quality 为该用户的上行网络质量，rx_quality 为该用户的下行网络质量。
• 当 uid 为远端用户 ID 时，目前仅支持获取该用户的上行网络质量 tx_quality ，下行网络质量 rx_quality 为 kNetworkQualityUnknown 。
• NetworkQuality 的定义详见：NetworkQuality 。

OnUserJoined

virtual void bytertc::IRTCRoomEventHandler::OnUserJoined(
    const char* uid,
    const char* team_id,
    const RangeAudioMode send_mode,
    int elapsed)

远端用户加入房间回调。
此回调用于提示房间中有新用户加入。如果本地用户已经在房间中，有新的远端用户加入时，SDK 通过此回调方法通知房间中有新用户加入；如果用户加入房间前，房间中已有其他用户，加入房间后用户也会收到这些已在房间中的远端用户的加入房间回调。
回调的具体触发时机如下：
1.远端的房间模式为通信模式的用户或房间模式为其他模式的主播、观众角色的用户，调用 JoinChannel 方法加入房间。
2.远端的房间模式为通信模式的用户或房间模式为其他模式的主播、观众角色的用户，在断网后重连入房间。
3.远端已在房间中的房间模式为直播、游戏或云游戏模式的静默观众角色的用户，调用 SetClientRole 方法将用户角色切换至主播或观众。
4.本地用户加入房间时，会收到已在房间中的远端的房间模式为通信模式的用户或房间模式为其他模式的主播、观众角色的用户的加入房间回调。

传入参数

OnUserOffline

virtual void bytertc::IRTCRoomEventHandler::OnUserOffline(
    const char* uid,
    USER_OFFLINE_REASON_TYPE reason)

远端用户离开房间回调。
此回调用于提示房间中有远端用户离开。用户离开房间的原因有两个，即用户主动调用 LeaveChannel 方法离开房间和超时掉线。
回调的具体触发时机如下：
1.远端的房间模式为通信模式的用户或房间模式为其他模式的主播、观众角色的用户，调用 LeaveChannel 方法离开房间。用户离开的原因为 USER_OFFLINE_QUIT。
2.远端已在房间中的房间模式为直播、游戏或云游戏模式的主播、观众角色的用户调用 SetClientRole 方法将用户角色切换至静默观众。用户离开的原因为 USER_OFFLINE_QUIT。
3.远端的房间模式为通信模式的用户或房间模式为其他模式的主播、观众角色的用户，断网且一直未恢复。用户离开的原因为 USER_OFFLINE_DROPPED。

传入参数

OnMuteAllRemoteVideo

virtual void bytertc::IRTCRoomEventHandler::OnMuteAllRemoteVideo(
    const char* uid,
    bool muted)

当某个用户开启/关闭远端所有用户视频时回调该事件。

传入参数

OnUserMuteAudio

virtual void bytertc::IRTCRoomEventHandler::OnUserMuteAudio(
    const char* uid,
    bool muted)

远端用户将其本地音频流静音时，房间内其他人会收到这个回调。 该回调由远端用户调用 MuteLocalAudioStream 方法触发。

传入参数

OnUserEnableLocalAudio

virtual void bytertc::IRTCRoomEventHandler::OnUserEnableLocalAudio(
    const char* uid,
    bool enabled)

远端用户开启/关闭音频设备采集时，房间内其他人会收到这个回调。 该回调由远端用户调用 EnableLocalAudio 方法触发。

传入参数

OnLocalAudioStats

virtual void bytertc::IRTCRoomEventHandler::OnLocalAudioStats(
    const LocalAudioStats& stats)

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

传入参数

OnRemoteAudioStats

virtual void bytertc::IRTCRoomEventHandler::OnRemoteAudioStats(
    const RemoteAudioStats& stats)

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

传入参数

OnConnectionLost

virtual void bytertc::IRTCRoomEventHandler::OnConnectionLost()

SDK 与信令服务器连接断开回调。当 SDK 与信令服务器的网络连接断开超过 10 秒时回调该事件。

注意

• 除非主动调用 LeaveChannel ，否则 SDK 会一直尝试重连。

OnConnectionInterrupted

virtual void bytertc::IRTCRoomEventHandler::OnConnectionInterrupted()

SDK 与信令服务器连接中断回调。当 SDK 检测到与信令服务器的网络连接中断时回调该事件。

注意

• 除非主动调用 LeaveChannel ，否则 SDK 会一直尝试重连。

OnFirstLocalAudioFrame

virtual void bytertc::IRTCRoomEventHandler::OnFirstLocalAudioFrame(
    int elapsed)

当收到本地第一帧音频的时候上报该事件

传入参数

OnFirstRemoteAudioFrame

virtual void bytertc::IRTCRoomEventHandler::OnFirstRemoteAudioFrame(
    const char* uid,
    int elapsed)

当收到远端流的第一帧音频的时候上报该事件

传入参数

OnStreamRemove

virtual void bytertc::IRTCRoomEventHandler::OnStreamRemove(
    const ByteStream& stream,
    RtcStreamRemoveReason reason)

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

传入参数

OnStreamAdd

virtual void bytertc::IRTCRoomEventHandler::OnStreamAdd(
    const ByteStream& stream)

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

传入参数

OnRemoteStreamSwitch

virtual void bytertc::IRTCRoomEventHandler::OnRemoteStreamSwitch(
    const RemoteStreamSwitch& event)

收到远端流回退或恢复时回调该事件。

传入参数

OnRoomMessageReceived

virtual void bytertc::IRTCRoomEventHandler::OnRoomMessageReceived(
    const char* message)

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

传入参数

注意

1.同一房间内其他用户调用 SendMessageToRoom 发送广播消息时会收到该回调。

OnRoomBinaryMessageReceived

virtual void bytertc::IRTCRoomEventHandler::OnRoomBinaryMessageReceived(
    int size,
    const uint8_t* message)

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

传入参数

注意

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

OnUserMessageReceived

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

点对点消息回调。接收到同一房间内 uid 所属用户发来消息时触发。

传入参数

注意

• 同一房间内其他用户调用 SendMessageToUser 发送消息给本地用户时会收到该回调。

OnUserBinaryMessageReceived

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

接收到同一房间内 uid 所属用户发来二进制消息的回调。

传入参数

OnUserMessageSendResult

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

当调用 SendMessageToUser 函数发送消息后，回调此条消息的发送结果（反馈）。

传入参数

OnRoomMessageSendResult

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

当调用 SendMessageToRoom 函数发送消息后，回调此条消息的发送结果（反馈）。

传入参数

OnFirstLocalVideoFrame

virtual void bytertc::IRTCRoomEventHandler::OnFirstLocalVideoFrame(
    int width,
    int height,
    int elapsed)

收到第一帧本地视频画面时回调该事件。

传入参数

注意

第一帧本地视频显示在视图上时，触发此回调。

OnFirstLocalScreenFrame

virtual void bytertc::IRTCRoomEventHandler::OnFirstLocalScreenFrame(
    int width,
    int height,
    int elapsed)

当收到本地屏幕共享流第一帧时回调该事件。

传入参数

注意

第一帧本地视频显示在视图上时，触发此回调。

OnFirstRemoteVideoDecoded

virtual void bytertc::IRTCRoomEventHandler::OnFirstRemoteVideoDecoded(
    const char* uid,
    int width,
    int height,
    int elapsed)

当远端视频第一帧视频被解码时回调该事件。

传入参数

注意

收到第一帧远端视频流并解码成功时，触发此调用。应用可以在此回调中设置该用户的 View。

OnVideoSizeChanged

virtual void bytertc::IRTCRoomEventHandler::OnVideoSizeChanged(
    const char* uid,
    int width,
    int height,
    int rotation)

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

传入参数

OnFirstRemoteVideoFrame

virtual void bytertc::IRTCRoomEventHandler::OnFirstRemoteVideoFrame(
    const char* uid,
    int width,
    int height,
    int elapsed)

收到远端流后解码第一帧时回调该事件。

传入参数

注意

第一帧远端视频显示在视图上时，触发此调用。应用可在此调用中获知出图时间（elapsed）。出图时间指从订阅视频流到第一个视频帧刷出来的间隔。

OnFirstRemoteScreenFrame

virtual void bytertc::IRTCRoomEventHandler::OnFirstRemoteScreenFrame(
    const char* uid,
    int width,
    int height,
    int elapsed)

收到远端屏幕共享流后解码第一帧时回调该事件。

传入参数

OnUserMuteVideo

virtual void bytertc::IRTCRoomEventHandler::OnUserMuteVideo(
    const char* uid,
    bool muted)

远端用户暂停/恢复发送视频流时回调该事件，当远端用户调用 MuteLocalVideoStream 时，其他用户会触发此回调。

传入参数

注意

提示有其他用户暂停/恢复了视频流的发送。

OnUserEnableLocalVideo

virtual void bytertc::IRTCRoomEventHandler::OnUserEnableLocalVideo(
    const char* uid,
    bool enabled)

远端用户开启/关闭本地视频采集时回调该事件，当远端用户调用 EnableLocalVideo 时，其他用户会触发此回调。

传入参数

注意

提示有其他用户启用/关闭了本地视频功能。

OnLocalVideoStats

virtual void bytertc::IRTCRoomEventHandler::OnLocalVideoStats(
    const LocalVideoStats& stats)

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

传入参数

注意

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

OnRemoteVideoStats

virtual void bytertc::IRTCRoomEventHandler::OnRemoteVideoStats(
    const RemoteVideoStats& stats)

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

传入参数

注意

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

OnLocalAudioStateChanged

virtual void bytertc::IRTCRoomEventHandler::OnLocalAudioStateChanged(
    LocalAudioStreamState state,
    LocalAudioStreamError error)

本地音频的状态发生改变时，该回调通知当前的本地音频状态。

传入参数

OnRemoteAudioStateChanged

virtual void bytertc::IRTCRoomEventHandler::OnRemoteAudioStateChanged(
    const char* uid,
    RemoteAudioState state,
    RemoteAudioStateReason reason,
    int elapsed)

远端用户音频状态发生改变时，该回调通知当前的远端音频流状态。

传入参数

OnLocalVideoStateChanged

virtual void bytertc::IRTCRoomEventHandler::OnLocalVideoStateChanged(
    LocalVideoStreamState state,
    LocalVideoStreamError error)

本地视频的状态发生改变时，该回调返回当前的本地视频状态。

传入参数

OnRemoteVideoStateChanged

virtual void bytertc::IRTCRoomEventHandler::OnRemoteVideoStateChanged(
    const char* uid,
    RemoteVideoState state,
    RemoteVideoStateReason reason,
    int elapsed)

远端用户视频状态发生改变时，该回调报告当前的远端视频流状态。

传入参数

OnAudioFrameSendStateChanged

virtual void bytertc::IRTCRoomEventHandler::OnAudioFrameSendStateChanged(
    const RtcUser& user,
    FirstFrameSendState state)

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

传入参数

OnVideoFrameSendStateChanged

virtual void bytertc::IRTCRoomEventHandler::OnVideoFrameSendStateChanged(
    const RtcUser& user,
    FirstFrameSendState state)

视频首帧发送状态改变回调

传入参数

OnScreenVideoFrameSendStateChanged

virtual void bytertc::IRTCRoomEventHandler::OnScreenVideoFrameSendStateChanged(
    const RtcUser& user,
    FirstFrameSendState state)

屏幕共享流视频首帧发送状态改变回调

传入参数

OnAudioFramePlayStateChanged

virtual void bytertc::IRTCRoomEventHandler::OnAudioFramePlayStateChanged(
    const RtcUser& user,
    FirstFramePlayState state)

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

传入参数

OnVideoFramePlayStateChanged

virtual void bytertc::IRTCRoomEventHandler::OnVideoFramePlayStateChanged(
    const RtcUser& user,
    FirstFramePlayState state)

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

传入参数

OnScreenVideoFramePlayStateChanged

virtual void bytertc::IRTCRoomEventHandler::OnScreenVideoFramePlayStateChanged(
    const RtcUser& user,
    FirstFramePlayState state)

屏幕共享流视频首帧播放状态改变回调

传入参数

IRtcEngineLiteEventHandler

class IRtcEngineLiteEventHandler

音视频引擎事件回调接口

Defined in : byte_rtc_engine_lite_event_handler.h

成员函数

函数说明

OnWarning

virtual void IRtcEngineLiteEventHandler::OnWarning(
    int warn)

当内部发生警告事件时触发该回调

传入参数

OnError

virtual void IRtcEngineLiteEventHandler::OnError(
    int err)

当内部发生不可逆转错误时触发该回调

传入参数

OnAudioMixingFinished

virtual void IRtcEngineLiteEventHandler::OnAudioMixingFinished()

本地音乐文件播放已结束回调。 当调用 StartAudioMixing 启动的混音文件播放结束后，会触发该回调。

OnAudioMixingStateChanged

virtual void IRtcEngineLiteEventHandler::OnAudioMixingStateChanged(
    bytertc::AudioMixingState state,
    bytertc::AudioMixingError error)

音频混音文件播放状态改变时回调。此回调会被触发的时机汇总如下：
+ 当调用 StartAudioMixing 方法成功后， 会触发该 state 值为 kAudioMixingStatePlaying 回调； 否则触发 state 值为 kAudioMixingStateFailed 的回调。
+ 当调用 ResumeAudioMixing 方法恢复播放成功后， 会触发该 state 值为 kAudioMixingStatePlaying 回调； 否则触发 state 值为 kAudioMixingStateFailed 的回调。
+ 当调用 PauseAudioMixing 方法暂停播放后， 会触发该 state 值为 kAudioMixingStatePlaying 回调； 否则触发 state 值为 kAudioMixingStateFailed 的回调。
+ 当调用 StopAudioMixing 方法暂停止播放后， 会触发该 state 值为 kAudioMixingStatePlaying 回调； 否则触发 state 值为 kAudioMixingStateFailed 的回调。

传入参数

OnAudioEffectFinished

virtual void IRtcEngineLiteEventHandler::OnAudioEffectFinished(
    int sound_id)

本地音效文件播放已结束回调。 当调用 PlayEffect 方法开始播放指定音效文件， 音效文件播放结束后， 应用会收到该回调。

传入参数

OnLogReport

virtual void IRtcEngineLiteEventHandler::OnLogReport(
    const char* log_type,
    const char* log_content)

端监控日志回调。当产生一个端监控事件时触发该回调。

传入参数

OnConnecting

virtual void IRtcEngineLiteEventHandler::OnConnecting()

SDK 正在连接信令服务器回调。开始建连时触发。

注意

• 该回调已废弃，请使用 OnConnectionStateChanged 回调的 CONNECTION_STATE_CONNECTING 状态判断。

OnReconnecting

virtual void IRtcEngineLiteEventHandler::OnReconnecting()

SDK 正在重新连接信令服务器回调。开始重连时触发。

注意

• 该回调已废弃，请使用 OnConnectionStateChanged 回调的 CONNECTION_STATE_RECONNECTING 状态判断。

OnConnected

virtual void IRtcEngineLiteEventHandler::OnConnected()

SDK 已经连接上信令服务器回调。连接完成时触发。

注意

• 该回调已废弃，请使用 OnConnectionStateChanged 回调 的 CONNECTION_STATE_CONNECTED 或 CONNECTION_STATE_RECONNECTED 状态判断。

OnDisconnected

virtual void IRtcEngineLiteEventHandler::OnDisconnected()

SDK 与信令服务器连接断开回调。连接断开时触发。

注意

• 该回调已废弃，请使用 OnConnectionStateChanged 回调的 CONNECTION_STATE_DISCONNECTED 状态判断。

OnConnectionStateChanged

virtual void IRtcEngineLiteEventHandler::OnConnectionStateChanged(
    bytertc::CONNECTION_STATE state)

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

传入参数

OnNetworkTypeChanged

virtual void IRtcEngineLiteEventHandler::OnNetworkTypeChanged(
    bytertc::NetworkType type)

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

传入参数

OnMirrorStateChanged

virtual void IRtcEngineLiteEventHandler::OnMirrorStateChanged(
    bool mirrored)

当本地视频镜像状态改变时回调该事件。默认回调该事件。

传入参数

OnMediaDeviceStateChanged

virtual void IRtcEngineLiteEventHandler::OnMediaDeviceStateChanged(
    const char* device_id,
    bytertc::MediaDeviceType device_type,
    bytertc::MediaDeviceState device_state)

媒体设备开启、停止状态回调

传入参数

注意

当前正在使用中的设备开启成功/失败，停止成功/失败时回调该事件，目前仅支持音频录制设备和播放设备。

OnMediaDeviceNotification

virtual void IRtcEngineLiteEventHandler::OnMediaDeviceNotification(
    const char* device_id,
    bytertc::MediaDeviceType device_type,
    bytertc::MediaDeviceNotification notification_type)

媒体设备事件回调。

传入参数

注意

该回调包括了系统内媒体设备的事件通知，如设备的插入、拔出事件通知。

IRtcEngineEventHandler

class bytertc::IRtcEngineEventHandler

音视频引擎事件回调接口。
CreateByteRtcEngine 传入该回调实例。
详见 IRtcEngineLiteEventHandler 、IRTCRoomEventHandler

Defined in : byte_rtc_engine_event_handler.h