@interface ByteRTCRoom : NSObject
objectivec

@property(nonatomic, weak) id<ByteRTCRoomDelegate> _Nullable delegate;
objectivec

- (void)destroy;
objectivec

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

- (NSString *_Nonnull)getRoomId;
objectivec

Available since 3.53

获取房间 ID。

返回值
房间 ID。

- (int)setRTCRoomDelegate:(id<ByteRTCRoomDelegate> _Nullable)roomDelegate;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

- (int)joinRoom:(NSString *_Nullable)token userInfo:(ByteRTCUserInfo *_Nonnull)userInfo roomConfig:(ByteRTCRoomConfig *_Nonnull)roomConfig;
objectivec

加入房间。

调用 createRTCRoom: 创建房间后，调用此方法加入房间，同房间内其他用户进行音视频通话。

传入参数

返回值
方法调用结果。

• 0: 成功
• -1: 参数无效
• -2: 已经在房间内。接口调用成功后，只要收到返回值为 0 ，且未调用 leaveRoom 成功，则再次调用进房接口时，无论填写的房间 ID 和用户 ID 是否重复，均触发此返回值。
  调用失败时，具体失败原因会通过 rtcRoom:onRoomStateChanged:withUid:state:extraInfo: 回调告知。

注意

• 同一个 AppID 的同一个房间内，每个用户的用户 ID 必须是唯一的。如果两个用户的用户 ID 相同，则后加入房间的用户会将先加入房间的用户踢出房间，并且先加入房间的用户会收到 rtcRoom:onRoomStateChanged:withUid:state:extraInfo: 回调通知，错误类型为重复登录 ByteRTCErrorCodeDuplicateLogin。
• 本地用户调用此方法加入房间成功后，会收到 rtcRoom:onRoomStateChanged:withUid:state:extraInfo: 回调通知。若本地用户同时为可见用户，加入房间时远端用户会收到 rtcRoom:onUserJoined:elapsed: 回调通知。
• 房间内不可见用户的容量远远大于可见用户，而且用户默认可见，因此对于不参与互动的用户，你需要调用 setUserVisibility: 更改为不可见用户。从而避免因房间内用户达到数量上限所导致的进房失败。默认情况下，一个 RTC 房间最多同时容纳 50 名可见用户，其中最多 30 人可同时上麦，更多信息参看用户和媒体流上限。
• 用户加入房间成功后，在本地网络状况不佳的情况下，SDK 可能会与服务器失去连接，并触发 rtcEngine:onConnectionStateChanged: 回调。此时 SDK 会自动重试，直到成功重连。重连成功后，本地会收到 rtcRoom:onRoomStateChanged:withUid:state:extraInfo:。

- (int)setUserVisibility:(BOOL)enable;
objectivec

设置用户可见性。未调用该接口前，本地用户默认对他人可见。
默认情况下，一个 RTC 房间最多同时容纳 50 名可见用户，最多 30 人可同时上麦。更多信息参看用户和媒体流上限。

传入参数

返回值

• 0: 调用成功。
• < 0: 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明。

注意

• 在加入房间前后，用户均可调用此方法设置用户可见性。
• 设置用户可见性，会收到设置成功/失败回调 rtcRoom:onUserVisibilityChanged:errorCode:。（v3.54 新增）
  • 在加入房间前设置用户可见性，若设置的可见性与默认值不同，将在加入房间时触发本回调。
  • 在加入房间后设置用户可见性，若可见性前后不同，会触发本回调。
  • 在断网重连后，若可见性发生改变，会触发本回调。
• 在房间内，调用此方法成功切换用户可见性后，房间内其他用户会收到相应的回调。
  • 从可见换至不可见时，房间内其他用户会收到 rtcRoom:onUserLeave:reason:。
  • 从不可见切换至可见时，房间内其他用户会收到 rtcRoom:onUserJoined:elapsed:。
  • 若调用该方法将可见性设为 false，此时尝试发布流会收到 ByteRTCWarningCodeSubscribeStreamForbiden 警告。

- (int)setMultiDeviceAVSync:(NSString* _Nullable) audioUserId;
objectivec

设置发流端音画同步。

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)leaveRoom;
objectivec

离开房间。

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

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 用户离开房间后，本地会收到 rtcRoom:onLeaveRoom: 的回调；
• 调用 setUserVisibility: 方法将自身设为可见的用户离开房间后，房间内其他用户会收到 rtcRoom:onUserLeave:reason: 回调通知。

- (int)updateToken:(NSString *_Nullable)token;
objectivec

更新 Token。
收到 onTokenWillExpire:，onPublishPrivilegeTokenWillExpire:，或 onSubscribePrivilegeTokenWillExpire: 时，你必须重新获取 Token，并调用此方法更新 Token，以保证通话的正常进行。

传入参数

返回值

• 0：成功；
• !0：失败。

注意
请勿同时调用 updateToken: 和 joinRoom:userInfo:roomConfig: 重新加入房间。

- (int) setRemoteVideoConfig:(NSString * _Nonnull) userId remoteVideoConfig:(ByteRTCRemoteVideoConfig *_Nonnull) remoteVideoConfig;
objectivec

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

传入参数

返回值
方法调用结果：

• 0：成功；
• !0：失败。

注意

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

- (int)publishStream:(ByteRTCMediaStreamType)type;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)unpublishStream:(ByteRTCMediaStreamType)type;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)publishScreen:(ByteRTCMediaStreamType)type;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 如果你已经在用户进房时通过调用 joinRoom:userInfo:roomConfig: 成功选择了自动发布，则无需再调用本接口。
• 调用 setUserVisibility: 方法将自身设置为不可见后无法调用该方法，需将自身切换至可见后方可调用该方法发布屏幕流。
• 调用该方法后，房间中的所有远端用户会收到 rtcRoom:onUserPublishScreen:type: 回调，其中成功收到音频流的远端用户会收到 rtcEngine:onFirstRemoteAudioFrame: 回调，订阅了视频流的远端用户会收到 rtcEngine:onFirstRemoteVideoFrameDecoded:withFrameInfo: 回调。
• 调用该方法后，本地用户会收到 rtcEngine:onScreenVideoFrameSendStateChanged:rtcUser:state:。
• 如果你需要向多个房间发布流，调用 startForwardStreamToRooms:。
• 调用 unpublishScreen: 取消发布。
• 查看 屏幕共享，获取更多信息。

- (int)unpublishScreen:(ByteRTCMediaStreamType)type;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)subscribeUserStream:(NSString *_Nonnull)userId streamType:(ByteRTCStreamIndex)streamType mediaType:(ByteRTCSubscribeMediaType)mediaType videoConfig:(ByteRTCSubscribeVideoConfig *_Nonnull)videoConfig __deprecated_msg("Will be removed in new version");
objectivec

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

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

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

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

传入参数

注意

• 你必须通过 rtcRoom:onStreamAdd: 和 rtcRoom:onStreamRemove:stream:reason: 两个回调获取当前房间里的音视频流信息，并调用本方法按需订阅流或修改订阅配置。
• 若订阅失败，你会收到 rtcEngine:onError: 回调通知，具体失败原因参看 ByteRTCErrorCode。
• 若调用 pauseAllSubscribedStream: 暂停接收远端音视频流，此时仍可使用该方法对暂停接收的流进行设置，你会在调用 resumeAllSubscribedStream: 恢复接收流后收到修改设置后的流。

- (int)subscribeStream:(NSString *_Nonnull)userId mediaStreamType:(ByteRTCMediaStreamType)mediaStreamType;
objectivec

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

传入参数

返回值
方法调用结果：

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

注意

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

- (int)subscribeAllStreamsWithMediaStreamType:(ByteRTCMediaStreamType)mediaStreamType;
objectivec

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

传入参数

返回值

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

注意

• 多次调用订阅接口时，将根据末次调用接口和传入的参数，更新订阅配置。
• 开启音频选路后，如果房间内的媒体流超过上限，建议通过调用 subscribeStream:mediaStreamType: 逐一指定需要订阅的媒体流。
• 调用该方法后，你会收到 rtcRoom:onStreamSubscribed:userId:subscribeConfig: 通知方法调用结果。
• 成功调用本接口后，订阅关系将持续到调用 unsubscribeStream:mediaStreamType: 或 unsubscribeAllStreamsWithMediaStreamType: 取消订阅或本端用户退房。
• 关于其他调用异常，你会收到 rtcRoom:onRoomStateChanged:withUid:state:extraInfo: 回调通知，具体异常原因参看 ByteRTCErrorCode。

