互动直播>客户端 API>Android

Android

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

BLive

Function：BLive SDK 主功能接口

BLive

函数列表 描述
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 接口

sharedInstance

创建 BLive 实例 (单例模式)

BLive sharedInstance(Context context)
参数 描述
context Android系统提供的关于应用环境全局信息的接口。必须设置，否则无法生成 BLive 实例对象。建议传入 Android 平台的 ApplicationContext。
  • BLive 类的所有接口函数，如无特殊说明，都是异步调用，对接口的调用建议在同一个线程进行
  • 请确保在调用其他 API 前先调用该方法创建并初始化
  • BLive Native SDK 只支持每个 App 中创建一个 BLive 实例对象

destroySharedIntance

销毁 BLive 实例对象

void destroySharedInstance()
  • 该方法释放 BLive SDK 使用的所有资源
  • 调用 destroySharedIntance 方法后，你将无法再使用 SDK 的其它方法和回调
  • 如需再次使用实时音视频通信功能,你必须重新调用 sharedInstance 方法创建一个新的 BLive 实例
  • 由于 destroySharedIntance 执行释放需要一些时间，因此如果在销毁后需要再次创建 BLive 实例，建议最好控制调用频率，减少可能存在的表现异常隐患。

setListener

设置回调接口

void setListener(BLiveListener listener)
参数 描述
listener 回调监听对象，详情见 BLiveListener
  • 您可以通过 BLiveListener 获得来自 SDK 的各种状态、事件通知，根据这些回调决定业务的后续动作。

enterRoom

加入房间

void enterRoom(BLiveParams param)
参数 描述
param 进房参数，详见 BLiveParams

必须加入房间才能发布或订阅音视频流。“发布”是指将自己的音、视频推送到服务器；“订阅”是指从服务器拉取房间里其他用户的音视频流。调用接口后，您会收到来自 BLiveListener 中的 onEnterBLiveRoom(result) 回调：

  • 如果加入成功，result 会是一个正数（result > 0），表示加入房间的时间消耗，单位是毫秒（ms）

  • 如果加入失败，result 会是一个负数（result < 0），表示进房失败的错误码

不管进房是否成功，enterRoom 都必须与 exitRoom 配对使用，在调用 exitRoom 前再次调用 enterRoom 函数会导致不可预期的错误问题。

exitRoom

离开房间

void exitRoom()
  • 调用 exitRoom() 接口会执行退出房间的相关逻辑，例如释放音视频设备资源和编解码器资源等
  • 待资源释放完毕，SDK 会通过 BLiveListener 中的 onExitBLiveRoom() 回调通知到您
  • 待资源释放完毕，SDK 会通过 BRTCListener 中的 onExitRoom() 回调通知到您
  • 如果您要再次调用 enterRoom() 或者切换到其他的音视频 SDK，请等待 onExitRoom() 回调到来之后再执行相关操作，否则可能会遇到摄像头或麦克风被占用等各种异常问题

switchRole

切换角色

void switchRole(BLiveRoleType role)
参数 描述
role 角色，详见 BLiveRoleType

调用本接口可以实现用户在“主播”和“观众”两种角色之间来回切换。

由于视频直播和语音聊天室需要支持多达10万名观众同时观看，所以设定了“只有主播才能发布自己的音视频”的规则。因此，当有些观众希望发布自己的音视频流（以便能跟主播互动）时，就需要先把自己的角色切换成“主播”。

在 BLive SDK 中，默认以主播角色进入房间，即进房间就会开启音视频采集并发布流。您可以通过进房参数 BLiveParams 来改变默认角色。

注意

  • 以主播身份进房发布流后，调用此接口切换到观众，将会停止发布音视频流
  • 以观众身份进房后，调用此接口切换到主播，SDK并不会自动发布音视频流，需要您再调用 startLocalAudio, muteLocalAudio, muteLocalVideo 等接口来启动音频或视频推流。

