ByteRTCAudioMixingManager

@interface ByteRTCAudioMixingManager :NSObject

成员函数

函数说明

startAudioMixing:filePath:config:

-(void)startAudioMixing:(int)id filePath:(NSString * _Nullable)filePath config:(ByteRTCAudioMixingConfig * _Nullable)config;

开始播放音乐文件及混音

传入参数

注意

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

stopAudioMixing:

-(void)stopAudioMixing:(int)id;

停止播放音乐文件及混音

传入参数

注意

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

pauseAudioMixing:

-(void)pauseAudioMixing:(int)id;

暂停播放音乐文件

传入参数

注意

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

resumeAudioMixing:

-(void)resumeAudioMixing:(int)id;

恢复播放音乐文件

传入参数

注意

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

preloadAudioMixing:filePath:

-(void)preloadAudioMixing:(int)id filePath:(NSString * _Nullable)filePath;

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

传入参数

注意

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

unloadAudioMixing:

-(void)unloadAudioMixing:(int)id;

卸载指定音乐文件

传入参数

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

setAudioMixingVolume:volume:type:

-(void)setAudioMixingVolume:(int)id volume:(int)volume type:(ByteRTCAudioMixingType)type;

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

传入参数

注意

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

getAudioMixingDuration:

-(int)getAudioMixingDuration:(int)id;

获取音乐文件时长

传入参数

返回值

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

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

getAudioMixingCurrentPosition:

-(int)getAudioMixingCurrentPosition:(int)id;

获取音乐文件播放进度

传入参数

返回值

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

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

setAudioMixingPosition:position:

-(void)setAudioMixingPosition:(int)id position:(int)position;

设置音乐文件的播放位置

传入参数

注意

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

enableAudioMixingFrame:

-(void)enableAudioMixingFrame:(ByteRTCAudioMixingType)type;

启动外部音频流混音

传入参数

注意

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

disableAudioMixingFrame

-(void)disableAudioMixingFrame;

关闭外部音频流混音

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

pushAudioMixingFrame:

-(int)pushAudioMixingFrame:(ByteRTCAudioFrame* _Nullable)audioFrame;

向 SDK 推送外部音频帧数据

传入参数

返回值

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

注意

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

ByteRTCEngineKit

@interface ByteRTCEngineKit : NSObject

SDK 回调给应用层的 delegate 对象，详见 ByteRTCEngineDelegate

静态函数

成员函数

函数说明

sharedInstance

+ (ByteRTCEngineKit * _Nullable) sharedInstance;

获取 ByteRTCEngineKit 单例对象。

返回值 由 initWithAppId:delegate:parameters: 创建的 ByteRTCEngineKit 对象。

注意

• 如果未调用 initWithAppId:delegate:parameters: 或在调用 destroy 之后调用该方法，则会返回 nil 。

destroy

+ (void)destroy;

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

注意

• 请确保一定是在所有业务场景的最后阶段才调用该方法。
• 该方法在调用之后，会销毁所有 SDK 相关的内存，并且停止与媒体服务器的任何交互。

• 在上一次 initWithAppId:delegate:parameters: 调用之后对SDK进行的任何设置， 将在下一次有效执行 initWithAppId:delegate:parameters: 时生效。

• 本方法为阻塞调用，会阻塞当前线程直到 SDK 彻底完成退出逻辑，因而需要注意不要在回调线程中直接调用本方法， 也需要注意不要在回调方法中等待主线程的执行而同时在主线程调用本方法，从而造成死锁。

getSdkVersion

+ (NSString * _Nonnull)getSdkVersion;

获取 SDK 当前的版本号。

返回值 SDK 当前的版本号。

getErrorDescription:

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

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

传入参数

返回值 描述文字。

initWithAppId:delegate:parameters:

- (id _Nonnull)initWithAppId:(NSString * _Nonnull)appId delegate:(id<ByteRTCEngineDelegate> _Nullable)delegate parameters:(NSDictionary* _Nullable)parameters;

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

传入参数

返回值 可用的 ByteRTCEngineKit 实例

注意 通常不建议在移动端设备上创建多于 2 个引擎实例。

destroyEngine

- (void)destroyEngine;

手动销毁引擎实例对象，如果当前的引擎对象是通过 initWithAppId:delegate:parameters: 所创建的，则行为与 destroy 保持一致

注意

• 请确保和需要销毁的 ByteRTCEngineKit 实例相关的业务场景全部结束后，才调用此方法
• 该方法在调用之后，会销毁所有和此 ByteRTCEngineKit 实例相关的内存，并且停止与媒体服务器的任何交互
• 本方法为阻塞调用，会阻塞当前线程直到SDK彻底完成退出逻辑，因而需要注意不要在回调线程中 直接调用本方法，也需要注意不要在回调方法中等待主线程的执行，而同时在主线程调用本方法，从而 造成死锁
• 可以通过 Objective-C 的ARC机制，在 dealloc 时自动触发销毁逻辑

setUserVisibility:

- (BOOL)setUserVisibility:(BOOL)enable;

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

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

传入参数

返回值 方法调用结果：

• YES: 方法调用成功
• NO: 方法调用失败

注意

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

publish

- (BOOL)publish;

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

注意

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

unpublish

- (BOOL)unpublish;

在当前所在房间内停止发布本地音视频流。

注意

• 在多房间模式下，调用 publish 手动发布音视频流后，调用此接口停止发布。
• 用户调用此方法停止发布音视频流后，房间中的其他用户将会收到 rtcEngine:didStreamRemoved:stream:reason: 回调通知。

clientRole

- (ByteRTCUserRoleType)clientRole;

获取当前用户角色。

返回值 当前用户角色，详见 ByteRTCUserRoleType 枚举类型。

joinRoomByKey:roomId:userInfo:rtcRoomConfig:

- (int)joinRoomByKey:(NSString *_Nullable)token roomId:(NSString *_Nonnull)roomId userInfo:(ByteRTCUserInfo *_Nonnull)userInfo rtcRoomConfig:(ByteRTCRoomConfig *_Nonnull)rtcRoomConfig;

创建/加入房间：房间不存在时即创建房间；房间存在时，未加入房间的用户可加入这个房间。
同一个房间内的用户间可以相互通话。
进房后重复调用无效，用户必须调用 leaveRoom: 退出当前房间后，才能加入下一个房间。

