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

Android

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

BRTCListener 用于给 SDK 调用者返回 SDK 接口调用的执行结果、消息、内部工作状态等回调通知，方便 SDK 调用者结合具体的业务场景进行相应处理。

BRTCListener

以下函数按照名称首字母升序排列

函数列表 描述
onConnectionLost SDK 跟服务器的连接断开
onConnectionRecovery SDK 跟服务器的连接恢复
onEnterRoom 进入房间成功与否的事件回调
onError 错误事件回调
onExitRoom 离开房间的事件回调
onFirstAudioFrame 已接收到某个远端用户的音频首帧的回调
onFirstVideoFrame 本地或远端用户视频首帧回调通知
onLocalVideoFallback 本地流视频回退或者恢复
onRecvCustomCmdMsg 收到自定义消息的事件回调
onRecvSEIMsg 收到 SEI 消息的回调
onRemoteUserEnterRoom 远端用户加入当前房间通知
onRemoteUserLeaveRoom 远端用户离开当前房间通知
onScreenCapturePaused 屏幕分享暂停的事件回调
onScreenCaptureResumed 屏幕分享恢复的事件回调
onScreenCaptureStarted 屏幕分享开启的事件回调
onScreenCaptureStoped 屏幕分享停止的事件回调
onSendFirstLocalVideoFrame 已发送本地视频首帧的回调
onSendFirstLocalAudioFrame 已发送本地音频首帧的回调
onSwitchRole 切换角色的结果回调
onStatistics 音视频相关的度量指标统计回调
onTryToReconnect SDK 尝试重新连接到服务器
onUserAudioAvailable 远端用户的音频可用或不可用状态发生状态变化时通知
onUserVideoAvailable 远端用户的视频可用或不可用状态发生状态变化时通知
onUserVoiceVolume 音量大小的反馈回调
onUserSubStreamAvailable 远端用户的辅流（通常是屏幕共享）的可用或不可用状态发生状态变化时通知

BRTCLogListener

函数列表 描述
onLog 日志打印回调

BRTCSnapShotListener

函数列表 描述
onSnapShotVideo 视频截图的回调

BRTCAudioFrameListener

函数列表 描述
onCapturedRawAudioFrame 本地采集并经过音频模块前处理后的音频数据回调
onLocalProcessedAudioFrame 本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调

详细信息

onError
错误事件，表示 SDK 抛出的不可恢复的错误，比如进入房间失败或设备开启失败等。

void onError(int errCode, String errMsg, Bundle extraInfo)

参数

名称 描述
errCode 错误码
errMsg 错误信息
extInfo 扩展信息字段，个别错误码可能会带额外的信息帮助定位问题

onEnterRoom
已加入房间的回调

void onEnterRoom(long result)

参数

名称 描述
result result > 0 时为进房耗时（ms），result < 0 时为进房错误码

详情

  • 调用 BRTC 中的 enterRoom 接口执行进房操作后，会收到来自 SDK 的 onEnterRoom(result) 回调

onExitRoom
离开房间的事件回调

void onExitRoom(int reason)

参数

名称 描述
reason 离开原因，见 BRTCDef.BRTC_EXIT_ROOM_REASON

详情

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

onRemoteUserEnterRoom
有用户加入当前房间

void onRemoteUserEnterRoom(String userId)

参数

名称 描述
userId 远端用户 ID

详情

  • onRemoteUserEnterRoom 和 onRemoteUserLeaveRoom 只适用于维护当前房间里的“成员列表”，如果需要显示远程画面，建议使用监听 onUserVideoAvailable() 事件回调

onRemoteUserLeaveRoom
有用户离开当前房间

void onRemoteUserLeaveRoom(String userId, int reason)

参数

名称 描述
userId 远端用户 ID
userId 离开原因。参见：BRTCDef.BRTC_EXIT_ROOM_REASON

onUserVideoAvailable
远端用户是否存在可播放的主路画面（一般用于摄像头）

void onUserVideoAvailable(String userId, boolean available)

参数

名称 描述
userId 远端用户 ID
available true表示可用，false表示不可用

详情

  • 收到 onUserVideoAvailable(userid, true) 通知时，表示该路画面已经有可用的视频数据帧到达，此时，您需要调用 startRemoteView 接口加载该用户的远程画面。

  • 收到 onUserVideoAvailable(userid, false) 通知时，表示该路远程画面已被关闭，可能由于您主动 mute 了该用户的视频，或者该用户关闭了自己的视频

  • 自动订阅模式下，收到此通知表示远端用户的视频流已经到达并会被自动拉取并解码
  • 手动订阅模式下，收到此通知表示远端用户的视频流已经可用，但还需要主动触发订阅才会拉取

