Public API

函数

函数说明

CreateByteRtcEngine

BYTE_API bytertc::IRtcEngine* bytertc::CreateByteRtcEngine(
    const char* app_id,
    bytertc::IRtcEngineEventHandler* event_handler)

创建 RTCEngine 实例。
此方法应该作为正常 SDK 流程中的第一步操作，通过创建一个 RTCEngine 实例，来使用 SDK 的其他能力。

传入参数

返回值

可用的 IRtcEngine 实例。

注意

• 该方法在第一次调用时初始化一个 RTCEngine 单例，除非调用 DestroyByteRtcEngine 方法，否则后续的所有调用均返回同一个实例。
• 连续多次调用该方法不会创建不同的 IRtcEngine 实例，仅第一次设置的 event_handler 是有效值，后续 的调用均会被忽略。
• 必须使用相同的 AppId，App 间才能进行通话。
• 在调用 DestroyByteRtcEngine 之后会销毁 IRtcEngine 实例，再次调用 CreateByteRtcEngine 方法则会重新创建一个全新的 IRtcEngine 实例。

CreateByteRtcEngineWithParameters

BYTE_API bytertc::IRtcEngine* bytertc::CreateByteRtcEngineWithParameters(
    const char* app_id,
    bytertc::IRtcEngineEventHandler* event_handler,
    const char* parameters)

创建 RTCEngine 实例。
此方法应该作为正常 SDK 流程中的第一步操作，通过创建一个 RTCEngine 实例，来使用 SDK 的其他能力。

传入参数

返回值

可用的 IRtcEngine 实例。

注意

• 该方法在第一次调用时初始化一个 RTCEngine 单例，除非调用 DestroyByteRtcEngine 方法，否则后续的所有调用均返回同一个实例。
• 连续多次调用该方法不会创建不同的 IRtcEngine 实例，仅第一次设置的 event_handler 是有效值，后续 的调用均会被忽略。
• 必须使用相同的 AppId，App 间才能进行通话。
• 在调用 DestroyByteRtcEngine 之后会销毁 IRtcEngine 实例，再次调用 CreateByteRtcEngine 方法则会重新创建一个全新的 IRtcEngine 实例。

DestroyByteRtcEngine

BYTE_API void bytertc::DestroyByteRtcEngine(
    bytertc::IRtcEngine* engine)

销毁由 CreateByteRtcEngine 创建的 RTCEngine 实例，并释放所有相关资源。

传入参数

注意

• 请确保一定是在所有业务场景的最后阶段才调用该方法。
• 该方法在调用之后，会销毁所有 SDK 相关的内存，并且停止与媒体服务器的任何交互。
• 在上一次 CreateByteRtcEngine 调用之后对 SDK 进行的任何设置， 将在下一次有效执行 CreateByteRtcEngine 时生效。
• 本方法为阻塞调用，会阻塞当前线程直到 SDK 彻底完成退出逻辑，因而需要注意不要在回调线程中 直接调用本方法，也需要注意不要在回调方法中等待主线程的执行而同时在主线程调用本方法，从而 造成死锁。

EnablePerformanceCollect

BYTE_API void bytertc::EnablePerformanceCollect(
    bool enable)

设置引擎是否开启性能采集功能，默认为开启。

传入参数

注意

• 开启后，SDK内部会采集CPU、内存使用量。可能会对性能有影响。
• 该接口会修改所有引擎实例的配置，是一个全局接口

GetErrorDescription

BYTE_API const char* bytertc::GetErrorDescription(
    int code)

获取错误码的描述

传入参数

返回值

错误码的描述

Feedback

BYTE_API int bytertc::Feedback(
    const char* data)

本次通话质量打分评价

传入参数

返回值

• 0: 成功
• -1: 上报失败，可能原因JoinChannel失败
• -2: 传入json解析失败
• -3: 传入json字段缺失
• -4: grade取值不合法

IRtcEngine

class bytertc::IRtcEngine

引擎API IRtcEngine用IRtcEngineEventHandler 注册接口类方法向应用程序发送回调通知

Defined in : byte_rtc_engine_interface.h

成员函数

函数说明

JoinChannel

virtual int bytertc::IRtcEngine::JoinChannel(
    const char* token,
    const char* channel_id,
    const char* uid,
    const char* info)

加入房间。用户调用此方法加入房间，在一个房间内的用户间可以相互通话。
用户调用 CreateByteRtcEngine 创建 RTC 引擎后，需调用此方法加入房间实现同其他用户进行音视频通话。如果用户调用此方法加入房间，则后续重复调用此方法均会失败，用户必须调用 LeaveChannel 退出当前房间后，才能加入下一个房间。
用户调用此方法加入房间成功后，会收到 OnJoinChannelSuccess 回调通知。

传入参数

返回值

方法调用结果。
+ 0: 成功
+ -1: channel_id 为空，失败
+ -2: uid 为空，失败

注意

• 使用不同 App ID 的 App 是不能互通的。
• 请务必保证生成 Token 使用的 App ID 和创建引擎时使用的 App ID 相同，否则会导致加入房间失败。
• 用户加入房间成功后，在本地网络状况不佳的情况下，SDK 可能会与服务器失去连接，此时 SDK 将会自动重连。重连成功后，本地会收到 OnRejoinChannelSuccess 回调通知。
• 房间模式（房间模式参考 SetChannelProfile ）为通话模式下的用户或直播、游戏、云游戏模式下用户角色（用户角色参考 SetClientRole ）为主播、观众的用户加入房间成功后，远端用户会收到 OnUserJoined 回调通知。
• 同一个 App ID 的同一个房间内，每个用户的用户ID 必须是唯一的。如果两个用户的用户ID 相同，则后加入房间的用户会将先加入房间的用户踢出房间，并且先加入房间的用户会收到 OnError 回调通知，错误类型为重复登录 BRERR_DUPLICATE_LOGIN 。

IRtcEngineLite

class bytertc::IRtcEngineLite

引擎 API

Defined in : byte_rtc_engine_lite_interface.h

成员函数

函数说明

GetVersion

virtual const char* bytertc::IRtcEngineLite::GetVersion(
    int* build)

获取当前 SDK 版本信息。

传入参数

返回值

当前 SDK 版本信息。

SetRecordingVolume

virtual void bytertc::IRtcEngineLite::SetRecordingVolume(
    const int volume)

调节音频采集音量

传入参数

注意

为保证更好的通话质量，建议将 volume 值设为 [0,100]。

SetPlaybackVolume

virtual void bytertc::IRtcEngineLite::SetPlaybackVolume(
    const int volume)

调节本地播放的所有远端用户混音后的音量

传入参数

注意

为保证更好的通话质量，建议将 volume 值设为 [0,100]。

StartMixScreenAudioToMainStream

virtual void bytertc::IRtcEngineLite::StartMixScreenAudioToMainStream()

开启声卡采集，将声卡播放的音频流合到本地采集的音频流中。
如果你希望将声卡播放的声音传输到远端（比如屏幕共享等场景），你必须开启声卡采集。如此，声卡播放的声音会合到本地采集的音频流在中，一起发送到远端。

注意

• 开启声卡采集后，你可以设置对应音量，参看 SetScreenAudioVolumeBeforeMixing
• 如果需要关闭声卡采集，参看 StopMixScreenAudioToMainStream

StopMixScreenAudioToMainStream

virtual void bytertc::IRtcEngineLite::StopMixScreenAudioToMainStream()

关闭声卡采集，声卡播放的音频流不再合到本地采集的音频流中。

注意

如果需要开启声卡采集，请参看 StartMixScreenAudioToMainStream

SetScreenAudioVolumeBeforeMixing

virtual void bytertc::IRtcEngineLite::SetScreenAudioVolumeBeforeMixing(
    int volume)

调节本地声卡采集音量。
开启本地声卡采集后，你可以使用此接口调节采集音量。 关于如何开启本地声卡采集，参考 StartMixScreenAudioToMainStream。

传入参数

EnableLocalAudio

virtual int bytertc::IRtcEngineLite::EnableLocalAudio(
    bool enable)

开启/关闭本地音频采集。
调用该方法后，房间中的其他用户会收到 OnUserEnableLocalAudio 事件回调。

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

注意

关闭本地音频采集后，依然会编码发送静音包，因此依然会有少量 CPU 和 网络带宽开销。

MuteLocalAudio

virtual void bytertc::IRtcEngineLite::MuteLocalAudio(
    MuteState mute_state)

控制本地音频流的发送状态：发送/不发送
使用此方法后，房间中的其他用户会收到回调： OnUserMuteAudio

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

注意

本方法仅控制本地音频流的发送状态，并不影响本地音频采集状态。

SetExternalAudioSource