传入参数

返回值 方法调用结果。

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

注意

• 同一个 AppID 的同一个房间内，每个用户的用户 ID 必须是唯一的。如果两个用户的用户 ID 相同，则后加入房间的用户会将先加入房间的用户踢出房间，并且先加入房间的用户会收到 rtcEngine:onError: 回调通知，错误类型为重复登录 BRERR_DUPLICATE_LOGIN。
• 本地用户调用此方法加入房间成功后，会收到 rtcEngine:onJoinRoomResult:withUid:errorCode:joinType:elapsed: 回调通知。
• 本地用户调用 setUserVisibility: 将自身设为可见后加入房间，远端用户会收到 rtcEngine:onUserJoined:elapsed: 回调通知。
• 用户加入房间成功后，在本地网络状况不佳的情况下，SDK 可能会与服务器失去连接，此时 SDK 将会自动重连。重连成功后，本地会收到 rtcEngine:onUserJoined:elapsed: 回调通知。

leaveRoom:

- (int)leaveRoom:(void (^_Nullable)(ByteRTCRoomStats *_Nonnull stat))leaveRoomBlock ;

离开房间。
用户调用此方法离开房间，结束通话过程，释放所有通话相关的资源。
调用 joinRoomByKey:roomId:userInfo:rtcRoomConfig: 方法加入房间后，必须调用此方法离开房间，否则无法进入下一个房间。无论当前是否在房间内，都可以调用此方法。重复调用此方法没有负面影响。
此方法是异步操作，调用返回时并没有真正退出房间。真正退出房间后，SDK 会执行调用此方法时传入的 Block 块。

传入参数

返回值 方法调用结果。

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

注意

• 可见的用户离开房间后，房间内其他用户会收到 rtcEngine:onUserLeave:reason: 回调通知。
• 如果调用此方法后立即销毁引擎，SDK 将无法执行作为参数传入的 Block 块。

leaveRoom

- (int)leaveRoom;

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

返回值 方法调用结果。

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

注意

• 用户离开房间后，本地会收到 rtcEngine:onLeaveRoomWithStats: 的回调；
• 可见的用户离开房间后，房间内其他用户会收到 rtcEngine:onUserLeave:reason: 回调通知；
• 调用 joinRoomByKey:roomId:userInfo:rtcRoomConfig: 方法加入房间后，必须调用此方法离开房间，否则无法进入下一个房间。无论当前是否在房间内，都可以调用此方法。重复调用此方法没有负面影响。

updateToken:

- (int)updateToken:(NSString *_Nonnull)token;

更新 Token。
用户调用 joinRoomByKey:roomId:userInfo:rtcRoomConfig: 方法加入房间时， 如果使用了过期的 Token 将导致加入房间失败，并会收到 rtcEngine:onJoinRoomResult:withUid:errorCode:joinType:elapsed: 回调， 回调错误码为 ByteRTCErrorCode 中的 ByteRTCErrorCodeInvalidToken 此时需要重新获取 Token，并调用此方法更新 Token。更新 Token 后，SDK 会自动加入房间。

传入参数

返回值 方法调用结果。

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

注意 Token 过期时，如果已经加入房间成功，则不会受到影响。Token 过期的错误会在下一次使用过期的 Token 加入房间时，或因本地网络状况不佳导致断网重新连入房间时通知用户。

startAudioCapture

- (void)startAudioCapture;

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

注意

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

stopAudioCapture

- (void)stopAudioCapture;

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

注意

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

setAudioScenario:

- (void)setAudioScenario:(ByteRTCAudioScenarioType)audioScenario;

设置音频场景类型。
你可以根据你的应用所在场景，选择合适的音频场景类型。
选择音频场景后，RTC 会自动根据客户端音频路由和发布订阅状态，适用通话音量/媒体音量。
本方法在进房前和进房后设置均可生效。

传入参数

注意

• 通话音量更适合通话、会议等对信息准确度更高的场景。通话音量会激活系统硬件信号处理，使通话声音更清晰。同时，音量无法降低到 0。
• 媒体音量更适合娱乐场景，因其声音的表现力会更强。媒体音量下，最低音量可以为 0。

setAudioProfile:

- (void)setAudioProfile:(ByteRTCAudioProfileType)audioProfile;

设置音质档位。你应根据业务场景需要选择适合的音质档位。

传入参数

注意

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

muteLocalAudio:

- (void)muteLocalAudio:(ByteRTCMuteState)muteState;

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

传入参数

返回值 方法调用结果

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

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

pauseAllSubscribedStream:

- (void)pauseAllSubscribedStream:(ByteRTCPauseResumControlMediaType) mediaType;

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

传入参数

注意

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

resumeAllSubscribedStream:

- (void)resumeAllSubscribedStream:(ByteRTCPauseResumControlMediaType) mediaType;

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

传入参数

注意

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

setAudioVolumeIndicationInterval:

- (void)setAudioVolumeIndicationInterval:(NSInteger)interval;

开启/关闭音量提示。默认关闭。
开启音量提示后，将按设置的时间间隔收到本地采集音量或订阅的远端用户的音量信息回调。 关于回调的具体信息，参看 rtcEngine:onAudioVolumeIndication:totalRemoteVolume:。

传入参数

setCaptureVolume:volume:

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

调节音频采集音量

传入参数

注意

• 无论是采集来自麦克风的音频流，还是屏幕音频流；无论是 RTC SDK 内部采集，还是自定义采集，都可以使用此接口进行音量调节。
• 在开启音频采集前后，你都可以使用此接口设定采集音量。

setPlaybackVolume:

- (void)setPlaybackVolume:(NSInteger)volume;

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

传入参数

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

enableAudioPropertiesReport:

- (void)enableAudioPropertiesReport:(ByteRTCAudioPropertiesConfig* _Nonnull)config;

启用音量提示。

传入参数

注意 开启提示后，你可以： + 通过 rtcEngine:onLocalAudioPropertiesReport: 回调获取本地麦克风和屏幕音频流采集的音量信息；

• 通过 rtcEngine:onRemoteAudioPropertiesReport:totalRemoteVolume: 回调获取订阅的远端用户的音量信息。

