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

iOS

编辑文档更新于 2021-01-25 18:07:40

概况BRTCBRTCDelegateBRTCCanvas对象和枚举

BRTC 提供可以灵活搭配的 API 组合,为移动端到移动端以及移动端到 Web 端提供质量可靠的实时音视频通信功能。

BRTC 包含应用程序调用的主要方法
BRTCDelegate 用于向应用程序发送回调通知
BRTCCanvas 用于设置视频的显示
对象和枚举定义了一些配置参数和文件夹包含 SDK 接口的入参及出参的类的定义

相关接口

基础方法

方法	描述
sharedInstance	创建BRTC实例
destroy	销毁BRTC实例
setDelegate	设置SDK回调事件

房间相关接口函数

方法	描述
joinRoom	加入房间,若房间不存在,系统将自动创建一个新房间
leaveRoom	离开房间

视频相关接口函数

方法	描述
switchCamera	切换摄像头
startLocalPreview	开启本地视频的预览画面
stopLocalPreview	停止本地视频采集及预览
muteLocalVideoStream	开关本地视频发送
muteRemoteVideoStream	停止/恢复接收指定用户的视频流
muteAllRemoteVideoStreams	停止/恢复接收所有远端视频流
startRemoteView	开始显示远端视频画面
stopRemoteView	停止显示远端视频画面,同时不再拉取该远端用户的视频数据流
setLocalRenderMode	设置本地视图显示模式
setRemoteRenderMode	设置远端视图显示模式
setVideoEncoderConfiguration	设置视频编码配置
enableEncSmallVideoStream	开启小流
setRemoteVideoStreamType	选定观看指定 uid 的大画面或小画面
setNetworkQosParamer	设置网络流控相关参数
setPriorRemoteVideoStreamType	设定观看方优先选择的视频质量
snapshotVideo	视频画面截图

摄像头相关接口函数

方法	描述
isCameraZoomSupported	查询当前摄像头是否支持缩放
setZoom	设置摄像头缩放因子（焦距）
isCameraTorchSupported	查询是否支持开关闪光灯（手电筒模式）
enableTorch	开关闪光灯

音频相关接口函数

方法	描述
enableLocalAudio	开关本地音频采集
muteLocalAudioStream	开关本地音频发送
muteRemoteAudioStream	停止/恢复接收指定用户的音频流
muteAllRemoteAudioStreams	停止/恢复接收所有远端音频流
setAudioEncoderConfiguration	设置视频编码配置
setAudioRoute	设置音频路由
enableAudioVolumeEvaluation	启用音量大小提示

音频设备相关接口函数

方法	描述
getAudioCaptureVolume	获取当前麦克风设备音量
setAudioCaptureVolume	置麦克风设备的音量
getAudioPlayoutVolume	获取当前扬声器设备音量
setAudioPlayoutVolume	设置当前扬声器音量

Log相关接口

方法	描述
getSDKVersion	获取 SDK 版本信息
setLogLevel	设置 Log 输出级别

房间回调接口

错误和警告事件

事件	描述
onError	错误回调：SDK 不可恢复的错误,一定要监听,并分情况给用户适当的提示

房间事件

事件	描述
onJoinedRoom	加入房间的回调
onLeaveRoom	离开房间的回调
onUserJoined	远端用户加入房间的回调
onUserLeave	远端用户离开房间的回调

视频事件

事件	描述
onFirstVideoFrameRendered	视频首帧渲染
onSendFirstLocalVideoFrame	成功发送视频首帧的回调
onUserVideoAvailable	远端用户是否开启摄像头视频

音频事件

事件	描述
onFirstRemoteAudioFrame	远端音频首帧渲染
onSendFirstLocalAudioFrame	成功发送音频首帧的回调
onUserAudioAvailable	远端用户是否开启音频上行

硬件设备事件

事件	描述
onUserVoiceVolume	提示音量大小的回调

链路状态事件

事件	描述
onConnectionChangedToState	链接状态变化

{{allComment[version]}} ×

暂无评论
{{comment.author}}

{{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}

{{comment.content}}