virtual void bytertc::IRtcEngineLite::SetExternalAudioSource(
    bool enable,
    int sample_rate,
    unsigned int record_channels,
    unsigned int playout_channels)

设置是否启用外部音频采集渲染。

传入参数

注意

• 该方法应该在 JoinChannel 前使用
• 启用自定义音频采集渲染后，使用 PushExternalAudioFrame 推送音频数据。
• 启用自定义音频采集渲染后，使用 PullExternalAudioFrame 拉取音频数据。

SetAudioDeviceObserver

virtual void bytertc::IRtcEngineLite::SetAudioDeviceObserver(
    IAudioDeviceObserver* obs)

启动音频外部源采集渲染时，添加音频外部设备事件监控

传入参数

PushExternalAudioFrame

virtual bool bytertc::IRtcEngineLite::PushExternalAudioFrame(
    int8_t* data,
    int samples)

推送外部音频数据。使用 SetExternalAudioSource 启用自定义音频采集渲染后，可以使用本方法推送外部音频数据。

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

注意

• 必须是 pcm 数据，推送间隔是 10ms，音频采样格式为 s16。
• 该函数运行在用户调用线程内，是一个同步函数

PullExternalAudioFrame

virtual bool bytertc::IRtcEngineLite::PullExternalAudioFrame(
    int8_t* data,
    int samples)

拉取远端音频数据。使用 SetExternalAudioSource 启用自定义音频采集渲染后，可以使用本方法拉取远端音频数据。

传入参数

返回值

方法调用结果
+ true:方法调用成功
+ false：方法调用失败

注意

• 必须是 pcm 数据，拉取间隔是 10ms，音频采样格式为 s16。
• 该函数运行在用户调用线程内，是一个同步函数

StartAudioMixing

virtual int bytertc::IRtcEngineLite::StartAudioMixing(
    const char* file_path,
    bool loopback,
    bool replace,
    int cycle)

开始播放音乐文件及混音。

传入参数

返回值

• 0: 成功
• <0: 失败

注意

• 该方法指定本地和麦克风采集的音频流进行混音或替换。替换是指用音频文件替换麦克风采集的音频流。
• 该方法可以选择是否让对方听到本地播放的音频，并指定循环播放的次数。 调用本方法播放音乐文件及混音结束后，应用会收到 OnAudioMixingFinished 回调。
• 开始播放音乐文件及混音后，可以调用 StopAudioMixing 方法停止播放音乐文件。
• 该方法混音数据来源外部文件，且支持的文件格式有: mp3，aac，m4a，3gp，wav；而SetAudioPlayoutMixStream 混音的数据来源外部缓存且音频格式为PCM；这两种混音方式可以共存。
• 单个房间只支持一路音乐文件的播放，多次调用该函数后，只有最后一次调用会生效。
• 请在房间内调用该方法。

StopAudioMixing

virtual void bytertc::IRtcEngineLite::StopAudioMixing()

停止播放音乐文件及混音

注意

• 调用 StartAudioMixing 方法开始播放音乐文件及混音后，调用该方法可以停止播放音乐文件及混音。
• 请在房间内调用该方法。

PauseAudioMixing

virtual int bytertc::IRtcEngineLite::PauseAudioMixing()

暂停播放音乐文件

返回值

• 0: 成功
• <0: 失败

注意

• 调用 StartAudioMixing 方法开始播放音乐文件及混音后，可以通过调用该方法暂停播放音乐文件。
• 调用该方法暂停播放音乐文件后，可调用 ResumeAudioMixing 方法恢复播放。
• 请在房间内调用该方法。

ResumeAudioMixing

virtual int bytertc::IRtcEngineLite::ResumeAudioMixing()

恢复播放音乐文件

返回值

• 0: 成功
• <0: 失败

注意

• 调用 PauseAudioMixing 方法暂停播放音乐文件后，可以通过调用该方法恢复播放。
• 请在房间内调用该方法

AdjustAudioMixingVolume

virtual int bytertc::IRtcEngineLite::AdjustAudioMixingVolume(
    int volume)

调节音乐文件的文件音量。为保证更好的音质，建议将 volume 值设为 [0,100]。

传入参数

返回值

• 0: 成功
• <0: 失败

注意

• 调用该方法可同时调节的是本地和远端播放音量。仅调节本端音量可使用 AdjustAudioMixingPlayoutVolume ， 仅调节远端音量可使用 AdjustAudioMixingPublishVolume。
• 该方法对 AdjustAudioMixingPlayoutVolume 和 AdjustAudioMixingPublishVolume 的音量调节影响是乘积关系。
• 请在房间内调用该方法。

AdjustAudioMixingPlayoutVolume

virtual int bytertc::IRtcEngineLite::AdjustAudioMixingPlayoutVolume(
    int volume)

调节音乐文件的本地播放音量。为保证更好的音质，建议将 volume 值设为 [0,100]。

传入参数

返回值

• 0: 成功
• <0: 失败

注意

• 调用该方法可以调节混音的音乐文件在本地播放的音量大小。如果需要同时调节本地和远端播放音量可使用 AdjustAudioMixingVolume 方法。
• 请在房间内调用该方法。

AdjustAudioMixingPublishVolume

virtual int bytertc::IRtcEngineLite::AdjustAudioMixingPublishVolume(
    int volume)

调节音乐文件的远端播放音量。为保证更好的音质，建议将 volume 值设为 [0,100]。

传入参数

返回值

• 0: 成功
• <0: 失败

注意

• 该方法调节混音的音乐文件在远端播放的音量大小。如果需要同时调节本地和远端播放音量可使用 AdjustAudioMixingVolume 方法。
• 请在房间内调用该方法。

GetAudioMixingDuration

virtual int bytertc::IRtcEngineLite::GetAudioMixingDuration()

获取音乐文件时长

返回值

• >0: 成功, 音乐文件时长，单位为毫秒。
• <0: 失败

注意

请在房间内调用该方法。

GetAudioMixingCurrentPosition

virtual int bytertc::IRtcEngineLite::GetAudioMixingCurrentPosition()

获取音乐文件播放进度

返回值

• >0: 成功, 音乐文件播放进度，单位为毫秒。
• <0: 失败

注意

请在房间内调用该方法。

SetAudioMixingPosition

virtual int bytertc::IRtcEngineLite::SetAudioMixingPosition(
    int pos)

设置音频文件的播放位置

传入参数

返回值

• 0: 成功
• <0: 失败

注意

该方法可以设置音频文件的播放位置，这样你可以根据实际情况从指定的位置播放音乐文件，无需从头到尾完整播放一个音乐文件。

GetEffectVolume

virtual int bytertc::IRtcEngineLite::GetEffectVolume(
    int sound_id)

获取指定音效文件的文件音量

传入参数

返回值

• >0: 成功，文件音量，音量范围为 0~400。
• <0: 失败

注意

请在房间内调用该方法。

SetVolumeOfEffect

virtual int bytertc::IRtcEngineLite::SetVolumeOfEffect(
    int sound_id,
    int volume)

调节指定音效文件的文件音量

传入参数

返回值

• 0: 成功
• <0: 失败

注意

• 该方法调节音效文件在本地和远端播放的音量大小。
• 请在房间内调用该方法。

PlayEffect

virtual int bytertc::IRtcEngineLite::PlayEffect(
    int sound_id,
    const char* file_path,
    bool loopback,
    int cycle,
    int volume)

开始播放指定音效文件。你可以在该方法中设置音效文件的播放次数、音量大小，以及远端用户是否能听到该音效。

传入参数

返回值

• 0: 成功
• <0: 失败

注意

• 调用该方法播放音效结束后，应用会收到 OnAudioEffectFinished 回调。
• 可以多次调用该方法，通过传入不同的音效文件的 sound_id 和 file_path，以实现同时播放多个音效文件，实现音效叠加。
• 可以调用 StopEffect 方法停止播放指定音效文件。
• 请在房间内调用该方法。

PreloadEffect

virtual int bytertc::IRtcEngineLite::PreloadEffect(
    int sound_id,
    const char* file_path)

预加载指定音效文件。

传入参数

返回值

• 0: 成功
• <0: 失败

注意

+ 调用该方法预加载播放指定音效文件。预加载操作可以在进房间之前完成（所有混音相关接口，如果没有标注请在房间内调用都可在没有进入房间的时候调用）。如果音效文件很长，加载操作可能会耗时较长，建议应用开发者将预加载操作放在子线程进行。

• 该方法只是预加载播放指定音效文件，只有调用 PlayEffect 方法才开始播放指定音效文件。

• 该方法预加载指定音效文件可以通过 UnloadEffect 来卸载。

UnloadEffect

virtual int bytertc::IRtcEngineLite::UnloadEffect(
    int sound_id)

卸载指定音效文件