setEarMonitorMode:

- (void)setEarMonitorMode:(ByteRTCEarMonitorMode)mode;

开启/关闭耳返功能

传入参数

注意

• 你必须在使用 RTC SDK 提供的内部音频采集功能时，使用耳返功能。
• 耳返功能仅在连接了有线耳机时有效。
• 受 iOS 平台限制，RTC 仅支持软件耳返功能。

setEarMonitorVolume:

- (void)setEarMonitorVolume:(NSInteger)volume;

设置耳返的音量

传入参数

注意

• 设置耳返音量前，你必须先调用 setEarMonitorMode: 打开耳返功能。
• 耳返功能仅在使用 RTC SDK 提供的内部音频采集功能，并连接了有线耳机时有效。

setLocalVideoSink:withSink:withPixelFormat:

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

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

传入参数

注意

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

setRemoteVideoSink:withSink:withPixelFormat:

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

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

传入参数

注意

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

setVideoEncoderConfig:config:

- (int)setVideoEncoderConfig:(ByteRTCStreamIndex)streamIndex config:(NSArray <ByteRTCVideoSolution *> * _Nullable)videoSolutions;

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

传入参数

返回值

• 0：成功
• !0：失败

注意

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

setVideoCaptureConfig:

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

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

传入参数

返回值

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

注意

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

setLocalVideoCanvas:withCanvas:

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

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

传入参数

返回值

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

setRemoteVideoCanvas:withIndex:withCanvas:

- (int)setRemoteVideoCanvas:(NSString * _Nonnull)uid withIndex:(ByteRTCStreamIndex)streamIndex withCanvas:(ByteRTCVideoCanvas * _Nullable)canvas;

渲染来自指定远端用户 uid 的视频流时，设置使用的视图和渲染模式。
如果需要解除视频的绑定视图，把 canvas 设置为空。

传入参数

返回值

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

注意

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

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

startVideoCapture

- (void)startVideoCapture;

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

注意

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

stopVideoCapture

- (void)stopVideoCapture;

关闭内部视频采集。默认为关闭状态。
调用该方法后，本地用户会收到 rtcEngine:onMediaDeviceStateChanged:device_type:device_state:device_error: 的回调。
进房后调用该方法，房间中的其他用户会收到 rtcEngine:onUserStopVideoCapture: 的回调。

注意

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

muteLocalVideo:

- (void)muteLocalVideo:(ByteRTCMuteState)mute_state;

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

传入参数

注意

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

setLocalVideoMirrorMode:

- (int)setLocalVideoMirrorMode:(ByteRTCMirrorMode) mode;

设置采用前置摄像头采集时，是否开启镜像模式。默认为关闭状态。

传入参数

返回值

• 0：成功
• <0：失败

setLocalVideoMirrorType:

- (int)setLocalVideoMirrorType:(ByteRTCMirrorType) mirrorType;

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

传入参数

注意

• 该接口调用前，各视频源的初始状态如下：

• 切换视频源不影响镜像设置。
• 屏幕视频流始终不受镜像设置影响。

switchCamera:

- (int)switchCamera:(ByteRTCCameraID) cameraId;

切换视频内部采集时使用的前置/后置摄像头
调用此接口后，在本地会触发 rtcEngine:onMediaDeviceStateChanged:device_type:device_state:device_error: 回调。

传入参数

返回值

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

注意

• 默认使用前置摄像头。
• 如果你正在使用相机进行视频采集，切换操作当即生效；如果相机未启动，后续开启内部采集时，会打开设定的摄像头。

checkVideoEffectLicense:

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

视频特效许可证检查

传入参数

返回值

• 0: 许可证验证成功
• !0: 许可证验证失败

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

enableVideoEffect:

- (int)enableVideoEffect:(BOOL)enabled;

创建/销毁视频特效引擎

传入参数

返回值 方法调用结果

• 0: 成功
• !0: 失败

注意

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

setVideoEffectAlgoModelPath:

- (void)setVideoEffectAlgoModelPath:(NSString * _Nonnull)modelPath;

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

传入参数

setVideoEffectNodes:

- (int) setVideoEffectNodes:(NSArray <NSString *> *_Nonnull)effectNodePaths;

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

传入参数

返回值

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

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

updateVideoEffectNode:nodeKey:nodeValue:

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

设置特效强度

传入参数

返回值

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

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

setVideoEffectColorFilter:

- (int) setVideoEffectColorFilter:(NSString * _Nonnull)resPath;

设置颜色滤镜

传入参数

返回值

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

setVideoEffectColorFilterIntensity:

- (int) setVideoEffectColorFilterIntensity:(float) intensity;

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

传入参数

返回值

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

sendSEIMessage:andMessage:andRepeatCount:

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

在视频通信时，通过视频帧发送 SEI 数据。

传入参数

返回值

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

注意

• 你可以通过此接口对 RTC SDK 内部采集的视频帧添加 SEI。对于采用自定义采集获得的视频帧：如果原视频帧中没有添加 SEI 数据，那么你可以调用此接口为其中添加 SEI 信息后，进行编码传输；如果原视频帧中已添加了 SEI 数据，那么，调用此接口不生效
• 如果调用此接口之后的 2s 内，没有可带 SEI 的视频帧（比如没有开启视频采集和传输），那么，SEI 数据不会被加进视频帧中。
• 消息发送成功后，远端会收到 rtcEngine:onSEIMessageReceived:andMessage: 回调。

registerLocalVideoProcessor:withConfig:

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

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

传入参数

返回值

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

注意

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

registerLocalEncodedVideoFrameObserver:

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

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

传入参数

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

subscribeUserStream:streamType:mediaType:videoConfig:

- (void)subscribeUserStream:(NSString *_Nonnull)userId streamType:(ByteRTCStreamIndex)streamType mediaType:(ByteRTCSubscribeMediaType)mediaType videoConfig:(ByteRTCSubscribeVideoConfig *_Nonnull)videoConfig;

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

传入参数

注意

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

setAudioPlaybackDevice:

- (int)setAudioPlaybackDevice:(ByteRTCAudioPlaybackDevice)audioPlaybackDevice;

