HarmonyOS

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

API 概览BRTCBrtcListenerBrtcDeviceManagerBrtcBeautyManagerBrtcAudioEffectManagerBrtcMediaPlayerManager枚举和类常见问题

本页面介绍 SDK 定义的枚举类型和自定义导出类。

枚举

视频相关枚举值定义

枚举类型
BrtcVideoStreamType	视频流类型
BrtcVideoResolutionMode	视频宽高比模式
BrtcVideoRotation	视频画面旋转方向
BrtcVideoFillMode	视频画面填充模式

音频相关枚举值定义

枚举类型
BrtcAudioQuality	声音音质

网络相关枚举值定义

枚举类型
BrtcVideoQosPreference	视频画面质量调整策略

其他

枚举类型
BrtcLogLevel	日志级别

类

类名	说明
BrtcEngineAdvancedConfig	BRTC 引擎配置
BrtcRoomParams	进房参数
BrtcRenderParams	视频渲染参数
BrtcNetworkQosParam	网络流控相关参数
BrtcVideoEncParam	视频配置参数

详细信息

BrtcVideoStreamType
视频流类型

变量名	值	描述
BIG	0	主画面视频流
SMALL	1	小画面视频流
SUB	2	辅流（屏幕分享）

详情

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

BrtcVideoResolutionMode
视频宽高比模式

变量名	值	描述
LANDSCAPE	0	风景模式（横屏）
PORTRAIT	1	肖像模式（竖屏）

详情 SDK 1.0.0 对此属性的支持尚不完善。

BrtcVideoRotation
视频画面旋转方向

变量名	值	描述
ROTATION_0	0	不旋转
ROTATION_90	1	顺时针旋转90度
ROTATION_180	2	顺时针旋转180度
ROTATION_270	3	顺时针旋转270度

详情

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

BrtcVideoFillMode
视频画面填充模式

变量名	值	描述
FILL	0	图像铺满屏幕，超出显示视窗的视频部分将被裁剪，画面不会拉伸变形
FIT	1	图像长边填满屏幕，短边区域会被填充黑色

BrtcAudioQuality
声音音质

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

详情

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

BrtcVideoQosPreference
视频画面质量调整策略

变量名	值	描述
SMOOTH	1	保流畅
CLEAR	2	保清晰，默认值

详情

指当 BRTC SDK 感知到程序运行条件受限（如弱网、高 CPU 等），您期望视频画面是优先“保清晰”或“保流畅”（两种模式均会优先保障声音数据的传输）
- SMOOTH：优先保证画面流畅性，但极限情况下，画面也会调整而变得模糊
- CLEAR：默认。优先保证清晰度，但极限情况下，也会出现卡顿
针对不同的流类型，可以设置不同的策略

BrtcLogLevel
Log 级别

变量名	值	描述
ERROR	0	仅输出错误级别的日志
WARNING	1	输出警告、错误级别的日志
INFO	2	输出一般信息、警告和错误级别的日志信息
DEBUG	3	输出调试、一般信息、警告和错误级别的日志信息

详情

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

BrtcEngineAdvancedConfig
引擎初始化参数

变量名	描述
applicationContext	应用的上下文，通常通过 `common.UIAbilityContext.getApplicationContext()` 获取
config	Map<string, string>，扩展型配置键值对。

config 目前开放的配置包括：

键	值	描述
enableNativeLog	true 或 false	是否开启 SDK 内部原生日志信息

BrtcRoomParams
进入房间参数

变量名	类型	是否必填	描述
appId	字符串	是	您的应用ID，需要在控制台创建
userSig	字符串	是	用户签名参考SDK 动态授权
roomId	字符串	是	房间号
userId	字符串	是	用户数据

BrtcRenderParams
视频渲染参数

变量名	类型	是否必填	描述
rotation	BrtcVideoRotation	否	画面角度
fillMode	BrtcVideoFillMode	否	画面填充模式

BrtcNetworkQosParam
网络流控相关参数

变量名	类型	是否必填	描述
preference	BrtcVideoQosPreference	是	“保清晰”或“保流畅
streamType	BrtcVideoStreamType	是	流类型

BrtcVideoEncParam
视频配置参数

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