传入参数

返回值

• 0: 成功
• <0: 失败

注意

• 调用该方法卸载指定音效文件。
• 如果调用 StopEffect 方法时，音效文件没有被卸载，SDK会自动调用该方法卸载音效文件。

StopEffect

virtual int bytertc::IRtcEngineLite::StopEffect(
    int sound_id)

停止播放指定音效文件

传入参数

返回值

• 0: 成功
• <0: 失败

注意

• 调用该方法停止播放指定音效文件。
• 该方法内部会主动调用 UnloadEffect 来卸载指定音效文。

PauseEffect

virtual int bytertc::IRtcEngineLite::PauseEffect(
    int sound_id)

暂停播放指定音效文件

传入参数

返回值

• 0: 成功
• <0: 失败

注意

调用该方法暂停播放指定音效文件，可以调用 ResumeEffect 方法恢复播放。

ResumeEffect

virtual int bytertc::IRtcEngineLite::ResumeEffect(
    int sound_id)

恢复播放指定音效文件

传入参数

返回值

• 0: 成功
• <0: 失败

注意

• 调用 PauseEffect 方法暂停播放指定音效文件后， 可以通过该方法恢复播放。
• 调用 PauseAllEffects 方法暂停所有音效文件的播放后，也可以通过该方法恢复单个音效文件播放。

SetEffectsVolume

virtual void bytertc::IRtcEngineLite::SetEffectsVolume(
    int volume)

调节所有音效文件的文件音量

传入参数

注意

• 该方法调节混音的所有音效文件在本地和远端播放的音量大小。
• 请在房间内调用该方法。

StopAllEffects

virtual void bytertc::IRtcEngineLite::StopAllEffects()

停止所有音效文件的播放

注意

该方法停止所有音效文件的播放。

PauseAllEffects

virtual void bytertc::IRtcEngineLite::PauseAllEffects()

暂停所有音效文件的播放。

注意

调用该方法暂停所有音效文件的播放，可调用 ResumeAllEffects 方法恢复播放。

ResumeAllEffects

virtual void bytertc::IRtcEngineLite::ResumeAllEffects()

恢复所有音效文件的播放

注意

• 调用该方法恢复所有音效文件的播放。在调用 PauseAllEffects 暂停所有音效文件的播放后，可以调用该方法可恢复所有音效文件的播放。
• 调用 PauseEffect 方法暂停单个指定音效文件的播放后，也可以调用该方法恢复播放，但是效率太低，不推荐这么使用。

UnloadAllEffects

virtual void bytertc::IRtcEngineLite::UnloadAllEffects()

卸载所有音效文件

注意

• 调用该方法卸载所有音效文件。如果引擎被销毁时有音效文件没有被卸载，SDK会自动调用该方法卸载所有音效文件。

• 调用 IRtcRoom::LeaveChannel 离开房间后，不会自动调用该方法卸载所有音效文件。如果需要在离开房间后卸载所有音效文件，需要应用主动调用该方法。

SetAudioPlayoutMixStream

virtual void bytertc::IRtcEngineLite::SetAudioPlayoutMixStream(
    bool enable,
    int sample_rate,
    int channel_num)

启动/停止外部音频流混音， 并设置混音数据格式

传入参数

注意

• 调用该方法设置外部音频混音的PCM格式，即 PushAudioMixingStreamData 的 audio_frame 的音频数据格式。
• 调用该方法混音的数据来源外部缓存，且音频格式为PCM； StartAudioMixing 方法混音数据来源外部文件，且支持的文件格式有: mp3，aac，m4a，3gp，wav。这两种混音方式可以共存。
• enable 为 false 时，停止外部音频流混音。 或者引擎释放时，SDK内部会停止混音。
• 该方法启动的外部音频流混音不支持音量调节，暂停，暂停恢复操作。

GetAudioMixingStreamCachedFrameNum

virtual int bytertc::IRtcEngineLite::GetAudioMixingStreamCachedFrameNum()

获取SDK当前缓冲数据

返回值

• >0: 成功，缓冲的音频采样点个数。
• 0: 失败

注意

调用该方法可以实时获取缓存数据量，并以此数据为基准调整数据推送节奏来避免内存溢出

PushAudioMixingStreamData

virtual bool bytertc::IRtcEngineLite::PushAudioMixingStreamData(
    int8_t* audio_frame,
    int frame_num)

向SDK推送混音的音频数据

传入参数

返回值

• true: 成功
• false: 失败

注意

• 调用该方法前，必须通过 SetAudioPlayoutMixStream 方法设置 audio_frame 的数据格式。
• 调用该方法前，先通过 GetAudioMixingStreamCachedFrameNum 获取缓存的数据量，并调整推送数据的节奏以避免内部缓存溢出导致推送失败。
• 使用参考建议：首次推送数据，请在应用侧先缓存一定数据（如 200 毫秒）， 然后一次性推送过去；此后的推送操作定时 10 毫秒一次，并且每次的音频数据量为 10 毫秒数据量。

EnableLocalVideo

virtual int bytertc::IRtcEngineLite::EnableLocalVideo(
    bool enable)

该方法开启或关闭本地视频采集。本地视频采集默认为开启。
调用该方法后，房间中的其他用户会收到 OnUserEnableLocalVideo 回调。

传入参数

返回值

• 0：方法调用成功
• <0：方法调用失败

注意

• 关闭本地视频采集后，不会编码发送视频数据。
• 该方法在 JoinChannel 前可以调用。
• 该方法设置的是内部引擎为启用或禁用状态，在 LeaveChannel 后仍然有效。

SetVideoEncoderConfig

virtual int bytertc::IRtcEngineLite::SetVideoEncoderConfig(
    const VideoSolution* solutions,
    int solution_num)

启动推送多路视频流，设置推送多路流时的各路视频参数， 包括分辨率，帧率，码率，缩放模式，网络不佳时的回退策略等。

传入参数

返回值

• 0：成功
• !0：失败

注意

• 视频参数数组中，分辨率必须是依次减小，从大到小排列的。
• 最大分辨率没有限制。但是如果设置的分辨率无法编码，就会导致编码推流失败。
• 数组元素不超过3个。

SetLocalVideoCanvas

virtual int bytertc::IRtcEngineLite::SetLocalVideoCanvas(
    StreamIndex index,
    const VideoCanvas& canvas)

设置本地视频渲染时，使用的视图，并设置渲染模式。
你应在加入房间前，绑定本地视图。退出房间后，此设置仍然有效。 如果需要解除绑定，你可以调用本方法绑定空视图。

传入参数

返回值

• 0：成功
• !0：失败

SetLocalVideoRender

virtual int bytertc::IRtcEngineLite::SetLocalVideoRender(
    IVideoSink* sink)

设置本地视频渲染器 该方法设置本地视频外部渲染器。应用程序通过调用此接口绑定本地视频流的渲染器canvas。 在应用程序开发中，通常在初始化后调用该方法进行本地视频设置，然后再加入频道。退出频道后，绑定仍然有效， 如果需要解除绑定，可以指定空的VideoSink。

传入参数

返回值

• 0: 成功；
• !0: 失败；

SetLocalScreenRender

virtual int bytertc::IRtcEngineLite::SetLocalScreenRender(
    IVideoSink* sink)

设置屏幕共享本地渲染器 该方法设置屏幕共享本地外部渲染器。应用通过调用此接口绑定本地屏幕共享流的渲染器 IVideoSink 。 在应用开发中，通常在初始化后调用该方法进行本地屏幕共享设置，然后再加入房间。退出房间后，绑定仍然有效， 如果需要解除绑定，可以指定空的 VideoSinkIVideoSink。

传入参数

返回值

0 :成功； -1 :失败；

MuteLocalVideo

virtual int bytertc::IRtcEngineLite::MuteLocalVideo(
    MuteState muteState)

停止/启动发送本地视频流，默认不发送。
无论你使用 SDK 的视频采集编码功能，还是使用自定义采集功能，你都应使用此接口启动发送本地视频流。 调用该方法后，房间中的其他用户会收到 OnUserMuteVideo 的回调。

传入参数

返回值

• 0：成功
• !0：失败

注意

本方法只是停止本地视频流的发送，不影响视频采集状态。

StartPreview

virtual int bytertc::IRtcEngineLite::StartPreview()

开启本地视频预览

返回值

• 0：成功
• !0：失败

注意

• 只有和 EnableLocalVideo 一起调用才会真正打开相机。
• 进入房间自动发布流，也会自动打开相机。

StopPreview

virtual int bytertc::IRtcEngineLite::StopPreview()

停止本地视频预览

返回值

• 0：成功
• !0：失败

注意

退出房间会自动关闭相机

SwitchCamera

virtual int bytertc::IRtcEngineLite::SwitchCamera()