设置音频播放设备为扬声器或者听筒，默认使用扬声器。
音频播放设备发生变化时，会收到 rtcEngine:onAudioPlaybackDeviceChanged: 回调。

传入参数

返回值 方法调用结果

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

注意

• 该方法适用于手机等移动设备。
• 听筒和扬声器为移动设备自带的音频播放设备。听筒一般用于通话，扬声器一般用于外放。
• 连接有线或者蓝牙音频播放设备后，音频路由将切换至有线耳机或者蓝牙耳机。不同音频场景中，音频路由和发布订阅状态到音量类型的映射关系详见 ByteRTCAudioScenarioType 。
• 进房前和进房后，均可调用此方法设置音频播放设备。

startLiveTranscoding:observer:

- (int)startLiveTranscoding:(ByteRTCLiveTranscoding *_Nullable)transcoding observer:(id<LiveTranscodingDelegate> _Nullable)observer;

开启转推直播，并设置合流的视频视图布局和音频属性。

传入参数

注意

• 启用服务端转推时，设置 observer 为 null。
• 只有主播角色的用户才能开启转推直播。
• 调用该方法后，启动结果和推流过程中的错误均会通过回调 rtcEngine:onLiveTranscodingResult:errorCode: 通知用户。

stopLiveTranscoding

- (int)stopLiveTranscoding;

停止转推直播。

返回值 方法调用结果。

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

updateLiveTranscoding:

- (int)updateLiveTranscoding:(ByteRTCLiveTranscoding *_Nonnull)transcoding;

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

传入参数

返回值 方法调用结果。

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

enableCloudRending:

- (int)enableCloudRending:(NSString *_Nonnull)rendingInfo;

按照传入的布局信息开启云端渲染。

传入参数

返回值 方法调用结果。

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

updateCloudRending:

- (int)updateCloudRending:(NSString *_Nonnull)rendingInfo;

按照传入的布局信息更新云端渲染。

传入参数

返回值 方法调用结果。

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

disableCloudRending

- (int)disableCloudRending;

停止云端渲染。

返回值 方法调用结果。

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

pushExternalVideoFrame:time:

- (BOOL)pushExternalVideoFrame:(CVPixelBufferRef _Nonnull )frame time:(CMTime)pts;

推送外部视频帧。

传入参数

返回值

• YES 推送成功
• NO 推送失败

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

pushExternalVideoFrame:time:rotation:

- (BOOL)pushExternalVideoFrame:(CVPixelBufferRef _Nonnull )frame time:(CMTime)pts rotation:(ByteRTCVideoRotation)rotation;

推送外部视频帧。

传入参数

返回值

• YES 推送成功
• NO 推送失败

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

pushExternalVideoFrame:time:rotation:extendedData:supplementaryInfo:

- (BOOL)pushExternalVideoFrame:(CVPixelBufferRef _Nonnull )frame time:(CMTime)pts rotation:(ByteRTCVideoRotation)rotation extendedData:(NSData* _Nullable)extendedData supplementaryInfo:(NSData* _Nullable)supplementoryInfo;

推送外部视频帧。

传入参数

返回值

• YES 推送成功
• NO 推送失败

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

pushExternalByteVideoFrame:

- (BOOL)pushExternalByteVideoFrame:(ByteRTCVideoFrame * _Nonnull)frame;

推送外部视频帧，使用 ByteRTCVideoFrame 进行封装。

传入参数

返回值

• YES 推送成功
• NO 推送失败

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

enableExternalAudioDevice:playbackFormat:

- (void)enableExternalAudioDevice:(ByteRTCAudioFormat * _Nonnull) recordingFormat playbackFormat:(ByteRTCAudioFormat * _Nonnull) playbackFormat;

启用自定义音频采集渲染

传入参数

注意

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

disableExternalAudioDevice

- (void)disableExternalAudioDevice;

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

注意

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

setRecordingAudioFrameParameters:channels:

- (BOOL)setRecordingAudioFrameParameters:(NSInteger)samplesPerSec channels:(NSInteger)channels;

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

传入参数

返回值 方法调用结果

• YES: 方法调用成功
• NO: 方法调用失败

注意 使用本方法设置参数，并使用 setAudioFrameObserver: 注册数据观察者，之后可以在 ByteRTCAudioFrameObserver的 onRecordAudioFrame:收到数据

setPlaybackAudioFrameParameters:channels:

- (BOOL)setPlaybackAudioFrameParameters:(NSInteger)samplesPerSec channels:(NSInteger)channels;

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

传入参数

返回值 方法调用结果

• YES: 方法调用成功
• NO: 方法调用失败

注意 使用本方法设置参数，并使用 setAudioFrameObserver: 注册数据观察者，之后可以在 ByteRTCAudioFrameObserver的 onPlaybackAudioFrame:收到数据

setMixedAudioFrameParameters:channels:

- (BOOL)setMixedAudioFrameParameters:(NSInteger)samplesPerSec channels:(NSInteger)channels;

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

传入参数

返回值 方法调用结果

• YES: 方法调用成功
• NO: 方法调用失败

注意 使用本方法设置参数，并使用 setAudioFrameObserver: 注册数据观察者，之后可以在 ByteRTCAudioFrameObserver的 onMixedAudioFrame:收到数据

setAudioFrameObserver:

- (BOOL)setAudioFrameObserver:(_Nullable id<ByteRTCAudioFrameObserver>) audioFrameObserver;

设置音频数据回调观察者

传入参数

返回值 方法调用结果

• YES: 方法调用成功
• NO: 方法调用失败

注意 本方法需要与下面3个方法配合使用：setRecordingAudioFrameParameters:channels:、 setPlaybackAudioFrameParameters:channels:、 setMixedAudioFrameParameters:channels:

registerLocalAudioProcessor:format:

- (BOOL)registerLocalAudioProcessor:(_Nullable id<ByteRTCAudioProcessor>) audioProcessor format:(ByteRTCAudioFormat* _Nullable)format;

设置自定义音频处理器。
使用该处理器，你可以调用 processAudioFrame: 对 RTC SDK 采集得到的音频帧进行自定义处理，并将处理后的音频帧用于 RTC 音视频通信。
SDK 只持有 processor 的弱引用，你应保证其生命周期。

传入参数

