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

    Android

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

    BRTC 是 BRTC SDK 的入口类，它为 App 提供了快速搭建音视频通信的 API。
    BRTCListener 包含了大部分来自 SDK 内部的事件通知，方便调用者根据回调信息做出相应的处理。
    调用 BRTC 的接口最好在同一个线程进行，不建议在不同的线程同时调用。

    基础接口

    函数列表 描述
    sharedInstance 创建 BRTC 实例
    destroySharedIntance 销毁 BRTC 实例
    getSDKVersion 获取 SDK 版本信息
    setListener 设置回调接口
    setDefaultStreamRecvMode 设置默认的订阅模式
    setNetworkQosParam 设置网络流控相关参数
    callExperimentalAPI 调用实验性 API 接口

    房间相关接口

    函数列表 描述
    enterRoom 进入房间
    exitRoom 离开房间
    switchRole 切换角色

    音频相关接口

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

    视频相关接口

    函数列表 描述
    startLocalPreview 开启本地视频的预览画面
    stopLocalPreview 停止本地视频采集及预览
    setLocalRenderParams 本地图像的渲染设置
    muteLocalVideo 暂停/恢复推送本地的视频数据
    startRemoteView 开始拉取并显示指定用户的远端画面
    stopRemoteView 停止显示远端视频画面，同时不再拉取该远端用户的视频数据流
    muteRemoteVideoStream 暂停/恢复接收指定的远端视频流
    muteAllRemoteVideoStreams 暂停/恢复接收所有远端视频流
    setRemoteRenderParams 远端图像的渲染设置
    setRemoteVideoStreamType 切换指定远端用户的大小画面
    setVideoEncoderMirror 设置视频编码输出的画面方向
    setVideoEncoderParam 设置视频编码器相关参数
    enableEncSmallVideoStream 开启大小画面双路编码模式
    setVideoEncoderRotation 设置视频编码器输出的画面方向
    setVideoFallbackEnable 设置弱网条件下流是否开启自适应回退机制
    setVideoMuteImage 设置本地画面被暂停期间的替代图片
    setWatermark 设置水印
    snapshotVideo 视频画面截图
    setGSensorMode 设置重力感应模式
    setLocalVideoProcessListener 设置本地视频帧监听

    屏幕分享相关接口

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

    互动直播相关接口

    函数列表 描述
    startMixTranscode 开始混流转码
    stopMixTranscode 停止混流转码
    playMixStream 开始播放合流
    stopMixStream 停止播放合流
    setRtmpEngineObserver 设置直播流播放器事件监听

    日志相关

    函数列表 描述
    setConsoleEnabled 启用或禁用控制台日志打印
    setLogDirPath 修改日志保存路径
    setLogLevel 设置日志输出级别
    setLogListener 设置日志回调

    获取各种管理器

    函数列表 描述
    getAudioEffectManager 获取音效管理类 BRTCAudioEffectManager
    getBeautyManager 获取美颜管理类 BRTCBeautyManager
    getDeviceManager 获取设备管理类 BRTCDeviceManager
    getMediaPlayerManager 获取媒体播放管理器类 BRTCMediaPlayerManager

    自定义消息

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

    接口详细描述

    sharedInstance

    创建 BRTC 实例（单例模式）

    BRTC sharedInstance(Context context)

    参数

    名称 描述
    context Android系统提供的关于应用环境全局信息的接口。必须设置，否则无法生成 BRTC 实例对象。建议传入 Android 平台的 ApplicationContext。

    返回

    • BRTC 实例对象

    详情

    • BRTC 类的所有接口函数，如无特殊说明，都是异步调用，对接口的调用建议在同一个线程进行
    • 请确保在调用其他 API 前先调用该方法创建并初始化
    • BRTC Native SDK 只支持每个 App 中创建一个 BRTC 实例对象

    destroySharedInstance

    销毁 BRTC 实例对象

    void destroySharedInstance()

    详情

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

    setListener

    设置回调接口

    void setListener(BRTCListener listener)

    参数

    名称 描述
    listener 回调监听对象，详见 BRTCListener

    详情

    • 您可以通过 BRTCListener 获得来自 SDK 的各种状态、事件通知，根据这些回调决定业务的后续动作。

    enterRoom

    加入房间

    void enterRoom(BRTCDef.BRTCParams param)

    参数

    名称 描述
    param 进房参数，详见 BRTCParams

    详情

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

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

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

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

    exitRoom

    离开房间

    void exitRoom()

    详情

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

    switchRole

    切换角色

    void switchRole(BRTCDef.BRTCRoleType role)

    详情

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

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

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

    参数

    名称 描述
    role 角色，详见 BRTCRoleType

    注意

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

    setDefaultStreamRecvMode

    设置默认的订阅模式

    void setDefaultStreamRecvMode(boolean autoRecvAudio, boolean audoRecvVideo)

    详情

    默认情况下，SDK在感知到有远端用户推流时，会自动拉取其音视频流，但默认不播放声音、显示视频，但会占用下行带宽，并进行解码。目的是当需要播放远端用户声音和画面时，可以立刻播放，达到“秒开”的效果。但这会需要额外的带宽和计算资源。

    您可以根据使用场景，设置不自动拉流解码，在需要播放的时候再订阅远端音视频流，缺点是播放耗时要长一些。

    注意：需要在进入房间（enterRoom）前调用该接口，设置才能生效。

    参数

    名称 描述
    autoRecvAudio true表示自动订阅该远端用户的音频流
    autoRecvVideo true表示自动订阅该远端用户的视频流

    setGSensorMode

    设置重力感应的适配模式

    void setGSensorMode(BRTCDef.BRTCGSensorMode mode)

    参数

    参数 描述
    mode 重力感应适配模式，详情请参考BRTCDef.BRTCGSensorMode

    详情

    您可以通过本接口实现如下这种友好的交互体验：

    当用户将手机或 Pad 上下颠倒时，由于摄像头的采集方向没有变，所以房间中其他用户所看到的画面会变成上下颠倒的，

    在这种情况下，您可以通过调用该接口让 SDK 根据设备陀螺仪的朝向自动调整本地画面和编码器输出画面的旋转方向，以使远端观众可以看到正常朝向的画面。

    startLocalPreview

    开启本地视频的预览画面

    void startLocalPreview(boolean frontCamera, BRTCVideoView view)

    参数

    名称 描述
    frontCamera true：前置摄像头；false：后置摄像头
    view 承载视频画面的控件

    详情

    • 请在 enterRoom 之后调用此函数
    • 当开始渲染首帧摄像头画面时，您会收到 BRTCListener 中的 onFirstVideoFrame(null) 回调

    注意

    • 目前尚不支持在进入房间前调用此方法，建议您在收到 BRTCListener 的 onEnterRoom 回调中来调用
    • 如果当前正在屏幕共享，且设置的流类型是 BRTCVideoStreamTypeBig，调用此接口后，将会停止屏幕共享，恢复显示摄像头画面

    stopLocalPreview

    停止本地视频采集及预览

    void stopLocalPreview()

    muteLocalVideo

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

    void muteLocalVideo(boolean mute)

    参数

    名称 描述
    mute true：暂停；false：恢复

    详情

    该接口可以暂停（或恢复）发布本地的视频画面，暂停之后，同一房间中的其他用户将无法继续看到自己的画面。调用此接口，并不会操作物理摄像头设备，比较适合频繁开关视频的场景。

    注意：如果您还调用了 startScreenCapture 接口启动了屏幕共享，并设置了 streamType 是 BRTCVideoStreamTypeSub，此时摄像头和屏幕共享将会是两个独立的视频流在发布。在这种情况下，调用此接口，只作用于摄像头流。如果您需要暂定/恢复屏幕共享，建议您试用 pauseScreenCapture 和 resumeScreenCapture 接口。

    • 当暂停推送本地视频后，房间里的其它成员将会收到 onUserVideoAvailable(userid, false) 回调通知
    • 当恢复推送本地视频后，房间里的其它成员将会收到 onUserVideoAvailable(userid, true) 回调通知

    setVideoMuteImage

    设置本地画面被暂停期间的替代图片

    void setVideoMuteImage(Bitmap image, int fps)

    参数

    名称 描述
    image 设置替代图片，空值代表在 muteLocalVideo 之后不再发送视频流数据，默认值为空
    fps 设置替代图片帧率，最小值为5，最大值为10，默认5

    详情

    当您调用 muteLocalVideo(true) 暂停本地画面时，您可以通过调用本接口设置一张替代图片，设置后，房间中的其他用户会看到这张替代图片。

    setWatermark

    为视频画面添加水印

    void setWatermark(Bitmap image, int streamType, float x, float y, float width)

    参数

    名称 描述
    image 水印图片，必须使用透明底色的 png 格式
    streamType 指定给哪一路画面设置水印。见BRTCDef.BRTCVideoStreamType
    x 水印的坐标，取值范围为0 - 1的浮点数
    y 水印的坐标，取值范围为0 - 1的浮点数
    width 水印的宽度，取值范围为0 - 1的浮点数

    详情

    如果当前视频的编码分辨率是 640 x 360，参数设置为：x = 0.1，y = 0.1，width = 0.2，那么水印的左上坐标点就是（640 × 0.1，360 × 0.1）即（64，36），水印的宽度是 640 × 0.2 = 128px，水印的高度会根据水印图片的宽高比由 SDK 自动算出。

    startRemoteView

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

    void startRemoteView(String userId, BRTCDef.BRTCVideoStreamType type, BRTCVideoView view)

    参数

    名称 描述
    userId 远端用户ID
    streamType 指定要观看 userId 的视频流类型:
    高清大画面：BRTCVideoStreamTypeBig
    低清小画面：BRTCVideoStreamTypeSmall
    辅流（屏幕分享）：BRTCVideoStreamTypeSub
    view 承载视频画面的控件

    详情

    • 该函数会拉取指定 userid 的视频流显示在您指定的 view 控件上，您可以通过 setRemoteRenderParams() 设置显示模式
    • 如果您提前知道房间中某个 userid 正在推流，可以直接调用 startRemoteView 显示该用户的远端画面。
    • 如果您不知道房间中有哪些用户开启了视频，可以在 enterRoom() 后等待来自 SDK 的 onUserVideoAvailable(userId, true) 回调通知
    • 调用 startRemoteView() 只是启动拉取，此时画面还需要加载，当加载完毕后会通过 onFirstVideoFrame(userId) 通知您
    • SDK 支持同时观看某 userid 的大画面和辅路，或者小画面和辅路，但不支持同时观看大画面和小画面
    • 只有当指定的 userid 通过 enableEncSmallVideoStream() 开启双路编码后，才能观看该用户的小画面
    • 如果该用户的小画面不存在，则默认显示大画面

    stopRemoteView

    停止显示远端视频画面，同时不再拉取该远端用户的视频数据流

    void stopRemoteView(String userId, BRTCDef.BRTCVideoStreamType type)

    参数

    名称 描述
    userId 远端用户ID
    streamType 指定要观看 userId 的视频流类型:
    高清大画面：BRTCVideoStreamTypeBig
    低清小画面：BRTCVideoStreamTypeSmall
    辅流（屏幕分享）：BRTCVideoStreamTypeSub

    详情

    调用此接口后，SDK 会清理关联到该远端用户的相关视频显示资源

    调用此接口后，无论在手动订阅模式还是自动订阅模式下，都会停止接收该远端用户的视频流。区别是：

    • 在手动订阅模式下，会释放掉该用户视频流相关的全部资源。如果需要再次恢复显示，需要重新发起订阅。
    • 在自动订阅模式下，不需要重新订阅，再次恢复显示，画面显示速度更快。

    muteRemoteVideoStream

    暂停/恢复接收指定的远端视频流

    从 SDK 2.1 版本开始，此接口标记为废除。请使用下方带有流类型的版本：muteRemoteVideoStream。如果继续使用该接口，则默认操作的是流类型为 BRTCVideoStreamTypeBig 的视频画面。

    void muteRemoteVideoStream(String userId, boolean mute)

    muteRemoteVideoStream

    暂停/恢复接收指定的远端视频流

    void muteRemoteVideoStream(String userId, BRTCDef.BRTCVideoStreamType type, boolean mute)

    参数

    名称 描述
    userId 远端用户ID
    type 流类型，包括：
    高清大画面：BRTCVideoStreamTypeBig
    低清小画面：BRTCVideoStreamTypeSmall
    辅流（屏幕分享）：BRTCVideoStreamTypeSub
    mute true：暂停；false：恢复

    详情

    • 该接口仅暂停/恢复接收指定的远端用户的视频流，但并不释放显示资源
    • 手动订阅模式下，如果是首次针对此远端用户调用此方法并设置 mute 为 false，会自动订阅该远端用户的流
    • 当设置 mute 为 true 时：
      • 自动订阅模式下，调用此方法不会停止拉取视频流数据，也不会停止解码
      • 手动订阅模式下，调用此方法，服务器会停止下发视频流数据

    muteAllRemoteVideoStreams

    暂停/恢复接收所有远端视频流

    void muteAllRemoteVideoStreams(boolean mute)

    参数

    名称 描述
    mute true：暂停；false：恢复

    详情

    • 调用本接口，可以理解为针对当前每一个远端用户执行一次 muteRemoteVideoStream
    • 调用本接口会同时影响当前订阅的所有远端用户，以及后订阅用户的默认 mute 状态。但您仍然可以可以通过 muteRemoteVideoStream 接口单独改变某个远端用户的 mute 状态

    setVideoEncoderParam

    设置视频编码器相关参数

    void setVideoEncoderParam(BRTCDef.BRTCVideoEncParam param)

    参数

    名称 描述
    param 视频编码参数，详情 BRTCVideoEncParam

    详情

    • 该设置决定了远端用户看到的画面质量（同时也是云端录制出的视频文件的画面质量）

    setVideoEncoderRotation

    设置视频编码器输出的画面方向

    void setVideoEncoderRotation(BRTCDef.BRTCVideoRotation rotation)

    参数

    名称 描述
    roation 旋转角度。目前支持 0, 90, 180, 270 这四种

    详情

    该设置不影响本地画面的预览方向，但会影响房间中其他用户所观看到（以及云端录制文件）的画面方向。

    当用户将手机或 Pad 上下颠倒时，由于摄像头的采集方向没有变，所以房间中其他用户所看到的画面会变成上下颠倒的，

    在这种情况下，您可以通过调用该接口将 SDK 编码出的画面方向旋转180度，如此一来，房间中其他用户所看到的画面可保持正常的方向。

    如果您希望实现上述这种友好的交互体验，我们更推荐您直接调用 setGSensorMode 实现更加智能的方向适配，无需您手动调用本接口。

    注意：必须在 startLocalAudio 和 muteLocalVideo(false) 之后调用，否则可能设置无效。

    setVideoFallbackEnable
    设置弱网条件下流是否开启自适应回退机制

    void setVideoFallbackEnable(boolean enable)

    参数

    名称 描述
    enable true: 开启自适应回退机制 false: 禁用自适应回退机制

    详情

    • 当开启时，网络不理想的环境下，自动大流关闭保留小流，如果网络条件还不好就关闭视频，只留音频。如果网络变好，会从只留音频变成恢复推小流，如果网络还很宽裕，再恢复成推大小流。
    • SDK 2.2 版本开始提供此接口

    setNetworkQosParam

    设置网络流控相关参数

    void setNetworkQosParam(BRTCDef.BRTCNetworkQosParam param)

    参数

    名称 描述
    param 网络流控参数，详见 BRTCNetworkQosParam

    详情

    • 该设置决定 SDK 在各种网络环境下的调控策略（例如弱网下选择“保清晰”或“保流畅”）

    setLocalRenderParams

    设置本地画面的渲染参数

    void setLocalRenderParams(BRTCDef.BRTCRenderParams renderParams)

    参数

    名称 描述
    params 详见 BRTCRenderParams

    详情

    可设置的参数包括有：画面的旋转角度、填充模式以及镜像模式等。

    setRemoteRenderParams

    设置远端用户画面的渲染参数

    void setRemoteRenderParams(String userId, BRTCVideoStreamType type, BRTCDef.BRTCRenderParams renderParams)

    参数

    名称 描述
    userId 用户 ID
    type 指定要观看 userId 的视频流类型:
    高清大画面：BRTCVideoStreamTypeBig
    低清小画面：BRTCVideoStreamTypeSmall
    辅流（屏幕分享）：BRTCVideoStreamTypeSub
    params 详见 BRTCRenderParams

    详情

    与设置本地画面渲染参数相同，针对远端用户也可以设置画面的旋转角度、填充模式以及镜像模式等。

    setVideoEncoderMirror

    设置编码器输出的画面镜像模式

    void setVideoEncoderMirror(boolean mirror)

    参数

    名称 描述
    mirror true：开启远端画面镜像；false：关闭远端画面镜像，默认值：false

    详情

    • 该接口不改变本地摄像头的预览画面，但会改变另一端用户看到的（以及服务器录制的）画面效果
    • 即便是在推流过程中，您也可以随时调用此接口来改变编码的镜像效果
    • 该接口只针对于主画面有效。如果当前同时在推流摄像头和屏幕共享流，则只有摄像头会有镜像效果

    注意：必须在 startLocalAudio 和 muteLocalVideo(false) 之后调用，否则可能设置无效。

    enableEncSmallVideoStream

    开启大小画面双路编码模式

    int enableEncSmallVideoStream(boolean enable, BRTCDef.BRTCVideoEncParam  smallVideoEncParam)

    参数

    名称 描述
    enable true：开启；false：不开启，默认值：false
    smallVideoEncParam 详见 BRTCVideoEncParam()

    返回

    • 0：成功；-1：大画面已经是最低画质

    详情

    • 开启该模式后，当前用户会同时编码输出【高清大画面】和【低清小画面】两个规格的视频画面（但只有一路音频流）
    • 对于开启该模式的当前用户，会占用更多的网络带宽，并且会消耗更多的 CPU 计算资源
    • 对于同一房间的远程观众而言：
      • 如果下行网络很好，或者显示区域较大，可以选择观看【高清大画面】
      • 如果下行网络较差，或者显示区域较小，可以选择观看【低清小画面】

    考虑到同时编码两个规格的视频画面，需要更多的计算资源，在硬件设备较差的系统上请谨慎开启此功能

    setRemoteVideoStreamType

    切换指定远端用户的大小画面

    int setRemoteVideoStreamType(String userId, BRTCVideoStreamType type)

    参数

    名称 描述
    userId 用于指定要观看的 userId
    type 视频流类型，即选择看大画面（BRTCVideoStreamTypeBig）或小画面（BRTCVideoStreamTypeSmall）

    详情

    • 只有在远端用户调用 enableEncSmallVideoStream 提前开启双路编码模式，切换动作才有效果
    • 在不通过此接口进行设置的情况下，默认订阅的视频画面为大画面
    • 该接口在 startRemoteView 之前和之后调用均可以

    setSystemVolumeType

    设置系统音量类型。此接口在新版本 SDK 中移动到了 BRTCDeviceManager 类中。

    snapshotVideo

    视频画面截图

    void snapshotVideo(String userId, BRTCVideoStreamType type, BRTCListener.BRTCSnapshotListener listener)

    参数

    名称 描述
    userId 本地或远端用户ID
    type 视频流类型，支持 BRTCVideoStreamTypeBig（通常是摄像头） 和 BRTCVideoStreamTypeSub（通常是屏幕共享）
    listener 画面截取后的回调。参考 BRTCSnapshotListener

    详情

    • 如果设置的视频流类型是 BRTCVideoStreamTypeSub，请确保已经开启了屏幕共享
    • 如果设置的是远端用户ID，请确保已经通过 muteRemoteAudio, muteRemoteVideo 或 startRemoteVideo 等接口订阅了该远端用户的视频流。针对本地不存在的用户调用此方法是无效的。

    startLocalAudio

    开启本地音频的采集和上行

    void startLocalAudio(BRTCDef.BRTCAudioQuality quality)

    参数

    名称 描述
    quality 声音音质，详见 BRTCAudioQuality

    详情

    • SDK 默认不会采集您的麦克风声音数据，您需要主动调用该函数来开启麦克风采集，并将音频数据传输给房间里的其他用户
    • 该函数会检查麦克风的使用权限，如果当前 App 没有麦克风权限，SDK 会向用户申请开启
    • （>= Version 2.2）如果您没有通过 setSystemVolumeType 改变过默认系统音量类型，调用此接口会设置系统音量类型为通话音量

    stopLocalAudio

    关闭本地音频的采集和上行

    void stopLocalAudio()

    详情

    • 调用此方法，会停止传递本地麦克风音频数据给房间里其他用户，并释放对麦克风设备的占用
    • （>= Version 2.2）如果您没有通过 setSystemVolumeType 改变过默认系统音量类型，调用此接口会设置系统音量类型为媒体音量

    muteLocalAudio

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

    void muteLocalAudio(boolean mute)

    参数

    名称 描述
    mute true：静音；false：取消静音

    详情

    • 当静音本地音频后，房间里的其它成员会收到 onUserAudioAvailable(userId, false) 回调通知
    • 当取消静音本地音频后，房间里的其它成员会收到 onUserAudioAvailable(userId, true) 回调通知
    • 与 stopLocalAudio 不同之处在于，muteLocalAudio(true) 并不会释放对麦克风设备的占用，只是码率极低的静音数据

    muteRemoteAudio

    静音/取消静音指定的远端用户的声音

    void muteRemoteAudio(String userId, boolean mute)

    参数

    名称 描述
    userId 远端用户ID
    mute true：静音；false：取消静音

    详情

    • 当您静音某用户的远端音频时，SDK 会停止播放指定用户的声音。
    • 自动订阅模式下，还会继续拉取该远端用户的音频数据。需要恢复播放时速度较快。
    • 手动订阅模式下，会停止拉取该用户的音频数据数据。恢复播放的速度比自动订阅模式下稍慢一些。
    • 在调用了 muteAllRemoteAudio 后，仍然可以调用此方法单独针对某一个当前已订阅的远端用户进行设置

    setAudioRoute
    此接口在新版本 SDK 中移动到了 BRTCDeviceManager 类中。请参考 BRTCDeviceManager

    muteAllRemoteAudio

    静音/取消静音所有用户的声音

    void muteAllRemoteAudio(boolean mute)

    参数

    名称 描述
    mute true：静音；false：取消静音

    详情

    • mute 设置为 true 时，会停止播放所有远端用户的音频流

    • mute 设置为 false 时，会恢复播放所有远端用户的音频流

    注意：当设置 mute 为 false 时，如果自动针对所有远端用户发起拉流。因此，在手动订阅模式下，建议谨慎使用此接口。

    setRemoteAudioVolume

    设定某一个远端用户的声音播放音量

    void setRemoteAudioVolume(String userId, int volume)

    参数

    名称 描述
    userId 远端用户 ID
    volume 音量大小，取值范围为 0 - 100，默认值：100

    详情

    • 您可以通过 setRemoteAudioVolume(userId, 0) 将某一个远端用户的声音静音
    • 将 volume 设置成 100 之后感觉音量还是太小，可以将 volume 最大设置成 150，但超过 100 的 volume 会有爆音的风险，请谨慎操作

    setAudioCaptureVolume

    调节麦克风采集音量

    void setAudioCaptureVolume(int volume)

    参数

    名称 描述
    volume 音量大小范围是：[0 ~ 100]，默认值为 100

    getAudioCaptureVolume

    获取麦克风采集音量

    int getAudioCaptureVolume()

    返回

    音量大小，范围是 0 ~ 100

    setAudioPlayoutVolume

    调节播放音量大小

    void setAudioPlayoutVolume(int volume)

    参数

    名称 描述
    volume 音量大小范围是：[0 ~ 100]，默认值为 100

    详情

    • 调用此方法，会改变系统通话音量和媒体音量大小，对系统其他音量大小没有影响

    getAudioPlayoutVolume

    获取播放音量大小

    int getAudioPlayoutVolume()

    返回

    音量大小，范围是 0 ~ 100

    enableAudioVolumeEvaluation

    启用音量大小提示

    void enableAudioVolumeEvaluation(int intervalMs)

    参数

    名称 描述
    intervalMs 设置 onUserVoiceVolume 回调的触发间隔，单位为ms，最小间隔为 100ms
    设置小于等于 0 则会关闭回调，建议值：300ms

    详情

    开启后会在 onUserVoiceVolume 中获取到 SDK 对音量大小值的评估。

    setAudioFrameListener

    设置音频帧监听器

    void setAudioFrameListener(BRTCListener.BRTCAudioFrameListener listener)

    参数

    名称 描述
    listener 音频帧监听器。详细说明参考BRTCListener.BRTCAudioFrameListener

    详情

    • 当您需要获取到音频帧数据来满足一些应用场景的使用需要（如语音识别）时，您可以通过此方法来设置一个音频帧监听器来达到此目的。
    • 支持本地麦克风采集到的原始音频帧以及经过音频前处理模块处理后的音频帧。更多的能力，以 BRTCListener.BRTCAudioFrameListener 文档描述为准。

    enableCustomAudioCapture

    开启或关闭音频自采集

    void enableCustomAudioCapture(boolean enable);

    参数

    名称 描述
    enable true 表示启用，false表示禁用

    • 该接口用于开启自定义音频采集功能。开启后，SDK 不再运行原有的音频采集流程，即不再继续从麦克风采集音频数据，而是只保留音频编码和发送能力。您需要通过 sendCustomAudioData 不断地向 SDK 塞入自己采集的音频数据。

    • 设置开启自采集后，如果之前的麦克风已经打开，SDK 会自动关闭麦克风。

    • 设置关闭自采集后，如果之前的麦克风已经关闭，SDK 会自动打开麦克风。如果之前从未开启过麦克风，则 SDK 不会自动打开麦克风。

    sendCustomAudioData

    发送自定义音频数据

    void sendCustomAudioData(@NonNull BRTCDef.BRTCAudioFrame frame);

    参数

    名称 描述
    frame 音频数据帧。类型具体描述请参考BRTCAudioFrame

    详情

    • 在调用 enableCustomAudioCapture 开启自采集后，您需要通过该接口不断地向 SDK 塞入自己采集的音频数据
    • 在调用 enableCustomAudioCapture 关闭自采集后，继续调用此方法递送音频数据，将会被忽略
    • 注意 SDK 仅支持 16 bit depth 的音频数据，且单次递送的音频数据必须以 10ms 为一个最小单位
    • 强烈建议您在独立线程中调用此接口来发送音频数据，避免阻塞其他线程的工作
    • 注意要确保调用时间间隔的平滑性，不要忽快忽慢，否则会导致音频收听起来发生卡顿、丢字等问题

    getDeviceManager

    获取设备管理类 BRTCDeviceManager

    BRTCDeviceManager getDeviceManager()

    getAudioEffectManager

    获取音效管理类 BRTCAudioEffectManager

    BRTCAudioEffectManager getAudioEffectManager()

    getBeautyManager

    获取美颜特效类 BRTCBeautyManager

    BRTCBeautyManager getBeautyManager()

    getMediaPlayerManager

    获取媒体播放管理器类 BRTCMediaPlayerManager

    BRTCMediaPlayerManager getMediaPlayerManager()

    startScreenCapture

    开始屏幕分享

    // 从 SDK 2.1 版本开始以下方法标记为废弃：