切换前后摄像头

返回值

• 0：成功
• !0：失败

注意

• 移动平台可用，PC平台不可用。
• 如果本地有多个摄像头且想选择特定工作摄像头可通过 IVideoDeviceManager 类来控制

PushScreenFrame

virtual bool bytertc::IRtcEngineLite::PushScreenFrame(
    IByteVideoFrame* frame)

发送屏幕共享本地视频数据

传入参数

返回值

• true :成功；
• false :失败；

注意

• 暂时只支持 YUV420P 格式的视频帧。
• 该函数运行在用户调用线程内，即将销毁 RtcEngine 实例前，请停止调用该函数推送屏幕共享数据

StartScreenCaptureByWindowId

virtual int bytertc::IRtcEngineLite::StartScreenCaptureByWindowId(
    view_t window_id,
    const Rectangle& region_rect,
    const DesktopCaptureParameters& capture_params)

该方法共享一个窗口或该窗口的部分区域。用户需要在该方法中指定想要共享的窗口 id 。

传入参数

返回值

• 0: 成功；
• -1: 失败；

注意

• 本函数和 PublishScreen 互斥使用，当调用 StopScreenCapture 后方可再用 PublishScreen。
• 本函数和 StopScreenCapture 是成对调用的。
• 在收到 OnFirstRemoteScreenFrame 事件后通过调用 SetupRemoteScreen 或 SetRemoteScreenRender 函数来设置远端屏幕共享视图。
• 本地可调用 SetupLocalScreen 或 SetLocalScreenRender 函数设置本地屏幕共享视图。
• 也可通过注册 RegisterVideoFrameObserver 视频回调对象，监听 OnLocalScreenFrame 本地屏幕视频回调事件和 OnRemoteScreenFrame 远端屏幕共享视频回调事件来获取原始数据。

StartScreenCaptureByScreenRect

virtual int bytertc::IRtcEngineLite::StartScreenCaptureByScreenRect(
    const Rectangle& screen_rect,
    const Rectangle& region_rect,
    const DesktopCaptureParameters& capture_params)

通过指定区域共享屏幕，共享一个屏幕或该屏幕的部分区域。用户需要在该方法中指定想要共享的屏幕区域。

传入参数

返回值

• 0: 成功；
• -1: 失败；

注意

• 本函数和 PublishScreen 互斥使用，当调用 StopScreenCapture 后方可再用 PublishScreen。
• 本函数和 StopScreenCapture 是成对调用的
• 在收到 OnFirstRemoteScreenFrame 事件后通过调用 SetupRemoteScreen 或 SetRemoteScreenRender 函数来设置远端屏幕共享视图。
• 本地可调用 SetupLocalScreen 或 SetLocalScreenRender 函数设置本地屏幕共享视图。
• 也可通过注册 RegisterVideoFrameObserver 视频回调对象，监听 OnLocalScreenFrame 本地屏幕视频回调事件和 OnRemoteScreenFrame 远端屏幕共享视频回调事件来获取原始数据。

StartScreenCaptureByDisplayId

virtual int bytertc::IRtcEngineLite::StartScreenCaptureByDisplayId(
    unsigned int display_id,
    const Rectangle& region_rect,
    const DesktopCaptureParameters& capture_params)

通过屏幕 id 共享屏幕，共享一个屏幕或该屏幕的部分区域。用户需要在该方法中指定想要共享的屏幕 id 。

传入参数

返回值

• 0: 成功；
• -1: 失败；

注意

共享一个窗口或该窗口的部分区域。需要在该方法中指定想要共享的窗口 id 。

UpdateScreenCaptureRegion

virtual int bytertc::IRtcEngineLite::UpdateScreenCaptureRegion(
    const Rectangle& region_rect)

更新屏幕共享区域。

传入参数

返回值

• 0: 成功；
• -1: 失败；

UpdateScreenCaptureParameters

virtual int bytertc::IRtcEngineLite::UpdateScreenCaptureParameters(
    const DesktopCaptureParameters& capture_params)

更新屏幕共享的编码参数配置。

传入参数

返回值

• 0: 成功；
• -1: 失败；

StopScreenCapture

virtual void bytertc::IRtcEngineLite::StopScreenCapture()

停止屏幕或者窗口共享。

注意

• 本函数必须在 StartScreenCaptureByScreenRect 或者 StartScreenCaptureByWindowId 之后调用
• 本函数不可和 PublishScreen 、UnpublishScreen 混用。

GetScreenCaptureSourceList

virtual IScreenCaptureSourceList* bytertc::IRtcEngineLite::GetScreenCaptureSourceList()

获取共享对象(应用窗口和桌面)列表, 使用完之后需要调用对应的release接口释放

GetThumbnail

virtual IByteVideoFrame* bytertc::IRtcEngineLite::GetThumbnail(
    ScreenCaptureSourceType type,
    view_t source_id,
    int max_width,
    int max_height)

获取共享对象缩略图

SetExternalVideoSource

virtual void bytertc::IRtcEngineLite::SetExternalVideoSource(
    bool enable)

设置外部视频输入源

传入参数

注意

该方法应该在 StartPreview 与 JoinChannel 前使用

PushExternalVideoFrame

virtual bool bytertc::IRtcEngineLite::PushExternalVideoFrame(
    IByteVideoFrame* frame)

发送外部源视频数据

传入参数

注意

• 暂时只支持 YUV420P 格式的视频帧。
• 该函数运行在用户调用线程内

SetPublishFallbackOption

virtual int bytertc::IRtcEngineLite::SetPublishFallbackOption(
    int option)

设置发布的音视频流回退选项

传入参数

返回值

• 0: 方法调用成功
• <0: 方法调用失败

注意

• 1. 在网络情况不理想、设备性能不足时，实时音视频的质量会下降。通过这个接口来设置网络情况不佳或性能不足时只发送小流，以保证通话质量。

• 1. 这个方法只在设置了发送多个流的情况下有效。
• 1. 必须在进房前设置，进房后设置或更改设置无效。
• 1. 设置回退选项后，本端发布的音视频流发生回退或从回退中恢复时，对端会收到 OnRemoteStreamSwitch 回调通知。

SetSubscribeFallbackOption

virtual int bytertc::IRtcEngineLite::SetSubscribeFallbackOption(
    SubscribeFallbackOptions option)

设置订阅的音视频流回退选项

传入参数

返回值

0: 方法调用成功
+ <0: 方法调用失败

注意

• 1. 在网络情况不理想、设备性能不足时，实时音视频的质量会下降。通过这个接口来设置网络情况不佳或性能不足时只订阅小流或音频流，以保证通话质量。

• 1. 必须在进房前设置，进房后设置或更改设置无效。
• 1. 设置回退选项后，本端订阅的音视频流发生回退或从回退中恢复时,会收到 OnRemoteStreamSwitch 回调通知。
• 1. 设置回退选项后，本端订阅的视频流因为回退分辨率发生变化时,会收到 OnVideoSizeChanged 回调通知。

SetRemoteUserPriority

virtual int bytertc::IRtcEngineLite::SetRemoteUserPriority(
    const char* user_id,
    RemoteUserPriority priority)

设置用户优先级

传入参数

返回值

0: 方法调用成功
+ <0: 方法调用失败

注意

• 1. 该方法与 SetSubscribeFallbackOption 搭配使用。
• 1. 如果开启了订阅流回退选项，弱网或性能不足时会优先保证收到的高优先级用户的流的质量。
• 1. 该方法在进房前后都可以使用，可以修改远端用户的优先级。

SetBusinessId

virtual int bytertc::IRtcEngineLite::SetBusinessId(
    const char* business_id)

设置业务标识参数。
可通过 business_id 区分不同的业务场景（角色/策略等）。business_id 由客户自定义，相当于一个“标签”， 可以分担和细化现在 AppId 的逻辑划分的功能。

传入参数

返回值

• 0： 成功。
• <0： 失败，具体原因参照 BusinessCheckCode 。
• -6001： 用户已经在房间中。
• -6002： 输入非法，合法字符包括所有小写字母、大写字母和数字，除此外还包括四个独立字符分别是：英文句号，短横线，下划线和 @ 。

注意

• 需要在调用 JoinChannel 之前调用，JoinChannel之后调用该方法无效。

ReplaceBackground

virtual int bytertc::IRtcEngineLite::ReplaceBackground(
    BACKGROUND_MODE mode,
    DIVIDE_MODEL divide_model)

开启背景并设置背景模式与分割模式

传入参数

返回值

• 0：成功
• !0：失败

DisableBackground

virtual void bytertc::IRtcEngineLite::DisableBackground()

关闭背景

SetLocalVideoMirrorMode

