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

    Android

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

    对象和枚举 定义了一些配置参数和文件夹包含 SDK 接口的入参及出参的类的定义。

    详细信息

    枚举

    视频相关枚举值定义 说明
    BRTCVideoResolution 视频分辨率
    BRTCVideoResolutionMode 视频宽高比模式
    BRTCVideoStreamType 视频流类型
    BRTCVideoFillMode 视频画面填充模式
    BRTCVideoRotation 视频画面旋转方向
    BRTCVideoMirrorType 本地视频预览镜像类型
    BRTC_REMOTE_USER_LEAVE_REASON 远端用户离开房间时的原因
    BRTC_EXIT_ROOM_REASON 本端用户离开房间时的原因
    网络相关枚举值定义 说明
    BRTCVideoQosPreference 画质偏好
    声音相关枚举值定义 说明
    BRTCAudioQuality 声音音质
    BRTCAudioRoute 音频路由,即声音由哪里输出
    BRTCSystemVolumeType 系统音量类型,即声音由用哪种音量输出
    BRTCNSMode 音频去噪模式
    Log 相关枚举值定义 说明
    BRTCLogLevel Log 级别

    关键类型定义

    对象 说明
    BRTCParams 进入房间参数
    BRTCRenderParams 画面显示参数
    BRTCVideoEncParam 视频配置参数
    BRTCNetworkQosParam 网络流控相关参数
    BRTCVolumeInfo 音量大小
    BRTCStatistics 统计数据
    BRTCRemoteStatistics 远端成员的音视频统计信息
    BRTCLocalStatistics 本地的音视频统计信息
    BRTCGSensorMode 重力感应模式
    BRTCAudioFrame 音频帧数据结构
    BRTCVideoFrame 视频帧数据结构
    BRTCNetworkQuality 推拉流质量级别
    BRTCNetworkQualityInfo 推拉流质量评价详情
    BRTCCameraCaptureFormat 摄像头采集格式
    BRTCAudioMusicParam 背景音乐的播放控制信息
    BRTCVideoCanvas 视频视图容器(固定布局)

    详细信息

    BRTCVideoResolution
    视频分辨率

    变量名 值 描述
    BRTCVideoResolution_120_120 1 默认码率：100 kbps
    BRTCVideoResolution_160_160 3 默认码率：120 kbps
    BRTCVideoResolution_270_270 5 默认码率：200 kbps
    BRTCVideoResolution_480_480 7 默认码率：400 kbps
    BRTCVideoResolution_160_120 50 默认码率：100 kbps
    BRTCVideoResolution_240_180 52 默认码率：150 kbps
    BRTCVideoResolution_280_210 54 默认码率：200 kbps
    BRTCVideoResolution_320_240 56 默认码率：200 kbps
    BRTCVideoResolution_400_300 58 默认码率：300 kbps
    BRTCVideoResolution_480_360 60 默认码率：350 kbps
    BRTCVideoResolution_640_480 62 默认码率：500 kbps
    BRTCVideoResolution_960_720 64 默认码率：800 kbps
    BRTCVideoResolution_160_90 100 默认码率：100 kbps
    BRTCVideoResolution_256_144 102 默认码率：150 kbps
    BRTCVideoResolution_320_180 104 默认码率：200 kbps
    BRTCVideoResolution_480_270 106 默认码率：300 kbps
    BRTCVideoResolution_640_360 108 默认码率：400 kbps
    BRTCVideoResolution_960_540 110 默认码率：700 kbps
    BRTCVideoResolution_1280_720 112 默认码率：1000 kbps
    BRTCVideoResolution_1920_1080 114 默认码率：2000 kbps

    详情

    此处仅定义横屏分辨率，如需使用竖屏分辨率（例如360 × 640），需要同时指定 BRTCVideoResolutionMode 为 Portrait

    BRTCVideoResolutionMode
    视频宽高比模式

    变量名 值 描述
    BRTCVideoResolutionModeAuto 0 自动决定分辨率模式
    BRTCVideoResolutionModePortrait 1 肖像模式（竖屏）
    BRTCVideoResolutionModeLandscape 2 风景模式（横屏）

    BRTCVideoStreamType
    视频流类型

    变量名 值 描述
    BRTCVideoStreamTypeBig 0 主画面视频流
    BRTCVideoStreamTypeSmall 1 小画面视频流
    BRTCVideoStreamTypeSub 2 辅流（屏幕分享）

    详情

    • BRTC 内部有三种不同的音视频流，分别是：
      • 主画面：最常用的一条线路，一般用来传输摄像头的视频数据
      • 小画面：跟主画面的内容相同，但是分辨率和码率更低
      • 辅流画面：一般用于屏幕分享
    • 如果主播的上行网络和性能比较好，则可以同时送出大小两路画面
    • SDK 不支持单独开启小画面，小画面必须依附于主画面而存在

    BRTCVideoFillMode
    视频画面填充模式

    变量名 值 描述
    BRTCVideoFillMode_Fill 0 图像铺满屏幕，超出显示视窗的视频部分将被裁剪
    BRTCVideoFillMode_Fit 1 图像长边填满屏幕，短边区域会被填充黑色

    详情

    • 如果画面的显示分辨率不等于画面的原始分辨率，就需要您设置画面的填充模式:
      • BRTCVideoFillMode_Fill，图像铺满屏幕，超出显示视窗的视频部分将被裁剪，画面显示可能不完整
      • BRTCVideoFillMode_Fit，图像长边填满屏幕，短边区域会被填充黑色，画面的内容完整

    BRTCVideoRotation
    视频画面旋转方向

    变量名 值 描述
    BRTCVideoRotation_0 0 不旋转
    BRTCVideoRotation_90 1 顺时针旋转90度
    BRTCVideoRotation_180 2 顺时针旋转180度
    BRTCVideoRotation_270 3 顺时针旋转270度

    详情

    • BRTC SDK 提供了对本地和远程画面的旋转角度设置 API，旋转角度都是指顺时针方向的

    BRTCVideoMirrorType
    本地视频预览镜像类型

    变量名 值 描述
    BRTCVideoMirrorTypeAuto 0 前置摄像头镜像，后置摄像头不镜像
    BRTCVideoMirrorTypeEnable 1 前后置摄像头画面均镜像
    BRTCVideoMirrorTypeDisable 2 前后置摄像头画面均不镜像

    BRTCVideoQosPreference
    画质偏好

    变量名 值 描述
    BRTCVideoQosPreferenceSmooth 1 弱网下保流畅
    BRTCVideoQosPreferenceClear 2 弱网下保清晰，默认值

    详情

    • 指当 BRTC SDK 在遇到弱网络环境时，您期望“保清晰”或“保流畅”，两种模式均会优先保障声音数据的传输
      • Smooth：默认。弱网下优先流畅性，当用户网络较差的时候画面也会比较模糊
      • Clear：弱网下优先清晰度，当用户网络较差的时候会出现卡顿，但画面清晰度不会大幅缩水

    BRTCAudioQuality
    声音音质

    变量名 值 描述
    BRTCAudioQualitySpeech 1 流畅音质：采样率：16k；单声道；音频裸码率：16kbps；适合语音通话为主的场景，比如在线会议，语音通话
    BRTCAudioQualityDefault 2 默认音质：采样率：48k；单声道；音频裸码率：50kbps；SDK 默认的音频质量，如无特殊需求推荐选择之
    BRTCAudioQualityMusic 3 高音质：采样率：48k；双声道 + 全频带；音频裸码率：128kbps；适合需要高保真传输音乐的场景，比如K歌、音乐直播等

    详情

    • 音频音质用来衡量声音的保真程度，BRTCAudioQualitySpeech 适用于通话场景，BRTCAudioQualityMusic 适用于高音质音乐场景

    BRTCAudioRoute
    音频路由，即声音由哪里输出

    音频输出路由 值 描述
    BRTCAudioModeSpeakerphone 0 扬声器，位于手机底部，即我们常说的“外放”，声音较大
    BRTCAudioModeEarpiece 1 听筒，位于手机顶部，需要凑近才能听到，私密性较好

    BRTCSystemVolumeType
    系统音量类型,即声音由用哪种音量输出

    系统音量输出 值 描述
    BRTCSystemVolumeTypeAuto 0 “麦上通话，麦下媒体”，即上麦时使用通话音量，不上麦则使用媒体音量。（这个特性需要升级到 2.2 或以上版本才支持）
    BRTCSystemVolumeTypeVOIP 1 通话全程使用媒体音量。适合不需要上麦，只收看直播的应用场景
    BRTCSystemVolumeTypeMedia 2 全程使用通话音量，适合需要频繁进行语音互动的场景，如多人会议

    BRTCLogLevel
    Log 级别

    变量名 值 描述
    BRTCLogLevelVerbose 0 输出所有级别的 Log
    BRTCLogLevelDebug 1 输出 DEBUG，INFO，WARNING，ERROR 级别的 Log
    BRTCLogLevelInfo 2 输出 INFO，WARNING，ERROR 级别的 Log
    BRTCLogLevelWarn 3 只输出WARNING，ERROR 级别的 Log
    BRTCLogLevelError 4 只输出ERROR 级别的 Log
    BRTCLogLevelNone 6 不输出日志

    详情

    • 不同的日志等级定义了不同的详实程度和日志数量，设置的日志级别值越低，输出日志里越大，占用的相关计算资源和磁盘空间（假设会写入磁盘）也越大。推荐在正式产品中将日志等级设置为 BRTCLogLevelInfo 即可。

    BRTCNSMode 音频去噪模式
    📝 该类型从 3.15.3 版本开始提供

    变量名 值 描述
    BRTCNSModeNormal 0 背景为低噪声环境
    BRTCNSModeDefault 1 默认。背景为中噪声环境
    BRTCNSModeHigh 2 背景为高噪声环境

    BRTCParams
    进入房间参数

    变量名 类型 是否必填 描述
    appId String 是 您的应用ID，需要在 控制台创建
    sign String 是 用户签名 参考SDK 动态授权
    roomID String 是 房间号
    userId String 是 用户数据
    role BRTCRoleType 否 进房默认角色
    appScene BRTCAppScene 否 SDK 使用场景

    BRTCRoleType
    房间角色

    变量名 值 描述
    BRTCRoleAnchor 0 主播，进房默认角色。进入房间内会推流
    BRTCRoleAudience 1 观众，不会推流。即便调用 muteLocalAudio, muteLocalVideo 等接口

    详情

    • 可以在进入房间后调用 switchRole 接口在两种角色之间切换
    • 主播切换到观众后，会禁用本地音视频
    • 观众切换到主播后，不会自动开启本地音视频。您需要调用 startLocalAudio, startLocalPreview, muteLocalAudio, muteLocalVideo 等接口来主动开启音视频采集和推流

    BRTCRenderParams
    视频渲染参数

    变量名 类型 是否必填 描述
    rotation BRTCVideoRotation 否 画面朝向
    fillMode BRTCVideoFillMode 否 画面填充模式
    mirrorType BRTCVideoMirrorType 否 画面朝向

    BRTCVideoEncParam
    视频配置参数

    变量名 类型 是否必填 描述
    bandWidth int 否 视频码率，单位为 kbps。默认值 400
    width int 否 视频的宽。默认值 640
    height int 否 视频的高。默认值 360
    fps int 否 视频的帧率。默认值 15
    resolutionMode BRTCVideoResolutionMode 否 视频宽高比模式。默认值是 BRTCVideoResolutionModeAuto

    BRTCNetworkQosParam
    网络流控相关参数

    变量名 类型 是否必填 描述
    preference BRTCVideoQosPreference 否 弱网下是“保清晰”或“保流畅”

    BRTCVolumeInfo
    音量大小

    变量名 类型 是否必填 描述
    volume int 否 说话者的音量，取值范围 0 - 100
    userId String 否 说话者的用户ID

    详情

    • 表示语音音量的评估大小，通过这个数值，您可以在 UI 界面上用图标表征 userId 是否有在说话

    BRTCStatistics
    统计数据

    变量名 说明
    appCpu 当前 App 的 CPU 使用率（％）
    rtt 延迟（毫秒）。指 SDK 到 BRTC 服务器的一次网络往返时间。该值越小越好。一般低于50ms的 rtt 相对理想，而高于 100ms 的 rtt 会引入较大的通话延时。
    upLoss 上行丢包率（％）。该值越小越好。例如，丢包率为 0 表示网络很好，丢包率为 30 则意味着 SDK 向服务器发送的数据包中会有 30% 丢失在上行传输中
    downLoss 下行丢包率（％）。该值越小越好，例如，丢包率为 0 表示网络很好，丢包率为 30 则意味着 SDK 向服务器发送的数据包中会有 30% 丢失在下行传输中
    sendBytes 发送字节总数
    receiveBytes 接收字节总数
    localArray 自己本地的音视频统计信息，可能有主画面、小画面以及辅路画面等多路的情况，因此是一个数组
    remoteArray 远端成员的音视频统计信息，可能有主画面、小画面以及辅路画面等多路的情况，因此是一个数组

    BRTCRemoteStatistics
    远端成员的音视频统计信息

    变量名 说明
    userId 用户 ID
    finalLoss 该线路的总丢包率（％）。该值越小越好。例如，丢包率为 0 表示网络很好。丢包率是该线路的 userId 从上行到服务器再到下行的总丢包率。 如果 downLoss 为 0，但是 finalLoss 不为 0，说明该 userId 在上行就出现了无法恢复的丢包
    width 视频宽度
    height 视频高度
    frameRate 接收帧率（fps）
    videoBitrate 视频码率（Kbps）
    audioSampleRate 音频采样率（Hz）
    audioBitrate 音频码率（Kbps）
    jitterBufferDelay 播放时延（ms）
    streamType 流类型（大画面 / 小画面 / 辅路画面）

    BRTCLocalStatistics
    本地的音视频统计信息

    变量名 说明
    width 视频宽度
    height 视频高度
    frameRate 帧率（fps）
    videoBitrate 视频发送码率（Kbps）
    audioSampleRate 音频采样率（Hz）
    audioBitrate 音频发送码率（Kbps）
    streamType 流类型（大画面 / 小画面 / 辅路画面）

    BRTCGSensorMode
    重力感应模式

    变量名 值 描述
    BRTC_GSENSOR_MODE_DISABLE 0 关闭重力感应
    BRTC_GSENSOR_MODE_UIAUTOLAYOUT 1 当前用户发布出去的视频画面会跟随设备的重力感应方向进行相应的调整，同时本地预览画面保持方向不变。
    BRTC_GSENSOR_MODE_UIFIXLAYOUT 2 当前用户发布出去的视频画面会跟随设备的重力感应方向进行相应的调整，同时本地预览画面也会进行相应的旋转适配。

    BRTC_REMOTE_USER_LEAVE_REASON
    远端用户离开房间的原因

    变量名 值 描述
    ACTIVE 0 用户主动退出房间
    TIMEOUT 1 表示用户超时退出
    EVICTED 2 被踢出房间

    BRTC_EXIT_ROOM_REASON
    本地用户离房原因

    变量名 值 描述
    ACTIVE 0 用户主动退出房间
    EVICTED 1 被踢出房间
    CLOSED 2 当前房间整个被解散
    REJOIN 3 相同用户从其他端加入房间。
    建议您在这种情况下主动处理一下同一个用户多端登录，避免意想不到的问题

    BRTCAudioFrame
    音频帧数据结构

    变量名 类型 描述
    data byte[] 音频 PCM 数据
    length int PCM 数据长度，单位：字节
    sampleRate int 音频采样率
    channel int 音频通道数
    timestamp long 音频时间戳，单位：毫秒

    BRTCVideoFrame
    视频帧数据结构

    变量名 类型 描述
    pixelFormat int 颜色空间类型。目前仅开放支持 BRTC_VIDEO_PIXEL_FORMAT_NV21
    bufferType int 数据缓冲区类型。目前仅开放支持 BRTC_VIDEO_BUFFER_TYPE_BYTE_ARRAY
    data byte[] 视频帧数据
    width int 视频帧宽度
    height int 视频帧高度
    timestamp long 视频帧时间戳，单位：毫秒
    rotation int 视频帧旋转角度，取值：0，90，180，270

    📝注：尚未支持的字段暂不描述

    BRTCNetworkQuality
    推、拉流质量评价级别

    变量名 值 描述
    UNKNOWN 0 未知，通常是不存在推流或拉流的情形
    EXCELLENT 1 极好
    GOOD 2 良好
    POOR 3 一般
    BAD 4 差
    VBAD 5 极差
    DOWN 6 不可用

    BRTCNetworkQualityInfo
    推、拉流质量评价详情

    变量名 类型 描述
    networkQuality BRTCNetworkQuality 推、拉流质量评价级别，参考 BRTCNetworkQuality
    userId String 用户ID，本地或远端用户。本地用户ID始终为0。

    BRTCAppScene
    SDK 使用场景 📝此属性从 SDK 3.10.0 开始提供

    变量名 描述
    BRTCAppScene_VIDEOCALL 实时互动模式（默认）
    BRTCAppScene_LIVE 互动直播模式

    MixStreamParams
    主播发起混流的参数

    变量名 类型 描述
    mixStreamId String 混流ID。可以使用 onMixedNotification 下发的已存在流ID，也可以设置为空字符串，让服务器创建新的
    customData String 附加在混流上的自定义信息，可以为空
    mode BLiveLayoutMode 混流布局。1表示自定义（默认），2表示画廊布局
    forceMix boolean 单路流时是否强制转码，默认为 false
    canvas MixLayoutCanvasBean 混流布局描述
    cells List<MixStreamCellModel> 参与混流的视频单元信息

    MixLayoutCanvasBean
    混流的画布参数

    变量名 类型 描述
    width int 画布宽
    height int 画布高
    isPortrait Boolean 是否竖屏
    color String 画布填充的颜色，如 #ff0000
    fitMode BLiveFitMode 填充方式： 0-aspectFit(补黑边, 默认模式), 1-aspectFill(裁剪), 2-fill(拉伸填充)
    video MixLayoutVideoBean 编解码参数

    BLiveFitMode
    视频画面填充模式

    枚举 取值 描述
    MODE_FIT 0 默认模式。按比例填充，无法填满的部分补黑
    MODE_ASPECTFILL 1 图像铺满屏幕，超出显示视窗的视频部分将被裁剪
    MODE_FILL 2 图像长边填满屏幕，短边区域会被填充黑色

    MixLayoutVideoBean
    混流的编解码参数

    变量名 类型 描述
    useQp Boolean 固定量化值（Constant Quantizer），让每一帧获得相同品质，屏幕分享等需要高品质画面的场景需要用到
    codec String 编解码协议，目前只支持h264
    bitrate int 目标带宽值
    fps int 每秒画面数
    gop int 相邻关键帧间隔

    MixStreamCellModel
    流画面参数

    变量名 类型 描述
    cellName String 流在画布上显示的名称
    streamIdentifier StreamIdentifierBean 流标识信息
    x int 流画面填充在画布上的起始点
    y int 流画面填充在画布上的起始点
    width int 流画面的宽
    height int 流画面的高
    zOrder int 流画面的z轴排列顺序
    fitMode BLiveFitMode 流画面的填充方式： 0-aspectFit(补黑边, 默认模式), 1-aspectFill(裁剪), 2-fill(拉伸填充)
    color String 画布填充的背景颜色

    StreamIdentifierBean
    流标识信息

    变量名 类型 描述
    type String 应用使用的底层类型，目前为brtc-vloud
    data DataBean 扩展信息，目前仅开放了设置用户ID

    PlayMixStreamInfo 混流播放信息

    变量名 类型 描述
    view BLiveView 共有两个派生类：TextureRenderView和SurfaceRenderView，可以根据需要选择其中任何一种。默认使用TextureRenderView
    streamId String 待播放的混流ID。SDK会根据此ID来查询对应的流地址。
    overrideUrl String 可选。如果设置了此地址，将播放此地址指向的媒体流，不再查询 streamId 对应的流地址。
    audioOn boolean 是否播放音频
    videoOn boolean 是否播放视频
    resolution BLiveResolution 服务器可能存在多种分辨率的媒体流，可以根据需要，指定某一种分辨率来播放。如果不指定，则默认播放列表首位的媒体流。
    index int 从0开始的视频规格索引。当您收到 onMixStreamAdded通知时，其中可能包含多种规格的视频，您可以指定播放其中某一种规格。

    BLiveResolution
    视频分辨率

    枚举 取值 描述
    High16x9 high16x9 高清16：9
    High4x3 high4x3 高清4：3
    Std16x9 std16x9 标清16：9
    Std4x3 std4x3 标清4：3
    Raw raw 原画

    BRTCCameraCaptureFormat
    摄像头支持的分辨率

    变量名 类型 描述
    width int 摄像头支持的分辨率宽度
    height int 摄像头支持的分辨率高度

    MixSteamAddressBean
    混流属性

    变量名 类型 描述
    roomId String 房间ID
    taskId String 混流ID
    customData String 自定义数据
    timeout int 播放器网络连接请求超时时间，单位：秒
    streamList List flv格式的混流地址列表
    streamResolutionList String JSON格式的混流信息列表。可能包含多个分辨率的混流信息（rtmp/flv/m3u8 地址、名称、给播放器设置DNS解析的URL等）
    pull boolean 如果为true表示需要播放器主动断流重新拉取

    BRTCAudioMusicParam
    背景音乐的播放控制信息

    变量名 类型 描述
    id int 音乐 ID
    path String 音效文件的完整路径或 URL 地址
    loopCount int 音乐循环播放的次数，取值范围为 0 - 任意正整数。默认值为0
    publish boolean 是否将音乐传到远端
    true: 音乐在本地播放的同时，远端用户也能听到该音乐
    false(默认值): 主播只能在本地听到该音乐，远端观众听不到。默认值：false
    isShortFile boolean 播放的是否为短音乐文件
    true: 需要重复播放的短音乐文件
    false(默认值): 正常的音乐文件
    startTimeMS long 音乐播放开始时间，单位：毫秒
    endTimeMS long 音乐播放结束时间，单位：毫秒

    BRTCVideoCanvas
    视频视图容器（固定布局）
    📝 该类型从 3.13 版本开始提供

    BRTCVideoCanvas 是为了方便您在固定布局下显示本地或远端用户视频画面提供的视图类。它继承于 Framelayout。您可以在您的 xml 布局文件中，直接定义一个视图对象：

    <org.brtc.sdk.adapter.BRTCVideoCanvas  
    android:id="@+id/local_video_canvas"  
    android:layout_width="match_parent"  
    android:layout_height="match_parent" />

    然后使用支持 BRTCVideoCanvas 参数的接口来传入此视图对象。例如：

    BRTCVideoCanvas brtcVideoCanvas = findViewById(R.id.local_video_canvas);
brtcEngine.startLocalPreviewWithCanvas(true, brtcVideoCanvas);

    ⚠️ 建议您只在固定布局情况下使用此对象及其配套方法。大多数情况下，仍然建议您使用动态创建 BRTCVideoView 的方式及配套方法。

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