Public API

函数

函数说明

SetHardWareEncodeContext

BYTERTC_API bool bytertc::SetHardWareEncodeContext(
    jobject j_egl_context)

用于给编码器设置共享的EGLContext，该接口需要传入一个 android.opengl.EGLContext 类型的EGLContext 如果只有C++的EGLContext，则需要在绑定了EGLContext的线程环境下执行 SetHardWareEncodeContext() 方法设置。 设置后，RTC的编码器即可和当前的EGLContext共享资源。 如果Android使用纯C++接口，则该方法必须在引擎创建前设置，用于初始化EGLContext，如果没有共享的EGLContext，参数传递nullptr即可 引擎销毁后，应该调用 ClearHardWareEncodeContext() 来进行资源释放

传入参数

返回值 true: 设置成功 false：设置失败

SetHardWareEncodeContext

BYTERTC_API bool bytertc::SetHardWareEncodeContext();

用于给编码器设置共享的EGLContext，该接口需要在绑定了EGLContext的接口下执行方法设置。 设置后，RTC的编码器即可和当前的EGLContext共享资源。 如果Android使用纯C++接口，则该方法必须在引擎创建前设置，如果没有绑定了EGLContext的线程环境，可以使用参数为jobject的接口替代 引擎销毁后，应该调用 ClearHardWareEncodeContext() 来进行资源释放

返回值 true: 设置成功 false：设置失败

ClearHardWareEncodeContext

BYTERTC_API void bytertc::ClearHardWareEncodeContext();

用于清除共享的EGLContext，在引擎销毁后，如果确定之后不会再使用 则应该调用本接口在进行EGLContext的资源释放

SetApplicationContext

BYTERTC_API void bytertc::SetApplicationContext(
    jobject j_application_context)

用于设置Android的ApplicationContext给Engine使用， 如果Android使用纯C++接口，则该方法必须在引擎创建前设置

传入参数

BuildVideoFrame

BYTERTC_API IVideoFrame* bytertc::BuildVideoFrame(
    const VideoFrameBuilder& builder)

创建 IVideoFrame

传入参数

PushExternalVideoFrame

BYTERTC_API bool bytertc::PushExternalVideoFrame(
    IRtcEngine* engine,
    const IVideoFrame* frame)

发送外部源视频数据

传入参数

注意 1.支持 YUV420P，NV12，D3D texture，Cuda 内存，OpenGL texture等格式的视频帧。 2.该函数运行在用户调用线程内

RegisterLocalEncodedVideoFrameObserver

BYTERTC_API void bytertc::RegisterLocalEncodedVideoFrameObserver(
    IRtcEngine* engine,
    ILocalEncodedVideoFrameObserver* observer)

注册本地视频帧监测器。
无论使用内部采集还是自定义采集，调用该方法后，SDK 每监测到一帧本地视频帧时，都会将视频帧信息通过 OnLocalEncodedVideoFrame 回调给用户

传入参数

注意 该方法可在进房前后的任意时间调用，调用越早，对视频帧的监测越早

BuildAudioFrame

BYTERTC_API IAudioFrame* bytertc::BuildAudioFrame(
    const AudioFrameBuilder& builder)

创建 IAudioFrame

传入参数

CreateRtcEngine

BYTERTC_API bytertc::IRtcEngine* bytertc::CreateRtcEngine(
    const char* app_id,
    bytertc::IRtcEngineEventHandler* event_handler,
    const char* parameters)

创建 RTCEngine 实例。
如果当前线程中未创建引擎实例，那么你必须先使用此方法，以使用 RTC 提供的各种音视频能力。
如果当前线程中已创建了引擎实例，再次调用此方法时，会创建另一个独立的引擎实例。

传入参数

返回值 可用的 IRtcEngine 实例。

注意

• 如果你在同一个线程中创建了多个引擎实例，这些实例必须分别调用 DestroyRtcEngine 销毁。
• 在 Linux 平台上创建引擎实例的数量取决于系统的硬件性能。

DestroyRtcEngine

BYTERTC_API void bytertc::DestroyRtcEngine(
    bytertc::IRtcEngine* engine)

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

传入参数

注意

• 请确保和需要销毁的 IRtcEngine 实例相关的业务场景全部结束后，才调用此方法。
• 该方法在调用之后，会销毁所有和此 IRtcEngine 实例相关的内存，并且停止与媒体服务器的任何交互。
• 你不可以在回调线程中直接调用本方法；也不可以在回调方法中等待主线程的执行而同时在主线程调用本方法，否则会造成死锁。原因是本方法为阻塞调用，会阻塞当前线程直到 SDK 彻底完成退出逻辑。

GetErrorDescription

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

获取错误码的描述

传入参数

返回值 错误码的描述

注意 该接口是通用功能，调用时不需要依赖引擎对象。

GetSDKVersion

BYTERTC_API const char* bytertc::GetSDKVersion();

获取当前 SDK 版本信息。

返回值 当前 SDK 版本信息。

Feedback

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

本次通话质量打分评价

传入参数

返回值

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

IAudioMixingManager

class bytertc::IAudioMixingManager

混音管理类

Defined in : bytertc_audio_mixing_manager.h

成员函数

函数说明

StartAudioMixing

virtual void bytertc::IAudioMixingManager::StartAudioMixing(
    int id,
    const char * file_path,
    const AudioMixingConfig& config)

开始播放音乐文件及混音

传入参数

注意

• 调用本方法成功播放音乐文件后，SDK 会向本地回调当前的混音状态，见 OnAudioMixingStateChanged。
• 开始播放音乐文件及混音后，可以调用 StopAudioMixing 方法停止播放音乐文件。
• 本方法混音数据来源于外部文件，而 EnableAudioMixingFrame 的混音数据来源于外部缓存且音频格式为 PCM；这两种混音方式可以共存。

StopAudioMixing

virtual void bytertc::IAudioMixingManager::StopAudioMixing(
    int id)

停止播放音乐文件及混音

传入参数

注意

• 调用 StartAudioMixing 方法开始播放音乐文件及混音后，可以调用本方法停止播放音乐文件及混音。
• 调用本方法停止播放音乐文件后，SDK 会向本地回调通知已停止混音，见 OnAudioMixingStateChanged。
• 调用本方法停止播放音乐文件后，该音乐文件会被自动卸载。

PauseAudioMixing

virtual void bytertc::IAudioMixingManager::PauseAudioMixing(
    int id)

暂停播放音乐文件及混音

传入参数

注意