virtual void bytertc::IRtcEngineLite::SetLocalVideoMirrorMode(
    MirrorMode mirrorMode)

设置采用前置摄像头采集时，是否开启镜像模式。
调用后，你会收到回调：OnMirrorStateChanged

传入参数

GetLocalVideoMirrorMode

virtual bool bytertc::IRtcEngineLite::GetLocalVideoMirrorMode()

获得当前本地镜像状态

返回值

• true：是镜像模式
• false：不是镜像模式

SetAudioPerformanceProfile

virtual void bytertc::IRtcEngineLite::SetAudioPerformanceProfile(
    AudioPerformanceProfile profile)

通过设置音频处理策略等级，获得不同的音频处理质量。默认使用 auto 模式。
此设置会影响音频采集端在音频采集后，发送前对音频的处理策略，达成不同的处理效果；
也会影响音频接收端在音频流接收后，播放前对音频的处理策略，达成不同的处理效果。
你应使用此方法，实现音频体验和系统性能占用之间的平衡:
如果你希望系统性能占用较低，你应设置较低的策略等级；如果你更在意音频质量，你应选择设置更高的策略等级。
一般情况下，你可使用 auto 模式（默认）。此时，sdk 会根据应用所在机型等级，自动适配音频处理策略。

传入参数

注意

• 如果你希望在此次音视频通话中设置音频处理策略等级，你必须在进房前调用此方法。
• 如果在进房后调用此方法，下次进房时才会应用你设置的策略等级。
• 如果以下策略无法满足需求，请联系技术支持人员实现自定义配置。

SetEncryptInfo

virtual void bytertc::IRtcEngineLite::SetEncryptInfo(
    ByteEngineEncryptType encrypt_type,
    const char* key,
    int key_size)

设置AES加密算法和加密密钥
有四种内置的加密算法，详见 ByteEngineEncryptType

传入参数

注意

• 该方法与 SetCustomizeEncryptHandler 为互斥关系，只能使用自定义加密方法和默认加密方式的一种。 即按照调用顺序，最后一个调用的方法为最终生效的版本
• 该方法必须在调用 JoinChannel 之前调用，可重复调用，以最后调用的参数作为生效参数
• AES加密算法限制，超过36位的key会被截断，仅取前36位

SetCustomizeEncryptHandler

virtual void bytertc::IRtcEngineLite::SetCustomizeEncryptHandler(
    IByteEngineEncryptHandler* handler)

设置自定义加密
需要实现对应的加密/解密方法，详情参考 ByteEngineEncryptType

传入参数

注意

• 该方法与 SetEncryptInfo 为互斥关系，即按照调用顺序， 最后一个调用的方法为最终生效的版本
• 该方法必须在调用 JoinChannel 之前调用，可重复调用，以最后调用的参数作为生效参数
  + 无论加密或者解密，其对原始数据的长度修改，需要控制在90%-120%之间，即如果输入数据为100字节，则处理完成后的数据必须在 90至120字节之间，如果加密或解密结果超出该长度限制，则该音视频帧会被丢弃
  + 数据加密/解密为串行执行，因而视实现方式不同，可能会影响到最终渲染效率，是否使用该方法，需要由使用方谨慎评估

SetRecordingAudioFrameParameters

virtual void bytertc::IRtcEngineLite::SetRecordingAudioFrameParameters(
    int sample_rate,
    int channels)

设置本地麦克风录制的音频数据回调参数

传入参数

注意

使用本方法设置参数，并使用RegisterAudioFrameObserver注册数据观察者，之后可以在IAudioFrameObserver的 OnRecordAudioFrame收到数据

SetPlaybackAudioFrameParameters

virtual void bytertc::IRtcEngineLite::SetPlaybackAudioFrameParameters(
    int sample_rate,
    int channels)

设置远端所有用户音频数据混音后的音频数据回调参数

传入参数

注意

使用本方法设置参数，并使用RegisterAudioFrameObserver注册数据观察者，之后可以在IAudioFrameObserver的 OnPlaybackAudioFrame收到数据

SetMixedAudioFrameParameters

virtual void bytertc::IRtcEngineLite::SetMixedAudioFrameParameters(
    int sample_rate,
    int channels)

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

传入参数

注意

使用本方法设置参数，并使用RegisterAudioFrameObserver注册数据观察者，之后可以在IAudioFrameObserver的 OnMixedAudioFrame收到数据

RegisterAudioFrameObserver

virtual void bytertc::IRtcEngineLite::RegisterAudioFrameObserver(
    IAudioFrameObserver* observer)

注册音频数据回调观察者

传入参数

注意

本方法需要与下面3个方法配合使用：SetRecordingAudioFrameParameters、 SetPlaybackAudioFrameParameters、 SetMixedAudioFrameParameters

RegisterVideoFrameObserver

virtual void bytertc::IRtcEngineLite::RegisterVideoFrameObserver(
    IVideoFrameObserver* observer)

注册视频数据回调观察者

传入参数

注意

• 该方法可以在任意时间调用，建议在 JoinChannel 前。
• 本接口支持动态取消注册，将参数设置为 nullptr 取消注册。

RegisterMetadataObserver

virtual void bytertc::IRtcEngineLite::RegisterMetadataObserver(
    IMetadataObserver* observer)

注册 metadata 观察者，用于接收或发送 metadata，底层通过在视频帧中添加 SEI 数据实现该功能。
注册观察者后，发送的视频帧里面没有 SEI 信息， 会触发 OnReadyToSendMetadata 回调。
注册观察者后，接收的视频帧里面有 SEI 信息，会触发接收 OnMetadataReceived 回调。

传入参数

注意

• 使用视频自定义采集与渲染时，可以直接在视频帧中添加与获取 metadata，不建议使用本接口。
• 本接口支持动态取消注册，将参数设置为 nullptr 取消注册。

EnableAutoPublish

virtual void bytertc::IRtcEngineLite::EnableAutoPublish(
    bool auto_publish)

设置引擎自动发布属性

传入参数

注意

设置引擎是否自动发布用户的本地流，必须在joinChannel前调用。engine引擎默认auto_publish为true。当auto_publish为true时engine->publish()、 engine->unpublish()接口不应当被调用。

GetVideoDeviceManager

virtual IVideoDeviceManager* bytertc::IRtcEngineLite::GetVideoDeviceManager()

创建视频设备管理实例

传入参数

返回值

视频设备管理实例，详见IVideoDeviceManager

注意

当不再使用IVideoDeviceManager实例时，调用该实例的 Release接口，以免资源泄露

GetAudioDeviceManager

virtual IAudioDeviceManager* bytertc::IRtcEngineLite::GetAudioDeviceManager()

设备音频管理接口创建

传入参数

返回值

音频设备管理接口

RegisterRemoteAudioFrameObserver

virtual void bytertc::IRtcEngineLite::RegisterRemoteAudioFrameObserver(
    IRemoteAudioFrameObserver* observer)

注册音频数据回调观察者

传入参数

注意

注册该回调，可以收到单个远端用户的PCM数据

SetRuntimeParameters

virtual void bytertc::IRtcEngineLite::SetRuntimeParameters(
    const char * json_string)

设置运行时的参数

传入参数

IRtcRoom

class bytertc::IRtcRoom

房间接口

Defined in : byte_rtc_room_interface.h

成员函数

函数说明

SetClientRole

virtual void bytertc::IRtcRoom::SetClientRole(
    CLIENT_ROLE_TYPE role)

设置用户角色。
用户可通过设置用户角色，控制：1.是否发布音视频流；2.用户自身是否在房间中隐身。详见用户角色 CLIENT_ROLE_TYPE。
默认用户角色为主播角色 CLIENT_ROLE_BROADCASTER
房间模式（通过调用接口 SetChannelProfile 可设置房间模式）为直播模式、游戏模式、云游戏模式时，设置用户角色生效。房间模式为通信模式时不区分用户角色。

传入参数

注意

• 在加入房间前，用户可调用此方法设置用户角色。加入房间后，用户也可通过此方法切换用户角色。
• 用户在加入房间成功后调用该方法切换用户角色，调用成功后，远端用户会收到相应的回调通知：1.用户角色从静默观众切换至观众或主播时会收到 OnUserJoined 回调通知；2.用户角色从观众或主播切换至静默观众时会收到 OnUserOffline 回调通知。

SetChannelProfile

virtual void bytertc::IRtcRoom::SetChannelProfile(
    CHANNEL_PROFILE_TYPE profile_type)

设置房间模式。
通过设置房间模式，用户可以选择应用 SDK 针对不同房间模式场景的优化策略。
默认的房间模式为通信模式 CHANNEL_PROFILE_COMMUNICATION
房间模式必须在调用 JoinChannel 加入房间前设置，加入房间后设置不生效。设置用户角色（通过方法 SetClientRole ）建议在设置完房间模式后。