- (int)unsubscribeStream:(NSString *_Nonnull)userId mediaStreamType:(ByteRTCMediaStreamType)mediaStreamType;
objectivec

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

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

传入参数

返回值
方法调用结果：

• 0：成功；
• !0：失败。

注意

• 调用该方法后，你会收到 rtcRoom:onStreamSubscribed:userId:subscribeConfig: 通知方法调用结果。
• 关于其他调用异常，你会收到 rtcRoom:onStreamStateChanged:withUid:state:extraInfo: 回调通知，具体失败原因参看 ByteRTCErrorCode。

- (int)unsubscribeAllStreamsWithMediaStreamType:(ByteRTCMediaStreamType)mediaStreamType;
objectivec

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

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

传入参数

返回值
方法调用结果：

• 0：成功
• !0：失败

注意

• 调用该方法后，你会收到 rtcRoom:onStreamSubscribed:userId:subscribeConfig: 通知方法调用结果。
• 关于其他调用异常，你会收到 rtcRoom:onRoomStateChanged:withUid:state:extraInfo: 回调通知，具体失败原因参看 ByteRTCErrorCode。

- (int)subscribeScreen:(NSString *_Nonnull)userId mediaStreamType:(ByteRTCMediaStreamType)mediaStreamType;
objectivec

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

传入参数

返回值
方法调用结果：

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

注意

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

- (int)unsubscribeScreen:(NSString *_Nonnull)userId mediaStreamType:(ByteRTCMediaStreamType)mediaStreamType;
objectivec

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

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

传入参数

返回值
方法调用结果：

• 0：成功；
• !0：失败。

注意

• 调用该方法后，你会收到 rtcRoom:onStreamSubscribed:userId:subscribeConfig: 通知方法调用结果。
• 关于其他调用异常，你会收到 rtcRoom:onStreamStateChanged:withUid:state:extraInfo: 回调通知，具体失败原因参看 ByteRTCErrorCode。

- (int)pauseAllSubscribedStream:(ByteRTCPauseResumControlMediaType) mediaType;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)resumeAllSubscribedStream:(ByteRTCPauseResumControlMediaType) mediaType;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (NSInteger)sendUserMessage:(NSString *_Nonnull)userId message:(NSString *_Nonnull)message config:(ByteRTCMessageConfig)config;
objectivec

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

传入参数

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

注意

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

- (NSInteger)sendUserBinaryMessage:(NSString * _Nonnull)uid message:(NSData * _Nonnull)message config:(ByteRTCMessageConfig)config;
objectivec

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

传入参数

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

注意

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

- (NSInteger)sendRoomMessage:(NSString *_Nonnull)message;
objectivec

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

传入参数

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

注意

• 在发送房间内文本消息前，必须先调用 joinRoom:userInfo:roomConfig: 加入房间。
• 调用该函数后会收到一次 rtcRoom:onRoomMessageSendResult:error: 回调，通知消息发送方发送成功或失败；
• 若文本消息发送成功，则房间内所有远端用户会收到 rtcRoom:onRoomMessageReceived:message: 回调。

- (NSInteger)sendRoomBinaryMessage:(NSData * _Nonnull)message;
objectivec

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

传入参数

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

注意

• 在房间内广播二进制消息前，必须先调用 joinRoom:userInfo:roomConfig: 加入房间。
• 调用该函数后会收到一次 rtcRoom:onRoomMessageSendResult:error: 回调，通知消息发送方发送成功或失败；
• 若二进制消息发送成功，则房间内所有用户会收到 rtcRoom:onRoomBinaryMessageReceived:message: 回调。

- (int)startForwardStreamToRooms:(NSArray <ByteRTCForwardStreamConfiguration *> * _Nullable)configurations;
objectivec

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

传入参数

返回值

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

注意

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

- (int)updateForwardStreamToRooms:(NSArray <ByteRTCForwardStreamConfiguration *> * _Nullable)configurations;
objectivec

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

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

传入参数

返回值

• 0: 方法调用成功

注意

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

- (int)stopForwardStreamToRooms;
objectivec

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

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)pauseForwardStreamToAllRooms;
objectivec

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

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)resumeForwardStreamToAllRooms;
objectivec

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

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (ByteRTCRangeAudio *_Nullable)getRangeAudio;
objectivec

获取范围语音接口实例。

返回值
方法调用结果：

• ByteRTCRangeAudio：成功，返回一个 ByteRTCRangeAudio 实例。
• NULL：失败，当前 SDK 不支持范围语音功能。

注意
首次调用该方法须在创建房间后、加入房间前。范围语音相关 API 和调用时序详见范围语音。

- (ByteRTCSpatialAudio *_Nullable)getSpatialAudio;
objectivec

获取空间音频接口实例。

返回值
方法调用结果：

• ByteRTCSpatialAudio：成功，返回一个 ByteRTCSpatialAudio 实例。
• NULL：失败，当前 SDK 不支持空间音频功能。

注意

• 首次调用该方法须在创建房间后、加入房间前。 空间音频相关 API 和调用时序详见空间音频。
• 只有在使用支持真双声道播放的设备时，才能开启空间音频效果；
• 机型性能不足可能会导致音频卡顿，使用低端机时，不建议开启空间音频效果；
• SDK 最多支持 30 个用户同时开启空间音频功能。

- (int)setRemoteRoomAudioPlaybackVolume:(NSInteger)volume;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

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

- (int)setAudioSelectionConfig:(ByteRTCAudioSelectionPriority)audioSelectionPriority;
objectivec

Available since 3.52.

设置本端发布流在音频选路中的优先级。

传入参数

注意
在控制台上为本 appId 开启音频选路后，调用本接口才会生效。进房前后调用均可生效。更多信息参见音频选路。
如果本端用户同时加入不同房间，使用本接口进行的设置相互独立。

- (NSInteger)setRoomExtraInfo:(NSString *_Nonnull)key value:(NSString *_Nonnull)value;
objectivec

Available since 3.52.

设置/更新房间附加信息，可用于标识房间状态或属性，或灵活实现各种业务逻辑。

传入参数

返回值

• 0: 方法调用成功，返回本次调用的任务编号；
• <0: 方法调用失败，具体原因详见 ByteRTCSetRoomExtraInfoResult。

注意

• 在设置房间附加信息前，必须先调用 joinRoom:userInfo:roomConfig: 加入房间。
• 调用该方法后，会收到一次 rtcRoom:onSetRoomExtraInfoResult:error: 回调，提示设置结果。
• 调用该方法成功设置附加信息后，同一房间内的其他用户会收到关于该信息的回调 rtcRoom:onRoomExtraInfoUpdate:value:lastUpdateUserId:lastUpdateTimeMs:。
• 新进房的用户会收到进房前房间内已有的全部附加信息通知。

- (int)startSubtitle:(ByteRTCSubtitleConfig *_Nonnull)subtitleConfig;
objectivec

Available since 3.52

识别或翻译房间内所有用户的语音，形成字幕。

调用该方法时，可以在 ByteRTCSubtitleMode 中选择语音识别或翻译模式。如果选择识别模式，语音识别文本会通过 rtcRoom:onSubtitleMessageReceived: 事件回调给你；

如果选择翻译模式，你会同时收到两个 rtcRoom:onSubtitleMessageReceived: 回调，分别包含字幕原文及字幕译文。

调用该方法后，用户会收到 rtcRoom:onSubtitleStateChanged:errorCode:errorMessage: 回调，通知字幕是否开启。

传入参数

返回值

• 0: 调用成功。
• !0: 调用失败。

注意

• 使用字幕功能前，你需要在 RTC 控制台 开启实时字幕功能。
• 如果你需要使用流式语音识别模式，你应在 语音技术控制台 创建流式语音识别应用。创建时，服务类型应选择 流式语音识别，而非 音视频字幕生成。创建后，在 RTC 控制台 上启动流式语音识别，并填写创建语音技术应用时获取的相关信息，包括：APP ID，Access Token，和 Cluster ID。
• 如果你需要使用实时语音翻译模式，你应开通机器翻译服务，参考 开通服务。完成开通后，在 RTC 控制台 上启用实时语音翻译模式。
• 如需指定源语言，你需要在调用 joinRoom 接口进房时，通过 extraInfo 参数传入格式为"语种英文名": "语种代号" JSON 字符串，例如设置源语言为英文时，传入 "source_language": "en"。如未指定源语言，SDK 会将系统语种设定为源语言。如果你的系统语种不是中文、英文和日文，此时 SDK 会自动将中文设为源语言。
• 识别模式下，你可以传入 RTC 控制台上预设或自定义的语种英文名和语种代号。识别模式下支持的语言参看识别模式语种支持。
• 翻译模式下，你需要传入机器翻译规定的语种英文名和语种代号。翻译模式下支持的语言及对应的代号参看翻译模式语言支持。