• 调用 StartAudioMixing 方法开始播放音乐文件及混音后，可以通过调用本方法暂停播放音乐文件及混音。
• 调用本方法暂停播放音乐文件及混音后，可调用 ResumeAudioMixing 方法恢复播放及混音。
• 调用本方法暂停播放音乐文件后，SDK 会向本地回调通知已暂停混音，见 OnAudioMixingStateChanged。

ResumeAudioMixing

virtual void bytertc::IAudioMixingManager::ResumeAudioMixing(
    int id)

恢复播放音乐文件及混音

传入参数

注意

• 调用 PauseAudioMixing 方法暂停播放音乐文件及混音后，可以通过调用本方法恢复播放及混音。
• 调用本方法恢复播放音乐文件及混音后，SDK 会向本地回调通知音乐文件正在播放中，见 OnAudioMixingStateChanged。

PreloadAudioMixing

virtual void bytertc::IAudioMixingManager::PreloadAudioMixing(
    int id,
    const char* file_path)

预加载指定音乐文件到内存中

传入参数

注意

• 需要频繁播放某个音乐文件的时候，调用本方法预加载该文件，在播放的时候可以只加载一次该文件，减少 CPU 占用。
• 本方法只是预加载指定音乐文件，只有调用 StartAudioMixing 方法才开始播放指定音乐文件。
• 调用本方法预加载音乐文件后，SDK 会回调通知音乐文件已加载，见 OnAudioMixingStateChanged。
• 调用本方法预加载的指定音乐文件可以通过 UnloadAudioMixing 卸载。

UnloadAudioMixing

virtual void bytertc::IAudioMixingManager::UnloadAudioMixing(
    int id)

卸载指定音乐文件

传入参数

注意 不论音乐文件是否播放，调用本方法卸载该文件后，SDK 会回调通知混音已停止，见 OnAudioMixingStateChanged。

SetAudioMixingVolume

virtual void bytertc::IAudioMixingManager::SetAudioMixingVolume(
    int id,
    int volume,
    AudioMixingType type)

调节音乐文件在本地和远端播放的音量大小

传入参数

注意

• 调用本方法设置音量前，请先调用 PreloadAudioMixing 或 StartAudioMixing。
• 为保证更好的音质，建议将 volume 值设为 [0,100]。

GetAudioMixingDuration

virtual int bytertc::IAudioMixingManager::GetAudioMixingDuration(
    int id)

获取音乐文件时长

传入参数

返回值

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

注意 调用本方法获取音乐文件时长前，需要先调用 PreloadAudioMixing 或 StartAudioMixing。

GetAudioMixingCurrentPosition

virtual int bytertc::IAudioMixingManager::GetAudioMixingCurrentPosition(
    int id)

获取音乐文件播放进度

传入参数

返回值

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

注意 调用本方法获取音乐文件播放进度前，需要先调用 StartAudioMixing 开始播放音乐文件。

SetAudioMixingPosition

virtual void bytertc::IAudioMixingManager::SetAudioMixingPosition(
    int id,
    int position)

设置音乐文件的播放位置

传入参数

注意

• 本方法可以设置音乐文件的播放位置，这样你可以根据实际情况从指定的位置播放音乐文件，无需从头到尾完整播放一个音乐文件。
• 调用本方法设置音乐文件的播放位置前，需要先调用 StartAudioMixing 开始播放音乐文件。

EnableAudioMixingFrame

virtual void bytertc::IAudioMixingManager::EnableAudioMixingFrame(
    AudioMixingType type)

启动外部音频流混音

传入参数

注意

• 必须先调用本方法启动外部音频流混音，随后调用 PushAudioMixingFrame 方法，才能向 SDK 推送外部音频帧数据。
• 本方法的混音数据来源于外部缓存且音频格式为 PCM；而 StartAudioMixing 的混音数据来源于外部文件，支持的文件格式有: mp3，aac，m4a，3gp，wav；这两种混音方式可以共存。
• 该方法启动的外部音频流混音不支持音量调节，暂停，暂停恢复操作。
• 如要关闭外部音频流混音，请使用 DisableAudioMixingFrame。

DisableAudioMixingFrame

virtual void bytertc::IAudioMixingManager::DisableAudioMixingFrame()

关闭外部音频流混音

注意 使用 EnableAudioMixingFrame 开启外部音频流混音后，请使用本方法关闭该混音。

PushAudioMixingFrame

virtual int bytertc::IAudioMixingManager::PushAudioMixingFrame(
    IAudioFrame* audio_frame)

向 SDK 推送外部音频帧数据

传入参数

返回值

• 0: 设置成功
• <0: 设置失败

注意

• 调用该方法前，须通过 EnableAudioMixingFrame 启动外部音频流混音。
• 使用参考建议：首次推送数据，请在应用侧先缓存一定数据（如 200 毫秒），然后一次性推送过去；此后的推送操作定时 10 毫秒一次，并且每次的音频数据量为 10 毫秒数据量。

IEncryptHandler

class bytertc::IEncryptHandler

加密/解密处理函数

Defined in : bytertc_defines.h

成员函数

函数说明

OnEncryptData

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

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

传入参数

返回值 加密后的数据

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

注意

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

OnDecryptData

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

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

传入参数

返回值 加密后的数据

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

注意

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

IDeviceCollection

class bytertc::IDeviceCollection

音视频设备相关的信息

Defined in : bytertc_device_manager.h

成员函数

函数说明

GetCount

virtual int bytertc::IDeviceCollection::GetCount()

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

返回值 音视频设备数量

GetDevice

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

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

传入参数

返回值

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

Release

virtual void bytertc::IDeviceCollection::Release()

释放当前 IDeviceCollection 对象占用的资源。

注意 不需要返回音视频设备相关信息列表时应该调用本方法释放相关资源。

IVideoDeviceManager

class bytertc::IVideoDeviceManager

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

Defined in : bytertc_device_manager.h

成员函数

函数说明

EnumerateVideoCaptureDevices

virtual IDeviceCollection* bytertc::IVideoDeviceManager::EnumerateVideoCaptureDevices()

获取当前系统内视频采集设备列表。

返回值 包含系统中所有视频采集设备的列表，参看 IDeviceCollection。

SetVideoCaptureDevice

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

设置当前视频采集设备

传入参数

返回值

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

GetVideoCaptureDevice

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

获取当前 SDK 正在使用的视频采集设备信息

传入参数

返回值

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

IAudioDeviceManager

class bytertc::IAudioDeviceManager

音频设备管理类

Defined in : bytertc_device_manager.h

成员函数