传入参数

注意

• 为保证音视频质量和实时性，建议相同房间内的用户使用相同的房间模式。

LeaveChannel

virtual void bytertc::IRtcRoom::LeaveChannel()

离开房间。
用户调用此方法离开房间，结束通话过程，释放所有通话相关的资源。
调用 JoinChannel 方法加入房间后，在通话结束时必须调用此方法结束通话，否则无法开始下一次通话。无论当前是否在房间中，都可以调用此方法。重复调用此方法不会有负面影响。
此方法是异步操作，调用返回时并没有真正退出房间。真正退出房间后，本地会收到 OnLeaveChannel 回调通知。

注意

• 通信模式下的用户和其他房间模式下的主播、 观众角色的用户离开房间后，远端用户会收到 OnUserOffline 回调通知。
• 如果调用 LeaveChannel 后立即调用销毁引擎，SDK 将无法触发 OnLeaveChannel 回调。

RenewToken

virtual void bytertc::IRtcRoom::RenewToken(
    const char* token)

更新 Token。
Token 有一定的有效期，当 Token 过期时，用户需调用此方法更新房间的 Token 信息。
用户调用 JoinChannel 方法加入房间时，如果使用了过期的 Token 将导致加入房间失败，并会收到 OnChannelError 回调通知，回调错误码为 BRERR_INVALID_TOKEN 。此时需要重新获取 Token ，并调用此方法更新 Token。

传入参数

注意

• 如果用户因 Token 过期导致加入房间失败，则调用此方法更新 Token 后 SDK 会自动重新加入房间，而不需要用户自己调用 JoinChannel 方法。
• Token过期时，如果已经加入房间成功，则不会受到影响。Token 过期的错误会在下一次使用过期的 Token 加入房间或由于本地网络状况不佳导致断网重连入房间时通知给用户。

SendUserMessage

virtual int64_t bytertc::IRtcRoom::SendUserMessage(
    const char* uid,
    const char* message)

给房间内指定的用户发送消息，返回这次发送消息的编号。
调用该函数后会收到一次 OnUserMessageSendResult 回调，告知发送结果。

传入参数

返回值

这次发送消息的编号，从 1 开始递增。

注意

1.调用该函数后会收到一次OnUserMessageSendResult 回调； 2.若消息发送成功，则 uid 所指定的用户会收到 OnUserMessageReceived 回调。

SendUserBinaryMessage

virtual int64_t bytertc::IRtcRoom::SendUserBinaryMessage(
    const char* uid,
    int length,
    const uint8_t* message)

给房间内指定的用户发送二进制消息，返回这次发送消息的编号。

传入参数

返回值

返回这次发送消息的编号，从 1 开始递增

注意

1.调用该函数后会收到一次 OnUserMessageSendResult 回调； 2.若消息发送成功，则 uid 所指定的用户会收到 OnUserBinaryMessageReceived 回调。

SendRoomMessage

virtual int64_t bytertc::IRtcRoom::SendRoomMessage(
    const char* message)

给房间内的所有其他用户发送广播消息。

传入参数

注意

1.调用该函数后会收到一次 OnRoomMessageSendResult 回调； 2.同一房间内的其他用户会收到 OnRoomMessageReceived 回调。

SendRoomBinaryMessage

virtual int64_t bytertc::IRtcRoom::SendRoomBinaryMessage(
    int size,
    const uint8_t* message)

给房间内的所有其他用户发送广播消息。

传入参数

注意

1.调用该函数后会收到一次 OnRoomMessageSendResult 回调； 2.同一房间内的其他用户会收到 OnRoomBinaryMessageReceived 回调。

PublishScreen

virtual void bytertc::IRtcRoom::PublishScreen(
    const ScreenParameters& paramters)

发布本地屏幕共享流到房间。

传入参数

注意

• 直播、游戏、云游戏房间模式下，此方法仅适用于角色为主播的用户。应用可以通过调用 SetClientRole 方法设置用户角色。
• 调用此方法发布本端屏幕共享流后，用户还需要通过设置定时任务周期性调用 PushScreenFrame 方法，将需要发送的屏幕数据推送给 SDK。
• 远端会收到 OnFirstRemoteScreenFrame 、OnStreamAdd 事件。
• 该函数和 StartScreenCaptureByWindowId 、StartScreenCaptureByScreenRect 函数是互斥调用的，可在调用 UnpublishScreenIUnpublishScreen 函数后调用上述函数。
• 在收到 OnFirstRemoteScreenFrame 事件后通过调用 SetupRemoteScreen 或 SetRemoteScreenRender 函数来设置远端屏幕共享视图。
• 本地可调用 SetupLocalScreen 或 SetLocalScreenRender 函数设置本地屏幕共享视图。
• 也可通过注册 RegisterVideoFrameObserver 视频回调对象，监听 OnLocalScreenFrame本地屏幕视频回调事件和 OnRemoteScreenFrame远端屏幕共享视频回调事件来获取原始数据。

UnpublishScreen

virtual void bytertc::IRtcRoom::UnpublishScreen()

停止发布本地屏幕共享流到房间。

注意

远端会收到 OnStreamRemove 事件。

SubscribeStream

virtual void bytertc::IRtcRoom::SubscribeStream(
    const char* user_id,
    const SubscribeConfig& info)

订阅指定的房间内远端音视频流。
关闭自动订阅功能，使用手动订阅模式时用户调用此方法按需订阅房间中的音视频流。
此方法仅在关闭自动订阅功能时生效。用户需在加入房间前调用 EnableAutoSubscribe 方法关闭自动订阅功能以使用手动订阅模式。
用户在自动订阅功能开启时调用此方法，SDK 不会订阅音视频流，并通过 OnChannelWarning 回调通知用户订阅失败，回调警告码为 BRWARN_SUBSCRIBE_STREAM_FORBIDEN 。
订阅流失败时，SDK 会按失败原因回调 OnChannelError 通知用户，具体错误可参考错误码 RTC_ERROR_CODE 描述。

传入参数

注意

• 此方法仅支持订阅当前房间中的远端音视频流。如果指定的流在当前房间内不曾存在，则 SDK 不会订阅。
• 用户调用 JoinChannel 方法加入房间后：1.当房间内有新的音视频流发布时，本地会收到 OnStreamAdd 回调通知；2.当房间内音视频流停止发布时，本地会收到 OnStreamRemove 回调通知。通过这两个回调用户可以获得当前房间中的音视频流信息，并在需要时调用此方法订阅该音视频流。

Unsubscribe

virtual void bytertc::IRtcRoom::Unsubscribe(
    const char* user_id,
    bool is_screen)

停止订阅指定的房间内远端音视频流。
关闭自动订阅功能，使用手动订阅模式时用户调用此方法停止订阅已订阅的音视频流。
此方法仅在关闭自动订阅功能时生效。用户需在加入房间前调用 EnableAutoSubscribe 方法关闭自动订阅功能以使用手动订阅模式。

传入参数

注意

• 不管是否订阅了指定的远端音视频流，都可以调用此方法停止订阅。停止订阅的 stream_id 无效或未订阅时，SDK不会做任何处理，没有负面影响。

SetAudioVolumeIndicationInterval

virtual void bytertc::IRtcRoom::SetAudioVolumeIndicationInterval(
    int interval)

设置是否开启房间内音量提示。
如果开启，将以设置的时间间隔收到音量事件回调。无论房间内有无发言，都会收到回调。 具体回调参看 OnAudioVolumeIndication

传入参数

SetRemoteAudioPlaybackVolume

virtual void bytertc::IRtcRoom::SetRemoteAudioPlaybackVolume(
    const char* user_id,
    int volume)

调节来自远端用户的音频播放音量

传入参数

MuteAllRemoteAudio

virtual void bytertc::IRtcRoom::MuteAllRemoteAudio(
    MuteState mute_state)

设置对来自远端的所有音频流的接收状态。默认为接收。

传入参数

注意

本方法只影响本地是否接收远端音频流，并不影响远端音频设备的采集发送功能。

MuteRemoteAudio

virtual void bytertc::IRtcRoom::MuteRemoteAudio(
    const char* uid,
    MuteState mute_state)

设置对来自远端指定用户的音频流的接收状态。默认为接收。

传入参数

注意

本方法只影响本地是否接收远端音频流，并不影响远端音频设备的采集发送功能。

SetRemoteVideoCanvas

virtual void bytertc::IRtcRoom::SetRemoteVideoCanvas(
    const char* user_id,
    StreamIndex index,
    const VideoCanvas& canvas)

设置来自指定远端用户 user_id 的视频渲染时，使用的视图，并设置渲染模式。
你应在加入房间前，绑定视图。退出房间后，此设置失效。
如果需要解除某个用户的绑定视图，你可以把 view 设置为空。

