BYTERTC_API bytertc::IRTCVideo* bytertc::createRTCVideo(
    const char* app_id,
    bytertc::IRTCVideoEventHandler *event_handler,
    const char* parameters)
cpp

创建 IRTCVideo 实例。

如果当前进程中未创建引擎实例，那么你必须先使用此方法，以使用 RTC 提供的各种音视频能力。

如果当前进程中已创建了引擎实例，再次调用此方法时，会返回已创建的引擎实例。

传入参数

返回值

• IRTCVideo：创建成功。返回一个可用的 IRTCVideo 实例
• Null：创建失败。

BYTERTC_API void bytertc::destroyRTCVideo();
cpp

销毁由 createRTCVideo 所创建的引擎实例，并释放所有相关资源。

注意

• 请确保和需要销毁的 IRTCVideo 实例相关的业务场景全部结束后，才调用此方法。如果在多线程场景下，调用此接口后，又调用了其他 IRTCVideo 相关接口，可能导致 SDK 崩溃。该方法在调用之后，会销毁所有和此 IRTCVideo 实例相关的内存，并且停止与媒体服务器的任何交互。
• 调用本方法会启动 SDK 退出逻辑。引擎线程会保留，直到退出逻辑完成。因此，不要在回调线程中直接调用此 API，也不要在回调中等待主线程的执行，并同时在主线程调用本方法。不然会造成死锁。

BYTERTC_API const char* bytertc::getErrorDescription(
    int code)
cpp

获取 SDK 内各种错误码、警告码的描述文字。

传入参数

返回值
错误码的描述

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

BYTERTC_API const char* bytertc::getSDKVersion();
cpp

获取当前 SDK 版本信息。

返回值
当前 SDK 版本信息。

BYTERTC_API IAudioFrame* bytertc::buildAudioFrame(
    const AudioFrameBuilder& builder)
cpp

创建 IAudioFrame

传入参数

返回值
详见 IAudioFrame

BYTERTC_API IPublicStreamParam* bytertc::createPublicStreamParam();
cpp

创建公共流参数实例

BYTERTC_API ITranscoderParam* bytertc::createTranscoderParam();
cpp

创建合流参数实例

BYTERTC_API IVideoFrame* bytertc::buildVideoFrame(
    const VideoFrameBuilder& builder)
cpp

创建 IVideoFrame

传入参数

返回值
IVideoFrame 实例

BYTERTC_API IEncodedVideoFrame* bytertc::buildEncodedVideoFrame(
    const EncodedVideoFrameBuilder& builder)
cpp

创建 IEncodedVideoFrame

传入参数

返回值
IEncodedVideoFrame 实例

class bytertc::IRTCRoom
cpp

房间接口

virtual void bytertc::IRTCRoom::destroy()
cpp

退出并销毁调用 createRTCRoom 所创建的房间实例。

virtual void bytertc::IRTCRoom::setUserVisibility(
    bool enable)
cpp

设置用户可见性。未调用该接口前，本地用户默认对他人可见。

传入参数

注意

• 该方法在加入房间前后均可调用。
• 在房间内调用此方法，房间内其他用户会收到相应的回调通知：

• 从 false 切换至 true 时，房间内其他用户会收到 onUserJoined 回调通知；
• 从 true 切换至 false 时，房间内其他用户会收到 onUserLeave 回调通知。

• 若调用该方法将可见性设为 false，此时尝试发布流会收到 kWarningCodePublishStreamForbiden 警告。

virtual void bytertc::IRTCRoom::setRTCRoomEventHandler(
    IRTCRoomEventHandler* room_event_handler)
cpp

通过设置 IRTCRoom 对象的事件句柄，监听此对象对应的回调事件。

传入参数

virtual int bytertc::IRTCRoom::joinRoom(
    const char* token,
    const UserInfo& user_info,
    const RTCRoomConfig& config)
cpp

创建/加入房间：房间不存在时即创建房间；房间存在时，未加入房间的用户可加入这个房间。

同一房间内的用户间可以相互通话。

传入参数

返回值

• 0: 成功
• -1：room_id / user_info.uid 包含了无效的参数。
• -2：已经在房间内。接口调用成功后，只要收到返回值为 0 ，且未调用 leaveRoom:leaveRoom 成功，则再次调用进房接口时，无论填写的房间 ID 和用户 ID 是否重复，均触发此返回值。

注意

• 同一个 App ID 的同一个房间内，每个用户的用户 ID 必须是唯一的。如果两个用户的用户 ID 相同，则后进房的用户会将先进房的用户踢出房间，并且先进房的用户会收到 onRoomStateChanged 回调通知，错误类型详见 ErrorCode 中的 kErrorCodeDuplicateLogin。
• 本地用户调用此方法加入房间成功后，会收到 onRoomStateChanged 回调通知。若本地用户同时为可见用户，加入房间时远端用户会收到 onUserJoined 回调通知。关于可见性设置参看 setUserVisibility。
• 用户加入房间成功后，在本地网络状况不佳的情况下，SDK 可能会与服务器失去连接，并触发 onConnectionStateChanged 回调。此时 SDK 会自动重试，直到成功重连。重连成功后，本地会收到 onRoomStateChanged 回调通知。

virtual void bytertc::IRTCRoom::leaveRoom()
cpp

离开房间。

用户调用此方法离开房间，结束通话过程，释放所有通话相关的资源。

加入房间后，必须调用此方法结束通话，否则无法开始下一次通话。无论当前是否在房间内，都可以调用此方法。重复调用此方法没有负面影响。

此方法是异步操作，调用返回时并没有真正退出房间。真正退出房间后，本地会收到 onLeaveRoom 回调通知。

注意

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

virtual int bytertc::IRTCRoom::updateToken(
    const char* token)
cpp

更新 Token。
Token 中同时包含进房、发布和订阅权限，各权限有一定的有效期，并且到期前 30 秒会触发回调，提示用户更新 Token 相关权限。此时需要重新获取 Token，并调用此方法更新 Token，以保证通话的正常进行。

传入参数

返回值
方法调用结果：

• 0：成功；
• <0：失败。具体失败原因参看 ReturnStatus。

注意

1. 3.50（不含）以前的版本中，Token 中的发布和订阅权限为保留参数，无实际控制权限；3.50 及以后版本开放 Token 发布订阅控制权限，如需通过 Token 控制连麦权限，请联系技术支持团队开通白名单后支持。
2. 请勿同时调用 updateToken 和 joinRoom 方法更新 Token。若因 Token 过期或无效导致加入房间失败或已被移出房间，你应该在获取新的有效 Token 后调用 joinRoom 重新加入房间。

virtual int64_t bytertc::IRTCRoom::sendUserMessage(
    const char* uid,
    const char* message,
    MessageConfig config)
cpp

给房间内指定的用户发送点对点文本消息（P2P）。

传入参数

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

注意

• 在发送房间内文本消息前，必须先调用 joinRoom 加入房间。
• 调用该函数后会收到一次 onUserMessageSendResult 回调，通知消息发送方发送成功或失败；
• 若文本消息发送成功，则 uid 所指定的用户会收到 onUserMessageReceived 回调。

virtual int64_t bytertc::IRTCRoom::sendUserBinaryMessage(
    const char* uid,
    int length,
    const uint8_t* message,
    MessageConfig config)
cpp

给房间内指定的用户发送点对点二进制消息（P2P）。

传入参数

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

注意

• 在发送房间内二进制消息前，必须先调用 joinRoom 加入房间。
• 调用该函数后会收到一次 onUserMessageSendResult 回调，通知消息发送方发送成功或失败；
• 若二进制消息发送成功，则 uid 所指定的用户会收到 onUserBinaryMessageReceived 回调。

virtual int64_t bytertc::IRTCRoom::sendRoomMessage(
    const char* message)
cpp

给房间内的所有其他用户群发文本消息。

传入参数

注意

• 在发送房间内二进制消息前，必须先调用 joinRoom 加入房间。
• 调用该函数后，会收到一次 onRoomMessageSendResult 回调。
• 同一房间内的其他用户会收到 onRoomMessageReceived 回调。

virtual int64_t bytertc::IRTCRoom::sendRoomBinaryMessage(
    int size,
    const uint8_t* message)
cpp

给房间内的所有其他用户群发二进制消息。

传入参数

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

注意

• 在发送房间内二进制消息前，必须先调用 joinRoom 加入房间。
• 调用该函数后，会收到一次 onRoomMessageSendResult 回调。
• 同一房间内的其他用户会收到 onRoomBinaryMessageReceived 回调。

virtual void bytertc::IRTCRoom::publishStream(
    MediaStreamType type)
cpp

在当前所在房间内发布本地通过摄像头/麦克风采集的媒体流

传入参数

注意

• 如果你已经在用户进房时通过调用 joinRoom 成功选择了自动发布，则无需再调用本接口。
• 调用 setUserVisibility 方法将自身设置为不可见后无法调用该方法，需将自身切换至可见后方可调用该方法发布摄像头音视频流。
• 如果你需要发布屏幕共享流，调用 publishScreen。(Linux 不适用)
• 如果你需要向多个房间发布流，调用 startForwardStreamToRooms。
• 调用此方法后，房间中的所有远端用户会收到 onUserPublishStream 回调通知，其中成功收到了音频流的远端用户会收到 onFirstRemoteAudioFrame 回调，订阅了视频流的远端用户会收到 onFirstRemoteVideoFrameDecoded 回调。
• 调用 unpublishStream 取消发布。

virtual void bytertc::IRTCRoom::unpublishStream(
    MediaStreamType type)
cpp

停止将本地摄像头/麦克风采集的媒体流发布到当前所在房间中

传入参数

注意

• 调用 publishStream 手动发布摄像头音视频流后，你需调用此接口停止发布。
• 调用此方法停止发布音视频流后，房间中的其他用户将会收到 onUserUnpublishStream 回调通知。

virtual void bytertc::IRTCRoom::publishScreen(
    MediaStreamType type)
cpp