函数说明

EnumerateAudioPlaybackDevices

virtual IDeviceCollection* bytertc::IAudioDeviceManager::EnumerateAudioPlaybackDevices()

获取当前系统内音频播放设备列表。如果后续设备有变更，你会收到 OnMediaDeviceStateChanged 回调通知，然后需要重新调用本接口以获得新的设备列表。

返回值 包含系统中所有音频播放设备的列表，参看 IDeviceCollection。

EnumerateAudioCaptureDevices

virtual IDeviceCollection* bytertc::IAudioDeviceManager::EnumerateAudioCaptureDevices()

获取当前系统内音频采集设备列表。如果后续设备有变更，你需要重新调用本接口以获得新的设备列表。

返回值 一个包含系统中所有音频采集设备列表的对象，详见 IDeviceCollection。

注意 当不再使用返回的对象时，你需要调用 Release 进行释放。

SetAudioPlaybackDevice

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

设置音频播放设备。

传入参数

返回值 方法调用结果

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

SetAudioCaptureDevice

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

设置音频采集设备。

传入参数

返回值 方法调用结果

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

SetAudioPlaybackDeviceVolume

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

设置当前音频播放设备音量

传入参数

返回值 方法调用结果

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

GetAudioPlaybackDeviceVolume

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

获取当前音频播放设备音量

传入参数

返回值 方法调用结果

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

SetAudioCaptureDeviceVolume

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

设置当前音频采集设备音量

传入参数

返回值 方法调用结果

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

GetAudioCaptureDeviceVolume

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

获取当前音频采集设备音量

传入参数

返回值 方法调用结果

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

SetAudioPlaybackDeviceMute

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

设置当前音频播放设备静音状态，默认为非静音。

传入参数

返回值 方法调用结果

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

GetAudioPlaybackDeviceMute

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

获取当前音频播放设备是否静音的信息。

传入参数

返回值 方法调用结果

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

SetAudioCaptureDeviceMute

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

设置当前音频采集设备静音状态，默认为非静音。

传入参数

返回值 方法调用结果

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

GetAudioCaptureDeviceMute

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

获取当前音频采集设备是否静音的信息。

传入参数

返回值 方法调用结果

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

GetAudioPlaybackDevice

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

获取当前音频播放设备 ID。

传入参数

返回值 方法调用结果

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

GetAudioCaptureDevice

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

获取当前音频采集设备 ID。

传入参数

返回值 方法调用结果

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

StartAudioPlaybackDeviceTest

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

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

传入参数

返回值 方法调用结果

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

注意

• 该方法必须在 JoinRoom 前调用，且不可与其它音频设备测试功能同时应用。
• 你需调用 StopAudioPlaybackDeviceTest 停止测试。

StopAudioPlaybackDeviceTest

virtual int bytertc::IAudioDeviceManager::StopAudioPlaybackDeviceTest()

停止音频播放设备测试。

返回值 方法调用结果

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

注意 调用 StartAudioPlaybackDeviceTest 后，需调用本方法停止测试。

StartAudioCaptureDeviceTest

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

启动音频采集设备测试。
该方法测试音频采集设备是否能正常工作。启动测试后，会收到 OnAudioVolumeIndication 回调上报的音量信息。

传入参数

返回值 方法调用结果

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

注意

• 该方法必须在 JoinRoom 前调用，且不可与其它音频设备测试功能同时应用。
• 你需调用 StopAudioCaptureDeviceTest 停止测试。

StopAudioCaptureDeviceTest

virtual int bytertc::IAudioDeviceManager::StopAudioCaptureDeviceTest()

停止音频采集设备测试。

返回值 方法调用结果

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

注意 调用 StartAudioCaptureDeviceTest 后，需调用本方法停止测试。

StartAudioDeviceLoopbackTest

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

开始音频设备回路测试。
该方法测试音频采集设备和音频播放设备是否能正常工作。一旦测试开始，音频采集设备会采集本地声音 并通过音频播放设备播放出来，同时用户 App 会收到 OnAudioVolumeIndication 回调上报的音量信息。

传入参数

返回值 方法调用结果

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

注意

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

StopAudioDeviceLoopbackTest

virtual int bytertc::IAudioDeviceManager::StopAudioDeviceLoopbackTest()

停止音频设备回路测试。

返回值 方法调用结果

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

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

InitAudioPlaybackDeviceForTest

virtual int bytertc::IAudioDeviceManager::InitAudioPlaybackDeviceForTest(
    const char deviceId[MAX_DEVICE_ID_LENGTH])

尝试初始化音频播放设备，可检测出设备不存在、权限被拒绝/禁用等异常问题。

传入参数

返回值 设备状态错误码

• 0: 设备检测结果正常
• -1: 接口状态不正确，例如在正常启动采集后再调用该接口进行检测
• -2: 采集设备无麦克风权限，尝试初始化设备失败
• -3: 设备不存在，当前没有设备或设备被移除时返回
• -4: 设备音频格式不支持
• -5: 其它原因错误

注意 1. 该接口需在进房前调用； 2. 检测成功不代表设备一定可以启动成功，还可能因设备被其他应用进程独占，或 CPU/内存不足等原因导致启动失败。

InitAudioCaptureDeviceForTest

virtual int bytertc::IAudioDeviceManager::InitAudioCaptureDeviceForTest(
    const char deviceId[MAX_DEVICE_ID_LENGTH])

尝试初始化音频采集设备，可检测设备不存在、权限被拒绝/禁用等异常问题。

传入参数

返回值 设备状态错误码

• 0: 设备检测结果正常
• -1: 接口状态不正确，例如在正常启动采集后再调用该接口进行检测
• -2: 采集设备无麦克风权限，尝试初始化设备失败
• -3: 设备不存在，当前没有设备或设备被移除时返回
• -4: 设备音频格式不支持
• -5: 其它原因错误

注意 1. 该接口需在进房前调用; 2. 检测成功不代表设备一定可以启动成功，还可能因设备被其他应用进程独占，或 CPU/内存不足等原因导致启动失败。

IRtcEngine

class bytertc::IRtcEngine

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

Defined in : bytertc_engine_interface.h

成员函数

函数说明

JoinRoom

virtual int bytertc::IRtcEngine::JoinRoom(
    const char* token,
    const char* room_id,
    const UserInfo& user_info,
    const RTCRoomConfig& room_config)