传入参数

返回值

• 0：成功
• !0：失败

注意

• 实际使用时，你可以在收到回调 OnUserJoined 或 onFirstRemoteVideoFrameonfirstremotevideoframe 时获得远端用户 user_id。
• 这两个回调的差别是：如果启用了视频录制功能，视频录制服务会作为一个哑客户端加入房间，因此其他客户端会收到对应的 OnUserJoined 回调；
• 而不会收到 onFirstRemoteVideoFrameonfirstremotevideoframe 回调。你不应给录制的亚客户端绑定视图（因为它不会发送视频流）。

SetRemoteVideoRender

virtual void bytertc::IRtcRoom::SetRemoteVideoRender(
    const char* uid,
    IVideoSink* render)

设置远端视频外部渲染器

传入参数

注意

该方法绑定远程用户视频流的渲染器，如需解绑，设置为空即可。

RemoveAllRemoteVideo

virtual void bytertc::IRtcRoom::RemoveAllRemoteVideo()

去除所有远端视频。

SetRemoteScreenRender

virtual void bytertc::IRtcRoom::SetRemoteScreenRender(
    const char* uid,
    IVideoSink* render)

设置屏幕共享远端外部渲染器

传入参数

注意

该方法绑定远端用户屏幕共享流的渲染器，如需解绑，设置为空即可。

RemoveAllRemoteScreen

virtual void bytertc::IRtcRoom::RemoveAllRemoteScreen()

去除屏幕共享所有远端视图。

SetDefaultMuteAllRemoteVideoStreams

virtual void bytertc::IRtcRoom::SetDefaultMuteAllRemoteVideoStreams(
    bool mute)

设置是否默认接收视频流.

传入参数

注意

该方法在加入房间前后都可调用。如果在加入房间后调用，会接收不到后面加入房间的用户的视频流

RemoteFirstVideoFrameRender

virtual int bytertc::IRtcRoom::RemoteFirstVideoFrameRender(
    const char* userid,
    unsigned int elapse,
    int64_t timestamp)

远端首帧视频帧渲染.

传入参数

返回值

• 0：成功
• !0：失败

MuteAllRemoteVideo

virtual void bytertc::IRtcRoom::MuteAllRemoteVideo(
    MuteState muteState)

设置是否播放所有远端视频流

传入参数

注意

本方法不影响远端视频采集和发送状态

MuteRemoteVideo

virtual void bytertc::IRtcRoom::MuteRemoteVideo(
    const char* userid,
    MuteState muteState)

设置是否播放远端视频流

传入参数

注意

本方法不影响远端视频采集和发送状态

EnableAutoSubscribe

virtual void bytertc::IRtcRoom::EnableAutoSubscribe(
    SubscribeMode audio_mode,
    SubscribeMode video_mode)

设置订阅模式。
用户调用此方法设置房间中音视频流的订阅模式。SDK 默认使用自动订阅模式。
如需开启手动订阅功能，建议在调用 JoinChannel 方法加入房间前设置完成。

传入参数

注意

• SDK 提供两种订阅模式：1.自动订阅模式，开启自动订阅功能时，SDK 自动帮助用户订阅房间中所有其他用户发布的音视频流；2.手动订阅模式，关闭自动订阅功能时，SDK不会自动订阅房间内的音视频流，只通过 OnStreamAdd 和 OnStreamRemove 回调通知用户当前所在房间中有哪些音视频流，由用户根据自己的需要调用 SubscribeStream 方法手动订阅其他用户发布的音视频流。
• SDK 可以分别对音频/视频设置订阅模式。

IByteVideoFrame

class bytertc::IByteVideoFrame

视频帧

Defined in : byte_rtc_video_frame.h

静态函数

成员函数

函数说明

build_video_frame

static IByteVideoFrame* bytertc::IByteVideoFrame::build_video_frame(
    const ByteVideoFrameBuilder& builder)

根据视频帧参数创建视频帧并返回指针

传入参数

返回值

返回后的视频帧指针

frame_type

virtual int bytertc::IByteVideoFrame::frame_type() const

获取视频帧类型

返回值

视频帧类型

pixel_format

virtual int bytertc::IByteVideoFrame::pixel_format() const

获取视频帧格式

返回值

视频帧格式

timestamp_us

virtual int64_t bytertc::IByteVideoFrame::timestamp_us() const

获取视频帧时间戳

返回值

视频帧时间戳,单位:微妙

width

virtual int bytertc::IByteVideoFrame::width() const

获取视频帧宽度

返回值

视频帧宽度

height

virtual int bytertc::IByteVideoFrame::height() const

获取视频帧高度

返回值

视频帧高度

rotation

virtual int bytertc::IByteVideoFrame::rotation() const

获取视频帧旋转角度

返回值

视频帧旋转角度

color_space

virtual int bytertc::IByteVideoFrame::color_space() const

获取视频帧颜色空间

返回值

视频帧颜色空间

number_of_planes

virtual int bytertc::IByteVideoFrame::number_of_planes() const

视频帧颜色 plane 数量

返回值

视频帧颜色 plane 数量

注意

yuv数据存储格式分为 plane 存储格式和pack存储格式，plane 格式中有 y，u，v 分开存储，pack 中 yuv 数据

get_plane_data

virtual uint8_t* bytertc::IByteVideoFrame::get_plane_data(
    int plane_index)

获取 plane 数据指针

传入参数

get_plane_line_size

virtual int bytertc::IByteVideoFrame::get_plane_line_size(
    int plane_index)

获取 plane 中数据行的长度

传入参数

get_extra_data_info

virtual uint8_t* bytertc::IByteVideoFrame::get_extra_data_info(
    int& size)

获取扩展数据指针

传入参数

返回值

扩展数据的指针

get_supplementary_info

virtual uint8_t* bytertc::IByteVideoFrame::get_supplementary_info(
    int& size)

获取补充数据指针

传入参数

返回值

补充数据的指针

get_hwaccel_buffer

virtual void* bytertc::IByteVideoFrame::get_hwaccel_buffer()

获取本地缓冲区指针

返回值

本地缓冲区指针

shallow_copy

virtual IByteVideoFrame* bytertc::IByteVideoFrame::shallow_copy()

浅拷贝视频帧并返回指针

返回值

浅拷贝的视频帧的指针

release

virtual void bytertc::IByteVideoFrame::release()

释放视频帧

to_i420

virtual void bytertc::IByteVideoFrame::to_i420()

视频帧数据转为 YUV I420 格式

IVideoDeviceCollection

class bytertc::IVideoDeviceCollection

获取视频设备相关的信息

Defined in : byte_rtc_device_manager.h

成员函数

函数说明

GetCount

virtual int bytertc::IVideoDeviceCollection::GetCount()

获取当前系统内视频采集设备数量

返回值

视频采集设备数量

GetDevice

virtual int bytertc::IVideoDeviceCollection::GetDevice(
    int index,
    char device_name[MAX_DEVICE_ID_LENGTH],
    char device_id[MAX_DEVICE_ID_LENGTH])

根据索引号，获取设备信息

传入参数

返回值

• 0：方法调用成功
• !0：方法调用失败

注意

使用方负责按MAX_DEVICE_ID_LENGTH大小，分配与释放内存

Release

virtual void bytertc::IVideoDeviceCollection::Release()

释放当前IVideoDeviceCollection对象占用的资源

注意

该结构不需要的时候应该调用本函数释放视频操作相关的资源

IVideoDeviceManager

class bytertc::IVideoDeviceManager

主要用于枚举、设置视频采集设备

Defined in : byte_rtc_device_manager.h

成员函数

函数说明

EnumerateVideoDevices

virtual IVideoDeviceCollection* bytertc::IVideoDeviceManager::EnumerateVideoDevices()

获取当前系统视频设备列表

返回值

一个包含系统中所有视频设备列表的对象，详见 IVideoDeviceCollection

注意

• 该方法返回一个IVideoDeviceCollection对象，可以通过该对象枚举系统中视频设备
• 不再使用返回的对象时，调用IVideoDeviceCollection对象的Release进行释放

SetDevice

virtual int bytertc::IVideoDeviceManager::SetDevice(
    const char device_id[MAX_DEVICE_ID_LENGTH])

设置当前视频采集设备

传入参数

返回值

• 0：方法调用成功
• !0：方法调用失败

GetDevice

virtual int bytertc::IVideoDeviceManager::GetDevice(
    char device_id[MAX_DEVICE_ID_LENGTH])

获取当前SDK正在使用的设备信息

传入参数

返回值

• 0：方法调用成功
• !0：方法调用失败

注意

使用方负责按MAX_DEVICE_ID_LENGTH大小，分配与释放内存

