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

iOS

编辑文档更新于 2024-11-11 06:14:32

概况BRTCBRTCDelegateBRTCDeviceManagerBRTCBeautyManagerBRTCMediaPlayerManager对象和枚举错误码

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

BRTC 功能的主要接口类
BRTCDelegate 事件回调接口
BRTCDeviceManager 设备管理接口
BRTCBeautyManager 美颜特效接口
BRTCMediaPlayerManager 媒体文件播放接口
对象和枚举关键类型定义

BRTC 基础方法

创建与销毁	描述
sharedInstance	创建 BRTC 单例
destroySharedIntance	销毁 BRTC 单例
delegate	设置事件回调

房间相关接口函数	描述
enterRoom	进入房间
exitRoom	离开房间
switchRole	切换角色
setDefaultStreamRecvMode	设置订阅模式

视频相关接口函数	描述
startLocalPreview	开启本地视频的预览画面
stopLocalPreview	停止本地视频采集及预览
muteLocalVideo	暂停/恢复推送本地的视频数据
startRemoteView	开始拉取，并绑定视频渲染控件
updateRemoteView	更新远端视频画面的窗口
stopRemoteView	停止显示远端视频画面，同时不再拉取该远端用户的视频数据流
stopAllRemoteView	停止订阅所有远端用户的视频流，并释放全部渲染资源
muteRemoteVideoStream	暂停/恢复接收指定的远端视频流
muteAllRemoteVideoStreams	暂停/恢复接收所有远端视频流
setVideoEncoderParam	设置视频编码器相关参数
setNetworkQosParam	设置网络流控相关参数
setLocalRenderParams	本地图像的渲染设置
setRemoteRenderParams	远端图像的渲染设置
setGSensorMode	设置重力感应的适配模式
setVideoEncoderMirror	控制编码器输出的画面镜像模式
enableEncSmallVideoStream	开启大小画面双路编码模式
setRemoteVideoStreamType	切换指定远端用户的大小画面
snapshotVideo	视频画面截图

音频相关接口	描述
startLocalAudio	开启本地音频的采集
stopLocalAudio	关闭本地音频的采集
muteLocalAudio	静音/取消静音本地的音频
muteRemoteAudio	静音/取消静音指定的远端用户的声音
muteAllRemoteAudio	静音/取消静音所有用户的声音
setAudioCaptureVolume	设置 SDK 采集音量
getAudioCaptureVolume	获取 SDK 采集音量
setAudioPlayoutVolume	设置 SDK 播放音量
getAudioPlayoutVolume	获取 SDK 播放音量
enableAudioVolumeEvaluation	启用音量大小提示

设备管理相关接口	描述
getDeviceManager	获取设备管理类 BRTCDeviceManager

美颜特效和图像水印相关接口	描述
getBeautyManager	获取美颜管理对象 BRTCBeautyManager
setWatermark	添加水印

背景音乐和声音特效相关接口	描述
getAudioEffecter	获取音效管理类 BRTCAudioEffecter

屏幕分享相关接口	描述
startScreenCaptureInApp	开始应用内的屏幕分享（该接口仅支持 iOS 13.0 及以上的 iPhone 和 iPad）
startScreenCaptureByReplaykit	开始全系统的屏幕分享（该接口支持 iOS 11.0 及以上的 iPhone 和 iPad）
stopScreenCapture	停止屏幕分享
pauseScreenCapture	暂停屏幕分享
resumeScreenCapture	恢复屏幕分享

自定义采集和渲染	描述
setAudioFrameCallbackDelegate	设置音频帧数据的回调
setCustomAudioRenderingFrameCallbackFormat	设置本地麦克风采集出的原始音频帧回调格式

自定义消息发送	描述
sendCustomCmdMsg	发送自定义消息给房间内所有用户
sendSEIMsg	将小数据量的自定义数据嵌入视频帧中

Log 相关接口函数	描述
getSDKVersion	获取 SDK 版本信息
setLogLevel	设置 Log 输出级别
setConsoleEnabled	启用或禁用控制台日志打印
setLogDirPath	修改日志保存路径
setLogDelegate	设置日志回调
callExperimentalAPI	调用实验性 API 接口

BRTCDelegate 回调

错误事件和警告事件	描述
onError	错误回调

房间事件回调	描述
onEnterRoom	已加入房间回调
onExitRoom	离开房间的事件回调
onSwitchRole	切换角色的事件回调

成员事件回调	描述
onRemoteUserEnterRoom	有用户加入当前房间
onRemoteUserLeaveRoom	有用户离开当前房间
onUserVideoAvailable	远端用户是否存在可播放的主路画面（一般用于摄像头）
onUserSubStreamAvailable	某远端用户发布/取消了辅路视频画面
onUserAudioAvailable	远端用户是否存在可播放的音频数据
onFirstVideoFrame	开始渲染本地或远程用户的首帧画面
onFirstAudioFrame	开始播放远程用户的首帧音频
onSendFirstLocalVideoFrame	首帧本地视频数据已经被送出
onSendFirstLocalAudioFrame	首帧本地音频数据已经被送出

统计和质量回调	描述
onStatistics	音视频技术指标的实时统计回调
onNetworkQuality	推、拉流质量评价回调

硬件设备事件回调	描述
onUserVoiceVolume	用于提示音量大小的回调，包括每个 userId 的音量和远端总音量

服务器事件回调	描述
onConnectionLost	SDK 跟服务器的连接断开
onTryToReconnect	SDK 尝试重新连接到服务器
onConnectionRecovery	SDK 跟服务器的连接恢复

自定义消息的接收回调	描述
onRecvCustomCmdMsgUserId	收到自定义消息回调
onMissCustomCmdMsgUserId	自定义消息丢失回调
onRecvSEIMsg	收到 SEI 消息的回调

屏幕分享回调	描述
onScreenCaptureStarted	当屏幕分享开始时，SDK 会通过此回调通知
onScreenCapturePaused	当屏幕分享暂停时，SDK 会通过此回调通知
onScreenCaptureResumed	当屏幕分享恢复时，SDK 会通过此回调通知
onScreenCaptureStoped	当屏幕分享停止时，SDK 会通过此回调通知

Log 信息回调	描述
onLog	本地 LOG 的打印回调

枚举

视频相关枚举值定义
BRTCVideoResolution	视频分辨率
BRTCVideoResolutionModeLandscape	视频宽高比模式
BRTCVideoStreamType	视频流类型
BRTCVideoFillMode	视频画面填充模式
BRTCVideoRotation	视频画面旋转方向
BRTCVideoMirrorType	本地视频预览镜像类型
BRTCSnapshotSourceType	视频截图来源

网络相关枚举值定义
BRTCQosControlMode	流控模式
BRTCVideoQosPreference	画质偏好
BRTCRoleType	角色

声音相关枚举值定义
BRTCAudioQuality	声音音质
BRTCAudioRoute	音频路由，即声音由哪里输出
BRTCSystemVolumeType	系统音量类型，即声音由用哪种音量输出

Log 相关枚举值定义
BRTCLogLevel	Log 级别

关键类型定义

类名	说明
BRTCParams	进入房间参数
BRTCVideoEncParam	视频编码参数
BRTCNetworkQosParam	网络流控相关参数
BRTCVolumeInfo	音量大小
BRTCStatistics	统计数据
BRTCRemoteStatistics	远端成员的音视频统计信息
BRTCLocalStatistics	本地的音视频统计信息

{{allComment[version]}} ×

暂无评论
{{comment.author}}

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

{{comment.content}}