- (int)stopSubtitle;
objectivec

Available since 3.52

关闭字幕。

调用该方法后，用户会收到 rtcRoom:onSubtitleStateChanged:errorCode:errorMessage: 回调，通知字幕是否关闭。

返回值

• 0: 调用成功。
• !0: 调用失败。

@interface ByteRTCVideo : NSObject
objectivec

@property (nonatomic, weak) id<ByteRTCVideoDelegate> _Nullable delegate;
objectivec

+ (void)destroyRTCVideo;
objectivec

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

注意

• 请确保和需要销毁的 ByteRTCVideo 实例相关的业务场景全部结束后，才调用此方法
• 该方法在调用之后，会销毁所有和此 ByteRTCVideo 实例相关的内存，并且停止与媒体服务器的任何交互
• 调用本方法会启动 SDK 退出逻辑。引擎线程会保留，直到退出逻辑完成。因此，不要在回调线程中直接调用此 API，会导致死锁。同时此方法是耗时操作，不建议在主线程调用本方法，避免主线程阻塞。
• 可以通过 Objective-C 的ARC机制，在 dealloc 时自动触发销毁逻辑

+ (NSString * _Nonnull)getSDKVersion;
objectivec

获取 SDK 当前的版本号。

返回值
SDK 当前的版本号。

+ (int) setLogConfig:(ByteRTCLogConfig *_Nonnull) logConfig;
objectivec

配置 SDK 本地日志参数，包括日志级别、存储路径、日志文件最大占用的总空间、日志文件名前缀。

传入参数

返回值

• 0：成功。
• –1：失败，本方法必须在创建引擎前调用。
• –2：失败，参数填写错误。

注意
本方法必须在调用 createRTCVideo:delegate:parameters: 之前调用。

+ (NSString * _Nonnull)getErrorDescription:(NSInteger)code;
objectivec

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

传入参数

返回值
描述文字。

+ (ByteRTCVideo * _Nullable) createRTCVideo:(NSString * _Nonnull)appId delegate:(id<ByteRTCVideoDelegate> _Nullable)delegate parameters:(NSDictionary * _Nonnull)parameters;
objectivec

创建引擎对象。
如果当前进程中未创建引擎实例，那么你必须先使用此方法，以使用 RTC 提供的各种音视频能力。
如果当前进程中已创建了引擎实例，再次调用此方法时，会返回已创建的引擎实例。

传入参数

返回值
可用的 ByteRTCVideo 实例

- (int)setAudioSourceType:(ByteRTCAudioSourceType) type;
objectivec

切换音频采集方式

传入参数

返回值
方法调用结果：

• >0: 切换成功。
• -1：切换失败。

注意

• 进房前后调用此方法均有效。
• 如果你调用此方法由内部采集切换至自定义采集，SDK 会自动关闭内部采集。然后，调用 pushExternalAudioFrame: 推送自定义采集的音频数据到 RTC SDK 用于传输。
• 如果你调用此方法由自定义采集切换至内部采集，你必须再调用 startAudioCapture 手动开启内部采集。

- (int)setAudioRenderType:(ByteRTCAudioRenderType) type;
objectivec

切换音频渲染方式

传入参数

返回值
方法调用结果：

• >0: 切换成功。
• -1：切换失败。

注意

• 进房前后调用此方法均有效。
• 如果你调用此方法切换至自定义渲染，调用 pullExternalAudioFrame: 获取音频数据。

- (int)startAudioCapture;
objectivec

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

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

可见用户进房后调用该方法，房间中的其他用户会收到 rtcEngine:onUserStartAudioCapture:uid: 的回调。

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)stopAudioCapture;
objectivec

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

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

可见用户进房后调用该方法，房间中的其他用户会收到 rtcEngine:onUserStopAudioCapture:uid: 的回调。

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)setAudioProfile:(ByteRTCAudioProfileType)audioProfile;
objectivec

设置音质档位。

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)setAnsMode:(ByteRTCAnsMode)ansMode;
objectivec

支持根据业务场景，设置通话中的音频降噪模式。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 该接口进房前后均可调用，可重复调用，仅最后一次调用生效。
• 降噪算法包含传统降噪和 AI 降噪。传统降噪主要是抑制平稳噪声，比如空调声、风扇声等。而 AI 降噪主要是抑制非平稳噪声，比如键盘敲击声、桌椅碰撞声等。房间设置为以下 ChannelProfile 时，AI 降噪始终为关闭状态，调用本接口只能调整传统降噪强度：ByteRTCRoomProfileLowLatency, ByteRTCRoomProfileChorus 和 [Deprecated] ByteRTCRoomProfileLiveBroadcasting 。

- (int)enableAGC:(BOOL)enable;
objectivec

Available since 3.51

打开/关闭 AGC 功能
打开/关闭 AGC(Analog Automatic Gain Control)模拟自动增益控制功能。

开启该功能后，SDK 会自动调节麦克风的采集音量，确保音量稳定。

传入参数

返回值

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

注意
该方法在进房前后均可调用。如果你需要在进房前使用 AGC 功能，请联系技术支持获得私有参数，传入对应 ByteRTCRoomProfile 。
要想在进房后开启 AGC 功能，你需要把 ByteRTCRoomProfile 设为 ByteRTCRoomProfileMeeting、ByteRTCRoomProfileMeetingRoom 或ByteRTCRoomProfileClassroom 。
AGC 功能生效后，不建议再调用 setAudioCaptureDeviceVolume: 来调节设备麦克风的采集音量。

- (int)setVoiceChangerType:(ByteRTCVoiceChangerType)voiceChanger;
objectivec

Available since 3.32

设置变声特效类型

传入参数

返回值
方法调用结果：

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

注意

• 如需使用该功能，需集成 SAMI 动态库，详情参看按需集成插件文档。
• 在进房前后都可设置。
• 对 RTC SDK 内部采集的音频和自定义采集的音频都生效。
• 只对单声道音频生效。
• 与 setVoiceReverbType: 互斥，后设置的特效会覆盖先设置的特效。

- (int)setVoiceReverbType:(ByteRTCVoiceReverbType)voiceReverb;
objectivec

Available since 3.32

设置混响特效类型

传入参数

返回值
方法调用结果：

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

注意

• 在进房前后都可设置。
• 对 RTC SDK 内部采集的音频和自定义采集的音频都生效。
• 只对单声道音频生效。
• 与 setVoiceChangerType: 互斥，后设置的特效会覆盖先设置的特效。

-(int)setLocalVoiceEqualization:(ByteRTCVoiceEqualizationConfig* _Nonnull)config;
objectivec

设置本地采集语音的均衡效果。包含内部采集和外部采集，但不包含混音音频文件。

传入参数

返回值

• 0： 成功。
• < 0： 失败。

注意
根据奈奎斯特采样率，音频采样率必须大于等于设置的中心频率的两倍，否则，设置不生效。

-(int)setLocalVoiceReverbParam:(ByteRTCVoiceReverbConfig* _Nonnull)param;
objectivec

设置本地采集音频的混响效果。包含内部采集和外部采集，但不包含混音音频文件。

传入参数

返回值

• 0： 成功。
• < 0： 失败。

注意
调用 enableLocalVoiceReverb: 开启混响效果。

-(int)enableLocalVoiceReverb:(bool)enable;
objectivec

开启本地音效混响效果

传入参数

返回值

• 0： 成功。
• < 0： 失败。

注意
调用 setLocalVoiceReverbParam: 设置混响效果。

- (int)setCaptureVolume:(ByteRTCStreamIndex)index volume:(int)volume;
objectivec

调节音频采集音量

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)setPlaybackVolume:(NSInteger)volume;
objectivec

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

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)enableAudioPropertiesReport:(ByteRTCAudioPropertiesConfig* _Nonnull)config;
objectivec

启用音频信息提示。启用后，你可以收到 rtcEngine:onLocalAudioPropertiesReport:，rtcEngine:onRemoteAudioPropertiesReport:totalRemoteVolume:，和 rtcEngine:onActiveSpeaker:uid:。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

- (int)setRemoteAudioPlaybackVolume:(NSString *_Nonnull)roomID remoteUid:(NSString *_Nonnull)userID playVolume:(NSInteger)volume;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

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