在当前所在房间内手动发布本地屏幕共享音视频流。

如果你需要手动向多个房间发布屏幕共享流，可以使用同样的 uid 加入多个房间，并在每个房间调用该方法。同时，你可以在不同的房间发布不同的屏幕共享流类型。

传入参数

注意

• 即使你已经在用户进房时通过调用 joinRoom 成功选择了自动发布，也需要调用本接口。
• 调用 setUserVisibility 方法将自身设置为不可见后无法调用该方法，需将自身切换至可见后方可调用该方法发布屏幕流。
• 调用该方法后，房间中的所有远端用户会收到 onUserPublishScreen 回调，其中成功收到音频流的远端用户会收到 onFirstRemoteAudioFrame 回调，订阅了视频流的远端用户会收到 onFirstRemoteVideoFrameDecoded 回调。
• 调用该方法后，本地用户会收到 onScreenVideoFrameSendStateChanged。
• 调用 unpublishScreen 取消发布。
• 对 Linux，仅支持发布视频流。
• 查看 PC 端屏幕共享，获取更多信息。

virtual void bytertc::IRTCRoom::unpublishScreen(
    MediaStreamType type)
cpp

停止将本地屏幕共享音视频流发布到当前所在房间中

传入参数

注意

• 调用 publishScreen 发布屏幕流后，你需调用此接口停止发布。
• 调用此方法停止发布屏幕音视频流后，房间中的其他用户将会收到 onUserUnpublishScreen 回调。

virtual int bytertc::IRTCRoom::subscribeUserStream(
    const char* user_id,
    StreamIndex stream_type,
    SubscribeMediaType media_type,
    const SubscribeVideoConfig& video_config)
cpp

Deprecated since 3.36 and will be deleted in 3.51, use subscribeStream, unsubscribeStream, subscribeScreen and unsubscribeScreen instead.

订阅房间内指定的远端音视频流。

无论是自动订阅还是手动订阅模式，你都可以调用此方法按需订阅房间中的音视频流。

该方法也可用于更新已经订阅的流的属性、媒体类型等配置。

传入参数

注意

• 若订阅失败，你会收到 onStreamStateChanged 回调通知，具体失败原因参看 ErrorCode。
• 若调用 pauseAllSubscribedStream 暂停接收远端音视频流，此时仍可使用该方法对暂停接收的流进行设置，你会在调用 resumeAllSubscribedStream 恢复接收流后收到修改设置后的流。

virtual int bytertc::IRTCRoom::setRemoteVideoConfig(
    const char *user_id,
    const RemoteVideoConfig &remote_video_config)
cpp

设置期望订阅的远端视频流的参数。

传入参数

返回值
方法调用结果：

• 0：成功；
• <0：失败。具体失败原因参看 ReturnStatus。

注意

• 若使用 342 及以前版本的 SDK，调用该方法前请联系技术支持人员开启按需订阅功能。
• 该方法仅在发布端调用 enableSimulcastMode 开启了发送多路视频流的情况下生效，此时订阅端将收到来自发布端与期望设置的参数最相近的一路流；否则订阅端只会收到一路参数为分辨率 640px × 360px、帧率 15fps 的视频流。
• 若发布端开启了推送多路流功能，但订阅端不对流参数进行设置，则默认接受发送端设置的分辨率最大的一路视频流。
• 该方法需在进房后调用，若想进房前设置，你需调用 joinRoom，并对 room_config 中的 remote_video_config 进行设置。
• SDK 会根据发布端和所有订阅端的设置灵活调整视频流的参数，具体调整策略详见推送多路流文档。

virtual int bytertc::IRTCRoom::subscribeStream(
    const char *user_id,
    MediaStreamType type)
cpp

订阅房间内指定的通过摄像头/麦克风采集的媒体流，或更新对指定远端用户的订阅选项

传入参数

返回值
方法调用结果：

• 0：成功；
• <0：失败。具体失败原因参看 ReturnStatus。

注意

• 当调用本接口时，当前用户已经订阅该远端用户，不论是通过手动订阅还是自动订阅，都将根据本次传入的参数，更新订阅配置。
• 你必须先通过 onUserPublishStream} 回调获取当前房间里的远端摄像头音视频流信息，然后调用本方法按需订阅。
• 调用该方法后，你会收到 onStreamSubscribed 通知方法调用结果。
• 成功订阅远端用户的媒体流后，订阅关系将持续到调用 unsubscribeStream 取消订阅或本端用户退房。
• 关于其他调用异常，你会收到 onStreamStateChanged 回调通知，具体异常原因参看 ErrorCode。

virtual int bytertc::IRTCRoom::subscribeAllStreams(
    MediaStreamType type)
cpp

订阅房间内所有通过摄像头/麦克风采集的媒体流，或更新订阅选项。

传入参数

返回值

0: 方法调用成功
!0: 方法调用失败

注意

• 多次调用订阅接口时，将根据末次调用接口和传入的参数，更新订阅配置。
• 大会模式下，如果房间内的媒体流超过上限，建议通过调用 subscribeStream 逐一指定需要订阅的媒体流。
• 调用该方法后，你会收到 onStreamSubscribed 通知方法调用结果。
• 成功订阅远端用户的媒体流后，订阅关系将持续到调用 unsubscribeStream 取消订阅或本端用户退房。
• 关于其他调用异常，你会收到 onStreamStateChanged 回调通知，具体异常原因参看 ErrorCode。

virtual int bytertc::IRTCRoom::unsubscribeStream(
    const char *user_id,
    MediaStreamType type)
cpp

取消订阅房间内指定的通过摄像头/麦克风采集的媒体流。

该方法对自动订阅和手动订阅模式均适用。

传入参数

返回值
方法调用结果：

• 0：成功；
• <0：失败。具体失败原因参看 ReturnStatus。

注意

• 调用该方法后，你会收到 onStreamSubscribed 通知方法调用结果。
• 关于其他调用异常，你会收到 onStreamStateChanged 回调通知，具体失败原因参看 ErrorCode。

virtual int bytertc::IRTCRoom::unsubscribeAllStreams(
    MediaStreamType type)
cpp

取消订阅房间内所有的通过摄像头/麦克风采集的媒体流。

自动订阅和手动订阅的流都可以通过本方法取消订阅。

传入参数

返回值
方法调用结果：

• 0：成功
• !0：失败

注意

• 调用该方法后，你会收到 onStreamSubscribed 通知方法调用结果。
• 关于其他调用异常，你会收到 onStreamStateChanged 回调通知，具体失败原因参看 ErrorCode。

virtual int bytertc::IRTCRoom::subscribeScreen(
    const char *user_id,
    MediaStreamType type)
cpp

订阅房间内指定的远端屏幕共享音视频流，或更新对指定远端用户的订阅选项

传入参数

返回值
方法调用结果：

• 0：成功；
• <0：失败。具体失败原因参看 ReturnStatus。

注意

• 当调用本接口时，当前用户已经订阅该远端用户，不论是通过手动订阅还是自动订阅，都将根据本次传入的参数，更新订阅配置。
• 你必须先通过 onUserPublishScreen} 回调获取当前房间里的远端屏幕流信息，然后调用本方法按需订阅。
• 调用该方法后，你会收到 onStreamSubscribed 通知方法调用结果。
• 成功订阅远端用户的媒体流后，订阅关系将持续到调用 unsubscribeScreen 取消订阅或本端用户退房。
• 关于其他调用异常，你会收到 onStreamStateChanged 回调通知，具体异常原因参看 ErrorCode。

virtual int bytertc::IRTCRoom::unsubscribeScreen(
    const char *user_id,
    MediaStreamType type)
cpp

取消订阅房间内指定的远端屏幕共享音视频流。

该方法对自动订阅和手动订阅模式均适用。

传入参数

返回值
方法调用结果：

• 0：成功；
• <0：失败。具体失败原因参看 ReturnStatus。

注意

• 调用该方法后，你会收到 onStreamSubscribed 通知方法调用结果。
• 关于其他调用异常，你会收到 onStreamStateChanged 回调通知，具体失败原因参看 ErrorCode。

virtual void bytertc::IRTCRoom::pauseAllSubscribedStream(
    PauseResumeControlMediaType media_type)
cpp

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

传入参数

注意

• 该方法仅暂停远端流的接收，并不影响远端流的采集和发送；
• 该方法不改变用户的订阅状态以及订阅流的属性。
• 若想恢复接收远端流，需调用 resumeAllSubscribedStream。
• 多房间场景下，仅暂停接收发布在当前所在房间的流。

virtual void bytertc::IRTCRoom::resumeAllSubscribedStream(
    PauseResumeControlMediaType media_type)
cpp

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

传入参数

注意

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

virtual void bytertc::IRTCRoom::setMultiDeviceAVSync(
    const char* audio_user_id)
cpp

设置发流端音画同步。

当同一用户同时使用两个通话设备分别采集发送音频和视频时，有可能会因两个设备所处的网络环境不一致而导致发布的流不同步，此时你可以在视频发送端调用该接口，SDK 会根据音频流的时间戳自动校准视频流，以保证接收端听到音频和看到视频在时间上的同步性。

传入参数

注意

• 该方法在进房前后均可调用。
• 进行音画同步的音频发布用户 ID 和视频发布用户 ID 须在同一个 RTC 房间内。
• 调用该接口后音画同步状态发生改变时，你会收到 onAVSyncStateChange 回调。
• 同一 RTC 房间内允许存在多个音视频同步关系，但需注意单个音频源不支持与多个视频源同时同步。
• 如需更换同步音频源，再次调用该接口传入新的 audio_user_id 即可；如需更换同步视频源，需先解除当前的同步关系，后在新视频源端开启同步。

virtual int bytertc::IRTCRoom::startForwardStreamToRooms(
    const ForwardStreamConfiguration& configuration)
cpp

开始跨房间转发媒体流。
在调用 joinRoom 后调用本接口，实现向多个房间转发媒体流，适用于跨房间连麦等场景。

传入参数

返回值

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

注意