创建/加入房间：房间不存在时即创建房间；房间存在时即加入这个房间。
同一房间内的用户间可以相互通话。
进房后重复调用无效，用户必须调用 LeaveRoom 退出当前房间后，才能加入下一个房间。
本地用户调用此方法加入房间成功后，会收到 OnJoinRoomResult 回调通知。
本地用户调用 SetUserVisibility 将自身设为可见后加入房间，远端用户会收到 OnUserJoined。

传入参数

返回值

• 0: 成功
• -1: room_id 为空，失败
• -2: user_info 为空，失败

注意

• 使用不同 App ID 的 App 是不能互通的。
• 请务必保证生成 Token 使用的 App ID 和创建引擎时使用的 App ID 相同，否则会导致加入房间失败。
• 用户加入房间成功后，在本地网络状况不佳的情况下，SDK 可能会与服务器失去连接，此时 SDK 将会自动重连。重连成功后，本地会收到 OnJoinRoomResult 回调通知。
• 同一个 App ID 的同一个房间内，每个用户的用户 ID 必须是唯一的。如果两个用户的用户 ID 相同，则后进房的用户会将先进房的用户踢出房间，并且先进房的用户会收到 OnError 回调通知，错误类型详见 ErrorCode 中的 kErrorCodeDuplicateLogin。

IRtcEngineLite

class bytertc::IRtcEngineLite

引擎 API

Defined in : bytertc_engine_lite_interface.h

成员函数

函数说明

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。

传入参数

EnableAudioSpatialRender

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

开启/关闭空间音频渲染器。
开启后可以实现 3D 语音效果。

传入参数

注意 该方法目前仅支持在游戏引擎的世界房间模式下调用

StartAudioCapture

virtual void bytertc::IRtcEngineLite::StartAudioCapture()

开启内部音频采集。默认为关闭状态。
进房前调用该方法，本地用户会收到 OnMediaDeviceStateChanged 的回调。
进房后调用该方法，房间中的其他用户会收到 OnUserStartAudioCapture 的回调。

注意

• 若未取得当前设备的麦克风权限，调用该方法后会触发 OnWarning 回调。
• 调用 StopAudioCapture 可以关闭音频采集设备，否则，SDK 只会在销毁引擎的时候自动关闭设备。
• 无论是否发布音频数据，你都可以调用该方法开启音频采集，并且调用后方可发布音频。
• 尚未进房并且已使用自定义采集时，关闭自定义采集后并不会自动开启内部采集。你需调用此方法手动开启内部采集。

StopAudioCapture

virtual void bytertc::IRtcEngineLite::StopAudioCapture()

关闭内部音频采集。默认为关闭状态。
进房前调用该方法，本地用户会收到 OnMediaDeviceStateChanged 的回调。
进房后调用该方法后，房间中的其他用户会收到 OnUserStopAudioCapture 的回调。

注意

• 调用 StartAudioCapture 可以开启音频采集设备。
• 设备开启后若一直未调用该方法关闭，则 SDK 会在销毁引擎的时候自动关闭音频采集设备。

MuteLocalAudio

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

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

传入参数

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

EnableExternalAudioDevice

virtual void bytertc::IRtcEngineLite::EnableExternalAudioDevice(
    const AudioFormat &recording_format,
    const AudioFormat &playback_format)

启用自定义音频采集渲染

传入参数

注意

• 该方法需要在进房前调用。
• 启用自定义音频采集渲染的状态在离开房间后仍然有效，会一直持续到调用 DisableExternalAudioDevice 关闭自定义音频采集渲染为止。
• 启用自定义音频采集渲染后，仍需要使用 PushExternalAudioFrame，推送外部音频数据，再使用 PullExternalAudioFrame 拉取外部音频数据。
• 当你已调用 StartAudioCapture 开启内部采集后，再调用此方法切换至自定义采集时，SDK 会自动关闭内部采集。
• 当你调用此方法开启自定义采集后，想要切换至内部采集，你必须先调用 DisableExternalAudioDevice 关闭自定义采集，然后调用 StartAudioCapture 手动开启内部采集。

DisableExternalAudioDevice

virtual void bytertc::IRtcEngineLite::DisableExternalAudioDevice()

禁用已开启的自定义音频采集渲染，将音频采集渲染由自定义模块切换至内部模块。

注意

• 如果你已开启自定义音频采集渲染，你可以在进房前，使用本接口将音频采集渲染由自定义模块切换至内部模块。
• 使用该 API 禁用自定义音频采集渲染后， SDK 不会自动开启内部的音频采集，需要开启 SDK 内部采集请使用 StartAudioCapture。
• 启用自定义音频采集渲染请使用 EnableExternalAudioDevice。

PushExternalAudioFrame

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

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

传入参数

返回值 方法调用结果

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

注意

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

PullExternalAudioFrame

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

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

传入参数

返回值 方法调用结果

• true:方法调用成功
• false：方法调用失败

注意

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

StartVideoCapture

virtual void bytertc::IRtcEngineLite::StartVideoCapture()

开启内部视频采集。默认为关闭状态。
调用该方法后，本地用户会收到 OnMediaDeviceStateChanged 的回调。
进房后调用该方法后，房间中的其他用户会收到 OnUserStartVideoCapture 的回调。

注意

• 内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。
• 若未取得当前设备的摄像头权限，调用该方法会不成功，并触发 OnMediaDeviceStateChanged 回调。
• 调用 StopVideoCapture 可以关闭视频采集设备，否则，SDK 只会在销毁引擎的时候自动关闭设备。
• 无论是否发布视频数据，你都可以调用该方法开启视频采集，并且调用后方可发布视频。
• 如果需要从自定义视频采集切换为内部视频采集，你必须先关闭自定义采集，再调用此方法手动开启内部采集。

StopVideoCapture

virtual void bytertc::IRtcEngineLite::StopVideoCapture()

关闭内部视频采集。默认为关闭状态。
调用该方法后，本地用户会收到 OnMediaDeviceStateChanged 的回调。
进房后调用该方法后，房间中的其他用户会收到 OnUserStopVideoCapture 的回调。

注意

• 调用 StartVideoCapture 可以开启视频采集设备。
• 设备开启后若一直未调用此方法关闭本地视频采集，则 SDK 会在销毁引擎的时候自动关闭。

SetVideoEncoderConfig

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

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

传入参数

返回值

• 0：成功
• !0：失败

注意

• 当使用内部采集时，视频采集的分辨率、帧率会根据编码参数进行适配。
• 默认的视频编码参数为：分辨率 640px
• 变更编码分辨率后马上生效，可能会引发相机重启。

SetLocalVideoCanvas

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

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

传入参数

返回值