- (int)setEarMonitorMode:(ByteRTCEarMonitorMode)mode;
objectivec

开启/关闭耳返功能。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 耳返功能仅适用于由 RTC SDK 内部采集的音频。
• 使用耳返必须佩戴耳机。为保证低延时耳返最佳体验，建议佩戴有线耳机。
• 对于 iOS，仅支持软件耳返功能。
• 对于 macOS，耳返功能仅支持设备通过 3.5mm 接口、USB 接口、或蓝牙方式直连耳机时可以使用。对于通过 HDMI 或 USB-C 接口连接显示器，再连接，或通过连接 OTG 外接声卡再连接的耳机，不支持耳返功能。

- (int)setEarMonitorVolume:(NSInteger)volume;
objectivec

设置耳返的音量。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明。

注意
设置耳返音量前，你必须先调用 setEarMonitorMode: 打开耳返功能。

- (int)setLocalVoicePitch:(NSInteger)pitch;
objectivec

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

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

- (int)enableVocalInstrumentBalance:(BOOL)enable;
objectivec

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

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)enablePlaybackDucking:(BOOL)enable;
objectivec

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

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

- (int)setLocalVideoSink:(ByteRTCStreamIndex)index withSink:(id<ByteRTCVideoSinkDelegate> _Nullable)videoSink withPixelFormat:(ByteRTCVideoSinkPixelFormat)requiredFormat;
objectivec

Deprecated since 3.57, use setLocalVideoRender:withSink:withLocalRenderConfig: instead.

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)setLocalVideoRender:(ByteRTCStreamIndex)index withSink:(id<ByteRTCVideoSinkDelegate> _Nullable)videoSink withLocalRenderConfig:(ByteRTCLocalVideoSinkConfig*)config;
objectivec

Available since 3.57

将本地视频流与自定义渲染器绑定。你可以通过参数设置返回指定位置和格式的视频帧数据。

传入参数

返回值

• 0: 调用成功。
• < 0: 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明。

注意

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

- (int)setRemoteVideoSink:(ByteRTCRemoteStreamKey* _Nonnull)streamKey withSink:(id<ByteRTCVideoSinkDelegate> _Nullable)videoSink withPixelFormat:(ByteRTCVideoSinkPixelFormat)requiredFormat;
objectivec

Deprecated since 3.57, use setRemoteVideoRender:withSink:withRemoteRenderConfig: instead.

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)setRemoteVideoRender:(ByteRTCRemoteStreamKey* _Nonnull)streamKey withSink:(id<ByteRTCVideoSinkDelegate> _Nullable)videoSink withRemoteRenderConfig:(ByteRTCRemoteVideoSinkConfig*)config;
objectivec

Available since 3.57

将远端视频流与自定义渲染器绑定。你可以通过参数设置返回指定位置和格式的视频帧数据。

传入参数

返回值

• 0: 调用成功。
• < 0: 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明。

注意

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

- (int)setLowLightAdjusted:(ByteRTCVideoEnhancementMode)mode;
objectivec

Available since 3.57

设置视频暗光增强模式。
对于光线不足、照明不均匀或背光等场景下推荐开启，可有效改善画面质量。

传入参数

返回值

• 0: API 调用成功。会立即生效，但需要等待下载和检测完成后才能看到增强后的效果。
• < 0: API 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明。

注意

• 开启后会影响设备性能，应根据实际需求和设备性能决定是否开启。
• 对 RTC SDK 内部采集的视频和自定义采集的视频都生效。

- (int)setVideoEncoderConfig:(ByteRTCStreamIndex)streamIndex config:(NSArray <ByteRTCVideoSolution *> * _Nullable)videoSolutions __deprecated_msg("Will be removed in new version");
objectivec

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

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

传入参数

返回值

• 0：成功
• !0：失败

注意

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

- (int)setVideoCaptureRotation:(ByteRTCVideoRotation)rotation;
objectivec

设置本端采集的视频帧的旋转角度。
当摄像头倒置或者倾斜安装时，可调用本接口进行调整。对于手机等普通设备，可调用 setVideoRotationMode: 实现旋转。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 对于内部采集的视频画面，如果已调用 setVideoRotationMode: 设置了旋转方向，会在此基础上叠加旋转角度。
• 调用本接口也将对自定义采集视频画面生效，在原有的旋转角度基础上叠加本次设置。
• 视频贴纸特效或通过 enableVirtualBackgroundenableVirtualBackground:withSource: 增加的虚拟背景，也会跟随本接口的设置进行旋转。
• 本地渲染视频和发送到远端的视频都会相应旋转，但不会应用到单流转推中。如果希望在单流转推的视频中应用旋转，调用 setVideoOrientation:。

- (int) enableSimulcastMode:(BOOL) enabled;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)setMaxVideoEncoderConfig:(ByteRTCVideoEncoderConfig * _Nullable) encoderConfig;
objectivec

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

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

传入参数

返回值
方法调用结果：

• 0：成功
• !0：失败

注意

• 你可以同时使用 enableSimulcastMode: 方法来发布多路分辨率不同的流。具体而言，若期望发布多路不同分辨率的流，你需要在发布流之前调用本方法以及 enableSimulcastMode: 方法开启多路流模式，SDK 会根据订阅端的设置智能调整发布的流数（最多发布 4 条）以及各路流的参数。其中，调用本方法设置的分辨率为各路流中的最大分辨率。具体规则参看推送多路流文档。
• 调用该方法前，SDK 默认仅发布一条分辨率为 640px × 360px，帧率为 15fps 的视频流。
• 自定义采集的场景下，务必调用该接口设置分辨率，以保证远端收到画面的完整性。
• 该方法适用于摄像头采集的视频流，设置屏幕共享视频流参数参看 setScreenVideoEncoderConfig:。

-(int)setVideoEncoderConfig:(NSArray <ByteRTCVideoEncoderConfig *> * _Nullable) encoderConfigs;
objectivec

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

传入参数

返回值
方法调用结果：

• 0：成功
• !0：失败

注意

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

-(int)setScreenVideoEncoderConfig:(ByteRTCScreenVideoEncoderConfig * _Nullable) encoderConfig;
objectivec

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

传入参数

返回值

• 0：成功。
• !0：失败。

注意

• 该方法需在 publishScreen: 发布屏幕共享流之前调用，之后调用不生效。
• 建议在采集视频前设置编码参数。若采集前未设置编码参数，则使用默认编码参数: 分辨率 1920px × 1080px，帧率 15fps。

-(int)setOriginalScreenVideoInfo:(int) originalCaptureWidth withOriginalCaptureHeight:(int)originalCaptureHeight;
objectivec

外部采集时，当屏幕或待采集窗口大小发生改变，为了使 RTC 更好地决策合适的帧率和分辨率积，调用此接口设置改变前的分辨率。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 调用此接口之前，建议调用 setScreenVideoEncoderConfig: 设置屏幕流编码相关参数：编码模式设置为智能模式，屏幕帧宽高设置为0，最大码率设置为-1，最小码率设置为0。
• 调用此接口后，你将收到回调 rtcEngine:onExternalScreenFrameUpdate:，根据 RTC 智能推荐的帧率和分辨率积重新采集。

- (int)setVideoCaptureConfig:(ByteRTCVideoCaptureConfig * _Nullable)captureConfig;
objectivec

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

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

传入参数

返回值

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

注意

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

- (int)setLocalVideoCanvas:(ByteRTCStreamIndex)streamIndex withCanvas:(ByteRTCVideoCanvas * _Nullable)canvas;
objectivec

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

传入参数

返回值

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

注意

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

- (int)updateLocalVideoCanvas:(ByteRTCStreamIndex)streamIndex withRenderMode:(ByteRTCRenderMode)renderMode withBackgroundColor:(NSUInteger)backgroundColor;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)setRemoteVideoCanvas:(ByteRTCRemoteStreamKey * _Nonnull)key withCanvas:(ByteRTCVideoCanvas * _Nullable)canvas;
objectivec

渲染来自指定远端用户 uid 的视频流时，设置使用的视图和渲染模式。

如果需要解除视频的绑定视图，把 canvas.view 设置为空。(canvas 中其他参数不能为空。)

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)updateRemoteStreamVideoCanvas:(ByteRTCRemoteStreamKey * _Nonnull)key withRenderMode:(ByteRTCRenderMode)renderMode withBackgroundColor:(NSUInteger)backgroundColor;
objectivec