• 调用本方法后，将在本端触发 onForwardStreamStateChanged 回调。
• 调用本方法后，你可以通过监听 onForwardStreamEvent 回调来获取各个目标房间在转发媒体流过程中的相关事件。
• 开始转发后，目标房间中的用户将接收到本地用户进房 onUserJoined 和发流 onUserPublishStream/onUserPublishScreen 的回调。
• 调用本方法后，可以调用 updateForwardStreamToRooms 更新目标房间信息，例如，增加或减少目标房间等。
• 调用本方法后，可以调用 stopForwardStreamToRooms 停止向所有房间转发媒体流。
• 调用本方法后，可以调用 pauseForwardStreamToAllRooms 暂停向所有房间转发媒体流。

virtual int bytertc::IRTCRoom::updateForwardStreamToRooms(
    const ForwardStreamConfiguration& configuration)
cpp

更新跨房间媒体流转发信息。

通过 startForwardStreamToRooms 发起媒体流转发后，可调用本方法增加或者减少目标房间，或更新房间密钥。
调用本方法增加或删减房间后，将在本端触发 onForwardStreamStateChanged 回调，包含发生了变动的目标房间中媒体流转发状态。

传入参数

返回值

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

注意

• 增加目标房间后，新增目标房间中的用户将接收到本地用户进房 onUserJoined 和发布 onUserPublishStream/onUserPublishScreen 的回调。
• 删减目标房间后，原目标房间中的用户将接收到本地用户停止发布 onUserUnpublishStream/onUserUnpublishScreen 和退房 onUserLeave 的回调。

virtual void bytertc::IRTCRoom::stopForwardStreamToRooms()
cpp

停止跨房间媒体流转发。
通过 startForwardStreamToRooms 发起媒体流转发后，可调用本方法停止向所有目标房间转发媒体流。

注意

• 调用本方法后，将在本端触发 onForwardStreamStateChanged 回调。
• 调用本方法后，原目标房间中的用户将接收到本地用户停止发布 onUserUnpublishStream/onUserUnpublishScreen 和退房 onUserLeave 的回调。
• 如果需要停止向指定的房间转发媒体流，请调用 updateForwardStreamToRooms 更新房间信息。
• 如果需要暂停转发，请调用 pauseForwardStreamToAllRooms，并在之后随时调用 resumeForwardStreamToAllRooms 快速恢复转发。

virtual void bytertc::IRTCRoom::pauseForwardStreamToAllRooms()
cpp

暂停跨房间媒体流转发。
通过 startForwardStreamToRooms 发起媒体流转发后，可调用本方法暂停向所有目标房间转发媒体流。
调用本方法暂停向所有目标房间转发后，你可以随时调用 resumeForwardStreamToAllRooms 快速恢复转发。

注意
调用本方法后，目标房间中的用户将接收到本地用户停止发布 onUserUnpublishStream/onUserUnpublishScreen 和退房 onUserLeave 的回调。

virtual void bytertc::IRTCRoom::resumeForwardStreamToAllRooms()
cpp

恢复跨房间媒体流转发。
调用 pauseForwardStreamToAllRooms 暂停转发之后，调用本方法恢复向所有目标房间转发媒体流。

注意
目标房间中的用户将接收到本地用户进房 onUserJoined 和发布 onUserPublishStream/onUserPublishScreen 的回调。

virtual void bytertc::IRTCRoom::setRemoteRoomAudioPlaybackVolume(
    int volume)
cpp

调节某个房间内所有远端用户的音频播放音量。

传入参数

注意
假设某远端用户 A 始终在被调节的目标用户范围内，+ 当该方法与 setRemoteAudioPlaybackVolume 共同使用时，本地收听用户 A 的音量为后调用的方法设置的音量；

• 当该方法与 setPlaybackVolume 方法共同使用时，本地收听用户 A 的音量将为两次设置的音量效果的叠加。

class bytertc::IRTCVideo
cpp

引擎 API

virtual void bytertc::IRTCVideo::setCaptureVolume(
    StreamIndex index,
    int volume)
cpp

调节音频采集音量

传入参数

注意
在开启音频采集前后，你都可以使用此接口设定采集音量。

virtual void bytertc::IRTCVideo::setPlaybackVolume(
    const int volume)
cpp

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

播放音频前或播放音频时，你都可以使用此接口设定播放音量。

传入参数

注意
假设某远端用户 A 始终在被调节的目标用户范围内，当该方法与 setRemoteAudioPlaybackVolume 或 setRemoteRoomAudioPlaybackVolume 共同使用时，本地收听用户 A 的音量将为两次设置的音量效果的叠加。

virtual void bytertc::IRTCVideo::startAudioCapture()
cpp

开启内部音频采集。默认为关闭状态。

内部采集是指：使用 RTC SDK 内置的音频采集机制进行视频采集。
调用该方法开启后，本地用户会收到 onAudioDeviceStateChanged 的回调。

非隐身用户进房后调用该方法，房间中的其他用户会收到 onUserStartAudioCapture 的回调。

注意

• 若未取得当前设备的麦克风权限，调用该方法后会触发 onWarning 回调。
• 调用 stopAudioCapture 可以关闭音频采集设备，否则，SDK 只会在销毁引擎的时候自动关闭设备。
• 由于不同硬件设备初始化响应时间不同，频繁调用 stopAudioCapture 和本接口闭麦/开麦可能出现短暂无声问题，建议使用 publishStream/unpublishStream 实现临时闭麦和重新开麦。
• 创建引擎后，无论是否发布音频数据，你都可以调用该方法开启音频采集，并且调用后方可发布音频。
• 如果需要从自定义音频采集切换为内部音频采集，你必须先停止发布流，调用 setAudioSourceType 关闭自定义采集，再调用此方法手动开启内部采集。

virtual void bytertc::IRTCVideo::stopAudioCapture()
cpp

立即关闭内部音频采集。默认为关闭状态。

内部采集是指：使用 RTC SDK 内置的音频采集机制进行视频采集。
调用该方法，本地用户会收到 onAudioDeviceStateChanged 的回调。

非隐身用户进房后调用该方法后，房间中的其他用户会收到 onUserStopAudioCapture 的回调。

注意

• 调用 startAudioCapture 可以开启音频采集设备。
• 如果不调用本方法停止内部视频采集，则只有当销毁引擎实例时，内部音频采集才会停止。

virtual void bytertc::IRTCVideo::setAudioProfile(
    AudioProfileType audio_profile)
cpp

设置音质档位。

当所选的 RoomProfileType 中的音频参数无法满足你的场景需求时，调用本接口切换的音质档位。

传入参数

注意

• 该方法在进房前后均可调用；
• 支持通话过程中动态切换音质档位。

virtual void bytertc::IRTCVideo::startVideoCapture()
cpp

立即开启内部视频采集。默认为关闭状态。

内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。

调用该方法后，本地用户会收到 onVideoDeviceStateChanged 的回调。

本地用户在非隐身状态下调用该方法后，房间中的其他用户会收到 onUserStartVideoCapture 的回调。

注意

• 调用 stopVideoCapture 可以停止内部视频采集。否则，只有当销毁引擎实例时，内部视频采集才会停止。
• 创建引擎后，无论是否发布视频数据，你都可以调用该方法开启内部视频采集。只有当（内部或外部）视频采集开始以后视频流才会发布。
• 如果需要从自定义视频采集切换为内部视频采集，你必须先关闭自定义采集，再调用此方法手动开启内部采集。

virtual void bytertc::IRTCVideo::stopVideoCapture()
cpp

立即关闭内部视频采集。默认为关闭状态。

内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。

调用该方法后，本地用户会收到 onVideoDeviceStateChanged 的回调。

非隐身用户进房后调用该方法，房间中的其他用户会收到 onUserStopVideoCapture 的回调。

注意

• 调用 startVideoCapture 可以开启内部视频采集。
• 如果不调用本方法停止内部视频采集，则只有当销毁引擎实例时，内部视频采集才会停止。

virtual int bytertc::IRTCVideo::setVideoCaptureConfig(
    const VideoCaptureConfig& videoCaptureConfig)
cpp

设置 RTC SDK 内部采集时的视频采集参数。

如果你的项目使用了 SDK 内部采集模块，可以通过本接口指定视频采集参数，包括模式、分辨率、帧率。

传入参数

返回值

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

注意

• 本接口在引擎创建后可调用，调用后立即生效。建议在调用 startVideoCapture 前调用本接口。
• 建议同一设备上的不同引擎使用相同的视频采集参数。
• 如果调用本接口前使用内部模块开始视频采集，采集参数默认为 Auto 模式。

virtual void bytertc::IRTCVideo::enableSimulcastMode(
    bool enabled)
cpp

该方法设置视频流发布端是否开启发布多路编码参数不同的视频流的模式。

传入参数

注意

• 你应在进房前或进房后但未发布流时，调用此方法。
• 开启推送多路流后，不能动态关闭，也不能更新多路流的路数和编码参数。
• 开启推送多路视频流模式后，你可以调用 setVideoEncoderConfig 为多路视频流分别设置编码参数。
• 该功能关闭时，或该功能开启但未设置多路流参数时，默认只发一路视频流，该流的编码参数为：分辨率 640px × 360px，帧率 15fps。

virtual int bytertc::IRTCVideo::setVideoEncoderConfig(
    const VideoEncoderConfig& max_solution)
cpp

视频发布端设置期望发布的最大分辨率视频流参数，包括分辨率、帧率、码率、网络不佳时的回退策略等。

该接口支持设置一路视频流参数，设置多路参数请使用重载 API：setVideoEncoderConfig。

传入参数

返回值
方法调用结果：

• 0：成功
• !0：失败

注意

