Toggle navigation
百家云开发者中心
文档首页
实时音视频
产品介绍
产品介绍
场景方案
性能数据
发版说明
快速入门
一分钟跑通 DEMO
一分钟集成 SDK
实现一个音视频直播
基础功能
Android
加入和离开房间
发布音视频流
订阅音视频流
设置视频编码参数
屏幕分享
音视频设备管理
调整通话音量
通话质量检测
iOS
加入和离开房间
发布音视频流
订阅音视频流
设置视频编码参数
屏幕分享
音视频设备管理
调整通话音量
通话质量检测
Web
加入和离开房间
创建本地音视频流
发布和订阅
通话质量检测
设置音视频编码属性
屏幕分享
音视频设备管理
全平台(C++)
加入和离开房间
发布音视频流
订阅音视频流
设置视频编码参数
屏幕分享
音视频设备管理
调整通话音量
通话前检测
通话中质量检测
electron
加入和离开房间
发布音视频流
订阅音视频流
设置视频编码参数
屏幕分享
音视频设备管理
调整通话音量
通话中质量检测
进阶功能
Android
播放音乐文件
视频截图
基础美颜
原始数据采集
发送自定义消息
iOS
视频截图
基础美颜
原始数据采集
发送自定义消息
Web
音视频轨道切换
自定义采集与播放渲染
浏览器的自动播放策略
动态关闭打开本地音视频
视频后处理
开启大小流
全平台(C++)
播放音乐文件
视频截图
原始数据采集
发送自定义消息
electron
播放音乐文件
视频截图
本地录制
发送自定义消息
客户端 API
Android
iOS
小程序
Web
Electron
C++
uni-app
Mac
HarmonyOS
服务端 API
房间管理
云端录制
旁路推流
常见问题
通用性问题
Android
开发与集成
Web
浏览器兼容性
WebRTC 已知问题及规避方案
iOS
开发与集成
最佳实践
Web
设备采集中断
房间和设备容错处理
实时音视频
>
客户端 API
>
Android
Android
编辑文档
更新于
2025-01-16 07:59:52
API概览
BRTC
BRTCListener
BRTCDeviceManager
BRTCAudioEffectManager
BRTCBeautyManager
BRTCMediaPlayerManager
对象和枚举
错误码
BRTC 提供可以灵活搭配的 API 组合,为移动端到移动端以及移动端到 Web 端提供质量可靠的实时音视频通信功能。
BRTC
BRTC 功能的主要接口类
BRTCListener
BRTC 事件回调接口
BRTCDeviceManager
BRTC 设备管理接口
BRTCBeautyManager
BRTC 美颜特效接口
BRTCAudioEffectManager
BRTC 音效管理接口
BRTCMediaPlayerManager
BRTC 媒体文件播放接口
对象和枚举
BRTC 关键类型定义
API 概览
最近更新日期:2022-11-29
创建实例和事件回调
函数列表
描述
sharedInstance
创建 BRTC 实例
destroySharedIntance
销毁 BRTC 实例
setListener
设置回调接口
房间相关接口函数
函数列表
描述
enterRoom
进入房间
exitRoom
离开房间
switchRole
切换角色
setDefaultStreamRecvMode
设置默认的订阅模式
视频相关接口函数
函数列表
描述
startLocalPreview
开启本地视频的预览画面
stopLocalPreview
停止本地视频采集及预览
muteLocalVideo
暂停/恢复推送本地的视频数据
setVideoMuteImage
设置本地画面被暂停期间的替代图片
startRemoteView
开始拉取并显示指定用户的远端画面
stopRemoteView
停止显示远端视频画面,同时不再拉取该远端用户的视频数据流
muteRemoteVideoStream
暂停/恢复接收指定的远端视频流
muteAllRemoteVideoStreams
暂停/恢复接收所有远端视频流
setVideoEncoderParam
设置视频编码器相关参数
setNetworkQosParam
设置网络流控相关参数
setLocalRenderParams
本地图像的渲染设置
setRemoteRenderParams
远端图像的渲染设置
setVideoEncoderMirror
设置视频编码输出的画面方向,即设置远端用户观看到的和服务器录制的画面方向
setVideoEncoderRotation
设置视频编码器输出的画面方向
enableEncSmallVideoStream
开启大小画面双路编码模式
setRemoteVideoStreamType
切换指定远端用户的大小画面
snapshotVideo
视频画面截图
setGSensorMode
设置重力感应模式
setVideoFallbackEnable
设置弱网条件下流是否开启自适应回退机制
音频相关接口
函数列表
描述
startLocalAudio
开启本地音频的采集和上行
stopLocalAudio
关闭本地音频的采集和上行
muteLocalAudio
静音/取消静音本地的音频
setAudioRoute
设置音频路由
muteRemoteAudio
静音/取消静音指定的远端用户的声音
muteAllRemoteAudio
静音/取消静音所有远端用户的声音
setRemoteAudioVolume
设定某一个远端用户的声音播放音量
setAudioCaptureVolume
设置 SDK 采集音量
getAudioCaptureVolume
获取 SDK 采集音量
setAudioPlayoutVolume
设置 SDK 播放音量
getAudioPlayoutVolume
获取 SDK 播放音量
enableAudioVolumeEvaluation
启用音量大小提示
setSystemVolumeType
设置通话时使用的系统音量类型
设备管理相关接口
函数列表
描述
getDeviceManager
获取设备管理类 BRTCDeviceManager
背景音乐和声音特效
函数列表
描述
getAudioEffectManager
获取音效管理类 BRTCAudioEffectManager
媒体文件播放器
函数列表
描述
getMediaPlayerManager
获取媒体文件播放器管理类 BRTCMediaPlayerManager
美颜特效和图像水印
函数列表
描述
getBeautyManager
获取美颜管理类 BRTCBeautyManager
setWatermark
设置水印
屏幕分享相关接口
函数列表
描述
startScreenCapture
开始屏幕分享
stopScreenCapture
停止屏幕分享
pauseScreenCapture
暂停屏幕分享
resumeScreenCapture
恢复屏幕分享
自定义消息发送
函数列表
描述
sendCustomCmdMsg
发送自定义消息给房间内所有用户
sendSEIMsg
将小数据量的自定义数据嵌入视频帧中
自定义采集和自定义渲染
函数列表
描述
setLocalVideoProcessListener
设置本地视频帧监听
setAudioFrameListener
设置音频数据自定义回调
调试相关接口函数
函数列表
描述
getSDKVersion
获取 SDK 版本信息
setLogLevel
设置日志输出级别
setConsoleEnabled
启用或禁用控制台日志打印
setLogDirPath
修改日志保存路径
setLogListener
设置日志回调
callExperimentalAPI
调用实验性 API 接口
BRTCListener 回调
房间事件回调
函数列表
描述
onEnterRoom
已加入房间的回调
onExitRoom
本地用户离开房间的事件回调
成员事件回调
函数列表
描述
onRemoteUserEnterRoom
远端用户加入当前房间通知
onRemoteUserLeaveRoom
远端用户离开当前房间通知
onSwitchRole
切换角色的结果回调
音视频事件回调
函数列表
描述
onUserVideoAvailable
远端用户的视频可用或不可用状态发生状态变化时通知
onUserSubStreamAvailable
远端用户的辅流(通常是屏幕共享)的可用或不可用状态发生状态变化时通知
onUserAudioAvailable
远端用户的音频可用或不可用状态发生状态变化时通知
onFirstVideoFrame
本地或远端用户视频首帧回调通知
onFirstAudioFrame
已接收到某个远端用户的音频首帧的回调
onSendFirstLocalVideoFrame
已发送本地视频首帧的回调
onSendFirstLocalAudioFrame
已发送本地音频首帧的回调
onLocalVideoFallback
本地流视频回退或者恢复
统计和质量回调
函数列表
描述
onStatistics
技术指标统计回调
onNetworkQuality
推、拉流质量评价回调
硬件设备事件回调
函数列表
描述
onUserVoiceVolume
用于提示音量大小的回调,包括每个 userId 的音量和远端总音量
服务器事件回调
函数列表
描述
onConnectionLost
SDK 跟服务器的连接断开
onTryToReconnect
SDK 尝试重新连接到服务器
onConnectionRecovery
SDK 跟服务器的连接恢复
自定义消息的接收回调
函数列表
描述
onRecvCustomCmdMsg
收到自定义消息回调
onMissCustomCmdMsg
自定义消息丢失回调
onRecvSEIMsg
收到 SEI 消息的回调
屏幕分享回调
函数列表
描述
onScreenCaptureStarted
当屏幕分享开始时,SDK 会通过此回调通知
onScreenCapturePaused
当屏幕分享暂停时,SDK 会通过此回调通知
onScreenCaptureResumed
当屏幕分享恢复时,SDK 会通过此回调通知
onScreenCaptureStoped
当屏幕分享停止时,SDK 会通过此回调通知
调试信息回调
函数列表
描述
onLog
有日志打印时的回调
onError
错误回调,表示 SDK 不可恢复的错误,一定要监听并分情况给用户适当的界面提示
枚举
房间与用户
枚举类型
BRTCRoomType
房间模式
BRTC_REMOTE_USER_LEAVE_REASON
远端用户离开房间时的原因
BRTC_EXIT_ROOM_REASON
本端用户离开房间时的原因
BRTCRoleType
角色类型
视频相关枚举值定义
枚举类型
BRTCVideoResolution
视频分辨率
BRTCVideoResolutionModeLandscape
视频宽高比模式
BRTCVideoStreamType
视频流类型
BRTCVideoFillMode
视频画面填充模式
BRTCVideoRotation
视频画面旋转方向
BRTCVideoMirrorType
本地视频预览镜像类型
BRTCSnapshotSourceType
视频截图来源
音频相关枚举值定义
枚举类型
BRTCAudioQuality
声音音质
BRTCAudioRoute
音频路由,即声音由哪里输出
BRTCSystemVolumeType
系统音量类型,即声音由用哪种音量输出
网络相关枚举值定义
枚举类型
BRTCQosControlMode
流控模式
BRTCVideoQosPreference
画质偏好
其他
枚举类型
BRTCLogLevel
日志级别
BRTCGSensorMode
设置重力感应的适应模式
常用结构定义
类名
说明
BRTCParams
进入房间参数
BRTCUser
BRTCUser
BRTCVideoEncParam
视频配置参数
BRTCNetworkQosParam
网络流控相关参数
BRTCVolumeInfo
音量大小
BRTCStatistics
统计数据
BRTCRemoteStatistics
远端成员的音视频统计信息
BRTCLocalStatistics
本地的音视频统计信息
BRTCAudioFrame
音频帧
BRTCScreenShareParams
屏幕共享参数
BRTCRenderParams
视频渲染参数
{{allComment[version]}}
×
暂无评论
{{comment.author}}
{{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
{{comment.content}}
评论
您需要
授权
后才能评论
Android
BRTC 提供可以灵活搭配的 API 组合,为移动端到移动端以及移动端到 Web 端提供质量可靠的实时音视频通信功能。
API 概览
最近更新日期:2022-11-29
创建实例和事件回调
房间相关接口函数
视频相关接口函数
音频相关接口
设备管理相关接口
背景音乐和声音特效
媒体文件播放器
美颜特效和图像水印
屏幕分享相关接口
自定义消息发送
自定义采集和自定义渲染
调试相关接口函数
BRTCListener 回调
房间事件回调
成员事件回调
音视频事件回调
统计和质量回调
硬件设备事件回调
服务器事件回调
自定义消息的接收回调
屏幕分享回调
调试信息回调
枚举
房间与用户
视频相关枚举值定义
音频相关枚举值定义
网络相关枚举值定义
其他
常用结构定义