Deprecated 从 3.56起， 将在3.62删除，使用updateRemoteStreamVideoCanvas替代。

修改远端视频帧的渲染设置，包括渲染模式和背景颜色。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)startVideoCapture;
objectivec

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

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

调用该方法后，本地用户会收到 rtcEngine:onVideoDeviceStateChanged:device_type:device_state:device_error: 的回调。

可见用户进房后调用该方法，房间中的其他用户会收到 rtcEngine:onUserStartVideoCapture:uid: 的回调。

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 调用 stopVideoCapture 可以停止内部视频采集。否则，只有当销毁引擎实例时，内部视频采集才会停止。
• 创建引擎后，无论是否发布视频数据，你都可以调用该方法开启内部视频采集。只有当（内部或外部）视频采集开始以后视频流才会发布。
• 如果需要从自定义视频采集切换为内部视频采集，你必须先停止发布流，关闭自定义采集，再调用此方法手动开启内部采集。
• 内部视频采集使用的摄像头由 switchCamera: 接口指定。（macOS 不支持）
• 自 v3.37.0 升级版本，你需要在应用中向用户申请摄像头权限后才能开始采集。

- (int)stopVideoCapture;
objectivec

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

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

调用该方法后，本地用户会收到 rtcEngine:onVideoDeviceStateChanged:device_type:device_state:device_error: 的回调。

可见用户进房后调用该方法，房间中的其他用户会收到 rtcEngine:onUserStopVideoCapture:uid: 的回调。

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)setLocalVideoMirrorType:(ByteRTCMirrorType) mirrorType;
objectivec

为采集到的视频流开启镜像

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 切换视频源不影响镜像设置。
• 屏幕视频流始终不受镜像设置影响。
• 使用外部渲染器时，mirrorType 支持设置为 0（无镜像）和 3（本地预览和编码传输镜像），不支持设置为 1（本地预览镜像）。
• 该接口调用前，各视频源的初始状态如下：

- (int)setRemoteVideoMirrorType:(ByteRTCRemoteStreamKey*)key withMirrorType:(ByteRTCRemoteMirrorType)mirrorType;
objectivec

Available since 3.57

使用内部渲染时，为远端流开启镜像。

传入参数

返回值

• 0: 调用成功。
• < 0: 调用失败，参看 ByteRTCReturnStatus 获得更多错误说明。

- (ByteRTCVideoEffect* _Null_unspecified)getVideoEffectInterface;
objectivec

获取视频特效接口。

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

- (int)getAuthMessage:(NSString *_Nullable*_Nullable)ppmsg;
objectivec

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

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

传入参数

返回值

• 0: 调用成功。
• –1000: 未集成特效 SDK。
• –1001: 特效 SDK 不支持该功能。
• –1002: 特效 SDK 版本不兼容。
• < 0: 调用失败，错误码对应具体描述参看 错误码表。

注意

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

- (int)checkVideoEffectLicense:(NSString * _Nonnull)licenseFile;
objectivec

Deprecated since 3.50 and will be deleted in 3.55, use initCVResource:withAlgoModelDir: instead.

视频特效许可证检查

传入参数

返回值

• 0: 调用成功。
• 1000: 未集成特效 SDK。
• 1001: 特效 SDK 不支持该功能。
• < 0: 调用失败。具体错误码，参看 错误码表。

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

- (void)setVideoEffectAlgoModelPath:(NSString * _Nonnull)modelPath __deprecated_msg("Will be removed in new version");
objectivec

Deprecated since 3.50 and will be deleted in 3.55, use initCVResource:withAlgoModelDir: instead.

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

传入参数

- (int)enableVideoEffect:(BOOL)enabled;
objectivec

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

创建/销毁视频特效引擎

传入参数

返回值

• 0: 调用成功。
• 1000: 未集成特效 SDK。
• 1001: 特效 SDK 不支持该功能。
• < 0: 调用失败。具体错误码，参看 错误码表。

注意

• 该方法须在调用 initCVResource:withAlgoModelDir: 和 setVideoEffectAlgoModelPath: 后调用。
• 该方法不直接开启/关闭视频特效，你须在调用该方法后，调用 setVideoEffectNodes: 开启视频特效。
• 通用场景下，特效引擎会随 RTC 引擎销毁而销毁。当你对性能有较高要求时，可在不使用特效相关功能时调用该方法中 false 单独销毁特效引擎。

- (int) setVideoEffectNodes:(NSArray <NSString *> *_Nonnull)effectNodePaths __deprecated_msg("Will be removed in new version");
objectivec

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

设置视频特效素材包

传入参数

返回值

• 0: 调用成功。
• 1000: 未集成特效 SDK。
• 1001: 特效 SDK 不支持该功能。
• < 0: 调用失败。具体错误码，参看 错误码表。

注意
在调用这个方法之前，你须先调用 enableVideoEffect 。

- (int) updateVideoEffectNode:(NSString * _Nonnull)nodePath nodeKey:(NSString * _Nonnull)nodeKey nodeValue:(float) nodeValue;
objectivec

Deprecated since 3.50 and will be deleted in 3.55, use updateEffectNode:key:value: instead.

设置特效强度

传入参数

返回值

• 0: 调用成功。
• 1000: 未集成特效 SDK。
• 1001: 特效 SDK 不支持该功能。
• < 0: 调用失败。具体错误码，参看 错误码表。

注意
该接口仅适用于同时含有上述三个参数的特效资源，对于如大部分贴纸类等没有强度参数的特效，该接口调用无效。

- (int) setVideoEffectColorFilter:(NSString * _Nonnull)resPath __deprecated_msg("Will be removed in new version");
objectivec

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

设置颜色滤镜

传入参数

返回值

• 0: 调用成功。
• 1000: 未集成特效 SDK。
• 1001: 特效 SDK 不支持该功能。
• < 0: 调用失败。具体错误码，参看 错误码表。

- (int) setVideoEffectColorFilterIntensity:(float) intensity __deprecated_msg("Will be removed in new version");
objectivec

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

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

传入参数

返回值

• 0: 调用成功。
• 1000: 未集成特效 SDK。
• 1001: 特效 SDK 不支持该功能。
• < 0: 调用失败。具体错误码，参看 错误码表。

- (int) setBackgroundSticker:(NSString* _Nullable)modelPath source:(ByteRTCVirtualBackgroundSource* _Nonnull)source __deprecated_msg("Will be removed in new version");
objectivec

Deprecated since 3.50 and will be deleted in 3.55, use enableVirtualBackground:withSource: instead.

将摄像头采集画面中的人像背景替换为指定图片或纯色背景。
若要取消背景特效，将背景贴纸特效素材路径设置为null。

传入参数

返回值

• 0：调用成功。
• 1000：未集成特效 SDK。
• 1001：特效 SDK 不支持该功能。
• < 0：调用失败。具体错误码，参看 错误码表。

注意
调用此接口前需依次调用以下接口：1、检查视频特效许可证 initCVResource:withAlgoModelDir:；2、设置视频特效算法模型路径 setVideoEffectAlgoModelPath:；3、开启视频特效 enableVideoEffect。

- (int) registerFaceDetectionObserver:(_Nullable id<ByteRTCFaceDetectionObserver>)faceDetectionObserver withInterval:(NSInteger)interval;
objectivec

Deprecated since 3.50 and will be deleted in 3.55, use registerFaceDetectionObserver:withInterval: instead.

注册人脸检测结果回调观察者

注册此观察者后，你会周期性收到 onFaceDetectResult: 回调。

传入参数

返回值

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

- (int) enableEffectBeauty:(BOOL)enable;
objectivec

开启/关闭基础美颜。

传入参数

返回值

• 0: 调用成功。
• –1000: 未集成特效 SDK。
• –1001: RTC SDK 版本不支持此功能。
• –1002: 特效 SDK 当前版本不支持此功能，建议使用特效 SDK v4.4.2+ 版本。
• –1003: 联系技术支持人员。
• –1004: 正在下载相关资源，下载完成后生效。
• <0: 调用失败，特效 SDK 内部错误，具体错误码请参考错误码表。

注意

• 本方法不能与高级视频特效接口共用。如已购买高级视频特效，建议参看集成指南使用高级美颜、特效、贴纸功能等。
• 使用此功能需要集成特效 SDK，建议使用特效 SDK v4.4.2+ 版本。更多信息参看 Native 端基础美颜。
• 调用 setBeautyIntensity:withIntensity: 设置基础美颜强度。若在调用本方法前没有设置美颜强度，则使用默认强度。各基础美颜模式的强度默认值分别为：美白 0.7，磨皮 0.8，锐化 0.5，清晰 0.7。
• 本方法仅适用于视频源，不适用于屏幕源。