• 若调用该方法设置了期望发布的最大分辨率的流参数之前，已调用 enableSimulcastMode 开启发布多路视频流的模式，SDK 会根据订阅端的设置自动调整发布的流数以及各路流的参数，其中最大分辨率为设置的分辨率，流数最多 4 条，具体参看推送多路流文档；否则仅发布该条最大分辨率的视频流。
• 调用该方法设置多路视频流参数前，SDK 默认仅发布一条分辨率为 640px × 360px，帧率为 15fps 的视频流。
• 使用自定义采集时，必须调用该方法设置编码参数，以保证远端收到画面的完整性。
• 该方法适用于摄像头采集的视频流，设置屏幕共享视频流参数参看 setScreenVideoEncoderConfig（Linux 不适用）。

virtual int bytertc::IRTCVideo::setVideoEncoderConfig(
    const VideoEncoderConfig* channel_solutions,
    int solution_num)
cpp

视频发布端设置推送多路流时各路流的参数，包括分辨率、帧率、码率、网络不佳时的回退策略等。

传入参数

返回值
方法调用结果：

• 0：成功
• !0：失败

注意

• 该方法是否生效取决于是否同时调用了 enableSimulcastMode 开启发布多路参数不同的视频流模式。若未开启推送多路流模式，但调用本方法设置了多个分辨率，SDK 默认发布分辨率最大的一条流，多个分辨率的设置会在开启推送多路流模式之后生效。
• 开启推送多路流后，不能动态关闭，也不能更新多路流的路数和编码参数。
• 调用该方法设置多路视频流参数前，SDK 默认仅发布一条分辨率为 640px × 360px，帧率为 15fps 的视频流。
• 调用该方法设置分辨率不同的多条流后，SDK 会根据订阅端设置的期望订阅参数自动匹配发送的流，具体规则参看推送多路流文档。
• 该方法适用于摄像头采集的视频流，设置屏幕共享视频流参数参看 setScreenVideoEncoderConfig（Linux 不适用）。

virtual int bytertc::IRTCVideo::setScreenVideoEncoderConfig(
    const ScreenVideoEncoderConfig& screen_solution)
cpp

为发布的屏幕共享视频流设置期望的编码参数，包括分辨率、帧率、码率、网络不佳时的回退策略等。

传入参数

返回值

0：成功。
!0：失败。

注意
建议在采集视频前设置编码参数。若采集前未设置编码参数，则使用默认编码参数: 分辨率 1920px × 1080px，帧率 15fps。

virtual int bytertc::IRTCVideo::setVideoEncoderConfig(
    StreamIndex index,
    const VideoSolution* solutions,
    int solution_num)
cpp

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

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

传入参数

返回值

• 0：成功
• !0：失败

注意

• 该接口已废弃，请使用同名新接口代替；若仍需使用该旧接口，请注意无需先调用 enableSimulcastMode 开启推送多路流模式。
• 当使用内部采集时，视频采集的分辨率、帧率会根据最大的编码分辨率、帧率进行适配
• 默认的视频编码参数为：分辨率 640px × 360px，帧率 15fps。
• 变更编码分辨率后马上生效，可能会引发相机重启。
• 屏幕流只取视频参数数组的第一组数据。

virtual int bytertc::IRTCVideo::setLocalVideoCanvas(
    StreamIndex index,
    const VideoCanvas& canvas)
cpp

设置本地视频渲染时使用的视图，并设置渲染模式。

传入参数

返回值

• 0：成功
• !0：失败

注意

• 你应在加入房间前，绑定本地视图。退出房间后，此设置仍然有效。
• 如果需要解除绑定，你可以调用本方法传入空视图。

virtual void bytertc::IRTCVideo::updateLocalVideoCanvas(
    StreamIndex index,
    const enum RenderMode renderMode,
    const uint32_t backgroundColor)
cpp

修改本地视频渲染模式和背景色。

传入参数

注意
你可以在本地视频渲染过程中，调用此接口。调用结果会实时生效。

virtual void bytertc::IRTCVideo::setRemoteVideoCanvas(
    RemoteStreamKey stream_key,
    const VideoCanvas& canvas)
cpp

设置渲染指定视频流 stream_key 时，使用的视图和渲染模式。

如果需要解除某个用户的绑定视图，你可以把 canvas 设置为空。

传入参数

注意
本地用户离开房间时，会解除调用此 API 建立的绑定关系；远端用户离开房间则不会影响。

virtual void bytertc::IRTCVideo::updateRemoteStreamVideoCanvas(
    RemoteStreamKey stream_key,
    const enum RenderMode renderMode,
    const uint32_t backgroundColor)
cpp

修改远端视频渲染模式和背景色。

传入参数

注意
你可以在远端视频渲染过程中，调用此接口。调用结果会实时生效。

virtual void bytertc::IRTCVideo::setLocalVideoSink(
    StreamIndex index,
    IVideoSink* video_sink,
    IVideoSink::PixelFormat required_format)
cpp

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

传入参数

注意

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

virtual void bytertc::IRTCVideo::setRemoteVideoSink(
    RemoteStreamKey stream_key,
    IVideoSink* video_sink,
    IVideoSink::PixelFormat required_format)
cpp

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

传入参数

注意

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

virtual int bytertc::IRTCVideo::pushScreenVideoFrame(
    IVideoFrame* frame)
cpp

推送屏幕视频帧

传入参数

返回值
方法调用结果：

• 0：成功；
• <0：失败。具体失败原因参看 ReturnStatus。

注意

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

virtual void bytertc::IRTCVideo::updateScreenCaptureRegion(
    const Rectangle& region_rect)
cpp

通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新采集区域。仅用于采集源为显示器屏幕时。

传入参数

注意
调用此接口前，必须已通过调用 startScreenVideoCapture 开启了内部屏幕流采集。

virtual int bytertc::IRTCVideo::startScreenVideoCapture(
    const ScreenCaptureSourceInfo& source_info,
    const ScreenCaptureParameters& capture_params)
cpp

采集屏幕视频流，用于共享。屏幕视频流包括：屏幕上显示的内容，应用窗口中显示的内容，或虚拟屏幕中显示的内容。

其中，虚拟屏幕中显示的内容仅在 Windows 平台上支持。

传入参数

返回值

• 0: 成功
• -1: 失败

注意

• 调用本接口时，采集模式应为内部模式。在外部采集模式下调用无效，并将触发 onVideoDeviceWarning 回调。
• 调用此方法仅开启屏幕流视频采集，不会发布采集到的视频。发布屏幕流视频需要调用 publishScreen。
• 调用 stopScreenVideoCapture 关闭屏幕视频源采集。
• 本地用户通过 onVideoDeviceStateChanged 的回调获取屏幕采集状态，包括开始、暂停、恢复、错误等。
• 调用成功后，本端会收到 onFirstLocalVideoFrameCaptured 回调。
• 调用此接口前，你可以调用 setScreenVideoEncoderConfig 设置屏幕视频流的采集帧率和编码分辨率。
• 在收到 onFirstLocalVideoFrameCaptured 回调后通过调用 setLocalVideoCanvas 或 setLocalVideoSink 函数设置本地屏幕共享视图。
• 可以调用 setLocalVideoSink 将本地视频流与自定义渲染器绑定，通过回调 onFrame 获取采集成功的本地视频帧。
• 再开启采集屏幕视频流后，你可以调用 updateScreenCaptureHighlightConfigupdatescreencapturehighlightconfig更新边框高亮设置，调用 updateScreenCaptureMouseCursorupdatescreencapturemousecursor更新对鼠标的处理设置，调用 updateScreenCaptureFilterConfigupdatescreencapturefilterconfig设置需要过滤的窗口。

virtual void bytertc::IRTCVideo::stopScreenVideoCapture()
cpp

停止屏幕视频流采集。

注意

• 调用本接口时，采集模式应为内部模式。在外部采集模式下调用无效，并将触发 onVideoDeviceWarning 回调。
• 要开启屏幕视频流采集，调用 startScreenVideoCapture。
• 调用后，本地用户会收到 onVideoDeviceStateChanged 的回调。
• 调用此接口不影响屏幕视频流发布。

virtual void bytertc::IRTCVideo::updateScreenCaptureHighlightConfig(
    const HighlightConfig& highlight_config)
cpp

通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新边框高亮设置。默认展示表框。

传入参数

注意

• 调用此接口前，必须已通过调用 startScreenVideoCapture 开启了内部屏幕流采集。
• 对 Linux 系统，采用 X11 协议时可用；采用 Wayland 协议时不可用。

virtual void bytertc::IRTCVideo::updateScreenCaptureMouseCursor(
    MouseCursorCaptureState capture_mouse_cursor)
cpp

通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新对鼠标的处理设置。默认采集鼠标。

传入参数

注意
调用此接口前，必须已通过调用 startScreenVideoCapture 开启了内部屏幕流采集。

virtual IScreenCaptureSourceList* bytertc::IRTCVideo::getScreenCaptureSourceList()
cpp

获取共享对象列表。

返回值
共享对象列表，包括应用窗口和屏幕。详见 IScreenCaptureSourceList。用户选择后，可调用 startScreenVideoCapture 进行共享。

注意

• 对 Linux 系统，采用 X11 协议时可用；采用 Wayland 协议时不可用。采用 Wayland 协议，调用 startScreenVideoCapture 时，系统会通过弹窗供用户选择共享对象。
• 使用完之后需要调用 release 接口释放。

virtual IVideoFrame* bytertc::IRTCVideo::getThumbnail(
    ScreenCaptureSourceType type,
    view_t source_id,
    int max_width,
    int max_height)
cpp

获取共享对象缩略图

传入参数

返回值
共享对象缩略图，详见 IVideoFrame。

注意
对 Linux 系统，采用 X11 协议时可用；采用 Wayland 协议时不可用。

virtual IVideoFrame* bytertc::IRTCVideo::getWindowAppIcon(
    view_t source_id,
    int max_width)
cpp

获取应用窗体所属应用的图标。

传入参数

返回值
详见 IVideoFrame。当屏幕共享对象为应用窗体，且有图标时有效，否则返回 nullptr。

注意
对 Linux 系统，采用 X11 协议时可用；采用 Wayland 协议时不可用。

virtual void bytertc::IRTCVideo::setVideoSourceType(
    StreamIndex stream_index,
    VideoSourceType type)
