BRTC 实时音视频>客户端 API>iOS

iOS

编辑文档 更新于
概况BRTCBRTCDelegateBRTCCanvas对象和枚举

BRTC 是 BRTC SDK 的入口类,它为 App 提供了快速搭建音视频通信的 API。
BRTC 包含 App 调用的主要方法,调用 BRTC 的接口最好在同一个线程进行,不建议在不同的线程同时调用。

函数

+ (instancetype) sharedInstance
- (void) destroy
- (void) setDelegate
- (void) joinRoom
- (void) leaveRoom
- (void) enableLocalAudio
- (void) muteLocalAudioStream
- (void) muteRemoteAudioStream
- (void) muteAllRemoteAudioStreams
- (void) setAudioEncoderConfiguration
- (void) setAudioRoute
- (void) setVideoEncoderConfiguration
- (void) setSystemVolumeType
- (void) enableAudioVolumeEvaluation
- (void) setAudioCaptureVolume
- (NSInteger) getAudioCaptureVolume
- (void) setAudioPlayoutVolume
- (NSInteger) getAudioPlayoutVolume
- (void) switchCamera
- (void) startLocalPreview
- (void) stopLocalPreview
- (void) muteLocalVideoStream
- (void) muteRemoteVideoStream
- (void) muteAllRemoteVideoStreams
- (void) startRemoteView
- (void) stopRemoteView
- (void) setLocalRenderMode
- (void) setRemoteRenderMode
- (void) setVideoEncoderConfiguration
- (void) enableEncSmallVideoStream
- (void) setRemoteVideoStreamType
- (void) setNetworkQosParameter
- (void) snapshotVideo
- (BOOL) isCameraZoomSupported
- (BOOL) isCameraTorchSupported
- (BOOL) enbaleTorch
- (void) setZoom
- (void) getSDKVersion
- (void) setLogLevel
+ (NSString *) getSDKVersion

详细信息

创建 BRTC 实例 

+ (instancetype)sharedInstance;

返回

  • BRTC 实例

详情

  • BRTC 类的所有接口函数,如无特殊说明,都是异步调用,对接口的调用建议在同一个线程进行
  • 请确保在调用其他 API 前先调用该方法创建并初始化
  • BRTC Native SDK 只支持每个App中创建一个 BRTC 实例

销毁 BRTC 实例 

- (void)destroy;

详情

  • 该方法释放 BRTC SDK 使用的所有资源
  • 调用 destroy 方法后,你将无法再使用 SDK 的其它方法和回调
  • 如需再次使用实时音视频通信功能,你必须重新调用 sharedInstance 方法创建一个新的 BRTC 实例
  • 调用该API后,需要等待资源全部释放,建议在子线程中调用该方法,避免主线程阻塞
  • 如需在销毁后再次创建 BRTC 实例,需要等待 destroy 方法执行结束后再创建实例

加入房间 

- (void)joinRoom:(BRTCConfig *_Nonnull)config;

参数

名称 描述
config 加入房间附带的信息,详见 BRTCConfig

详情

  • 该方法让用户加入通话的房间,加入房间内的每一个用户的uid必须是唯一的
  • 同一个房间内用户 ID 相同时,后进入的用户会将前一个用户踢出房间

离开房间 

- (void)leaveRoom;

详情

  • 离开房间,即挂断或退出房间
  • 调用 joinRoom 后,必须调用 leaveRoom 结束通话,否则无法开始下一次通话
  • 成功调用该方法离开频道后,本地会触发 onLeaveRoom 回调,远端会触发 onUserOffline 回调

切换前/后置摄像头 

- (void)switchCamera;

开启大小画面双路编码模式 

- (int)enableEncSmallVideoStream:(BOOL)enable withQuality:(BRTCSendVideoConfig *_Nonnull)smallVideoConfig;

参数

名称 描述
enable YES:开启 ~ NO:关闭(默认)
smallVideoConfig 对应的视频参数,详见 BRTCSendVideoConfig

开关本地音频采集和上行 

- (void)enableLocalAudio:(BOOL)enabled;

参数

名称 描述
enable YES:开启本地音频采集和上行（默认) ~ NO:停止本地音频采集和上行