- (int) setBeautyIntensity:(ByteRTCEffectBeautyMode) beautyMode withIntensity:(float)intensity;
objectivec

调整基础美颜强度。

传入参数

返回值

• 0: 调用成功。
• –1000: 未集成特效 SDK。
• –1001: RTC SDK 版本不支持此功能。
• <0: 调用失败，特效 SDK 内部错误，具体错误码请参考错误码表。

注意

• 若在调用 enableVideoEffect 前设置美颜强度，则对应美颜功能的强度初始值会根据设置更新。
• 销毁引擎后，美颜功能强度恢复默认值。

- (int)sendSEIMessage:(ByteRTCStreamIndex)streamIndex andMessage:(NSData* _Nonnull)message andRepeatCount:(int)repeatCount __deprecated_msg("Will be removed in new version");
objectivec

Deprecated since 3.50 and will be deleted in 3.55, use sendSEIMessage:andMessage:andRepeatCount:andCountPerFrame: instead.

通过视频帧发送 SEI 数据。

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

传入参数

返回值

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

注意

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

- (int)sendSEIMessage:(ByteRTCStreamIndex)streamIndex andMessage:(NSData* _Nonnull)message andRepeatCount:(int)repeatCount andCountPerFrame:(ByteRTCSEICountPerFrame) mode;
objectivec

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

传入参数

返回值

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

注意

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

- (int)setVideoDigitalZoomConfig:(ByteRTCZoomConfigType)type size:(float)size;
objectivec

Available since 3.51

设置本地摄像头数码变焦参数，包括缩放倍数，移动步长。

传入参数

返回值

• 0：成功。
• !0：失败。

注意

• 每次调用本接口只能设置一种参数。如果缩放系数和移动步长都需要设置，分别调用本接口传入相应参数。
• 由于移动步长的默认值为 0 ，在调用 setVideoDigitalZoomControl: 或 startVideoDigitalZoomControl: 进行数码变焦操作前，应先调用本接口。

- (int)setVideoDigitalZoomControl:(ByteRTCZoomDirectionType) direction;
objectivec

Available since 3.51

控制本地摄像头数码变焦，缩放或移动一次。设置对本地预览画面和发布到远端的视频都生效。

传入参数

返回值

• 0：成功。
• !0：失败。

注意

• 由于默认步长为 0，调用该方法前需通过 setVideoDigitalZoomConfig:size: 设置参数。
• 调用该方法进行移动前，应先使用本方法或 startVideoDigitalZoomControl: 进行放大，否则无法移动。
• 当数码变焦操作超出范围时，将置为临界值。例如，移动到了图片边界、放大到了 8 倍、缩小到原图大小。
• 如果你希望实现持续数码变焦操作，调用 startVideoDigitalZoomControl:。
• 如果你需要对摄像头进行光学变焦控制，参看 setCameraZoomRatio:。（macOS 不适用）

- (int)startVideoDigitalZoomControl:(ByteRTCZoomDirectionType)direction;
objectivec

Available since 3.51

开启本地摄像头持续数码变焦，缩放或移动。设置对本地预览画面和发布到远端的视频都生效。

传入参数

返回值

• 0：成功。
• !0：失败。

注意

• 由于默认步长为 0，调用该方法前需通过 setVideoDigitalZoomConfig:size: 设置参数。
• 调用该方法进行移动前，应先使用本方法或 setVideoDigitalZoomControl: 进行放大，否则无法移动。
• 当数码变焦操作超出范围时，将置为临界值并停止操作。例如，移动到了图片边界、放大到了 8 倍、缩小到原图大小。
• 你也可以调用 stopVideoDigitalZoomControl 手动停止控制。
• 如果你希望实现单次数码变焦操作，调用 setVideoDigitalZoomControl:。
• 如果你需要对摄像头进行光学变焦控制，参看 setCameraZoomRatio:。（macOS 不适用）

- (int)stopVideoDigitalZoomControl;
objectivec

Available since 3.51

停止本地摄像头持续数码变焦。

返回值

• 0：成功。
• !0：失败。

注意
关于开始数码变焦，参看 startVideoDigitalZoomControl:。

- (int)registerLocalVideoProcessor:(_Nullable id<ByteRTCVideoProcessorDelegate>) processor withConfig:(ByteRTCVideoPreprocessorConfig* _Nullable)config;
objectivec

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

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

传入参数

返回值

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

注意

• 重复调用此接口时，仅最后一次调用生效。效果不会叠加。
• 对于 iOS 平台，将 ByteRTCVideoPreprocessorConfig 中的 requiredPixelFormat 设置为 kVideoPixelFormatUnknown，可以通过避免格式转换带来一些性能优化。

- (int)registerLocalEncodedVideoFrameObserver:(_Nullable id<ByteRTCLocalEncodedVideoFrameObserver>) frameObserver;
objectivec

注册本地视频帧监测器。

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)enableExternalSoundCard:(bool)enable;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)startLiveTranscoding:(NSString * _Nonnull)taskID transcoding:(ByteRTCLiveTranscoding *_Nullable)transcoding observer:(id<LiveTranscodingDelegate> _Nullable)observer __deprecated_msg("deprecated since 352, will be deleted in 358, use startPushMixedStreamToCDN instead");
objectivec

Deprecated since 3.52, will be deleted in 3.58, use startPushMixedStreamToCDN:mixedConfig:observer: instead.

新增转推直播任务，并设置合流的图片、视频视图布局和音频属性。

同一个任务中转推多路直播流时，SDK 会先将多路流合成一路流，然后再进行转推。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 调用该方法后，启动结果和推流过程中的错误均会通过回调 onStreamMixingEvent:taskId:error:mixType: 通知用户。
• 调用 stopLiveTranscoding: 停止转推直播

- (int)stopLiveTranscoding:(NSString *_Nonnull)taskID __deprecated_msg("deprecated since 352, will be deleted in 358, use stopPushStreamToCDN instead");
objectivec

Deprecated since 3.52, will be deleted in 3.58, use stopPushStreamToCDN: instead.

停止转推直播，会收到 onStreamMixingEvent:taskId:error:mixType: 回调。

关于启动转推直播，参看 startLiveTranscoding:transcoding:observer:。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

- (int)updateLiveTranscoding:(NSString *_Nonnull)taskID transcoding:(ByteRTCLiveTranscoding *_Nonnull)transcoding __deprecated_msg("deprecated since 352, will be deleted in 358, use updatePushMixedStreamToCDN instead");
objectivec

Deprecated since 3.52, will be deleted in 3.58, use updatePushMixedStreamToCDN:mixedConfig: instead.

更新转推直播参数，会收到 onStreamMixingEvent:taskId:error:mixType: 回调。

开启转推直播功能后，你可以使用此方法更新合流转推功能配置参数。

传入参数

返回值
方法调用结果。

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

- (int)startPushMixedStreamToCDN:(NSString * _Nonnull)taskID mixedConfig:(ByteRTCMixedStreamConfig *_Nullable)config observer:(id<ByteRTCMixedStreamObserver> _Nullable)observer;
objectivec

Available since 3.52

新增合流转推直播任务，并设置合流的图片、视频视图布局和音频属性。

同一个任务中转推多路直播流时，SDK 会先将多路流合成一路流，然后再进行转推。

传入参数

返回值
方法调用结果。

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

注意

• 调用该方法后，启动结果和推流过程中的错误均会通过回调 onMixingEvent:taskId:error:mixType: 通知用户。
• 如果已在控制台配置了转推直播的服务端回调，调用本接口会收到 TranscodeStarted。重复调用该接口时，第二次调用会同时触发 TranscodeStarted 和 TranscodeUpdated。
• 调用 stopPushStreamToCDN: 停止转推直播

- (int)updatePushMixedStreamToCDN:(NSString *_Nonnull)taskID mixedConfig:(ByteRTCMixedStreamConfig *_Nonnull)config;
objectivec

Available since 3.52

更新合流转推直播参数，会收到 onMixingEvent:taskId:error:mixType: 回调。

开启转推直播功能后，你可以使用此方法更新合流转推功能配置参数。

传入参数

返回值
方法调用结果。

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

- (int)startPushSingleStreamToCDN:(NSString *_Nonnull)taskID singleStream:(ByteRTCPushSingleStreamParam *_Nonnull)singleStream observer:(id<ByteRTCPushSingleStreamToCDNObserver>_Nullable)observer;
objectivec