• 0：成功
• !0：失败

SetLocalVideoSink

virtual void bytertc::IRtcEngineLite::SetLocalVideoSink(
    StreamIndex index,
    IVideoSink* video_sink,
    IVideoSink::PixelFormat required_format)

将本地视频流与自定义渲染器绑定。

传入参数

注意

• RTC SDK 默认使用 RTC SDK 自带的渲染器（内部渲染器）进行视频渲染。
• 如果需要解除绑定，必须将 video_sink 设置为 null。进退房操作不会影响绑定状态。
• 一般在收到 OnFirstLocalVideoFrameCaptured 回调通知完成本地视频首帧采集后，调用此方法为视频流绑定自定义渲染器；然后加入房间。

SetRemoteVideoSink

virtual void bytertc::IRtcEngineLite::SetRemoteVideoSink(
    RemoteStreamKey stream_key,
    IVideoSink* video_sink,
    IVideoSink::PixelFormat required_format)

将远端视频流与自定义渲染器绑定。

传入参数

注意

• RTC SDK 默认使用 RTC SDK 自带的渲染器（内部渲染器）进行视频渲染。
• 该方法进房前后均可以调用。若想在进房前调用，你需要在加入房间前获取远端流信息；若无法预先获取远端流信息，你可以在加入房间并通过 OnUserJoined 或 OnFirstRemoteVideoFrameRendered 回调获取到远端流信息之后，再调用该方法。
• 如果需要解除绑定，必须将 video_sink 设置为 null。进退房操作不会影响绑定状态。

MuteLocalVideo

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

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

传入参数

注意

• 本方法只是停止/启动本地视频流的发送，不影响视频采集状态。
• 无论是否开启视频采集，你都可以启动发送本地视频流。这样，一旦开始采集视频，即可进行发送。

PushScreenFrame

virtual bool bytertc::IRtcEngineLite::PushScreenFrame(
    IVideoFrame* 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 是成对调用的。

• 在收到 OnFirstRemoteVideoFrameRendered 事件后通过调用 SetRemoteVideoCanvas 或 SetRemoteVideoSink 函数来设置远端屏幕共享视图。

• 本地可调用 SetLocalVideoCanvas 或 SetLocalVideoSink 函数设置本地屏幕共享视图。

• 也可通过注册 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 是成对调用的

• 在收到 OnFirstRemoteVideoFrameRendered 事件后通过调用 SetRemoteVideoCanvas 或 SetRemoteVideoSink 函数来设置远端屏幕共享视图。

• 本地可调用 SetLocalVideoCanvas 或 SetLocalVideoSink 函数设置本地屏幕共享视图。

• 也可通过注册 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 IVideoFrame* bytertc::IRtcEngineLite::GetThumbnail(
    ScreenCaptureSourceType type,
    view_t source_id,
    int max_width,
    int max_height)

获取共享对象缩略图

SetVideoSourceType

virtual void bytertc::IRtcEngineLite::SetVideoSourceType(
    VideoSourceType type)

切换视频采集方式（内部采集/自定义采集）

传入参数

注意

• 默认使用内部采集。内部采集指：使用 RTC SDK 内置的视频采集机制进行视频采集。
• 该方法进房前后均可调用。
• 当你已调用 StartVideoCapture 开启内部采集后，再调用此方法切换至自定义采集时，SDK 会自动关闭内部采集。
• 当你调用此方法开启自定义采集后，想要切换至内部采集，你必须先调用此方法关闭自定义采集，然后调用 StartVideoCapture 手动开启内部采集。

PushExternalVideoFrame

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

发送外部源视频数据

传入参数

注意 推送外部视频帧前，必须调用 SetVideoSourceType 开启外部视频源采集。

SetPublishFallbackOption

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

设置发布的音视频流回退选项
你可以调用这个接口来设置网络情况不佳或设备性能不足时只发送小流，以保证通话质量。

传入参数

返回值

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

注意

• 这个方法只在设置了发送多个流的情况下有效。
• 你必须在进房前设置，进房后设置或更改设置无效。
• 设置回退选项后，本端发布的音视频流发生回退或从回退中恢复时，订阅该音视频流的客户端会收到 OnSimulcastSubscribeFallback 回调通知。
• 你可以调用 API 或者在服务端下发策略设置回退。当使用服务端下发配置实现时，下发配置优先级高于在客户端使用 API 设定的配置。

SetSubscribeFallbackOption

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

设置订阅的音视频流回退选项
你可以通过调用该接口来设置网络情况不佳或性能不足时只订阅小流或音频流，以保证通话质量。

传入参数

返回值 0: 方法调用成功

• <0: 方法调用失败

注意

• 你必须在进房前设置，进房后设置或更改设置无效。
• 设置回退选项后，本端订阅的音视频流发生回退或从回退中恢复时,会收到 OnSimulcastSubscribeFallback 回调通知。
• 设置回退选项后，本端订阅的视频流因为回退分辨率发生变化时,会收到 OnRemoteVideoSizeChanged 回调通知。
• 你可以调用 API 或者在服务端下发策略设置回退。当使用服务端下发配置实现时，下发配置优先级高于在客户端使用 API 设定的配置。

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： 输入非法，合法字符包括所有小写字母、大写字母和数字，除此外还包括四个独立字符分别是：英文句号，短横线，下划线和 @ 。

注意

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

DisableBackground

virtual void bytertc::IRtcEngineLite::DisableBackground()

关闭背景

SetLocalVideoMirrorMode

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

设置采用前置摄像头采集时，是否开启镜像模式。

传入参数

SetEncryptInfo

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

设置传输时使用内置加密的方式

传入参数

注意

• 使用传输时内置加密时，使用此方法；如果需要使用传输时自定义加密，参看 OnEncryptData。 内置加密和自定义加密互斥，根据最后一个调用的方法确定传输是加密的方案。

• 该方法必须在进房之前调用，可重复调用，以最后调用的参数作为生效参数。

SetCustomizeEncryptHandler

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

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

传入参数

注意

• 该方法与 SetEncryptInfo 为互斥关系， 只能选择自定义加密方式或者默认加密方式。最终生效的加密方式取决于最后一个调用的方法。

• 该方法必须在进房之前调用，可重复调用，以最后调用的参数作为生效参数。

• 无论加密或者解密，其对原始数据的长度修改，需要控制在 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)

注册视频数据回调观察者

传入参数

注意

• 该方法可以在任意时间调用，建议在 JoinRoom 前。
• 本接口支持动态取消注册，将参数设置为 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()