Release

virtual void bytertc::IVideoDeviceManager::Release()

释放当前IVideoDeviceManager

注意

不需要的时候应该调用本函数释放视频设备管理实例

IAudioDeviceCollection

class bytertc::IAudioDeviceCollection

音频设备列表。 EnumeratePlaybackDevices 返回音频播放设备列表。 EnumerateRecordingDevices 返回音频采集设备列表。

Defined in : byte_rtc_device_manager.h

成员函数

函数说明

GetCount

virtual int bytertc::IAudioDeviceCollection::GetCount()

获取设备列表中设备个数

返回值

设备列表中设备个数

注意

• 当本集合是播放设备集合时返回播放设备，当是音频采集设备集合时返回音频采集设备
• 如果音频播放设备有变更，你需要重新调用 EnumeratePlaybackDevices 以获得新的设备列表.
• 如果音频采集设备有变更，你需要重新调用 EnumerateRecordingDevices 以获得新的设备列表.

GetDevice

virtual int bytertc::IAudioDeviceCollection::GetDevice(
    int index,
    char device_name[MAX_DEVICE_ID_LENGTH],
    char device_id[MAX_DEVICE_ID_LENGTH])

根据索引，获取当前设备列表中设备信息

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

注意

• 当本集合是播放设备集合时返回播放设备，当是音频采集设备集合时返回音频采集设备
• 如果音频播放设备有变更，你需要重新调用 EnumeratePlaybackDevices 以获得新的设备列表.
• 如果音频采集设备有变更，你需要重新调用 EnumerateRecordingDevices 以获得新的设备列表.

Release

virtual void bytertc::IAudioDeviceCollection::Release()

析构当前对象，释放内存

注意

严禁调用 delete 该结构体，该结构不需要的时候应该调用本函数释放音频操作相关的资源

IAudioDeviceManager

class bytertc::IAudioDeviceManager

音频设备管理类

Defined in : byte_rtc_device_manager.h

成员函数

函数说明

EnumeratePlaybackDevices

virtual IAudioDeviceCollection* bytertc::IAudioDeviceManager::EnumeratePlaybackDevices()

创建音频播放设备列表，该集合包含你调用本接口时系统中的音频播放设备。如果后续设备有变更，你需要重新调用本接口以获得新的设备列表.

返回值

音频播放设备列表，详见 IAudioDeviceCollection

注意

当不再使用返回的列表时，需要使用 Release 进行释放

EnumerateRecordingDevices

virtual IAudioDeviceCollection* bytertc::IAudioDeviceManager::EnumerateRecordingDevices()

创建音频采集设备列表，该集合包含你调用本接口时系统中的音频采集设备。如果后续设备有变更，你需要重新调用本接口以获得新的设备列表.

返回值

音频采集设备列表，详见 IAudioDeviceCollection

注意

当不再使用返回的列表时，需要使用 Release 进行释放

SetPlaybackDevice

virtual int bytertc::IAudioDeviceManager::SetPlaybackDevice(
    const char device_id[MAX_DEVICE_ID_LENGTH])

设置音频播放设备

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

SetRecordingDevice

virtual int bytertc::IAudioDeviceManager::SetRecordingDevice(
    const char device_id[MAX_DEVICE_ID_LENGTH])

设置音频采集设备

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

SetPlaybackDeviceVolume

virtual int bytertc::IAudioDeviceManager::SetPlaybackDeviceVolume(
    unsigned int volume)

设置音频播放设备音量

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

GetPlaybackDeviceVolume

virtual int bytertc::IAudioDeviceManager::GetPlaybackDeviceVolume(
    unsigned int* volume)

获取音频播放设备音量

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

SetRecordingDeviceVolume

virtual int bytertc::IAudioDeviceManager::SetRecordingDeviceVolume(
    unsigned int volume)

设置音频采集设备音量

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

GetRecordingDeviceVolume

virtual int bytertc::IAudioDeviceManager::GetRecordingDeviceVolume(
    unsigned int* volume)

获取音频采集设备音量

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

SetPlaybackDeviceMute

virtual int bytertc::IAudioDeviceManager::SetPlaybackDeviceMute(
    bool mute)

设置音频播放设备静音，默认为非静音。

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

GetPlaybackDeviceMute

virtual int bytertc::IAudioDeviceManager::GetPlaybackDeviceMute(
    bool* mute)

获取音频播放设备静音信息

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

SetRecordingDeviceMute

virtual int bytertc::IAudioDeviceManager::SetRecordingDeviceMute(
    bool mute)

设置音频采集设备静音，默认为非静音

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

GetRecordingDeviceMute

virtual int bytertc::IAudioDeviceManager::GetRecordingDeviceMute(
    bool* mute)

获取音频采集设备静音信息

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

GetPlaybackDevice

virtual int bytertc::IAudioDeviceManager::GetPlaybackDevice(
    char device_id[MAX_DEVICE_ID_LENGTH])

获取当前使用的音频播放设备ID

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

GetPlaybackDeviceInfo

virtual int bytertc::IAudioDeviceManager::GetPlaybackDeviceInfo(
    char device_id[MAX_DEVICE_ID_LENGTH],
    char device_name[MAX_DEVICE_ID_LENGTH])

获取当前音频播放设备信息

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

注意

• 注意参数前后顺序，设备ID在前，设备名称在后
• 该接口可能会废弃，请使用 GetPlaybackDevice

GetRecordingDevice

virtual int bytertc::IAudioDeviceManager::GetRecordingDevice(
    char device_id[MAX_DEVICE_ID_LENGTH])

获取当前音频采集设备ID

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

GetRecordingDeviceInfo

virtual int bytertc::IAudioDeviceManager::GetRecordingDeviceInfo(
    char device_id[MAX_DEVICE_ID_LENGTH],
    char device_name[MAX_DEVICE_ID_LENGTH])

获取当前音频采集设备信息

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

注意

• 注意参数前后顺序，设备ID在前，设备名称在后
• 该接口可能会废弃，请使用 GetRecordingDevice

StartPlaybackDeviceTest

virtual int bytertc::IAudioDeviceManager::StartPlaybackDeviceTest(
    const char* test_audio_file_path)

启动音频播放设备测试 该方法测试播放设备是否能正常工作。SDK 播放指定的音频文件，测试者如果能听到声音，说明播放设备能正常工作。

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

注意

• 测试功能必须在 JoinChannel 前应用，且不可与其它音频设备测试功能同时应用。
• 使用 StopPlaybackDeviceTest 停止测试。

StopPlaybackDeviceTest

virtual int bytertc::IAudioDeviceManager::StopPlaybackDeviceTest()

停止音频播放设备测试。

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

注意

调用 StartPlaybackDeviceTest 后，调用本方法停止测试。

StartAudioRecordingDeviceTest

virtual int bytertc::IAudioDeviceManager::StartAudioRecordingDeviceTest(
    int indication_interval)

启动音频采集设备测试。 该方法测试音频采集是否能正常工作，启动测试后，SDK 通过 OnAudioVolumeIndication 回调方法向应用上报音量信息

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

注意

• 测试功能必须在 JoinChannel 前应用。且不可与其它音频设备测试功能同时应用。
• 使用 StopAudioRecordingDeviceTest 停止测试。

StopAudioRecordingDeviceTest

virtual int bytertc::IAudioDeviceManager::StopAudioRecordingDeviceTest()

停止音频采集设备测试。

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

注意

调用 StartAudioRecordingDeviceTest 后，调用本方法停止测试。

StartAudioDeviceLoopbackTest

virtual int bytertc::IAudioDeviceManager::StartAudioDeviceLoopbackTest(
    int indication_interval)

开始音频设备回路测试。 该方法测试音频采集设备和音频播放设备是否能正常工作。一旦测试开始，音频采集设备会采集本地讲话声音 然后使用音频播放设备播放出来，同时 SDK 会通过 OnAudioVolumeIndication 回调向应用程序上报音量信息。

传入参数

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

注意

• 测试功能必须在 JoinChannel 前应用。且不可与其它音频设备测试功能同时应用。
• 使用 StopAudioDeviceLoopbackTest 停止测试。
• 该方法仅在本地进行音频设备测试，不涉及网络连接。

StopAudioDeviceLoopbackTest

virtual int bytertc::IAudioDeviceManager::StopAudioDeviceLoopbackTest()

停止音频设备回路测试。

返回值

方法调用结果
+ 0：方法调用成功
+ <0：方法调用失败

注意

调用 StartAudioDeviceLoopbackTest 后，调用本方法停止测试。

Release

virtual void bytertc::IAudioDeviceManager::Release()

析构当前对象，释放内存

注意

严禁调用 delete 该结构体，该结构不需要的时候应该调用本函数释放音频操作相关的资源