返回值 方法调用结果

• YES: 方法调用成功
• NO: 方法调用失败

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

pushExternalAudioFrame:

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

推送外部音频数据。

传入参数

返回值 方法调用结果

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

注意

• 推送外部音频数据前，必须开启自定义采集。
• 本方法中设置的 sampleRate（音频采样率） 和 channel（音频声道） 必须与 enableExternalAudioDevice:playbackFormat: 中设置的 sampleRate 和 channel 保持一致。

• 此方法推送音频数据的间隔为 10 毫秒。 samples (音频采样点个数）应该为 audioFrame.sampleRate / 100， 如设置采样率为 48000 时， 每次应该推送 480 个采样点。

• 音频采样格式为 S16。音频缓冲区内的数据格式必须为 PCM 数据，其容量大小应该为 audioFrame.samples

• 该函数运行在用户级线程内。若同时运行其他进程，将导致本进程中断。

pullExternalAudioFrame:

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

拉取外部音频数据。

传入参数

返回值 方法调用结果

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

注意

• 拉取外部音频数据前，必须开启自定义采集。
• 本方法中设置的 sampleRate（音频采样率） 和 channel（音频声道） 必须与 enableExternalAudioDevice:playbackFormat: 中设置的 sampleRate 和 channel 保持一致。

• 此方法拉取音频数据的间隔为 10 毫秒，音频采样格式为 S16。 samples (音频采样点个数）应该为 audioFrame.sampleRate / 100， 如设置采样率为 48000 时， 每次应该拉取 480 个采样点。

• 音频采样格式为 S16。音频缓冲区内的数据格式必须为 PCM 数据，其容量大小应该为 audioFrame.samples

• 该函数运行在用户级线程内。若同时运行其他进程，将导致本进程中断。

sendRoomMessage:

- (int)sendRoomMessage:(NSString * _Nonnull)message;

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

传入参数

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

注意

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

sendRoomBinaryMessage:

- (int)sendRoomBinaryMessage:(NSData * _Nonnull)message;

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

传入参数

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

注意

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

setBusinessId:

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

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

传入参数

返回值

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

注意

• 需要在调用 joinRoomByKey:roomId:userInfo:rtcRoomConfig: 之前调用， joinRoomByKey:roomId:userInfo:rtcRoomConfig:之后调用该方法无效。

feedbackTypes:desc:

- (int)feedbackTypes:(NSArray* _Nullable)types desc:(NSString* _Nullable)desc;

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

传入参数

返回值

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

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

sendUserMessage:message:

- (int64_t)sendUserMessage:(NSString * _Nonnull)uid message:(NSString * _Nonnull)message;

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

传入参数

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

注意

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

sendUserBinaryMessage:message:

- (int64_t)sendUserBinaryMessage:(NSString * _Nonnull)uid message:(NSData * _Nonnull)message;

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

传入参数

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

注意

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

setRemoteAudioPlaybackVolume:volume:

- (void)setRemoteAudioPlaybackVolume:(NSString* _Nonnull)uid volume:(int)volume;

调节来自指定远端用户的音频播放音量，默认为 100。

传入参数

setPublishFallbackOption:

- (int)setPublishFallbackOption:(ByteRTCPublishFallbackOption)option;

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

传入参数

返回值

• 0；方法调用成功；
• -1：方法调用失败；

注意

• 1. 在网络情况不理想、设备性能不足时，实时音视频的质量会下降。通过这个接口来设置网络情况不佳或性能不足时只发送小流，以保证通话质量。
• 1. 这个方法只在设置了发送多个流的情况下有效。
• 1. 必须在进房前设置，进房后设置或更改设置无效。
• 1. 设置回退选项后，本端发布的音视频流发生回退或从回退中恢复时，对端会收到 rtcEngine:OnSimulcastSubscribeFallback: 回调通知。

setSubscribeFallbackOption:

- (int)setSubscribeFallbackOption:(ByteRTCSubscribeFallbackOption)option;

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

传入参数

返回值

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

注意

• 在网络情况不理想、设备性能不足时，实时音视频的质量会下降。通过这个接口来设置网络情况不佳或性能不足时只订阅小流或音频流，以保证通话质量。
• 必须在进房前设置，进房后设置或更改设置无效。
• 设置回退选项后，本端订阅的音视频流发生回退或从回退中恢复时,会收到 rtcEngine:OnSimulcastSubscribeFallback: 回调通知。
• 设置回退选项后，本端订阅的视频流因为回退分辨率发生变化时,会收到 rtcEngine:onRemoteVideoSizeChanged:withFrameInfo: 回调通知。

setRemoteUserPriority:uid:

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

设置用户优先级

传入参数

返回值

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

注意

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

setEncryptType:key:

- (void)setEncryptType:(ByteRTCEncryptType)encrypt_type key:(NSString * _Nonnull)key;

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

传入参数

注意

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

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

setCustomizeEncryptHandler:

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

设置自定义加密和解密方式 需要实现对应的加密和解密方法。详情参考 ByteRTCEncryptHandler

传入参数

注意

• 该方法与 setEncryptType:key: 为互斥关系, 即按照调用顺序，最后一个调用的方法为最终生效的版本

• 该方法必须在调用 joinRoomByKey:roomId:userInfo:rtcRoomConfig: 之前调用，可重复调用，以最后调用的参数作为生效参数

• 无论加密或者解密，其对原始数据的长度修改，需要控制在90%-120%之间，即如果输入数据为100字节，则处理完成后的数据必须在 90至120字节之间，如果加密或解密结果超出该长度限制，则该音视频桢会被丢弃

• 数据加密/解密为串行执行，因而视实现方式不同，可能会影响到最终渲染效率，是否使用该方法，需要由使用方谨慎评估

createRtcRoom:

- (ByteRTCRoom * _Nullable)createRtcRoom:(NSString * _Nonnull)roomId;

创建并获取一个 ByteRTCRoom 对象

传入参数

注意

• 用户可以多次调用此方法创建多个 ByteRTCRoom 对象，再分别调用各 ByteRTCRoom 对象的 joinRoomByToken:userInfo:roomConfig: 方法，实现同时加入多个房间；
• 加入多个房间后，用户可以同时订阅各房间的音视频流，但是目前仅支持同一时间在一个房间内发布一路音视频流。

publishScreen

- (void)publishScreen;

发布本地屏幕共享流。

注意

• 直播、游戏、云游戏房间模式下，仅可见的用户可以调用此方法。你可以调用 setUserVisibility: 方法设置用户在房间中的可见性。
• 此方法只影响屏幕共享视频流的发布状态，并不影响屏幕视频流的采集情况。
• 发布成功后，远端会收到 rtcEngine:onStreamAdd: 回调。
• 调用 unpublishScreen 取消发布。

unpublishScreen

- (void)unpublishScreen;

取消发布屏幕流

注意

• 此方法只影响屏幕共享视频流的发布状态，并不影响屏幕视频流的采集情况。
• 调用成功后，远端会收到 rtcEngine:didStreamRemoved:stream:reason: 回调。
• 调用 publishScreen 启动发布。

pushScreenCaptureFrame:time:rotation:

- (void)pushScreenCaptureFrame:(CVPixelBufferRef _Nonnull )frame time:(CMTime)pts rotation:(int)rotation;

推送外部屏幕采集帧

传入参数

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

startScreenSharingWithPreferredExtension:groupId:

- (int)startScreenSharingWithPreferredExtension:(NSString *_Nullable)extension groupId:(NSString *_Nonnull)groupId API_AVAILABLE(ios(12));

开始内部屏幕采集

传入参数

返回值 0 :成功;

-1 :失败;

注意 1.屏幕采集分为内部采集和外部采集，本方法属于内部采集。 内部采集：由 SDK 进行屏幕采集和后续所有流程 外部采集：用户负责采集屏幕数据帧，通过接口提供给 SDK 2.调用该接口后远端能收到 rtcEngine:onFirstRemoteVideoFrameRendered:withFrameInfo: 和 rtcEngine:onStreamAdd: 事件。 3.内部采集时，外部不需要屏幕采集帧。

API_AVAILABLE

- (void)stopScreenSharing API_AVAILABLE(ios(12));

停止内部屏幕采集

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

startASR:handler:

- (void)startASR:(ByteRTCASRConfig *_Nonnull)asrConfig handler:(id<ByteRTCASREngineEventHandler> _Nonnull)handler ;

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

传入参数

stopASR

- (void)stopASR;

关闭语音识别服务

startFileRecording:withRecordingConfig:

- (int)startFileRecording:(ByteRTCStreamIndex)streamIndex withRecordingConfig:(ByteRTCRecordingConfig* _Nonnull)recordingConfig;

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

传入参数

返回值

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

注意

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

stopFileRecording:

- (void)stopFileRecording:(ByteRTCStreamIndex)streamIndex;

停止本地录制

传入参数

注意

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

getAudioMixingManager

- (ByteRTCAudioMixingManager *_Nullable)getAudioMixingManager;

混音管理接口创建

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

getPositionAudioRender

- (ByteRTCPositionAudioRender *_Nullable)getPositionAudioRender;

获取位置音频接口实例，包括范围语音、空间语音等和位置相关的音频接口。

返回值 位置音频管理接口实例。如果返回 NULL，则表示不支持空间音频，详见 ByteRTCPositionAudioRender 。

注意

• 只有在使用支持真双声道播放的设备时，才能开启空间音频效果；
• 在网络状况不佳的情况下，即使开启了这一功能，也不会产生空间音频效果；
• 机型性能不足可能会导致音频卡顿，使用低端机时，不建议开启空间音频效果；
• 空间音频效果在启用服务端选路功能时，不生效。

login:uid:

- (void)login:(NSString * _Nonnull)token uid:(NSString * _Nonnull)uid;

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

传入参数

注意

• 在调用本接口登录后，如果想要登出，需要调用 logout 登出后，才能再次登录。
• 本地用户调用此方法登录后，会收到 rtcEngine:onLoginResult:errorCode:elapsed: 回调通知登录结果，远端用户不会收到通知。

logout

- (void)logout;

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

注意

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

updateLoginToken:

- (void)updateLoginToken:(NSString * _Nonnull)token;

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

传入参数

注意

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

setServerParams:url:

- (void)setServerParams:(NSString * _Nonnull)signature url:(NSString * _Nonnull)url;

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

传入参数

注意

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

getPeerOnlineStatus:

- (void)getPeerOnlineStatus:(NSString * _Nonnull)peerUserId;

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

传入参数

注意

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

sendUserMessageOutsideRoom:message:

- (int64_t)sendUserMessageOutsideRoom:(NSString * _Nonnull)userId message:(NSString * _Nonnull)messageStr;

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

传入参数

返回值

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

注意

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

sendUserBinaryMessageOutsideRoom:message:

- (int64_t)sendUserBinaryMessageOutsideRoom:(NSString * _Nonnull)userId message:(NSData * _Nonnull)messageStr;

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

传入参数

返回值

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

注意

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

sendServerMessage:

- (int64_t)sendServerMessage:(NSString * _Nonnull)messageStr;

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

传入参数

返回值

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

注意

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

sendServerBinaryMessage:

- (int64_t)sendServerBinaryMessage:(NSData * _Nonnull)messageStr;

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

传入参数

返回值

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

注意

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

setScreenAudioSourceType:

- (void) setScreenAudioSourceType:(ByteRTCAudioSourceType)sourceType;

在屏幕共享时，设置屏幕音频的采集方式（内部采集/自定义采集）

传入参数

注意

• 默认采集方式是 RTC SDK 内部采集。当前不支持使用内部采集，请调用此方法，设置为使用自定义采集。
• 你应该在 publishScreen 前，调用此方法。否则，你将收到 rtcEngine:onWarning: 的报错：ByteRTCWarningSetScreenAudioSourceTypeFailed
• 如果设定为自定义采集，你必须再调用 publishScreen 将自定义采集到的屏幕音频帧推送到 RTC SDK。
• 无论是内部采集还是自定义采集，你都必须调用 publishScreen 将采集到的屏幕音频推送到远端。

setScreenAudioStreamIndex:

- (void) setScreenAudioStreamIndex:(ByteRTCStreamIndex) index;

在屏幕共享时，设置屏幕音频流和麦克风采集到的音频流的混流方式

传入参数

注意 你应该在 publishScreen 之前，调用此方法。否则，你将收到 rtcEngine:onWarning: 的报错：ByteRTCWarningSetScreenAudioStreamIndexFailed

pushScreenAudioFrame:

- (int) pushScreenAudioFrame:(ByteRTCAudioFrame* _Nonnull)audioFrame;

使用自定义采集方式，采集屏幕共享时的屏幕音频时，将音频帧推送至 RTC SDK 处进行编码等处理。

传入参数

返回值 方法调用结果

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

注意

• 调用此接口推送屏幕共享时的自定义采集的音频数据前，必须调用 setScreenAudioSourceType: 开启屏幕音频自定义采集。
• 你应每隔 10 毫秒，调用一次此方法推送一次自定义采集的音频帧。一次推送的音频帧中应包含 frame.sample_rate / 100 个音频采样点。比如，假如采样率为 48000Hz，则每次应该推送 480 个采样点。
• 音频采样格式为 S16。音频缓冲区内的数据格式必须为 PCM 数据，其容量大小应该为 samples
• 此函数运行在用户级线程内。若同时运行其他进程，将导致本进程中断。
• 调用此接口将自定义采集的音频帧推送到 RTC SDK 后，你必须调用 publishScreen 将采集到的屏幕音频推送到远端。在调用 publishScreen 前，推送到 RTC SDK 的音频帧信息会丢失。

setVideoSourceType:WithStreamIndex:

- (void)setVideoSourceType:(ByteRTCVideoSourceType)type WithStreamIndex:(ByteRTCStreamIndex)streamIndex;

设置向 SDK 输入的视频源

传入参数

注意

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

setExternalVideoEncoderEventHandler:

- (void)setExternalVideoEncoderEventHandler:(id<ByteRTCExternalVideoEncoderEventHandler> _Nullable)handler;

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

传入参数

注意

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

pushExternalEncodedVideoFrame:withVideoIndex:withEncodedVideoFrame:

- (BOOL)pushExternalEncodedVideoFrame:(ByteRTCStreamIndex)streamIndex withVideoIndex:(NSInteger)videoIndex withEncodedVideoFrame:(ByteRTCEncodedVideoFrame* _Nonnull)videoFrame;

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

传入参数

注意

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

setVideoDecoderConfig:withVideoDecoderConfig:

- (void)setVideoDecoderConfig:(ByteRTCRemoteStreamKey * _Nonnull)key withVideoDecoderConfig:(ByteRTCVideoDecoderConfig)config;

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

传入参数

注意

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

requestRemoteVideoKeyFrame:

- (void)requestRemoteVideoKeyFrame:(ByteRTCRemoteStreamKey * _Nonnull)key;

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

传入参数

注意

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

registerRemoteEncodedVideoFrameObserver:

- (void)registerRemoteEncodedVideoFrameObserver:(id<ByteRTCRemoteEncodedVideoFrameObserver> _Nullable)observer;

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

传入参数

注意

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

sendStreamSyncInfo:config:

- (int)sendStreamSyncInfo:(NSData* _Nonnull)data config:(ByteRTCStreamSycnInfoConfig * _Nonnull)config;

ByteRTCPositionAudioRender

@interface ByteRTCPositionAudioRender :NSObject

空间音频接口。

成员函数

函数说明

enableAudioSpatialRender:

-(void)enableAudioSpatialRender:(BOOL) enable;

开启或关闭空间音频效果。

传入参数

updatePosition:

-(int)updatePosition:(Position* _Nonnull) pos;

更新自己的位置坐标。

传入参数

返回值

• 0: 参数检查通过，但不代表更新成功；
• 其他: 更新失败。

updateSelfOrientation:

-(int)updateSelfOrientation:(HumanOrientation* _Nonnull) orientation;

更新自己的朝向。本地朝向的设置只影响本地听到的音频效果，不影响本地发出的音频效果。

传入参数

返回值 0: 代表更新成功

注意 本地用户调用 enableAudioSpatialRender: 使用空间音频功能时，需要调用 updatePosition: 接口更新位置坐标后，才能调用此接口。

ByteRTCRoom

@interface ByteRTCRoom : NSObject

成员变量

成员函数

变量说明

delegate

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

函数说明

destroy

- (void)destroy;

销毁房间

注意 调用该接口后，SDK 会先执行退房操作，然后释放房间处理回调指针

getRoomId

- (NSString *_Nullable)getRoomId;

获取房间 ID

setRtcRoomDelegate:

- (void)setRtcRoomDelegate:(id<ByteRTCRoomDelegate> _Nullable)roomDelegate;

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

传入参数

joinRoomByToken:userInfo:roomConfig:

- (int)joinRoomByToken:(NSString *_Nullable)token userInfo:(ByteRTCUserInfo *_Nonnull)userInfo roomConfig:(ByteRTCMultiRoomConfig *_Nonnull)roomConfig;

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

传入参数

返回值 方法调用结果。

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

注意

• 同一个 AppID 的同一个房间内，每个用户的用户 ID 必须是唯一的。如果两个用户的用户 ID 相同，则后加入房间的用户会将先加入房间的用户踢出房间，并且先加入房间的用户会收到 rtcEngine:onError: 回调通知，错误类型为重复登录 BRERR_DUPLICATE_LOGIN。
• 本地用户调用此方法加入房间成功后，会收到 rtcRoom:onJoinRoomResult:withUid:errorCode:joinType:elapsed: 回调通知。
• 本地用户调用 setUserVisibility: 将自身设为可见后加入房间，远端用户会收到 rtcRoom:onUserJoined:elapsed: 回调通知。
• 用户加入房间成功后，在本地网络状况不佳的情况下，SDK 可能会与服务器失去连接，此时 SDK 将会自动重连。重连成功后，本地会收到 rtcRoom:onUserJoined:elapsed: 回调通知。

setUserVisibility:

- (BOOL)setUserVisibility:(BOOL)enable;

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

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

传入参数

返回值 方法调用结果：

• YES: 方法调用成功
• NO: 方法调用失败

注意

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

clientRole

- (ByteRTCUserRoleType)clientRole;

获取当前用户角色。

返回值 当前用户角色，详见 ByteRTCUserRoleType 枚举类型。

leaveRoom

- (int)leaveRoom;

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

返回值 方法调用结果。

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

注意

• 用户离开房间后，本地会收到 onLeaveRoomWithStats:rtcRoom:onLeaveRoomWithStats: 的回调；
• 调用 setUserVisibility: 方法将自身设为可见的用户离开房间后，房间内其他用户会收到 rtcRoom:onUserLeave:reason: 回调通知。
• 调用 joinRoomByToken:userInfo:roomConfig: 方法加入房间后，必须调用此方法离开房间，否则无法进入下一个房间。无论当前是否在房间内，都可以调用此方法。重复调用此方法没有负面影响。

renewToken:

- (int)renewToken:(NSString *_Nullable)token;

更新 Token。
用户调用 joinRoomByToken:userInfo:roomConfig: 方法加入房间时， 如果使用了过期的 Token 将导致加入房间失败，并会收到 rtcEngine:onJoinRoomResult:withUid:errorCode:joinType:elapsed: 回调， 回调错误码为 ByteRTCErrorCode 中的 ByteRTCErrorCodeInvalidToken。 此时需要重新获取 Token，并调用此方法更新 Token。更新 Token 后，SDK 会自动加入房间。

传入参数

返回值 方法调用结果。

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

注意 Token 过期时，如果已经加入房间成功，则不会受到影响。Token 过期的错误会在下一次使用过期的 Token 加入房间时，或因本地网络状况不佳导致断网重新连入房间时通知用户。

publish

- (int)publish;

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

注意

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

unpublish

- (int)unpublish;

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

注意

• 在多房间模式下，调用 publish 手动发布音视频流后，调用此接口停止发布。
• 房间内用户调用此方法停止发布音视频流后，房间中的其他用户将会收到 rtcRoom:didStreamRemoved:stream:reason: 回调通知。

publishScreen:

- (int)publishScreen:(ByteRTCScreenParam * _Nonnull)param;

发布本地屏幕视频流到此房间。（外部采集）
调用此方法后，你还需要周期性调用 pushScreenCaptureFrame:time:rotation: 方法， 将需要发送的屏幕数据推送给 SDK。

传入参数

注意

• 仅房间内可见的用户可以进行手动发布。调用 setUserVisibility: 可以设置用户可见性。
• 调用此方法后，房间内的远端用户会收到 rtcRoom:onStreamAdd: 事件。

• 如果你需要由外部屏幕采集切换为内部采集，你必须调用 unpublishScreen 关闭外部采集后， 通过调用 startScreenSharingWithPreferredExtension:groupId: 开启内部采集。

• 本地可调用 setLocalVideoRenderer:forUserId: 函数设置本地屏幕共享视图。 onLocalScreenFrame:本地屏幕视频回调事件和 onRemoteScreenFrame:user:room: 远端屏幕共享视频回调事件来获取原始数据。

unpublishScreen

- (int)unpublishScreen;

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

注意

• 调用此方法后，远端会收到 rtcRoom:didStreamRemoved:stream:reason: 回调。
• 要发布本地屏幕视频流到指定房间，可以调用 publishScreen:

subscribeUserStream:streamType:mediaType:videoConfig:

- (void)subscribeUserStream:(NSString *_Nonnull)userId streamType:(ByteRTCStreamIndex)streamType mediaType:(ByteRTCSubscribeMediaType)mediaType videoConfig:(ByteRTCSubscribeVideoConfig *_Nonnull)videoConfig;

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

传入参数

注意

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

setAudioVolumeIndicationInterval:

- (void)setAudioVolumeIndicationInterval:(NSInteger)interval;

开启/关闭房间内音量提示。默认关闭。
开启音量提示后，将按设置的时间间隔收到本地采集音量或订阅的远端用户的音量信息回调。 关于回调的具体信息，参看 rtcEngine:onAudioVolumeIndication:totalRemoteVolume:。

传入参数

pauseAllSubscribedStream:

- (void)pauseAllSubscribedStream:(ByteRTCPauseResumControlMediaType) mediaType;

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

传入参数

注意

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

resumeAllSubscribedStream:

- (void)resumeAllSubscribedStream:(ByteRTCPauseResumControlMediaType) mediaType;

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

传入参数

注意

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

startLiveTranscoding:observer:

- (int)startLiveTranscoding:(ByteRTCLiveTranscoding *_Nullable)transcoding observer:(id<LiveTranscodingDelegate> _Nullable)observer;

开启转推直播，并设置视频视图布局、音频属性等参数

传入参数

注意

• 启用服务端转推时，设置 observer 为 null。
• 只有主播角色的用户才能开启转推直播。
• 调用该方法后，启动结果和推流过程中的错误均会通过回调 rtcEngine:onLiveTranscodingResult:errorCode: 通知用户。

stopLiveTranscoding

- (int)stopLiveTranscoding;

停止转推直播。

updateLiveTranscoding:

- (int)updateLiveTranscoding:(ByteRTCLiveTranscoding *_Nonnull)transcoding;

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

传入参数

返回值 方法调用结果。

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

setRemoteVideoCanvas:withIndex:withCanvas:

- (int)setRemoteVideoCanvas:(NSString * _Nonnull)uid withIndex:(ByteRTCStreamIndex)streamIndex withCanvas:(ByteRTCVideoCanvas * _Nullable)canvas;

渲染来自指定远端用户 uid 的视频流时，设置使用的视图和渲染模式。
如果需要解除视频的绑定视图，把 canvas 设置为空。

传入参数

返回值

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

注意

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

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

sendUserMessage:message:

- (int64_t)sendUserMessage:(NSString *_Nonnull)userId message:(NSString *_Nonnull)message;

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

传入参数

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

注意

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

sendUserBinaryMessage:message:

- (int64_t)sendUserBinaryMessage:(NSString * _Nonnull)uid message:(NSData * _Nonnull)message;

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

传入参数

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

注意

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

sendRoomMessage:

- (int64_t)sendRoomMessage:(NSString *_Nonnull)message;

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

传入参数

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

注意

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

sendRoomBinaryMessage:

- (int64_t)sendRoomBinaryMessage:(NSData * _Nonnull)message;

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

传入参数

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

注意

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