onUserAudioAvailable
远端用户是否存在可播放的音频数据

void onUserAudioAvailable(String userId, boolean available)

参数

名称 描述
userId 远端用户 ID
available true表示可用，false表示不可用
  • 自动订阅模式下，收到此通知表示远端用户的音频流已经到达并会被自动拉取并解码播放
  • 手动订阅模式下，收到此通知表示远端用户的音频流已经可用，但还需要主动触发订阅才能解码播放

onUserSubStreamAvailable
端用户的辅流（通常是屏幕共享）的可用或不可用状态发生状态变化时通知

void onUserSubStreamAvailable(String userId, boolean available)

参数

名称 描述
userId 远端用户 ID
available true表示可用，false表示不可用

详情

“辅路画面”一般被用于承载屏幕分享的画面。当您收到 onUserSubStreamAvailable(userId, true) 通知时，表示该路画面已经有可用的视频数据帧到达。您可以调用 startRemoteView 传入 BRTCVideoStreamTypeSub 类型来请求预览。

onFirstVideoFrame
开始渲染本地或远程用户的首帧画面

void onFirstVideoFrame(String userId, BRTCVideoStreamType type, int width, int height)

参数

名称 描述
userId 本地或远程用户 ID
type 视频流类型
width 画面宽度
height 画面高度

详情

  • 调用 startLocalPreivew、startRemoteView 之后，才会触发该回调。

onLocalVideoFallback
本地流视频回退或者恢复

void onLocalVideoFallback(boolean isFallback)

参数

名称 描述
isFallback true: 本地流视频回退，只推音频；false：本地流视频恢复推送。

详情

当检测到用户上行网络条件变差，无法满足原有视频流带宽需求时，SDK会自动关闭视频流，保留音频流。当视频流自动关闭和恢复时，您会通过此回调收到通知。您可以通过接口 setVideoFallbackEnable 来设置是否启用视频流自动回退机制。

onFirstAudioFrame
已接收到某个远端用户的音频首帧的回调

void onFirstAudioFrame(String userId)

参数

名称 描述
userId 远端用户 ID

onSendFirstLocalVideoFrame
首帧本地视频数据已经被送出

void onSendFirstLocalVideoFrame(BRTCVideoStreamType type)

参数

名称 描述
type 视频流类型，见BRTCDef.BRTCVideoStreamType

详情

  • SDK 会在 enterRoom 并 startLocalPreview 成功后开始摄像头采集，并将采集到的画面进行编码
  • 当 SDK 成功向云端送出第一帧视频数据后，会抛出这个回调事件

onSendFirstLocalAudioFrame
首帧本地音频数据已经被送出

void onSendFirstLocalAudioFrame()

详情

  • SDK 会在 enterRoom 并 startLocalAudio 成功后开始麦克风采集，并将采集到的声音进行编码
  • 当 SDK 成功向云端送出第一帧音频数据后，会抛出这个回调事件

onSwitchRole
切换角色的结果回调

void onSwitchRole(int errCode, String errMsg)

参数

名称 描述
errCode 错误码，ERR_NULL 代表切换成功，其他请参见错误码
errMsg 错误信息

onStatistics
音视频相关的度量指标统计回调

void onStatistics(BRTCStatistics statics)

参数

名称 描述
statistics 统计数据信息。包括本地和远程的。具体字段请参考 BRTCStatistics

详情

  • 如果您是熟悉音视频领域相关术语，可以通过这个回调获取 SDK 的所有技术指标。每 2 秒回调一次

onUserVoiceVolume
音量大小的反馈回调

void onUserVoiceVolume(ArrayList<BRTCDef.BRTCVolumeInfo> userVolumes, int totalVolume)

参数

名称 描述
userVolumes 所有正在说话的房间成员的音量，取值范围 0 - 100
totalVolume 所有远端成员的总音量, 取值范围 0 - 100

详情

  • 您可以通过调用 BRTC 中的 enableAudioVolumeEvaluation 接口来开关这个回调或者设置它的触发间隔。需要注意的是，调用 enableAudioVolumeEvaluation 开启音量回调后，无论频道内是否有人说话，都会按设置的时间间隔调用这个回调。如果没有人说话，则 userVolumes 为空，totalVolume 为 0。