cpp

设置向 SDK 输入的视频源，包括屏幕流
默认使用内部采集。内部采集指：使用 RTC SDK 内置的视频采集机制进行视频采集。

传入参数

注意

• 该方法进房前后均可调用。
• 当你已调用 startVideoCapture 开启内部采集后，再调用此方法切换至自定义采集时，SDK 会自动关闭内部采集。
• 当你调用此方法开启自定义采集后，想要切换至内部采集，你必须先调用此方法关闭自定义采集，然后调用 startVideoCapture 手动开启内部采集。
• 当你需要向 SDK 推送自定义编码后的视频帧，你需调用该方法将视频源切换至自定义编码视频源。

virtual int bytertc::IRTCVideo::pushExternalVideoFrame(
    IVideoFrame* frame)
cpp

推送外部视频帧。

传入参数

返回值
方法调用结果：

• 0：成功；
• <0：失败。具体失败原因参看 ReturnStatus。

注意

• 支持格式：I420, NV12, RGBA, BGRA, ARGB
• 该函数运行在用户调用线程内
• 推送外部视频帧前，必须调用 setVideoSourceType 开启外部视频源采集。

virtual IRTCRoom* bytertc::IRTCVideo::createRTCRoom(
    const char* room_id)
cpp

创建房间实例。

调用此方法仅返回一个房间实例，你仍需调用 joinRoom 才能真正地创建/加入房间。

多次调用此方法以创建多个 IRTCRoom 实例。分别调用各 IRTCRoom 实例中的 joinRoom 方法，同时加入多个房间。

多房间模式下，用户可以同时订阅各房间的音视频流。

传入参数

返回值
创建的 IRTCRoom 房间实例。

注意

• 如果需要加入的房间已存在，你仍需先调用本方法来获取 IRTCRoom 实例，再调用 joinRoom 加入房间。
• 请勿使用同样的 roomId 创建多个房间，否则后创建的房间实例会替换先创建的房间实例。
• 如果你需要在多个房间发布音视频流，无须创建多房间，直接调用 startForwardStreamToRooms 开始跨房间转发媒体流。

virtual void bytertc::IRTCVideo::setPublishFallbackOption(
    PublishFallbackOption option)
cpp

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

你可以调用该接口设置网络不佳或设备性能不足时从大流起进行降级处理，以保证通话质量。

传入参数

注意

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

virtual void bytertc::IRTCVideo::setSubscribeFallbackOption(
    SubscribeFallbackOption option)
cpp

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

你可调用该接口设置网络不佳或设备性能不足时允许订阅流进行降级或只订阅音频流，以保证通话流畅。

传入参数

注意

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

virtual int bytertc::IRTCVideo::setRemoteUserPriority(
    const char* room_id,
    const char* user_id,
    RemoteUserPriority priority)
cpp

设置用户优先级。

传入参数

返回值
0: 方法调用成功

• < 0: 方法调用失败

注意

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

virtual int bytertc::IRTCVideo::setBusinessId(
    const char* business_id)
cpp

设置业务标识参数

可通过 businessId 区分不同的业务场景。businessId 由客户自定义，相当于一个“标签”，可以分担和细化现在 AppId 的逻辑划分的功能，但不需要鉴权。

传入参数

返回值

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

注意

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

virtual IVideoEffect* bytertc::IRTCVideo::getVideoEffectInterface()
cpp

获取视频特效接口。

返回值
视频特效接口，参看 IVideoEffect。

virtual void bytertc::IRTCVideo::setEncryptInfo(
    EncryptType encrypt_type,
    const char* key,
    int key_size)
cpp

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

传入参数

注意

• 使用传输时内置加密时，使用此方法；如果需要使用传输时自定义加密，参看 onEncryptData。 内置加密和自定义加密互斥，根据最后一个调用的方法确定传输是加密的方案。
• 该方法必须在进房之前调用，可重复调用，以最后调用的参数作为生效参数。

virtual void bytertc::IRTCVideo::setCustomizeEncryptHandler(
    IEncryptHandler* handler)
cpp

设置自定义加密和解密方式。

传入参数

注意

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

virtual void bytertc::IRTCVideo::enableAudioFrameCallback(
    AudioFrameCallbackMethod method,
    AudioFormat format)
cpp

设置并开启指定的音频数据帧回调

传入参数

注意
开启音频回调并调用 registerAudioFrameObserver 后，IAudioFrameObserver 会收到对应的音频回调。两者调用顺序没有限制且相互独立。

virtual void bytertc::IRTCVideo::disableAudioFrameCallback(
    AudioFrameCallbackMethod method)
cpp

关闭音频回调

传入参数

注意
该方法需要在调用 enableAudioFrameCallback 之后调用。

virtual void bytertc::IRTCVideo::registerAudioFrameObserver(
    IAudioFrameObserver* observer)
cpp

注册音频数据回调观察者。

传入参数

注意
注册音频数据回调观察者并调用 enableAudioFrameCallback 后，IAudioFrameObserver 会收到对应的音频回调。

virtual void bytertc::IRTCVideo::registerLocalAudioProcessor(
    IAudioProcessor* processor,
    AudioFormat audioFormat)
cpp

Deprecated since 3.42 and will be deleted in 3.51, use registerAudioProcessor instead.

设置自定义音频处理器。

使用该处理器，你可以调用 processAudioFrame 对 RTC SDK 采集得到的音频帧进行自定义处理，并将处理后的音频帧用于 RTC 音视频通信。

SDK 只持有 processor 的弱引用，你应保证其生命周期。

传入参数

注意
重复调用此接口时，仅最后一次调用生效。效果不会叠加。

virtual int bytertc::IRTCVideo::registerLocalVideoProcessor(
    IVideoProcessor* processor,
    VideoPreprocessorConfig config)
cpp

设置自定义视频前处理器。

使用这个视频前处理器，你可以调用 processVideoFrame 对 RTC SDK 采集得到的视频帧进行前处理，并将处理后的视频帧用于 RTC 音视频通信。

传入参数

返回值

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

注意

• 对于 Windows 平台，经前处理返回的视频帧格式仅支持 kVideoPixelFormatI420
• 对于 Windows 平台，将 config 中的 required_pixel_format 设置为 kVideoPixelFormatI420，可以通过避免格式转换带来一些性能优化。
• 重复调用此接口时，仅最后一次调用生效。效果不会叠加。

virtual void bytertc::IRTCVideo::registerRemoteAudioFrameObserver(
    IRemoteAudioFrameObserver* observer)
cpp

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

注册音频数据回调观察者。

传入参数

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

virtual int bytertc::IRTCVideo::sendSEIMessage(
    StreamIndex stream_index,
    const uint8_t* message,
    int length,
    int repeat_count)
cpp

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

通过视频帧发送 SEI 数据。

在视频通话场景下，SEI 数据会随视频帧发送；在语音通话场景下，SDK 会自动生成一路 16px × 16px 的黑帧视频流用来发送 SEI 数据。

传入参数

返回值

• >=0: 将被添加到视频帧中的 SEI 的数量
• <0: 发送失败

注意

• 语音通话场景中，仅支持在内部采集模式下调用该接口发送 SEI 数据，且调用频率需为 15/repeat_count FPS。
• 视频帧仅携带前后 2s 内收到的 SEI 数据；语音通话场景下，若调用此接口后 1min 内未有 SEI 数据发送，则 SDK 会自动取消发布视频黑帧。
• 消息发送成功后，远端会收到 onSEIMessageReceived 回调。
• 语音通话切换至视频通话时，会停止使用黑帧发送 SEI 数据，自动转为用采集到的正常视频帧发送 SEI 数据。

virtual int bytertc::IRTCVideo::sendSEIMessage(
    StreamIndex stream_index,
    const uint8_t* message,
    int length,
    int repeat_count,
    SEICountPerFrame mode)
cpp

通过视频帧发送 SEI 数据。
在视频通话场景下，SEI 数据会随视频帧发送；在语音通话场景下，SDK 会自动生成一路 16px × 16px 的黑帧视频流用来发送 SEI 数据。

传入参数

返回值

• >= 0: 将被添加到视频帧中的 SEI 的数量。
• < 0: 发送失败。

注意

• 每秒发送的 SEI 消息数量建议不超过当前的视频帧率。在语音通话场景下，黑帧帧率为 15 fps。
• 语音通话场景中，仅支持在内部采集模式下调用该接口发送 SEI 数据。
• 视频通话场景中，使用自定义采集并通过 pushExternalVideoFrame 推送至 SDK 的视频帧，若本身未携带 SEI 数据，也可通过本接口发送 SEI 数据；若原视频帧中已添加了 SEI 数据，则调用此方法不生效。
• 视频帧仅携带前后 2s 内收到的 SEI 数据；语音通话场景下，若调用此接口后 1min 内未有 SEI 数据发送，则 SDK 会自动取消发布视频黑帧。
• 消息发送成功后，远端会收到 onSEIMessageReceived 回调。
• 语音通话切换至视频通话时，会停止使用黑帧发送 SEI 数据，自动转为用采集到的正常视频帧发送 SEI 数据。

virtual IVideoDeviceManager* bytertc::IRTCVideo::getVideoDeviceManager()
cpp

创建视频设备管理实例

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

virtual IAudioDeviceManager* bytertc::IRTCVideo::getAudioDeviceManager()
cpp

设备音频管理接口创建

返回值
音频设备管理接口

virtual int bytertc::IRTCVideo::startFileRecording(
    StreamIndex type,
    RecordingConfig config,
    RecordingType recording_type)
cpp

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

传入参数

返回值

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

注意

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

virtual void bytertc::IRTCVideo::stopFileRecording(
    StreamIndex type)
cpp

停止本地录制

传入参数

注意

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

virtual int bytertc::IRTCVideo::startAudioRecording(
    AudioRecordingConfig& config)
cpp

开启录制语音通话，生成本地文件。

传入参数

返回值

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

注意