新增单流转推直播任务。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 调用该方法后，关于启动结果和推流过程中的错误，会收到 onStreamPushEvent:taskId:error: 回调。
• 调用 stopPushStreamToCDN: 停止任务。
• 由于本功能不进行编解码，所以推到 RTMP 的视频流会根据推流端的分辨率、编码方式、关闭摄像头等变化而变化。

- (int)stopPushStreamToCDN:(NSString *_Nonnull)taskID;
objectivec

停止转推直播。

该方法可用于停止单流转推直播或停止合流转推直播，通过 taskId 区分需要停止的任务。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 关于启动单流转推直播，参看 startPushSingleStreamToCDN:singleStream:observer:。
• 关于启动合流转推直播，参看 startPushMixedStreamToCDN:mixedConfig:observer:。

- (int)startPushPublicStream:(NSString * _Nonnull)publicStreamId withLayout:(ByteRTCPublicStreaming *_Nullable)publicStream;
objectivec

发布一路公共流

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

传入参数

返回值

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

注意

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

- (int)stopPushPublicStream:(NSString * _Nonnull)publicStreamId;
objectivec

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

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

传入参数

返回值

• 0: 成功
• !0: 失败

- (int)updatePublicStreamParam:(NSString * _Nonnull)publicStreamId withLayout:(ByteRTCPublicStreaming *_Nullable)publicStream;
objectivec

更新公共流参数

关于发布公共流，查看 startPushPublicStream:withLayout:。
建议调用更新公共流前判断公共流是否已经成功启动，相关回调详见 rtcEngine:onPushPublicStreamResult:publicStreamId:errorCode:。

传入参数

返回值

• 0: 成功
• !0: 失败

- (int)startPlayPublicStream:(NSString * _Nonnull)publicStreamId;
objectivec

订阅指定公共流

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

传入参数

返回值

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

注意

• 一个客户端最多同时播放 5 路公共流，请及时调用 stopPlayPublicStream: 取消订阅公共流，避免订阅的公共流数量超限。
• 在调用本接口之前，建议先绑定渲染视图。

• 调用 setPublicStreamVideoCanvas:withCanvas: 绑定内部渲染视图。
• 调用 setPublicStreamVideoSink:withSink:withPixelFormat: 绑定自定义渲染视图：

• 调用本接口后，可以通过 rtcEngine:onFirstPublicStreamVideoFrameDecoded:withFrameInfo: 和 rtcEngine:onFirstPublicStreamAudioFrame: 回调公共流的视频和音频首帧解码情况。
• 调用本接口后，可以通过 rtcEngine:onPublicStreamSEIMessageReceived:andMessage:andSourceType: 回调公共流中包含的 SEI 信息。

- (int)stopPlayPublicStream:(NSString * _Nonnull)publicStreamId;
objectivec

取消订阅指定公共流

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

传入参数

返回值

• 0：成功
• !0：失败

- (int)setPublicStreamVideoCanvas:(NSString *_Nonnull)publicStreamId withCanvas:(ByteRTCVideoCanvas * _Nullable)canvas;
objectivec

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

传入参数

返回值

• 0：成功
• !0：失败

- (int)setPublicStreamVideoSink:(NSString *_Nonnull)publicStreamId withSink:(id<ByteRTCVideoSinkDelegate> _Nullable)videoSink withPixelFormat:(ByteRTCVideoSinkPixelFormat)requiredFormat;
objectivec

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

传入参数

返回值

• 0: 成功
• <0: 失败

- (int)setPublicStreamAudioPlaybackVolume:(NSString *_Nonnull)publicStreamId volume:(NSInteger)volume;
objectivec

Available since 3.51

调节公共流的音频播放音量。

传入参数

返回值

• 0: 成功调用。
• -2: 参数错误。

- (int)pushExternalVideoFrame:(ByteRTCVideoFrame * _Nonnull)frame;
objectivec

推送外部视频帧。

传入参数

返回值
方法调用结果：

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

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

- (int)enableAudioFrameCallback:(ByteRTCAudioFrameCallbackMethod) method format:(ByteRTCAudioFormat* _Nullable)format;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)disableAudioFrameCallback:(ByteRTCAudioFrameCallbackMethod) method;
objectivec

关闭音频回调

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)registerAudioFrameObserver:(_Nullable id<ByteRTCAudioFrameObserver>) audioFrameObserver;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意
注册音频数据回调观察者并调用 enableAudioFrameCallback:format: 后，ByteRTCAudioFrameObserver 会收到对应的音频回调。对回调中收到的音频数据进行处理，不会影响 RTC 的编码发送或渲染。

- (int)registerAudioProcessor:(_Nullable id<ByteRTCAudioFrameProcessor>)processor;
objectivec

注册自定义音频处理器。

注册完成后，你可以调用 enableAudioProcessor:audioFormat:，对本地采集到的音频进行处理，RTC SDK 将对处理后的音频进行编码和发送。也可以对接收到的远端音频进行自定义处理，RTC SDK 将对处理后的音频进行渲染。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 重复调用此接口时，仅最后一次调用生效。
• 更多相关信息，详见音频自定义处理。

- (int)enableAudioProcessor:(ByteRTCAudioFrameMethod)method audioFormat:(ByteRTCAudioFormat *_Nullable)format;
objectivec

设置并开启指定的音频帧回调，进行自定义处理。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 在调用此接口前，你需要调用 registerAudioProcessor: 注册自定义音频处理器。
• 要关闭音频自定义处理，调用 disableAudioProcessor:。

- (int)disableAudioProcessor:(ByteRTCAudioFrameMethod)method;
objectivec

关闭自定义音频处理。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

- (int)pushExternalAudioFrame:(ByteRTCAudioFrame * _Nonnull) audioFrame;
objectivec

推送自定义采集的音频数据到 RTC SDK。

传入参数

返回值
方法调用结果

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

注意

• 推送外部音频数据前，必须先调用 setAudioSourceType: 开启自定义采集。
• 你必须每隔 10 毫秒推送一次外部采集的音频数据。单次推送的 samples (音频采样点个数）应该为 audioFrame.sampleRate / 100。比如设置采样率为 48000 时， 每次应该推送 480 个采样点。

- (int)pullExternalAudioFrame:(ByteRTCAudioFrame * _Nonnull) audioFrame;
objectivec

拉取下行音频数据用于自定义音频渲染。
调用该方法后，SDK 会主动拉取待播放的音频数据，包括远端已解码和混音后的音频数据，用于外部播放。

传入参数

返回值
方法调用结果

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

注意

• 拉取外部音频数据前，必须先调用 setAudioRenderType: 开启自定义渲染。
• 由于 RTC SDK 的帧长为 10 毫秒，你应当每隔 10 毫秒拉取一次音频数据。确保音频采样点数（sample）x 拉取频率等于 audioFrame 的采样率 （sampleRate）。如设置采样率为 48000 时，每 10 毫秒调用本接口拉取数据，每次应拉取 480 个采样点。
• 音频采样格式为 S16。音频缓冲区内的数据格式必须为 PCM 数据，其容量大小应该为 audioFrame.samples × audioFrame.channel × 2。

- (int)setBusinessId:(NSString* _Nullable)businessId;
objectivec

设置业务标识参数

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

传入参数

返回值

• 0： 成功
• -2: ByteRTCReturnStatusParameterErr，参数非法。

注意

• 需要在调用 joinRoom:userInfo:roomConfig: 进房之前调用，进房之后调用该方法无效。

- (int)feedback:(ByteRTCProblemFeedbackOption)types info:(ByteRTCProblemFeedbackInfo* _Nullable)info;
objectivec

通话结束，将用户反馈的问题上报到 RTC。

传入参数

返回值

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

注意

• 你可以在 RTC 控制台上查看用户通过此接口提交的反馈详情和整体趋势。
• 如果用户上报时在房间内，那么问题会定位到用户当前所在的一个或多个房间；如果用户上报时不在房间内，那么问题会定位到引擎此前退出的房间。

- (void * _Nullable) getNativeHandle;
objectivec

Available since 353

获取 C++ 层 IRTCVideo 句柄。

返回值

• >0：方法调用成功, 返回 C++ 层 IRTCVideo 的地址。
• NULL：方法调用失败

注意
在一些场景下，获取 C++ 层 IRTCVideo，并通过其完成操作，相较于通过 OC 封装层完成有显著更高的执行效率。典型的场景有：视频/音频帧自定义处理，音视频通话加密等。

- (int)setPublishFallbackOption:(ByteRTCPublishFallbackOption)option;
objectivec

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

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 该方法仅在调用 enableSimulcastMode: 开启了发送多路视频流的情况下生效。
• 该方法必须在进房前设置，进房后设置或更改设置无效。
• 调用该方法后，如因性能或网络不佳产生发布性能回退或恢复，本端会提前收到 rtcEngine:onPerformanceAlarms:roomId:reason:sourceWantedData: 回调发出的告警，以便采集设备配合调整。
• 设置回退后，本地发布的音视频流发生回退或从回退中恢复时，远端会收到 rtcEngine:onSimulcastSubscribeFallback: 回调，通知该情况。
• 你可以调用客户端 API 或者在服务端下发策略设置回退。当使用服务端下发配置实现时，下发配置优先级高于在客户端使用 API 设定的配置。

- (int)setSubscribeFallbackOption:(ByteRTCSubscribeFallbackOption)option;
objectivec

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

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)setRemoteUserPriority:(ByteRTCRemoteUserPriority)priority InRoomId:(NSString *_Nonnull)roomId uid:(NSString *_Nonnull)uid;
objectivec