设备音频管理接口创建

传入参数

返回值 音频设备管理接口

StartFileRecording

virtual int bytertc::IRtcEngineLite::StartFileRecording(
    StreamIndex type,
    RecordingConfig config)

该方法将通话过程中的音视频数据录制到本地的文件中。

传入参数

返回值

• 0: 正常
• -1: 参数设置异常
• -2: 当前版本 SDK 不支持该特性，请联系技术支持人员

注意

• 调用该方法后，你会收到 OnRecordingStateUpdate 回调。
• 如果录制正常，系统每秒钟会通过 OnRecordingProgressUpdate 回调通知录制进度。

StopFileRecording

virtual void bytertc::IRtcEngineLite::StopFileRecording(
    StreamIndex type)

停止本地录制

传入参数

注意

• 调用 StartFileRecording 开启本地录制后，你必须调用该方法停止录制。
• 调用该方法后，你会收到 OnRecordingStateUpdate 回调提示录制结果。

SetRuntimeParameters

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

设置运行时的参数

传入参数

StartASR

virtual void bytertc::IRtcEngineLite::StartASR(
    const RTCASRConfig& asr_config,
    IRTCASREngineEventHandler* handler)

开启自动语音识别服务。该方法将识别后的用户语音转化成文字，并通过 OnMessage 事件回调给用户。

传入参数

StopASR

virtual void bytertc::IRtcEngineLite::StopASR()

关闭语音识别服务

GetAudioMixingManager

virtual IAudioMixingManager* bytertc::IRtcEngineLite::GetAudioMixingManager()

混音管理接口创建

返回值 混音管理实例，详见IAudioMixingManager

Login

virtual void bytertc::IRtcEngineLite::Login(
    const char* token,
    const char* uid)

必须先登录注册一个 uid，才能发送房间外消息和向业务服务器发送消息

传入参数

注意

• 在调用本接口登录后，如果想要登出，需要调用 Logout。
• 本地用户调用此方法登录后，会收到 OnLoginResult 回调通知登录结果，远端用户不会收到通知。

Logout

virtual void bytertc::IRtcEngineLite::Logout()

调用本接口登出后，无法调用房间外消息以及端到服务器消息相关的方法或收到相关回调。

注意

• 调用本接口登出前，必须先调用 Login 登录。
• 本地用户调用此方法登出后，会收到 OnLogout 回调通知结果，远端用户不会收到通知。

UpdateLoginToken

virtual void bytertc::IRtcEngineLite::UpdateLoginToken(
    const char* token)

更新用户用于登录的 Token
Token 有一定的有效期，当 Token 过期时，需调用此方法更新登录的 Token 信息。
调用 Login 方法登录时，如果使用了过期的 Token 将导致登录失败，并会收到 OnLoginResult 回调通知，错误码为 kLoginErrorCodeInvalidToken。此时需要重新获取 Token，并调用此方法更新 Token。

传入参数

注意

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

SetServerParams

virtual void bytertc::IRtcEngineLite::SetServerParams(
    const char* signature,
    const char* url)

设置业务服务器参数
客户端调用 SendServerMessage 或 SendServerBinaryMessage 发送消息给业务服务器之前，必须设置有效签名和业务服务器地址。

传入参数

注意

• 用户必须调用 Login 登录后，才能调用本接口。
• 调用本接口后，SDK 会使用 OnServerParamsSetResult 返回相应结果。

GetPeerOnlineStatus

virtual void bytertc::IRtcEngineLite::GetPeerOnlineStatus(
    const char* peer_user_id)

查询对端用户或本端用户的登录状态

传入参数

注意

• 必须调用 Login 登录后，才能调用本接口。
• 调用本接口后，SDK 会使用 OnGetPeerOnlineStatus 回调通知查询结果。
• 在发送房间外消息之前，用户可以通过本接口了解对端用户是否登录，从而决定是否发送消息。也可以通过本接口查询自己查看自己的登录状态。

SendUserMessageOutsideRoom

virtual int64_t bytertc::IRtcEngineLite::SendUserMessageOutsideRoom(
    const char* uid,
    const char* message)

给房间外指定的用户发送文本消息（P2P）

传入参数

返回值

• >0：发送成功，返回这次发送消息的编号，从 1 开始递增
• -1：发送失败，RtcEngine 实例未创建
• -2：发送失败，uid 为空

注意

• 在发送房间外文本消息前，必须先调用 Login 完成登录。
• 用户调用本接口发送文本信息后，会收到一次 OnUserMessageSendResultOutsideRoom 回调，得知消息是否成功发送。
• 若文本消息发送成功，则 uid 所指定的用户会通过 OnUserMessageReceivedOutsideRoom 回调收到该消息。

SendUserBinaryMessageOutsideRoom

virtual int64_t bytertc::IRtcEngineLite::SendUserBinaryMessageOutsideRoom(
    const char* uid,
    int length,
    const uint8_t* message)

给房间外指定的用户发送二进制消息（P2P）

传入参数

返回值

• >0：发送成功，返回这次发送消息的编号，从 1 开始递增
• -1：发送失败，RtcEngine 实例未创建
• -2：发送失败，uid 为空

注意

• 在发送房间外二进制消息前，必须先调用 Login 完成登录。
• 用户调用本接口发送二进制消息后，会收到一次 OnUserMessageSendResultOutsideRoom 回调，通知消息是否发送成功。
• 若二进制消息发送成功，则 uid 所指定的用户会通过 OnUserBinaryMessageReceivedOutsideRoom 回调收到该条消息。

SendServerMessage

virtual int64_t bytertc::IRtcEngineLite::SendServerMessage(
    const char* message)

客户端给业务服务器发送文本消息（P2Server）

传入参数

返回值

• >0：发送成功，返回这次发送消息的编号，从 1 开始递增
• -1：发送失败，RtcEngine 实例未创建

注意

• 在向业务服务器发送文本消息前，必须先调用 Login 完成登录，随后调用 SetServerParams 设置业务服务器。
• 调用本接口后，会收到一次 OnServerMessageSendResult 回调，通知消息发送方是否发送成功。
• 若文本消息发送成功，则之前调用 SetServerParams 设置的业务服务器会收到该条消息。

SendServerBinaryMessage

virtual int64_t bytertc::IRtcEngineLite::SendServerBinaryMessage(
    int length,
    const uint8_t* message)

客户端给业务服务器发送二进制消息（P2Server）

传入参数

返回值

• >0：发送成功，返回这次发送消息的编号，从 1 开始递增
• -1：发送失败，RtcEngine 实例未创建