详情

  • 该方法不影响接收或播放远端音频流
  • enableLocalAudio(false) 适用于只听不发的用户场景

停止/恢复接收所有远端音频流 

- (void)muteAllRemoteAudioStreams:(BOOL)mute;

参数

名称 描述
mute YES: 停止接收所有远端音频流 ～ NO:继续接收所有远端音频流(默认)

停止/恢复接收所有远端视频流 

- (void)muteAllRemoteVideoStreams:(BOOL)mute;

参数

名称 描述
mute YES: 停止接收所有远端视频流 ~ NO:继续接收所有远端视频流(默认)

开关本地音频发送 

- (void)muteLocalAudioStream:(BOOL)mute;

参数

名称 描述
mute YES:停止发送本地音频流 ~ NO:（默认）继续发送本地音频流

详情

  • 开关本地音频发送
  • 该方法用于允许/禁止往网络发送本地音频流
  • 成功调用该方法后,远端会触发 onUserAudioAvailable 回调
  • 该方法不影响录音状态,并没有禁用麦克风

开关本地视频采集 

- (void)muteLocalVideoStream:(BOOL)mute;

参数

名称 描述
mute YES:停止发送本地视频流 ~ NO:继续发送本地视频流（默认）

详情

  • 开关本地视频采集
  • 该方法禁用或重新启用本地视频采集,不影响接收远端视频
  • 成功禁用或启用本地视频采集后,远端会触发 onUserVideoAvailable 回调

停止/恢复接收指定用户的音频流 

- (void)muteRemoteAudioStream:(NSUInteger)uid mute:(BOOL)mute;

参数

名称 描述
uid 用户id
mute YES:停止接收指定用户的音频流 ~ NO:（默认）继续接收指定用户的音频流

停止/恢复接收指定用户的视频流 

- (void)muteRemoteVideoStream:(NSUInteger)uid mute:(BOOL)mute;

参数

名称 描述
uid 用户id
mute YES:停止接收指定用户的视频流 ~ NO:（默认）继续接收指定用户的视频流

设置音频编码配置 

- (void)setAudioEncoderConfiguration:(BRTCSendAudioConfig *_Nonnull)config;

参数

名称 描述
config 所推流的配置,详见 BRTCSendAudioConfig

setDelegate()
设置SDK事件回调监听

- (void)setDelegate:(id<BRTCDelegate> _Nullable)delegate;

参数

名称 描述
delegate SDK事件回调,详见 BRTCDelegate

设置本地视图显示模式 

- (void)setLocalRenderMode:(BRTCVideoRenderMode)renderMode;

参数

名称 描述
renderMode 显示模式,详见 BRTCVideoRenderMode

设置远端视图显示模式 

- (void)setRemoteRenderMode:(NSUInteger)uid mode:(BRTCVideoRenderMode)renderMode;

参数

名称 描述
uid 用户id
renderMode 显示模式,详见 BRTCVideoRenderMode

选定观看指定 uid 的大画面或小画面 

- (void)setRemoteVideoStreamType:(NSUInteger)uid type:(BRTCVideoStreamType)type;

参数

名称 描述
uid 用户id
type 视频类型,详见 BRTCVideoRenderMode

详情

  • 此功能需要该 uid 通过 enableEncSmallVideoStream 提前开启双路编码模式
  • 如果该 uid 没有开启双路编码模式,则此操作将无任何反应

设置视频编码配置 

- (void)setVideoEncoderConfiguration:(BRTCSendVideoConfig *_Nonnull)config;

参数

名称 描述
config 所推流的配置,详见 BRTCSendVideoConfig

开启本地视频的预览画面 

- (void)startLocalPreview:(BRTCCanvas *_Nonnull)canvas;

参数

名称 描述
canvas 用于显示推流画面的视图,视图设置为 [null] 则不进行显示

详情

  • 开启本地视频的预览画面 当开始渲染首帧摄像头画面时,您会收到 BRTCDelegate 中的 onFirstVideoFrame 回调
  • 使用该方法启用了本地视频预览后,如果直接调用 leaveRoom 退出频道,并不会关闭预览。如需关闭预览,请调用 stopLocalPreview

