互动直播>客户端 API>Android

Android

编辑文档 更新于
API概览BLiveBLiveListener对象和枚举错误码

API 概览

最近更新日期：2023-01-14

创建实例和事件回调

函数列表 描述
sharedInstance 创建 BLive 单例
destroySharedIntance 销毁 BLive 单例
setListener 设置回调接口

房间相关接口

函数列表 描述
enterRoom 进入房间
exitRoom 离开房间
switchRole 切换角色
setDefaultStreamRecvMode 设置默认的订阅模式
setPureWebrtc 设置是否只当 WebRTC 使用
isPureWebrtc 是否是 WebRTC

视频相关接口

函数列表 描述
setRtmpEngineObserver 设置 rtmpPlayer 的监听
startLocalPreview 开启本地视频的预览画面
stopLocalPreview 停止本地视频采集及预览
muteLocalVideo 暂停/恢复推送本地的视频数据
setVideoMuteImage 设置本地画面被暂停期间的替代图片
startRemoteView 开始拉取并显示指定用户的远端画面
updateRemoteView 更新指定用户的远端画面
stopRemoteView 停止显示远端视频画面，同时不再拉取该远端用户的视频数据流
muteRemoteVideoStream 暂停/恢复接收指定的远端视频流
muteAllRemoteVideoStreams 暂停/恢复接收所有远端视频流
setVideoEncoderParam 设置视频编码器相关参数
setNetworkQosParam 设置网络流控相关参数
setLocalRenderParams 本地图像的渲染设置
setRemoteRenderParams 远端图像的渲染设置
setVideoEncoderMirror 设置视频编码输出的画面方向，即设置远端用户观看到的和服务器录制的画面方向
setVideoEncoderRotation 设置视频编码器输出的画面方向
enableEncSmallVideoStream 开启大小画面双路编码模式
setRemoteVideoStreamType 切换指定远端用户的大小画面
snapshotVideo 视频画面截图
setGSensorMode 设置重力感应模式

音频相关接口

函数列表 描述
startLocalAudio 开启本地音频的采集和上行
stopLocalAudio 关闭本地音频的采集和上行
muteLocalAudio 静音/取消静音本地的音频
setAudioRoute 设置音频路由
muteRemoteAudio 静音/取消静音指定的远端用户的声音
muteAllRemoteAudio 静音/取消静音所有远端用户的声音
setRemoteAudioVolume 设定某一个远端用户的声音播放音量
setAudioCaptureVolume 设置 SDK 采集音量
getAudioCaptureVolume 获取 SDK 采集音量
setAudioPlayoutVolume 设置 SDK 播放音量
getAudioPlayoutVolume 获取 SDK 播放音量
enableAudioVolumeEvaluation 启用音量大小提示
setSystemVolumeType 设置通话时使用的系统音量类型

主播混流相关接口

函数列表 描述
startMixTranscode 开始混流转码
stopMixTranscode 停止混流转码

观众合流相关接口

函数列表 描述
playMixStream 开始播放合流
stopMixStream 停止播放合流

设备管理相关接口

函数列表 描述
getDeviceManager 获取设备管理类 BRTCDeviceManager

背景音乐和声音特效

函数列表 描述
getAudioEffectManager 获取音效管理类 BRTCAudioEffectManager

美颜特效和图像水印

函数列表 描述
getBeautyManager 获取美颜管理类 BRTCBeautyManager
setWatermark 设置水印

屏幕分享相关接口

函数列表 描述
startScreenCapture 开始屏幕分享
stopScreenCapture 停止屏幕分享
pauseScreenCapture 暂停屏幕分享
resumeScreenCapture 恢复屏幕分享

自定义消息发送

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

自定义采集和自定义渲染

函数列表 描述
setAudioFrameListener 设置音频数据自定义回调

调试相关接口函数

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

房间相关事件回调

函数列表 描述
onEnterBLiveRoom 已加入房间的回调
onExitBLiveRoom 离开房间的事件回调
onSwitchRole 切换角色的结果回调

混流相关事件回调

函数列表 描述
onStartMixStreamTranscode 主播开始混流的回调
onStopMixStreamTranscode 主播结束混流的回调
onMixStreamAdded 观众收到主播开始混流的回调
onMixStreamUpdate 观众收到主播变更混流信息的回调
onMixStreamRemoved 观众收到主播结束混流的回调

Rtmp播放相关事件回调

函数列表 描述
onRtmpLag 播放卡顿的回调
onOccurError 播放出错的回调
onRemoteVideoAvailable 当播放器回调onPrepared时的回调
onFirstFrameAvailable 当播放器回调onPrepared时的回调
onFrameResolutionChanged 帧分辨率发生改变时的回调
onCompletion 播放完成后的回调
onSeekComplete 点按滑动块的回调
onBufferingUpdate 流缓冲更新回调

枚举

枚举类型 描述
BLiveExitReason 本端用户离开房间时的原因
BLiveRoleType 角色类型
BLiveLayoutMode 视频画面布局
BLiveFitMode 视频画面填充模式
BLiveResolution 视频分辨率

常用结构体

结构体类型 描述
BLiveParams 进入房间参数
BLiveExtraParams 额外参数
MixStreamParams 混流参数
MixLayoutCanvasBean 背景画布参数
MixLayoutVideoBean 编解码参数
MixStreamCellModel 流画面参数
StreamIdentifierBean 流标识信息
DataBean 流用户信息
{{allComment[version]}} ×
  • 暂无评论
  • {{comment.author}}
    {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
    {{comment.content}}
您需要 后才能评论