• 录制包含各种音频效果。但不包含背景音乐。
• 调用 stopAudioRecording 关闭录制。
• 加入房间后才可调用。如果加入了多个房间，录制的文件中会包含各个房间的音频。离开最后一个房间后，录制任务自动停止。
• 调用该方法后，你会收到 onAudioRecordingStateUpdate 回调。

virtual int bytertc::IRTCVideo::stopAudioRecording()
cpp

停止音频文件录制

返回值

• 0: 正常
• -3: 当前版本 SDK 不支持该特性，请联系技术支持人员

注意
调用 startAudioRecording 开启本地录制。

virtual void bytertc::IRTCVideo::enableExternalSoundCard(
    bool enable)
cpp

启用匹配外置声卡的音频处理模式

传入参数

注意

• 当采用外接声卡进行音频采集时，建议开启此模式，以获得更好的音质。
• 开启此模式时，仅支持耳机播放。如果需要使用扬声器或者外置音箱播放，关闭此模式。

virtual void bytertc::IRTCVideo::setRuntimeParameters(
    const char * json_string)
cpp

设置运行时的参数

传入参数

注意
该接口需在 joinRoom 和 startAudioCapture 之前调用。

virtual int bytertc::IRTCVideo::feedback(
    ProblemFeedbackOption *type,
    int count,
    const char* problem_desc)
cpp

将用户反馈的问题上报到 RTC

传入参数

返回值

• 0: 上报成功
• -1: 上报失败，还没加入过房间
• -2: 上报失败，数据解析错误
• -3: 上报失败，字段缺失

注意
如果用户上报时在房间内，那么问题会定位到用户当前所在的一个或多个房间；如果用户上报时不在房间内，那么问题会定位到引擎此前退出的房间。

virtual IAudioMixingManager* bytertc::IRTCVideo::getAudioMixingManager()
cpp

混音管理接口创建

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

virtual int bytertc::IRTCVideo::login(
    const char* token,
    const char* uid)
cpp

必须先登录，才能调用 sendUserMessageOutsideRoom 和 sendServerMessage 发送房间外点对点消息和向应用服务器发送消息

在调用本接口登录后，如果想要登出，需要调用 logout。

传入参数

返回值

• 0：成功；
• <0：失败。具体失败原因参看 ReturnStatus。

注意
本地用户调用此方法登录后，会收到 onLoginResult 回调通知登录结果，远端用户不会收到通知。

virtual void bytertc::IRTCVideo::logout()
cpp

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

注意

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

virtual void bytertc::IRTCVideo::updateLoginToken(
    const char* token)
cpp

更新用户用于登录的 Token

Token 有一定的有效期，当 Token 过期时，需调用此方法更新登录的 Token 信息。

调用 login 方法登录时，如果使用了过期的 Token 将导致登录失败，并会收到 onLoginResult 回调通知，错误码为 kLoginErrorCodeInvalidToken。此时需要重新获取 Token，并调用此方法更新 Token。

传入参数

注意

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

virtual void bytertc::IRTCVideo::setServerParams(
    const char* signature,
    const char* url)
cpp

设置应用服务器参数

客户端调用 sendServerMessage 或 sendServerBinaryMessage 发送消息给应用服务器之前，必须设置有效签名和应用服务器地址。

传入参数

注意

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

virtual void bytertc::IRTCVideo::getPeerOnlineStatus(
    const char* peer_user_id)
cpp

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

传入参数

注意

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

virtual int64_t bytertc::IRTCVideo::sendUserMessageOutsideRoom(
    const char* uid,
    const char* message,
    MessageConfig config)
cpp

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

传入参数

返回值

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

注意

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

virtual int64_t bytertc::IRTCVideo::sendUserBinaryMessageOutsideRoom(
    const char* uid,
    int length,
    const uint8_t* message,
    MessageConfig config)
cpp

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

传入参数

返回值

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

注意

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

virtual int64_t bytertc::IRTCVideo::sendServerMessage(
    const char* message)
cpp

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

传入参数

返回值

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

注意

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

virtual int64_t bytertc::IRTCVideo::sendServerBinaryMessage(
    int length,
    const uint8_t* message)
cpp

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

传入参数

返回值

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

注意

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

virtual NetworkDetectionStartReturn bytertc::IRTCVideo::startNetworkDetection(
    bool is_test_uplink,
    int expected_uplink_bitrate,
    bool is_test_downlink,
    int expected_downlink_biterate)
cpp

开启通话前网络探测

传入参数

返回值
开启通话前网络探测结果，详见 NetworkDetectionStartReturn

注意

• 成功调用本接口后，会在 3s 内收到一次 onNetworkDetectionResult 回调，此后每 2s 会收到一次该回调，通知探测结果；
• 若探测停止，则会收到一次 onNetworkDetectionStopped 通知探测停止。

virtual void bytertc::IRTCVideo::stopNetworkDetection()
cpp

停止通话前网络探测

注意

• 调用本接口后，会收到一次 onNetworkDetectionStopped 回调通知探测停止。

virtual void bytertc::IRTCVideo::setAudioAlignmentProperty(
    const RemoteStreamKey& streamKey,
    AudioAlignmentMode mode)
cpp

在听众端，设置订阅的所有远端音频流精准对齐后播放。

传入参数

注意

• 你必须在实时合唱场景下使用此功能。在加入房间时，所有人应设置 RoomProfileType 为 kRoomProfileTypeChorus。
• 订阅的所有远端流必须通过 startAudioMixing 开启了背景音乐混音，并将 AudioMixingConfig 中的 sync_progress_to_record_frame 设置为 true。
• 如果订阅的某个音频流延迟过大，可能无法实现精准对齐。
• 合唱的参与者不应调用此 API，因为调用此 API 会增加延迟。如果希望从听众变为合唱参与者，应关闭对齐功能。

virtual int bytertc::IRTCVideo::startPushPublicStream(
    const char* public_stream_id,
    IPublicStreamParam* param)
cpp

发布一路公共流

用户可以指定房间内多个用户发布的媒体流合成一路公共流。使用同一 appID 的用户，可以调用 startPlayPublicStream 获取和播放指定的公共流。

传入参数

返回值

• 0: 成功。同时将收到 onPushPublicStreamResult 回调。
• !0: 失败。当参数不合法或参数为空，调用失败。

注意

• 同一用户使用同一公共流 ID 多次调用本接口无效。如果你希望更新公共流参数，调用 updatePublicStreamParam 接口。
• 不同用户使用同一公共流 ID 多次调用本接口时，RTC 将使用最后一次调用时传入的参数更新公共流。
• 使用不同的 ID 多次调用本接口可以发布多路公共流。
• 调用 stopPushPublicStream 停止发布公共流。
• 关于公共流功能的介绍，详见发布和订阅公共流

virtual int bytertc::IRTCVideo::stopPushPublicStream(
    const char* public_stream_id)
cpp

停止发布当前用户发布的公共流

关于发布公共流，查看 startPushPublicStream。

传入参数

返回值

• 0: 成功
• !0: 失败

virtual int bytertc::IRTCVideo::updatePublicStreamParam(
    const char* public_stream_id,
    IPublicStreamParam* param)
cpp

更新公共流参数

关于发布公共流，查看 startPushPublicStream。

传入参数

返回值

• 0: 成功
• !0: 失败

注意
调用本接口前需要通过 onPushPublicStreamResult 确认公共流是否已经成功启动。

virtual void bytertc::IRTCVideo::enableAudioPropertiesReport(
    const AudioPropertiesConfig& config)
cpp

启用音频信息提示。开启提示后，你会收到 onLocalAudioPropertiesReport，onRemoteAudioPropertiesReport 和 onActiveSpeaker。

传入参数

virtual int bytertc::IRTCVideo::setRemoteAudioPlaybackVolume(
    const char* room_id,
    const char* user_id,
    int volume)
cpp

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

传入参数

返回值
方法调用结果：

• 0：成功；
• <0：失败。具体失败原因参看 ReturnStatus。

注意
假设某远端用户 A 始终在被调节的目标用户范围内，+ 当该方法与 setRemoteRoomAudioPlaybackVolume 共同使用时，本地收听用户 A 的音量为后调用的方法设置的音量；

• 当该方法与 setPlaybackVolume 方法共同使用时，本地收听用户 A 的音量将为两次设置的音量效果的叠加。

virtual void bytertc::IRTCVideo::enableVocalInstrumentBalance(
    bool enable)
cpp

开启/关闭音量均衡功能。

开启音量均衡功能后，人声的响度会调整为 -16lufs。如果已调用 setAudioMixingLoudness 传入了混音音乐的原始响度，此音乐播放时，响度会调整为 -20lufs。（Linux 不支持）

传入参数

注意
该接口须在调用 startAudioMixing 开始播放音频文件之前调用。

virtual void bytertc::IRTCVideo::enablePlaybackDucking(
    bool enable)
cpp

打开/关闭音量闪避功能，适用于在 RTC 通话过程中会同时播放短视频或音乐的场景，如“一起看”、“在线 KTV”等。

开启该功能后，当检测到远端人声时，本地的媒体播放音量会自动减弱，从而保证远端人声的清晰可辨；当远端人声消失时，本地媒体音量会恢复到闪避前的音量水平。

传入参数

virtual void bytertc::IRTCVideo::registerLocalEncodedVideoFrameObserver(
    ILocalEncodedVideoFrameObserver* observer)
cpp

注册本地视频帧监测器。

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

传入参数

注意
该方法可在进房前后的任意时间调用，在进房前调用可保证尽可能早地监测视频帧并触发回调

virtual void bytertc::IRTCVideo::registerRemoteEncodedVideoFrameObserver(
    IRemoteEncodedVideoFrameObserver* observer)
cpp

注册远端编码后视频数据回調。

完成注册后，当 SDK 监测到远端编码后视频帧时，会触发 onRemoteEncodedVideoFrame 回调

传入参数

注意