设置用户优先级。

传入参数

返回值

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

注意

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

- (int)setEncryptInfo:(ByteRTCEncryptType)encrypt_type key:(NSString * _Nonnull)key;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)setCustomizeEncryptHandler:(id<ByteRTCEncryptHandler> _Nullable)handler;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- ( ByteRTCRoom * _Nullable)createRTCRoom:(NSString * _Nonnull)roomId;
objectivec

创建房间实例。

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

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

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

传入参数

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

注意

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

- (int)pushScreenVideoFrame:(CVPixelBufferRef _Nonnull )frame time:(CMTime)pts rotation:(int)rotation;
objectivec

推送外部屏幕采集帧

传入参数

返回值
方法调用结果：

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

注意
屏幕采集分为内部采集和外部采集，本方法属于外部采集。

- (int)setRuntimeParameters:(NSDictionary * _Nullable)parameters;
objectivec

设置运行时的参数

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (NSArray<ByteRTCScreenCaptureSourceInfo *> *_Nonnull)getScreenCaptureSourceList;
objectivec

获取共享对象(应用窗口和桌面)列表。

返回值
共享对象(应用窗口和桌面)列表。参看 ByteRTCScreenCaptureSourceInfo。
枚举值可作为调用 startScreenVideoCapture:captureParameters: 开启屏幕共享时的输入参数。

注意
仅桌面端可用。

- (int)startScreenVideoCapture:(ByteRTCScreenCaptureSourceInfo *_Nonnull)sourceInfo captureParameters:(ByteRTCScreenCaptureParam *_Nonnull)captureParameters;
objectivec

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

传入参数

返回值

• 0: 成功
• -1: 失败

注意

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

- (int)stopScreenVideoCapture;
objectivec

停止屏幕视频流采集。

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)updateScreenCaptureRegion:(CGRect)regionRect;
objectivec

内部屏幕流采集时，更新采集区域。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)updateScreenCaptureHighlightConfig:(ByteRTCHighlightConfig *_Nonnull)config;
objectivec

内部屏幕流采集时，更新边框高亮设置。默认展示边框。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)updateScreenCaptureMouseCursor:(ByteRTCMouseCursorCaptureState)mouseCursorCaptureState;
objectivec

内部屏幕流采集时，更新对鼠标的处理设置。默认采集鼠标。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

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

- (int)updateScreenCaptureFilterConfig:(NSArray<NSNumber *> * _Nullable) excludedWindowList;
objectivec

通过 RTC SDK 提供的采集模块采集屏幕视频流时，设置需要过滤的窗口。

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

• 调用此接口前，必须已通过调用 startScreenVideoCapture:captureParameters: 开启了内部屏幕流采集。
• 本函数在屏幕源类别是屏幕而非应用窗体时才起作用。详见：ByteRTCScreenCaptureSourceType。
• 调用本接口排除指定窗口时，共享视频的帧率无法达到 30fps。

- (ByteRTCImage *_Nonnull)getThumbnail:(ByteRTCScreenCaptureSourceType)sourceType sourceId:(intptr_t)sourceId maxWidth:(int)maxWidth maxHeight:(int)maxHeight;
objectivec

获取屏幕采集对象缩略图

传入参数

返回值
屏幕采集对象缩略图。缩略图由屏幕共享对象等比缩放而来。缩略图的大小小于等于此接口设定的尺寸。

- (ByteRTCImage *_Nonnull)getWindowAppIcon:(intptr_t)sourceId width:(int)width height:(int)height;
objectivec

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

传入参数

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

- (ByteRTCAudioDeviceManager *_Null_unspecified)getAudioDeviceManager;
objectivec

创建音频设备管理实例

返回值
ByteRTCAudioDeviceManager

- (ByteRTCVideoDeviceManager * _Null_unspecified)getVideoDeviceManager;
objectivec

创建视频设备管理实例

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

- (int)startFileRecording:(ByteRTCStreamIndex)streamIndex withRecordingConfig:(ByteRTCRecordingConfig* _Nonnull)recordingConfig type:(ByteRTCRecordingType)recordingType;
objectivec

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

传入参数

返回值

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

注意

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

- (int)stopFileRecording:(ByteRTCStreamIndex)streamIndex;
objectivec

停止本地录制

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)startAudioRecording:(ByteRTCAudioRecordingConfig* _Nonnull) recordingConfig;
objectivec

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

在进房前后开启录制，如果未打开麦克风采集，录制任务正常进行，只是不会将数据写入生成的本地文件；只有调用 startAudioCapture 接口打开麦克风采集后，才会将录制数据写入本地文件。

传入参数

返回值

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

注意

• 录制包含各种音频效果。但不包含背景音乐。
• 调用 stopAudioRecording 关闭录制。
• 加入房间前后均可调用。在进房前调用该方法，退房之后，录制任务不会自动停止，需调用stopAudioRecording 关闭录制。在进房后调用该方法，退房之后，录制任务会自动被停止。如果加入了多个房间，录制的文件中会包含各个房间的音频。
• 调用该方法后，你会收到 rtcEngine:onAudioRecordingStateUpdate:error_code: 回调。

- (int)stopAudioRecording;
objectivec

停止音频文件录制

返回值

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

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

- (ByteRTCAudioMixingManager *_Nullable)getAudioMixingManager __deprecated_msg("deprecated since 353.1, will be deleted in 359, use getAudioEffectPlayer and getMediaPlayer instead");
objectivec

Deprecated since 353.1, will be deleted in 359, use getAudioEffectPlayer or getMediaPlayer: instead

混音管理接口创建

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

- (ByteRTCAudioEffectPlayer *_Nullable)getAudioEffectPlayer;
objectivec

Available since 3.53

创建音效播放器实例。

返回值
音效播放器。详见 ByteRTCAudioEffectPlayer。

- (ByteRTCMediaPlayer *_Nullable)getMediaPlayer:(int)playerId;
objectivec

Available since 3.53

创建音乐播放器实例。

传入参数

返回值
音乐播放器实例，详见 ByteRTCMediaPlayer

- (int)login:(NSString * _Nonnull)token uid:(NSString * _Nonnull)uid;
objectivec

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

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

传入参数

返回值

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

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

- (int)logout;
objectivec

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

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)updateLoginToken:(NSString * _Nonnull)token;
objectivec

更新用户用于登录的 Token

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

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)setServerParams:(NSString * _Nonnull)signature url:(NSString * _Nonnull)url;
objectivec

设置应用服务器参数

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (int)getPeerOnlineStatus:(NSString * _Nonnull)peerUserId;
objectivec

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

传入参数

返回值

• 0: 调用成功。
• < 0 : 调用失败。查看 ByteRTCReturnStatus 获得更多错误说明

注意

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

- (NSInteger)sendUserMessageOutsideRoom:(NSString * _Nonnull)userId message:(NSString * _Nonnull)messageStr config:(ByteRTCMessageConfig)config;
objectivec

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

传入参数

返回值

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

注意

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

- (NSInteger)sendUserBinaryMessageOutsideRoom:(NSString * _Nonnull)userId message:(NSData * _Nonnull)messageStr config:(ByteRTCMessageConfig)config;
objectivec

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

传入参数

返回值

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

注意

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

- (NSInteger)sendServerMessage:(NSString * _Nonnull)messageStr;
objectivec

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

传入参数

返回值

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

注意

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