setPureWebrtc

设置是否只当 WebRTC 使用

void setPureWebrtc(boolean pureWebrtc)
参数 描述
pureWebrtc true表示纯 WebRTC

纯 WebRTC 使用 brtc，否则使用 blive 注意：需要在设置监听前使用。

isPureWebrtc

是否是纯 WebRTC

boolean isPureWebrtc()
  • true：纯 WebRTC；false：不是纯 WebRTC。

setRtmpEngineObserver

设置 RtmpPlayer 的监听

void setRtmpEngineObserver(BLiveRtmpEventObserver observer)
参数 描述
observer 监听，详情见 BLiveRtmpEventObserver

muteLocalVideo

暂停/恢复推送本地的视频数据

BLiveError muteLocalVideo(boolean mute)
参数 描述
mute true：暂停；false：恢复

startRemoteView

开始拉取并显示指定用户的远端画面

BLiveError startRemoteView(String userId, BRTCDef.BRTCVideoStreamType type, BRTCDef.BRTCVideoView view)
参数 描述
userId 指定远端用户的 userId
streamType 指定要观看 userId 的视频流类型:
高清大画面：BRTCVideoStreamTypeBig
低清小画面：BRTCVideoStreamTypeSmall
辅流（屏幕分享）：BRTCVideoStreamTypeSub
view 承载视频画面的控件

updateRemoteView

更新指定用户的远端画面

void updateRemoteView(String userId, BRTCDef.BRTCVideoView canvas, BRTCDef.BRTCVideoStreamType type)
参数 描述
userId 指定远端用户的 userId
canvas 承载视频画面的控件，设置为 [null] 则不进行显示
streamType 指定要观看 userId 的视频流类型:
高清大画面：BRTCVideoStreamTypeBig
辅流（屏幕分享）：BRTCVideoStreamTypeSub
  • 该接口可用于更新远端视频画面的渲染控件，常被用于切换显示区域的交互场景中。

muteLocalAudio

静音/取消静音本地的音频

BLiveError muteLocalAudio(boolean mute)
参数 描述
mute true：静音；false：取消静音

startMixTranscode

开始混流转码

void startMixTranscode(BLiveDef.MixStreamParams mixStreamParams)
参数 描述
mixStreamParams 混流参数，详情见 MixStreamParams
  • 只有主播可以调用该接口
  • 该接口需要在主播开启推流后调用
  • 主播开始混流转码后，观众端收到主播开始推流的回调通知

stopMixTranscode

停止混流转码

void stopMixTranscode(String mixStreamId)
参数 描述
mixStreamId 停止转码的流 Id
  • 只有主播可以调用该接口
  • 主播停止混流转码后，观众端收到主播停止推流的回调通知，观众端停止播放音视频

playMixStream

开始播放合流

void playMixStream(BLiveView view, String mixStreamId, boolean videoOn, boolean audioOn)
参数 描述
view 播放视频的 view
mixStreamId 播放的流 Id
videoOn 是否播放视频
audioOn 是否播放音频 
void playMixStream(BLiveView view, String mixStreamId, String url, boolean videoOn, boolean audioOn)
参数 描述
view 播放视频的 view
mixStreamId 播放的流 Id
url 播放的流 url
videoOn 是否播放视频
audioOn 是否播放音频
  • 建议观众端在收到 onMixStreamAdded 回调后，播放对应的音视频流

stopMixStream

停止播放合流

void stopMixStream(String mixStreamId)
参数 描述
mixStreamId 停止播放的流 Id 
void stopMixStream(String mixStreamId, String url)
参数 描述
mixStreamId 停止播放的流 Id
url 停止播放的流 url
  • 建议观众端在收到 onMixStreamRemoved 回调后，停止播放对应的音视频流
{{allComment[version]}} ×
  • 暂无评论
  • {{comment.author}}
    {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
    {{comment.content}}
您需要 后才能评论