• 更多自定义解码功能说明参看 自定义视频编解码。
• 该方法适用于手动订阅，并且进房前后均可调用，建议在进房前调用。
• 引擎销毁前需取消注册，调用该方法将参数设置为 nullptr 即可。

virtual void bytertc::IRTCVideo::setExternalVideoEncoderEventHandler(
    IExternalVideoEncoderEventHandler* encoder_handler)
cpp

注册自定义编码帧推送事件回调

传入参数

注意

• 该方法需在进房前调用。
• 引擎销毁前需取消注册，调用该方法将参数设置为 nullptr 即可。

virtual int bytertc::IRTCVideo::pushExternalEncodedVideoFrame(
    StreamIndex index,
    int video_index,
    IEncodedVideoFrame* video_stream)
cpp

推送自定义编码后的视频流

传入参数

返回值
方法调用结果：

• 0：成功；
• <0：失败。具体失败原因参看 ReturnStatus。

注意

• 目前仅支持推送 H264 和 ByteVC1 格式的视频帧，且视频流协议格式须为 Annex B 格式。
• 该函数运行在用户调用线程内
• 推送自定义编码视频帧前，必须调用 setVideoSourceType 将视频输入源切换至自定义编码视频源。

virtual void bytertc::IRTCVideo::setVideoDecoderConfig(
    RemoteStreamKey key,
    VideoDecoderConfig config)
cpp

在订阅远端视频流之前，设置远端视频数据解码方式

传入参数

注意

• 该方法仅适用于手动订阅模式，并且在订阅远端流之前使用。
• 当你想要对远端流进行自定义解码时，你需要先调用 registerRemoteEncodedVideoFrameObserver 注册远端视频流监测器，然后再调用该接口将解码方式设置为自定义解码。监测到的视频数据会通过 onRemoteEncodedVideoFrame 回调出来。

virtual void bytertc::IRTCVideo::requestRemoteVideoKeyFrame(
    const RemoteStreamKey& stream_info)
cpp

在订阅远端视频流之后，向远端请求关键帧

传入参数

注意

• 该方法仅适用于手动订阅模式，并且在成功订阅远端流之后使用。
• 该方法适用于调用 setVideoDecoderConfig 开启自定义解码功能后，并且自定义解码失败的情况下使用

virtual int bytertc::IRTCVideo::sendStreamSyncInfo(
    const uint8_t* data,
    int32_t length,
    const StreamSycnInfoConfig& config)
cpp

发送音频流同步信息。将消息通过音频流发送到远端，并实现与音频流同步，该接口调用成功后，远端用户会收到 onStreamSyncInfoReceived 回调。

传入参数

返回值

• >=0: 消息发送成功。返回成功发送的次数。
• -1: 消息发送失败。消息长度大于 255 字节。
• -2: 消息发送失败。传入的消息内容为空。
• -3: 消息发送失败。通过屏幕流进行消息同步时，此屏幕流还未发布。
• -4: 消息发送失败。通过用麦克风或自定义设备采集到的音频流进行消息同步时，此音频流还未发布，详见错误码 ErrorCode。

注意

• 调用本接口的频率建议不超过 50 次每秒。
• 在 kRoomProfileTypeInteractivePodcast 房间模式下，此消息一定会送达。在其他房间模式下，如果本地用户未说话，此消息不一定会送达。

virtual void bytertc::IRTCVideo::setLocalVoicePitch(
    int pitch)
cpp

开启本地语音变调功能，多用于 K 歌场景。

使用该方法，你可以对本地语音的音调进行升调或降调等调整。

传入参数

virtual void bytertc::IRTCVideo::muteAudioPlayback(
    MuteState mute_state)
cpp

Deprecated since 3.45 and will be deleted in 3.51, use setPlaybackVolume instead.

控制本地音频流播放状态：播放/不播放

传入参数

注意
本方法仅控制本地收到音频流的播放状态，并不影响本地音频播放设备。

virtual int bytertc::IRTCVideo::startPlayPublicStream(
    const char* public_stream_id)
cpp

订阅指定公共流

无论用户是否在房间内，都可以调用本接口获取和播放指定的公共流。

传入参数

返回值

• 0: 成功。同时将收到 onPlayPublicStreamResult 回调。
• !0: 失败。当参数不合法或参数为空，调用失败。

注意

• 在调用本接口之前，建议先绑定渲染视图。

• 调用 setPublicStreamVideoCanvas 绑定内部渲染视图：
• 调用 setPublicStreamVideoSink 绑定自定义渲染视图：

• 调用本接口后，可以通过 onFirstPublicStreamVideoFrameDecoded 和 onFirstPublicStreamAudioFrame 回调公共流的视频和音频首帧解码情况。
• 调用本接口后，可以通过 onPublicStreamSEIMessageReceived 回调公共流中包含的 SEI 信息。
• 订阅公共流之后，可以通过调用 stopPlayPublicStream 接口取消订阅公共流。

virtual int bytertc::IRTCVideo::stopPlayPublicStream(
    const char* public_stream_id)
cpp

取消订阅指定公共流

关于订阅公共流，查看 startPlayPublicStream。

传入参数

返回值

• 0：成功
• !0：失败

virtual int bytertc::IRTCVideo::setPublicStreamVideoCanvas(
    const char* public_stream_id,
    const VideoCanvas& canvas)
cpp

为指定公共流绑定内部渲染视图。

传入参数

返回值

• 0：成功
• !0：失败

virtual int bytertc::IRTCVideo::setPublicStreamVideoSink(
    const char* public_stream_id,
    IVideoSink* video_sink,
    IVideoSink::PixelFormat format)
cpp

为指定公共流绑定自定义渲染器。详见自定义视频渲染。

传入参数

返回值
方法调用结果：

• 0：成功；
• <0：失败。具体失败原因参看 ReturnStatus。

virtual void bytertc::IRTCVideo::setVideoWatermark(
    StreamIndex streamIndex,
    const char* image_path,
    RTCWatermarkConfig config)
cpp

在指定视频流上添加水印。

传入参数

注意

• 调用 clearVideoWatermark 移除指定视频流的水印。
• 同一路流只能设置一个水印，新设置的水印会代替上一次的设置。你可以多次调用本方法来设置不同流的水印。
• 若开启本地预览镜像，或开启本地预览和编码传输镜像，则远端水印均不镜像；在开启本地预览水印时，本端水印会镜像。
• 开启大小流后，水印对大小流均生效，且针对小流进行等比例缩小。

virtual void bytertc::IRTCVideo::clearVideoWatermark(
    StreamIndex streamIndex)
cpp

移除指定视频流的水印。

传入参数

virtual int bytertc::IRTCVideo::setDummyCaptureImagePath(
    const char* file_path)
cpp

摄像头处于关闭状态时，使用静态图片填充本地推送的视频流。
可重复调用该接口来更新图片。若要停止发送图片，可传入空字符串或启用内部摄像头采集。

传入参数

返回值

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

注意

• 该接口只适用于 SDK 内部摄像头采集，不适用于自定义视频采集。
• 本地预览无法看到静态图片。
• 进入房间前后均可调用此方法。在多房间场景中，静态图片仅在发布的房间中生效。
• 针对该静态图片，滤镜和镜像效果不生效，水印效果生效。
• 只有主流能设置静态图片，屏幕流不支持设置。
• 开启大小流后，静态图片对大小流均生效，且针对小流进行等比例缩小。

virtual void bytertc::IRTCVideo::startCloudProxy(
    const CloudProxyConfiguration& configuration)
cpp

开启云代理

传入参数

注意

• 在加入房间前调用此接口
• 在开启云代理后，进行通话前网络探测
• 开启云代理后，并成功链接云代理服务器后，会收到 onCloudProxyConnected。
• 要关闭云代理，调用 stopCloudProxy。

virtual void bytertc::IRTCVideo::stopCloudProxy()
cpp

关闭云代理

注意
要开启云代理，调用 startCloudProxy。

class bytertc::IDeviceCollection
cpp

音视频设备相关的信息

virtual int bytertc::IDeviceCollection::getCount()
cpp

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

返回值
音视频设备数量

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

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

传入参数

返回值

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

virtual void bytertc::IDeviceCollection::release()
cpp

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

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

class bytertc::IAudioDeviceCollection
cpp

音频设备相关的信息

virtual int bytertc::IAudioDeviceCollection::getCount() override
cpp

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

返回值
音频设备数量

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

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

传入参数

返回值

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

virtual void bytertc::IAudioDeviceCollection::release()override
cpp

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

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

virtual int bytertc::IAudioDeviceCollection::getDevice(
    int index,
    AudioDeviceInfo* audio_device_info)
cpp

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

传入参数

返回值

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

class bytertc::IAudioDeviceManager
cpp

音频设备管理类

virtual IAudioDeviceCollection* bytertc::IAudioDeviceManager::enumerateAudioPlaybackDevices()
cpp

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

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

virtual IAudioDeviceCollection* bytertc::IAudioDeviceManager::enumerateAudioCaptureDevices()
cpp

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

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

virtual void bytertc::IAudioDeviceManager::followSystemPlaybackDevice(
    bool followed)
cpp

设置音频播放路由是否跟随系统。

传入参数

virtual void bytertc::IAudioDeviceManager::followSystemCaptureDevice(
    bool followed)
cpp

设置音频采集路由是否跟随系统。

传入参数

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

设置音频播放设备。

传入参数

返回值

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

注意
当你调用 followSystemPlaybackDevice 设置音频播放设备跟随系统后，将无法调用此接口设置音频播放设备。

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

设置音频采集设备。

传入参数

返回值
方法调用结果

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

注意
当你调用 followSystemCaptureDevice 设置音频采集设备跟随系统后，将无法调用此接口设置音频采集设备。

virtual int bytertc::IAudioDeviceManager::setAudioPlaybackDeviceVolume(
    unsigned int volume)
cpp

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

传入参数

返回值
方法调用结果

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

virtual int bytertc::IAudioDeviceManager::getAudioPlaybackDeviceVolume(
    unsigned int* volume)
cpp

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

传入参数

返回值
方法调用结果

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