onConnectionLost
SDK 跟服务器的连接断开

void onConnectionLost()

您收到这个回调后，通常情况下不需要进行额外的处理。因为 SDK 内部会自动发起重连并尝试进行恢复。

onTryToReconnect
SDK 尝试重新连接到服务器

void onTryToReconnect()

onConnectionRecovery
SDK 跟服务器的连接恢复

void onConnectionRecovery()

onRecvCustomCmdMsg
收到自定义消息回调

void onRecvCustomCmdMsg(String userId, int cmdID, int seq, byte[] message)

参数

名称 描述
userId 用户 ID
cmdID 命令 ID
seq 消息序号
message 消息数据

详情

  • 当房间中的某个用户使用 sendCustomCmdMsg 发送自定义消息时，房间中的其它用户可以通过 onRecvCustomCmdMsg 接口接收消息

onRecvSEIMsg
收到 SEI 消息的回调

void onRecvSEIMsg(String userId, byte[] data)

参数

名称 描述
userId 用户 ID
message 数据

详情

  • 当房间中的某个用户使用 sendSEIMsg 发送数据时，房间中的其它用户可以通过 onRecvSEIMsg 接口接收数据

onScreenCaptureStarted
当屏幕分享开始时，SDK 会通过此回调通知

void onScreenCaptureStarted()

onScreenCapturePaused
当屏幕分享暂停时，SDK 会通过此回调通知

void onScreenCapturePaused()

onScreenCaptureResumed
当屏幕分享恢复时，SDK 会通过此回调通知

void onScreenCaptureResumed()

onScreenCaptureStoped
当屏幕分享停止时，SDK 会通过此回调通知

void onScreenCaptureStoped(int reason)

参数

名称 描述
reason 停止原因，目前始终返回 0。更多原因会再后续 SDK 升级中陆续补充

onLog
日志打印回调

void onLog(String log, int level, String module)

参数

名称 描述
log 日志内容
level 日志等级，参见 BRTCLogLevel
module 值暂无具体意义，目前为固定值 BRTCSDK

onSnapShotVideo
视频截图的回调

void onSnapShotVideo(String userId, Bitmap bitmap)

参数

名称 描述
userId 本地或远端用户 ID
bitmap 视频截图数据

onCapturedRawAudioFrame
本地采集并经过音频模块前处理后的音频数据回调

void onCapturedRawAudioFrame(BRTCDef.BRTCAudioFrame audioFrame)

参数

名称 描述
audioFrame 音频帧数据。参考 BRTCAudioFrame

详情

当您设置完音频数据自定义回调之后，SDK 内部会把刚采集到并经过前处理(ANS、AEC、AGC）之后的数据，以 PCM 格式的形式通过本接口回调给您。

  • 音频帧时间固定为 10 毫秒，格式为 PCM
  • 时间帧转字节帧的公式：采样率 x 帧时长 x 声道数 x 采样点位宽，例如以 48KHz 采样率、单声道、16bit 采样点位宽为例，音频帧大小为： 48000 x 0.01(秒) x 1 x 16(比特) = 7680比特 = 960字节

请千万不要在此回调函数中做任何耗时操作！

由于 SDK 每隔 10ms 就要处理一帧音频数据，如果您的处理时间超过 10ms，就会导致声音异常。

此接口回调出的音频数据是可读写的，也就是说您可以在回调函数中同步修改音频数据，但请保证处理耗时。

SDK 2.2 版本开始提供此回调

onLocalProcessedAudioFrame
本地采集并经过音频模块前处理、音效处理和混 BGM 后的音频数据回调

void onLocalProcessedAudioFrame(BRTCDef.BRTCAudioFrame audioFrame)

参数

名称 描述
audioFrame 音频帧数据。参考 BRTCAudioFrame

详情

当您设置完音频数据自定义回调之后，SDK 内部会把刚采集到并经过前处理、音效处理和混 BGM 之后的数据，在最终进行网络编码之前，以 PCM 格式的形式通过本接口回调给您。其他音频格式的说明同 onCapturedRawAudioFrame

SDK 2.2 版本开始提供此回调

{{allComment[version]}} ×
  • 暂无评论
  • {{comment.author}}
    {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
    {{comment.content}}
您需要 后才能评论