Android

编辑文档更新于 2025-03-26 08:13:14

类型定义

Function：用户、视频等枚举和常量值的定义

BLiveExitReason

本端用户离开房间时的原因

枚举	取值	描述
None	0	端上发送leaveRoom消息
RoomClose	1	房间关闭
TokenExpire	2	从后端获取的登录token过期
Evicted	3	相同用户从其他端加入房间。建议您在这种情况下主动处理一下同一个用户多端登录，避免意想不到的问题
ReJoined	4	后进人员冲突，踢出之前进的房间
SocketClose	5	检测到socket close，离开房间
SdkCloseSocket	6	端上主动关闭socket连接

BLiveRoleType

角色类型

枚举	取值	描述
BLiveRoleAudience	0	观众，不会推流。即便调用 muteLocalAudio, muteLocalVideo 等接口
BLiveRoleAnchor	1	主播，进入房间内会推流

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

BLiveLayoutMode

视频画面布局

BLiveFitMode

视频画面填充模式

枚举	取值	描述
MODE_ASPECTFILL	1	图像铺满屏幕，超出显示视窗的视频部分将被裁剪
MODE_FILL	2	图像长边填满屏幕，短边区域会被填充黑色

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

BLiveResolution

视频分辨率

BLiveParams

进入房间参数

BLiveExtraParams

额外参数

MixStreamParams

开启混流的参数

MixLayoutCanvasBean

混流的画布参数

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

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	用户信息

DataBean

流用户信息

变量名	类型	描述
userId	String	用户的id