virtual int bytertc::IAudioDeviceManager::setAudioCaptureDeviceVolume(
    unsigned int volume)
cpp

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

传入参数

返回值
方法调用结果

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

virtual int bytertc::IAudioDeviceManager::getAudioCaptureDeviceVolume(
    unsigned int* volume)
cpp

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

传入参数

返回值
方法调用结果

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

virtual int bytertc::IAudioDeviceManager::setAudioPlaybackDeviceMute(
    bool mute)
cpp

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

传入参数

返回值
方法调用结果

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

virtual int bytertc::IAudioDeviceManager::getAudioPlaybackDeviceMute(
    bool* mute)
cpp

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

传入参数

返回值
方法调用结果

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

virtual int bytertc::IAudioDeviceManager::setAudioCaptureDeviceMute(
    bool mute)
cpp

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

传入参数

返回值
方法调用结果

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

virtual int bytertc::IAudioDeviceManager::getAudioCaptureDeviceMute(
    bool* mute)
cpp

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

传入参数

返回值
方法调用结果

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

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

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

传入参数

返回值
方法调用结果

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

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

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

传入参数

返回值
方法调用结果

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

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

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

传入参数

返回值
设备状态错误码

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

注意

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

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

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

传入参数

返回值
设备状态错误码

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

注意

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

virtual int bytertc::IAudioDeviceManager::startAudioPlaybackDeviceTest(
    const char* test_audio_file_path,
    int indication_interval)
cpp

启动音频播放设备检测。测试启动后，循环播放指定的音频文件，同时将通过 onAudioPlaybackDeviceTestVolume 回调播放时的音量信息。

传入参数

返回值
方法调用结果

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

注意

• 该方法可在进房前和进房后调用，不可与其它音频设备测试功能同时应用。
• 调用 stopAudioPlaybackDeviceTest 可以停止测试。

virtual int bytertc::IAudioDeviceManager::stopAudioPlaybackDeviceTest()
cpp

停止音频播放测试。

返回值
方法调用结果

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

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

virtual int bytertc::IAudioDeviceManager::startAudioDeviceRecordTest(
    int indication_interval)
cpp

开始音频采集设备和音频播放设备测试。

传入参数

返回值
方法调用结果

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

注意

• 该方法在进房前后均可调用。且不可与其它音频设备测试功能同时应用。
• 调用本接口 30 s 后，采集自动停止，并开始播放采集到的声音。录音播放完毕后，设备测试流程自动结束。你也可以在 30 s 内调用 stopAudioDeviceRecordAndPlayTest 来停止采集并开始播放此前采集到的声音。
• 调用 stopAudioDevicePlayTest 可以停止音频设备采集和播放测试。
• 你不应在测试过程中，调用 enableAudioPropertiesReport 注册音量提示回调。
• 该方法仅在本地进行音频设备测试，不涉及网络连接。

virtual int bytertc::IAudioDeviceManager::stopAudioDeviceRecordAndPlayTest()
cpp

停止采集本地音频，并开始播放采集到的声音。录音播放完毕后，设备测试流程结束。

调用 startAudioDeviceRecordTest 30 s 内调用本接口来停止采集并开始播放此前采集到的声音。

返回值
方法调用结果

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

注意
调用本接口开始播放录音后，可以在播放过程中调用 stopAudioDevicePlayTest 停止播放。

virtual int bytertc::IAudioDeviceManager::stopAudioDevicePlayTest()
cpp

停止由调用 startAudioDeviceRecordTest 开始的音频播放设备测试。

在音频播放设备测试自动结束前，可调用本接口停止音频采集与播放测试。

返回值
方法调用结果

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

class bytertc::IAudioMixingManager
cpp

混音管理类

virtual void bytertc::IAudioMixingManager::startAudioMixing(
    int mix_id,
    const char * file_path,
    const AudioMixingConfig& config)
cpp

开始播放音频文件。
可以通过传入不同的 ID 和 filepath 多次调用本方法，以实现同时播放多个混音文件，实现混音叠加。

传入参数

注意

• 如果已经通过 preloadAudioMixing 将文件加载至内存，确保此处的 ID 与预加载时设置的 ID 相同。
• 调用本方法播放音频文件后，关于当前的混音状态，会收到回调 onAudioMixingStateChanged。
• 开始播放音频文件后，可以调用 stopAudioMixing 方法停止播放音频文件。
• 本方法的混音数据来源于外部文件，而 enableAudioMixingFrame 的混音数据来源于外部缓存且音频格式为 PCM，这两种混音方式可以共存。

virtual void bytertc::IAudioMixingManager::stopAudioMixing(
    int mix_id)
cpp

停止播放音频文件及混音。

传入参数

注意

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

virtual void bytertc::IAudioMixingManager::pauseAudioMixing(
    int mix_id)
cpp

暂停播放音频文件及混音。

传入参数

注意

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

virtual void bytertc::IAudioMixingManager::resumeAudioMixing(
    int mix_id)
cpp

恢复播放音频文件及混音。

传入参数

注意

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

virtual void bytertc::IAudioMixingManager::preloadAudioMixing(
    int mix_id,
    const char* file_path)
cpp

预加载指定音乐文件到内存中，以避免频繁播放同一文件时的重复加载，减少 CPU 占用。

传入参数

注意

• 本方法只是预加载指定音频文件，只有调用 startAudioMixing 方法才开始播放指定音频文件。
• 调用本方法预加载音频文件后，关于当前的混音状态，会收到回调 onAudioMixingStateChanged。
• 调用本方法预加载的指定音频文件可以通过 unloadAudioMixing 卸载。

virtual void bytertc::IAudioMixingManager::unloadAudioMixing(
    int mix_id)
cpp

卸载指定音乐文件。

传入参数

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

virtual int bytertc::IAudioMixingManager::getAudioMixingDuration(
    int mix_id)
cpp

获取音频文件时长。

传入参数

返回值

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

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

virtual int bytertc::IAudioMixingManager::getAudioMixingCurrentPosition(
    int mix_id)
cpp

获取音频文件播放进度。

传入参数

返回值

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

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

virtual void bytertc::IAudioMixingManager::setAudioMixingPosition(
    int mix_id,
    int position)
cpp

设置音频文件的起始播放位置

传入参数

注意
在播放在线文件时，调用此接口可能造成播放延迟的现象。

virtual void bytertc::IAudioMixingManager::setAudioMixingDualMonoMode(
    int mix_id,
    AudioMixingDualMonoMode mode)
cpp

设置当前音频文件的声道模式

传入参数

注意

• 调用本方法设置音频文件的声道模式前，需要先调用 startAudioMixing 开始播放音频文件。
• 此方法对 enableAudioMixingFrame 播放的音乐无效。

virtual void bytertc::IAudioMixingManager::setAudioMixingPitch(
    int mix_id,
    int pitch)
cpp

开启本地播放音乐文件变调功能，多用于 K 歌场景。

使用该方法，你可以对本地播放音乐文件的音调进行升调或降调等调整。

传入参数

注意
本方法需要在调用 startAudioMixing 开始播放音频文件后、调用 stopAudioMixing 停止播放音频文件前使用，否则会触发 onAudioMixingStateChanged 回调报错

virtual int bytertc::IAudioMixingManager::setAudioMixingPlaybackSpeed(
    int mix_id,
    int speed)
cpp

设置混音时音频文件的播放速度

传入参数

注意

• 暂不支持对 PCM 音频数据进行变速调整。
• 你需要在调用 startAudioMixing 开始混音，并且收到onAudioMixingStateChanged 回调提示 AudioMixingState 状态为 kAudioMixingStatePlaying，AudioMixingError 错误码为 kAudioMixingErrorOk 之后调用该方法。
• 在 stopAudioMixing 停止混音或 unloadAudioMixing 卸载音频文件后调用该 API，会收到状态为 kAudioMixingStateFailed 错误码为 kAudioMixingErrorIdNotFound 的 onAudioMixingStateChanged 回调。

virtual void bytertc::IAudioMixingManager::setAudioMixingProgressInterval(
    int mix_id,
    int64_t interval)
cpp

设置混音时音频文件播放进度回调的间隔

传入参数

注意
本方法需要在调用 startAudioMixing 开始播放音频文件后、调用 stopAudioMixing 停止播放音频文件前使用，否则会触发 onAudioMixingStateChanged 回调报错。 若想在音乐文件开始播放前设置播放进度回调间隔，你需调用 startAudioMixing 在 AudioMixingConfig 中设置时间间隔，开始播放后可以通过此接口更新回调间隔。

virtual void bytertc::IAudioMixingManager::setAudioMixingLoudness(
    int mix_id,
    float loudness)
cpp

如果你需要使用 enableVocalInstrumentBalance 对混音音频文件/PCM 音频数据进行音量调整，你必须通过此接口传入其原始响度。

传入参数

注意
建议在 startAudioMixing 开始播放音频文件之前调用该接口，以免播放过程中的音量突变导致听感体验下降。

virtual void bytertc::IAudioMixingManager::enableAudioMixingFrame(
    int mix_id,
    AudioMixingType type)
cpp

启动 PCM 音频数据混音。

要实现多个 PCM 音频数据混音，多次调用本方法，并传入不同的 id。
启动 PCM 音频数据混音。

要实现多个 PCM 音频数据混音，多次调用本方法，并传入不同的 mix_id。

传入参数

注意

• 必须先调用本方法启动 PCM 音频数据混音，随后调用 pushAudioMixingFrame 方法，才会开始混音。
• 如要结束 PCM 音频数据混音，使用 disableAudioMixingFrame。

virtual void bytertc::IAudioMixingManager::disableAudioMixingFrame(
    int mix_id)
cpp

关闭 PCM 混音

传入参数

virtual int bytertc::IAudioMixingManager::pushAudioMixingFrame(
    int mix_id,
    IAudioFrame* audio_frame)
cpp

推送 PCM 音频帧数据用于混音

传入参数

返回值

• 0: 成功
• < 0: 失败

注意

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