注意

• 在向业务服务器发送二进制消息前，必须先调用 Login 完成登录，随后调用 SetServerParams 设置业务服务器。
• 调用本接口后，会收到一次 OnServerMessageSendResult 回调，通知消息发送方发送成功或失败。
• 若二进制消息发送成功，则之前调用 SetServerParams 设置的业务服务器会收到该条消息。

IVideoEffect

class bytertc::IVideoEffect

视频特效接口

Defined in : bytertc_video_effect_interface.h

成员函数

函数说明

CheckLicense

virtual int bytertc::IVideoEffect::CheckLicense(
    void* androidContext,
    void* jnienv,
    const char* licensePath)

视频特效许可证检查

传入参数

返回值

• 0: 调用成功
• 1000: 未集成cvsdk
• 1001: 本RTC版本不支持cv功能
• <0: 调用失败，具体错误码请参考 CV SDK 文档。

注意 开始使用视频特效前，你必须先调用这个方法进行许可证验证

GetAuthMessage

virtual int bytertc::IVideoEffect::GetAuthMessage(
    char ** ppmsg,
    int * len)

从 CV SDK 获取授权消息，用于获取在线许可证。

传入参数

返回值

• 0: 调用成功
• 1000: 未集成 CV SDK
• 1001: 本 RTC 版本不支持 CV 功能
• <0: 调用失败，具体错误码，请参考 CV SDK 文档。

注意

• 使用 CV 的功能前，你必须获取 CV SDK 的在线许可证。
  通过此接口获取授权消息后，你必须参考 在线授权说明。 自行实现获取在线许可证的业务逻辑。获取许可证后，你必须调用 CheckLicense 确认许可证有效。然后，你才可以使用 CV 功能。

• 获取授权消息后，调用 FreeAuthMessage 释放内存。

FreeAuthMessage

virtual int bytertc::IVideoEffect::FreeAuthMessage(
    char * pmsg)

使用完授权消息字符串后，释放内存。

传入参数

返回值

• 0: 调用成功
• 1000: 未集成 CV SDK
• 1001: 本 RTC 版本不支持 CV 功能
• <0: 调用失败，具体错误码，请参考 CV SDK 文档。

EnableEffect

virtual int bytertc::IVideoEffect::EnableEffect(
    bool enabled)

开启关闭视频特效

传入参数

返回值 0: 调用成功 1000: 未集成cvsdk <0: 调用失败，具体错误码含义请参考cvsdk文档

注意 在调用CheckLicense和SetAlgoModelPath后调用此方法

SetAlgoModelPath

virtual void bytertc::IVideoEffect::SetAlgoModelPath(
    const char* modelPath)

设置视频特效算法模型路径

传入参数

SetEffectNodes

virtual int bytertc::IVideoEffect::SetEffectNodes(
    const char** effectNodePaths,
    int nodeNum)

设置视频特效素材包，支持同时设置多个素材包

传入参数

返回值

• 0: 调用成功
• 1000: 未集成 CV SDK
• 1001: 本 RTC 版本不支持 CV 功能
• <0: 调用失败，具体错误码，请参考 CV SDK 文档。

UpdateNode

virtual int bytertc::IVideoEffect::UpdateNode(
    const char* nodePath,
    const char* nodeKey,
    float nodeValue)

设置特效强度

传入参数

返回值

• 0: 调用成功
• 1000: 未集成 CV SDK
• 1001: 本 RTC 版本不支持 CV 功能
• <0: 调用失败，具体错误码，请参考 CV SDK 文档。

SetColorFilter

virtual int bytertc::IVideoEffect::SetColorFilter(
    const char* resPath)

设置颜色滤镜

传入参数

返回值

• 0: 调用成功
• 1000: 未集成 CV SDK
• 1001: 本 RTC 版本不支持 CV 功能
• <0: 调用失败，具体错误码，请参考 CV SDK 文档。

SetColorFilterIntensity

virtual int bytertc::IVideoEffect::SetColorFilterIntensity(
    float intensity)

设置已启用颜色滤镜的强度

传入参数

返回值

• 0: 调用成功
• 1000: 未集成 CV SDK
• 1001: 本 RTC 版本不支持 CV 功能
• <0: 调用失败，具体错误码，请参考 CV SDK 文档。

IRtcRoom

class bytertc::IRtcRoom

房间接口

Defined in : bytertc_room_interface.h

成员函数

函数说明

SetUserVisibility

virtual void bytertc::IRtcRoom::SetUserVisibility(
    bool enable)

设置用户可见性。默认为可见。
通过对用户可见性进行设置，可以控制用户在房间内的行为：

• 能否发布音视频流；
  
• 用户自身是否在房间中隐身。

传入参数

注意

• 该方法在加入房间前后均可调用。
• 在房间内调用此方法，房间内其他用户会收到相应的回调通知：
• 从 false 切换至 true 时，房间内其他用户会收到 OnUserJoined 回调通知；
• 从 true 切换至 false 时，房间内其他用户会收到 OnUserLeave 回调通知。
• 若调用该方法将可见性设为 false，此时尝试发布流会收到 OnWarning 警告，具体原因参看 WarningCode 中的 kWarningCodePublishStreamForbiden 警告码。

JoinRoom

virtual void bytertc::IRtcRoom::JoinRoom(
    const char* token,
    const UserInfo& user_info,
    const MultiRoomConfig& config)

加入房间。
同一房间内的用户间可以相互通话。
进房后重复调用无效，用户必须调用 LeaveRoom 退出当前房间后，才能加入下一个房间。
本地用户调用此方法加入房间成功后，会收到 OnJoinRoomResult 回调通知。
本地用户调用 SetUserVisibility 将自身设为可见后加入房间，远端用户会收到 OnUserJoined。

传入参数

注意

• 使用不同 App ID 的 App 是不能互通的。
• 请务必保证生成 Token 使用的 App ID 和创建引擎时使用的 App ID 相同，否则会导致加入房间失败。
• 用户加入房间成功后，在本地网络状况不佳的情况下，SDK 可能会与服务器失去连接，此时 SDK 将会自动重连。重连成功后，本地会收到 OnJoinRoomResult 回调通知。
• 同一个 App ID 的同一个房间内，每个用户的用户 ID 必须是唯一的。如果两个用户的用户 ID 相同，则后进房的用户会将先进房的用户踢出房间，并且先进房的用户会收到 OnError 回调通知，错误类型详见 ErrorCode 中的 kErrorCodeDuplicateLogin。