停止本地视频采集及预览 

- (void)stopLocalPreview;

开始显示远端视频画面 

- (void)startRemoteView:(BRTCCanvas *_Nullable)canvas uid:(NSUInteger)uid;

参数

名称 描述
uid 用户id
canvas 用于显示推流画面的视图,视图设置为 [null] 则不进行显示

详情

  • 建议调用 startRemoteView 接口加载该用户的远程画面时,可以用 loading 动画优化加载过程中的等待体验<
  • 当首帧画面开始显示时,会收到 onFirstVideoFrameRendered 事件回调

停止显示远端视频画面 

- (void)stopRemoteView:(NSUInteger)uid;

参数

名称 描述
uid 用户id

详情

  • 停止显示远端视频画面,同时不再拉取该远端用户的视频数据流
  • 调用此接口后,SDK 会停止接收该用户的远程视频流,同时会清理相关的视频显示资源

设置网络流控相关参数 

- (void)setNetworkQosParameter:(BRTCNetworkQosParameter *)parameter;

参数

名称 描述
param 包含 preference 和 controlMode 属性 选择清晰模式,详见 BRTCNetworkQosParam

详情

  • 该设置决定 SDK 在各种网络环境下的调控策略（例如弱网下选择“保清晰”或“保流畅”）

详情

  • 低端设备推荐优先选择低清晰度的小画面
  • 如果对方没有开启双路视频模式,则此操作无效

视频画面截图 

- (void)snapshotVideo:(NSUInteger)uid completionBlock:(void (^)(UIImage *image))completionBlock;

参数

名称 描述
uid 用户id
listener 画面截取后的回调,详见 BRTCSnapShotListener.onSnapShotVideo

设置音频路由 

- (void)setAudioRoute:(BRTCAudioRoute)route;

参数

名称 描述
route 音频路由,即声音由哪里输出（扬声器、听筒),详见 BRTCAudioRouteMode

启用音量大小提示 

- (void)enableAudioVolumeEvaluation:(NSUInteger)interval;

参数

名称 描述
intervalMs onUserVoiceVolume 回调的触发间隔

详情

  • 开启后会在 onUserVoiceVolume 中获取到 SDK 对音量大小值的评估。如需打开此功能,请在 startLocalAudio() 之前调用
  • intervalMs 决定了 onUserVoiceVolume 回调的触发间隔,单位为ms,最小间隔为100ms,如果小于等于0则会关闭回调,建议设置为300ms

查询当前摄像头是否支持缩放 

- (BOOL)isCameraZoomSupported;

设置摄像头缩放因子（焦距) 

- (void)setZoom:(CGFloat)distance;

参数

名称 描述
distance 缩放因子

详情

  • 取值范围1 - 5,取值为1表示最远视角（正常镜头）,取值为5表示最近视角（放大镜头）
  • 最大值推荐为5,若超过5,视频数据会变得模糊不清

获取 SDK 版本信息 

+ (NSString *)getSDKVersion;

查询是否支持开关闪光灯（手电筒模式） 

- (BOOL)isCameraTorchSupported;

返回

  • YES：开启 ~ NO：关闭(默认)

开关闪光灯 

- (BOOL)enbaleTorch:(BOOL)enable;

参数

名称 描述
enable YES：开启 ~ NO：关闭(默认)

获取当前麦克风设备音量 

- (NSInteger)getAudioCaptureVolume;

设置麦克风设备的音量 

- (void)setAudioCaptureVolume:(NSInteger)volume;

参数

名称 描述
volume 麦克风音量大小,范围0 - 100

获取当前扬声器设备音量 

- (NSInteger)getAudioPlayoutVolume;

设置当前扬声器音量 

- (void)setAudioPlayoutVolume:(NSInteger)volume;

参数

名称 描述
volume 扬声器音量大小,范围0 - 100

设置log输出级别 

+ (void)setLogLevel:(BRTCLogLevel)level;

参数

名称 描述
level log级别,详见 BRTCLogLevel
{{allComment[version]}} ×
  • 暂无评论
  • {{comment.author}}
    {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
    {{comment.content}}
您需要 后才能评论