void startScreenCapture(BRTCDef.BRTCVideoEncParam encParams, BRTCDef.BRTCScreenShareParams shareParams)
// SDK 2.1 开始新增以下方法：
void startScreenCapture(int streamType, BRTCVideoView view, BRTCVideoEncParam encParams, BRTCScreenShareParams shareParams)

    参数

    名称 描述
    encParams 编码参数。如果设置为 null，SDK 会自动使用默认编码参数
    shareParams 暂未启用
    view 用于本地回显屏幕共享内容的视图
    streamType 屏幕分享使用的线路，可以设置为主路（0）或者辅路（2）

    详情

    • 使用带有流类型的版本，可以决定是将屏幕共享流替换当前摄像头流（ streamType设为主路），还是在推摄像头流的基础上，再多推一路屏幕共享流（ streamType设为辅路）。
    • 如果您的产品中不需要在本地回显共享的屏幕内容，view 传 null 即可
    • 如果您设置屏幕共享的显示视图和摄像头是同一个，并且设置 streamType设为辅路，可能在回显窗口中看到闪烁画面，原因是摄像头画面和屏幕共享画面交替绘制。只需要区分摄像头视图和屏幕共享视图即可。

    stopScreenCapture

    停止屏幕采集

    void stopScreenCapture()

    pauseScreenCapture

    暂停屏幕分享

    void pauseScreenCapture()

    调用暂停屏幕共享后，不会停止屏幕共享内容采集，只是会发送黑帧数据。

    resumeScreenCapture

    恢复屏幕分享

    void resumeScreenCapture()

    sendCustomCmdMsg

    自定义消息发送

    boolean sendCustomCmdMsg(int cmdID, byte[] data, boolean reliable, boolean ordered )

    参数

    名称 描述
    cmdID 消息 ID，取值范围为 0 ~ 9
    data 待发送的消息
    reliable 尚未启用
    ordered 尚未启用

    详情

    该接口可以借助音视频数据通道向当前房间里的其他用户广播您自定义的数据。但因为复用了音视频数据通道，请务必严格控制自定义消息的发送频率和消息体的大小，否则会影响音视频数据的质量控制逻辑，造成不确定性的问题

    sendSEIMsg

    将小数据量的自定义数据嵌入视频帧中

    boolean sendSEIMsg(byte[] data, int repeatCount)

    参数

    名称 描述
    data 待发送的消息，最大支持 1KB（1000 字节）的数据大小
    repeatCount 发送数据次数

    返回

    • true：发送消息已添加至视频帧，等待随后跟随视频帧发送；false：消息被限制发送

    详情

    • sendSEIMsg 是将数据直接塞入视频数据头中，建议尽量控制数据大小，推荐使用几个字节大小的数据
    • 最常见的用法是把自定义的时间戳（timstamp）用 sendSEIMsg 嵌入视频帧中，实现消息和画面的完美对齐
    • 数据在接口调用完后不会被即时发送出去，而是从下一帧视频帧开始带在视频帧中发送
    • 发送消息到房间内所有用户，每秒最多能发送 30 条消息（与 sendCustomCmdMsg 共享限制）
    • 每个包最大为 1KB，若发送大量数据，会导致视频码率增大，可能导致视频画质下降甚至卡顿
    • 若指定多次发送（repeatCount > 1），则数据会被带在后续的连续 repeatCount 个视频帧中发送出去，同样会导致视频码率增大
    • 如果 repeatCount > 1，多次发送，接收消息 onRecvSEIMsg 回调也可能会收到多次相同的消息，需要去重

    getSDKVersion

    获取 SDK 版本信息

    String getSDKVersion()

    setLogLevel

    设置日志输出级别

    void setLogLevel(BRTCDef.BRTCLogLevel level)

    参数

    名称 描述
    level log级别,详见 BRTCLogLevel

    setConsoleEnabled

    启用或禁用控制台日志打印（在 Android Studio 中，控制台可以理解为是 logcat 面板）

    void setConsoleEnabled(boolean enabled)

    参数

    名称 描述
    enabled 指定是否启用，默认为禁止状态

    setLogDirPath

    修改日志保存路径

    void setLogDirPath(String path)

    参数

    名称 描述
    path 日志文件保存路径

    详情

    • 请务必在所有其他接口之前调用此方法来设置，并且保证您指定的目录是存在的，并且您的应用程序拥有对该目录的读写权限，否则可能无法成功记录日志
    • SDK 不会自动清理保存下来的日志，需要您自行完成过期日志的清理工作
    • 单个日志文件的最大尺寸是 10MB，超过的会产生多个日志文件

    setLogListener

    设置日志回调

    void setLogListener(final BRTCLogListener logListener)

    参数

    名称 描述
    logListener 日志监听对象。参考 BRTCLogListener

    当您希望将 SDK 日志和您的业务日志输出记录到一起时，可以通过此方法设置一个 BRTCLogListener 对象，并实现如下方法：

    /**
* 日志打印时的回调
*
* @param log    日志内容
* @param level  日志等。参见 BRTC_LOG_LEVEL
* @param module 暂无具体意义，目前为固定值 'BRTCSDK'
*/
void onLog(String log, int level, String module)

    callExperimentalAPI

    调用实验性 API 接口

    void callExperimentalAPI(String jsonStr)

    参数

    名称 描述
    jsonStr 接口及参数描述的 JSON 字符串

    详情

    SDK 内部存在一些只针对特殊用户、特殊场景下的参数、方法。这些内容通常情况下，不适用于大多数普通用户，因此不会作为标准接口提供出来。如果在 BRTC SDK 标准接口中未能找到您需要的功能，您可以与我们联系来确认是否在试验性接口中可以开启或者设置。

    setLocalVideoProcessListener

    设置本地视频帧监听

    int setLocalVideoProcessListener(int pixelFormat, int bufferType,
                                 @NonNull BRTCListener.BRTCVideoFrameListener listener);

    参数

    名称 描述
    pixelFormat 指定需要回调的视频帧像素格式。目前仅支持 BRTCVideoFrame.BRTC_VIDEO_PIXEL_FORMAT_NV21 格式，设置其他值会抛出异常
    bufferType 指定需要回调的视频帧数据类型。目前仅支持 BRTCVideoFrame.BRTC_VIDEO_BUFFER_TYPE_BYTE_BUFFER
    listener 视频帧监听器。详细结构参考 BRTCVideoFrameListener

    详情

    • 如果您调用了 getBeautyManager 相关的美颜方法，则回调的是经过美颜处理后的视频帧
    • 因为视频帧回调方法是处于采集线程上的，为了避免影响后续视频帧处理流程，请在回调方法中务必控制好处理耗时，以免引起卡顿、延迟等问题
    • 目前版本仅开放了 NV21 的 BUFFER 格式的视频帧数据，因此不建议处理高分辨率（如 1920x1080）的视频帧

    startMixTranscode

    开始混流转码

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

    stopMixTranscode

    停止混流转码

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

    playMixStream

    开始播放合流

    void playMixStream(BRTCDef.PlayMixStreamInfo playMixStreamInfo)
    参数 描述
    PlayMixStreamInfo 混流播放参数，详情见PlayMixStreamInfo
    • 建议观众端在收到 onMixStreamAdded 回调后，播放对应的音视频流

    stopMixStream

    停止播放合流

    void stopMixStream(String mixStreamId)
    参数 描述
    mixStreamId 停止播放的流 Id
    • 建议观众端在收到 onMixStreamRemoved 回调后，停止播放对应的音视频流

    setRtmpEngineObserver

    设置直播流播放器事件监听

    void setRtmpEngineObserver(BLiveRtmpEventObserver observer)
    参数 描述
    observer 监听，详情见 BLiveRtmpEventObserver
    {{allComment[version]}} ×
    • 暂无评论
    • {{comment.author}}
      {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
      {{comment.content}}
    您需要 后才能评论