LeaveRoom

virtual void bytertc::IRtcRoom::LeaveRoom()

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

注意

• 调用 SetUserVisibility 将自身设为可见的用户离开房间后，房间内其他用户会收到 OnUserLeave 回调通知。
• 如果调用此方法后立即销毁引擎，SDK 将无法触发 OnLeaveRoom 回调。

UpdateToken

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

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

传入参数

注意

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

SendUserMessage

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

给房间内指定的用户发送文本消息（P2P），返回这次发送消息的编号。

传入参数

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

注意 1. 调用该函数后会收到一次 OnUserMessageSendResult 回调，通知消息发送方发送成功或失败；
2. 若文本消息发送成功，则 uid 所指定的用户会收到 OnUserMessageReceived 回调。

SendUserBinaryMessage

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

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

传入参数

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

注意 1. 调用该函数后会收到一次 OnUserMessageSendResult 回调，通知消息发送方发送成功或失败；
2. 若二进制消息发送成功，则 uid 所指定的用户会收到 OnUserBinaryMessageReceived 回调。

SendRoomMessage

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

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

传入参数

注意

• 调用该函数后，会收到一次 OnRoomMessageSendResult 回调。
• 同一房间内的其他用户会收到 OnRoomMessageReceived 回调。

SendRoomBinaryMessage

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

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

传入参数

注意

• 调用该函数后，会收到一次 OnRoomMessageSendResult 回调。
• 同一房间内的其他用户会收到 OnRoomBinaryMessageReceived 回调。

Publish

virtual void bytertc::IRtcRoom::Publish()

将本端音视频流发布到此房间。

注意 1.多房间模式下，默认音视频流不自动发布。你必须调用此接口，进行手动发布。 2.调用 SetUserVisibility 方法将自身设置为不可见后无法调用该方法，需将自身切换至可见后方可调用该方法发布音视频流。 3.用户在房间内，同一时间仅能发布一路音视频流。 4.房间内用户调用此方法成功发布音视频流后，房间中的其他用户将会收到 OnStreamAdd 回调通知。

Unpublish

virtual void bytertc::IRtcRoom::Unpublish()

停止将本端音视频流发布到此房间。

注意 1.在多房间模式下，调用 Publish 手动发布音视频流后，调用此接口停止发布。 2.房间内用户调用此方法停止发布音视频流后，房间中的其他用户将会收到 OnStreamRemove 回调通知。

PublishScreen

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

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

传入参数

注意

• 此方法适用于调用 SetUserVisibility 方法将自身设为可见的用户。
• 调用此方法发布本端屏幕共享流后，用户还需要通过设置定时任务周期性调用 PushScreenFrame 方法，将需要发送的屏幕数据推送给 SDK。

• 远端会收到 OnFirstRemoteVideoFrameRendered 、OnStreamAdd 事件。

• 该函数和 StartScreenCaptureByWindowId 、StartScreenCaptureByScreenRect 函数是互斥调用的，可在调用 UnpublishScreenIUnpublishScreen 函数后调用上述函数。

• 在收到 OnFirstRemoteVideoFrameRendered 事件后通过调用 SetRemoteVideoCanvas 或 SetRemoteVideoSink 函数来设置远端屏幕共享视图。

• 本地可调用 SetLocalVideoCanvas 或 SetLocalVideoSink 函数设置本地屏幕共享视图。

• 也可通过注册 RegisterVideoFrameObserver 视频回调对象，监听 OnLocalScreenFrame本地屏幕视频回调事件和 OnRemoteScreenFrame远端屏幕共享视频回调事件来获取原始数据。

• 该方法在 JoinRoom 后才能调用。

UnpublishScreen

virtual void bytertc::IRtcRoom::UnpublishScreen()

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

注意 远端会收到 OnStreamRemove 事件。

SubscribeUserStream

virtual void bytertc::IRtcRoom::SubscribeUserStream(
    const char* user_id,
    StreamIndex stream_type,
    SubscribeMediaType media_type,
    const SubscribeVideoConfig& video_config)

订阅房间内指定的远端音视频流。
无论是自动订阅还是手动订阅模式，你都可以调用此方法按需订阅房间中的音视频流。
该方法也可用于更新已经订阅的流的属性、媒体类型等配置。

传入参数

注意

• 你可以通过 OnStreamAdd 和 OnStreamRemove 两个回调获取当前房间你的音视频流信息，并调用本方法按需订阅流或修改订阅配置。
• 若订阅失败，你会收到 OnRoomError 回调通知，具体失败原因参看 ErrorCode。
• 若调用 PauseAllSubscribedStream 暂停接收远端音视频流，此时仍可使用该方法对暂停接收的流进行设置，你会在调用 ResumeAllSubscribedStream 恢复接收流后收到修改设置后的流。

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)

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

传入参数

SetRemoteAudioDirection

virtual void bytertc::IRtcRoom::SetRemoteAudioDirection(
    const char* user_id,
    float distance,
    float theta,
    float phi)

设置远端玩家音频源的距离、方位和仰角

传入参数

注意

• 该方法目前仅支持在游戏引擎的世界房间模式下调用
• 你需在调用 EnableAudioSpatialRender 开启空间音频渲染器后方可调用该方法

MuteAllRemoteAudio

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

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

传入参数

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

PauseAllSubscribedStream

virtual void bytertc::IRtcRoom::PauseAllSubscribedStream(
    PauseResumeControlMediaType media_type)

暂停接收来自远端的媒体流。

传入参数

注意

• 该方法仅暂停远端流的接收，并不影响远端流的采集和发送；
• 该方法不改变用户的订阅状态以及订阅流的属性。
• 若想恢复接收远端流，需调用 ResumeAllSubscribedStream。

ResumeAllSubscribedStream

virtual void bytertc::IRtcRoom::ResumeAllSubscribedStream(
    PauseResumeControlMediaType media_type)

恢复接收来自远端的媒体流

传入参数

注意

• 该方法仅恢复远端流的接收，并不影响远端流的采集和发送；
• 该方法不改变用户的订阅状态以及订阅流的属性。

SetRemoteVideoCanvas

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

设置来自指定远端用户 user_id 的视频渲染时，使用的视图，并设置渲染模式。
如果需要解除某个用户的绑定视图，你可以把 view 设置为空。

传入参数

返回值

• 0：成功
• !0：失败

注意 你应在加入房间后，绑定视图。退出房间后，此设置失效。

MuteAllRemoteVideo

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

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

传入参数

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

EnableAutoSubscribe

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

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

传入参数