AudioMode
使用的场景。● 0:主动订阅(默认)。
● 1:TopN(千人)。
● 2:P2P。
● 3:RTSA CMD自动订阅。
HRTCDeviceType
表3-32 系统音视频设备类型
枚举值 描述
HRTC_DEVTYPE_AUDIO_PLAY
BACK 音频播放设备。
HRTC_DEVTYPE_AUDIO_RECO
RDING 音频录制设备。
HRTC_DEVTYPE_VIDEO_CAPT
URE 视频采集设备。
HRTCStatsInfo
表3-33 统计信息
属性 类型 描述
mildlyFrozenC
ounts long 600ms卡顿次数 severelyFroze
nCounts long 超过1s卡顿次数 totalMildlyFro
zenTime long 600ms卡顿总时长 totalSeverelyF
rozenTime long 1s卡顿总时长 totalActiveTi
me long 总时间,包括每一路选看的视频流启动到停止的
时间总和
HRTCVideoEncParam
表3-34 视频编码参数属性说明
属性 类型 描述
streamType
HRTCStream
Type
视频流类型,根据HRTCStreamType和表14 不同 分辨率下帧率和码率的推荐值设置需要的分辨率 和宽高比width int 视频宽度
height int 视频高度
frameRate int 视频帧率,可参考表3-36中的帧率进行设置 minFrameRat
e int 视频最小帧率,大于0,小于frameRate bitRate int 视频码率,可参考表3-36中的码率进行设置 minBitrate int 视频最小码率,大于0,小于bitrate
disableAdjust
Res boolean 禁用分辨率自适应标志,推荐开启自适应(即 disableAdjustRes赋false)
表3-35 视频编码参数方法说明
方法 描述
public
HRTCVideoEncParam(HRT CStreamType streamType, int width, int height, int frameRate, int
minFrameRate, int bitrate, int minBitrate, boolean disableAdjustRes);
【功能说明】
HRTCVideoEncParam构造函数。
【请求参数】
● streamType:视频流类型,具体请参见
HRTCStreamType。
● width:视频宽度。
● height:视频高度。
● frameRate:视频帧率。
● minFrameRate:视频最小帧率。
● bitrate:视频码率。
● minBitrate:视频最小码率。
● disableAdjustRes:禁用分辨率自适应标志。
【返回参数】
HRTCVideoEncParam类对象。
public HRTCStreamType
getStreamType(); 【功能说明】
获取视频流类型。
【请求参数】
无
【返回参数】
视频流类型,具体参见HRTCStreamType。
public void
setStreamType(HRTCStrea mType streamType);
【功能说明】
设置视频流类型。
【请求参数】
streamType:流类型,具体请参见
HRTCStreamType。
【返回参数】
视频流类型,具体参见HRTCStreamType。
表3-36 不同分辨率下帧率和码率的推荐值
分辨率 分辨率类 型
比例 最小帧率
(fps) 最大帧率
(fps) 最小码 率
最大码 率 800 X 450 FHD 16:9 10 30 300 2100 960 X 540 FHD 16:9 10 30 400 2400 1120 X 630 FHD 16:9 10 30 450 2800 1280 X 720 FHD 16:9 10 30 500 4000 120 X 90 LD 4:3 10 30 64 240 160 X 120 SD 4:3 10 30 64 270 240 X 180 SD 4:3 10 30 80 450 320 X 240 HD 4:3 10 30 100 600 400 X 300 HD 4:3 10 30 200 900 480 X 360 HD 4:3 10 30 200 1000 640 X 480 FHD 4:3 10 30 250 1800 960 X 720 FHD 4:3 10 30 450 3000
表3-37 不同场景下帧率和码率的推荐值
分辨率 推荐帧率 通信场景推荐码率 直播场景推荐码率
160 X 90 15 90 180
320 X 180 15 200 400
480 X 270 15 350 700
640 X 360 15 450 900
640 X 360 30 850 1700
800 X 450 15 700 1400
800 X 450 30 1050 2100
960 X 540 15 850 1700
960 X 540 30 1200 2400
1120 X 630 15 950 1900
1120 X 630 30 1400 2800
1280 X 720 15 1200 2400
1280 X 720 30 2000 4000
120 X 90 15 80 160
分辨率 推荐帧率 通信场景推荐码率 直播场景推荐码率
160 X 120 15 90 180
240 X 180 15 150 300
320 X 240 15 200 400
400 X 300 15 300 600
480 X 360 15 350 700
480 X 360 30 500 1000
640 X 480 15 600 1200
640 X 480 30 900 1800
960 X 720 15 1000 2000
960 X 720 30 1500 3000
HRTCLocalVideoStats
表3-38 本地视频流信息详情
属性 类型 描述
width int 视频宽
height int 视频高
bitRate int 视频码率
frameRate int 视频帧率,单位:fps packetLoss int 视频丢包率
delay int 时延,单位:ms
jitter int 抖动
bytes long 字节数
sendFrameRat
e int 实际发送帧率,单位:fps
HRTCLocalAudioStats
表3-39 本地音频流信息详情
属性 类型 描述
sampleRate int 音频采样率 channels int 音频频道数 sendVEL int 发送语音电平 bitRate int 音频码率 packetLoss int 音频丢包率
delay int 时延,单位:ms
jitter int 抖动
bytes long 字节数
HRTCRemoteVideoStats
表3-40 远端视频流信息详情
属性 类型 描述
userId String 远端用户userId
width int 视频宽
height int 视频高
bitRate int 视频码率
frameRate int 视频帧率,单位:fps packetLoss int 视频丢包率
delay int 时延,单位:ms
jitter int 抖动
bytes long 字节数
rendererOutp
utFrameRate int 渲染帧率,单位:fps totalFrozenTi
me int 远端用户在加入房间后到离开房间前,发生视频
卡顿的累计时长,单位:ms
frozenRate int 远端用户在加入房间后到离开房间前,发生视频 卡顿的累计时长占视频总有效时长的百分比,单 位:%
HRTCRemoteAudioStats
表3-41 远端音频流信息详情
属性 类型 描述
userId String 远端用户ID sampleRate int 音频采样率 channels int 音频频道数 recvVEL int 接收语音电平 bitRate int 音频码率 packetLoss int 音频丢包率
delay int 时延,单位:ms
jitter int 抖动
bytes long 字节数
totalFrozenTi
me int 远端用户在加入房间后到离开房间前,发生音频
卡顿的累计时长,单位:ms
frozenRate int 远端用户在加入房间后到离开房间前,发生音频 卡顿的累计时长占音频总有效时长的百分比,单 位:%
HRTCConnectInfo
表3-42 跨房信息
属性 类型 描述
roomId String 跨房房间号 role
HRTCRoleTyp
e
跨房时角色,具体请参见HRTCRoleType。HRTCVideoFrame
表3-43 视频帧
属性 类型 描述
format
HRTCVideoFr
ameFormat
支持的视频格式 videoData byte[] 视频数据属性 类型 描述
width int 宽度,图像宽度,作为输入时,范围为 [90,1920],必须是4的整数倍
height int 高度,图像高度,作为输入时,范围为 [90,1200],必须是2的整数倍
HRTCFrameBuffer
表3-44 媒体帧数据
属性 类型 描述
mediaType HRTCMediaTy
pe 媒体帧类型
buffer ByteBuffer 媒体数据
HRTCLogLevel
表3-45 日志级别
枚举值 描述
HRTC_LOG_LEVEL_ERROR 错误级别日志 HRTC_LOG_LEVEL_WARNI
NG 警告级别日志
HRTC_LOG_LEVEL_INFO 信息级别日志 HRTC_LOG_LEVEL_DEBUG 调试级别日志
HRTCMediaType
表3-46 媒体类型
枚举值 描述
HRTC_MEDIA_TYPE_AUDI
O 音频,暂不支持
HRTC_MEDIA_TYPE_VIDEO 音频+视频
HRTCSpeakerModel
表3-47 声音播放模式
枚举值 描述
HRTC_SPEAKER_MODE_EA
RPIECE 听筒模式
HRTC_SPEAKER_MODE_SP
EAKER 外放模式
HRTCAudioRoute
表3-48 音频路由
枚举值 描述
HRTC_AUDIO_ROUTE_SPE
AKER 外放模式
HRTC_AUDIO_ROUTE_BLU
ETOOTH 蓝牙模式
HRTC_AUDIO_ROUTE_REC
EIVER 听筒模式
HRTC_AUDIO_ROUTE_HEA
DSET 耳机模式
HRTCStreamType
表3-49 流类型
枚举值 描述
HRTC_STREAM_TYPE_LD 流畅 HRTC_STREAM_TYPE_SD 标清 HRTC_STREAM_TYPE_HD 高清 HRTC_STREAM_TYPE_FHD 全高清
HRTCRoleType
表3-50 用户角色
枚举值 描述
HRTC_ROLE_TYPE_JOINER 双向流角色,例如主播加入 HRTC_ROLE_TYPE_PLAYER 接收流角色,例如观众
HRTCVideoDisplayMode
表3-51 图像填充模式
枚举值 描述
HRTC_VIDEO_DISPLAY_M
ODE_FIT (不拉伸)黑边模式,通过扩边的方式保持宽高比。
HRTC_VIDEO_DISPLAY_M
ODE_HIDDEN (不拉伸)裁剪模式,通过裁剪的方式保持宽高比。
HRTC_VIDEO_DISPLAY_M
ODE_FILL 视频尺寸进行缩放和拉伸以充满显示视窗。
HRTCConnStateTypes
表3-52 网络连接状态
枚举值 描述
HRTC_CONN_DISCONNEC
TED 连接断开
HRTC_CONN_CONNECTIN
G 建立网络连接中
HRTC_CONN_CONNECTED 网络连接成功 HRTC_CONN_RECONNETI
NG 重新建立网络连接中
HRTC_CONN_FAILED 网络连接失败 HRTC_CONN_LOST 网络连接异常 HRTC_CONN_INTERRUPTE
D 网络连接中断
HRTCConnChangeReason
表3-53 网络连接状态变化原因
枚举值 描述
HRTC_CONN_CHANGED_C
ONNECTING 正在连接
HRTC_CONN_CHANGED_J
OIN_SUCCESS 加入房间成功 HRTC_CONN_CHANGED_R
ECONNECTING 重连中 HRTC_CONN_CHANGED_R
ECONNECT_SUCCESS 重连成功 HRTC_CONN_CHANGED_J
OIN_FAILED 加入房间失败 HRTC_CONN_CHANGED_R
ECONNCET_FAILED 重连失败 HRTC_CONN_CHANGED_I
NTERRUPTED 连接中断 HRTC_CONN_CHANGED_K
EEP_ALIVE_TIMEOUT 心跳超时 HRTC_CONN_CHANGED_L
EAVE_ROOM 主动离开房间 HRTC_CONN_CHANGED_J
OIN_ROOM_SERVER_ERR OR
服务器异常
HRTC_CONN_CHANGED_S
FU_BREAKDOWN sfu服务故障 HRTC_CONN_CHANGED_J
OIN_ROOM_AUTH_FAILED 鉴权失败,appId或者签名错误 HRTC_CONN_CHANGED_J
OIN_ROOM_AUTH_RETRY 鉴权失败,重试 HRTC_CONN_CHANGED_J
OIN_ROOM_AUTH_CLOCK _SYNC
鉴权时间戳校验失败
HRTC_CONN_CHANGED_J OIN_ROOM_URL_NOT_RIG HT
URL错误 400
HRTC_CONN_CHANGED_J OIN_ROOM_SERVICE_UNR EACHABLE
服务不可达503
枚举值 描述 HRTC_CONN_CHANGED_I
NTERNAL_ERROR 内部错误 HRTC_CONN_CHANGED_K
ICKED_OFF 被踢出房间 HRTC_CONN_CHANGED_S
IGNATURE_EXPIRED 签名过期 HRTC_CONN_REASON_US
ER_REMOVED 用户移除 HRTC_CONN_REASON_RO
OM_DISMISSED 房间解散 HRTC_CONN_CHANGED_R
EGION_NOT_COVERED 区域未覆盖,所在区域不能提供RTC服务。
HRTC_CONN_CHANGED_L
OST 连接异常
HRTCRotationType
表3-54 旋转类型
枚举值 描述
HRTC_ROTATION_TYPE_0 不旋转
HRTC_ROTATION_TYPE_90 顺时针旋转90度 HRTC_ROTATION_TYPE_18
0 顺时针旋转180度
HRTC_ROTATION_TYPE_27
0 顺时针旋转270度
HRTCVideoFrameFormat
表3-55 视频帧格式
枚举值 描述
HRTC_VIDEO_FRAME_FOR
MAT_YUV420P YUV420 格式 HRTC_VIDEO_IMAGE_FOR
MAT_RGBA RGBA格式
枚举值 描述 HRTC_VIDEO_IMAGE_FOR
MAT_2D texture2d格式
HRTCVideoImageBufferType
表3-56 视频帧缓冲区类型
枚举值 描述
HRTC_VIDEO_IMAGE_BUF
FER_BYTE_ARRAY Array类型,对应HRTCVideoFrameFormat中的 YUV、RGBA格式
HRTCLeaveReason
表3-57 离开房间原因
枚举值 描述
HRTC_LEAVE_REASON_US
ER_LEAVE_ROOM 用户主动离开 HRTC_LEAVE_REASON_SE
RVER_ERROR 服务器异常 HRTC_LEAVE_REASON_BR
EAKDOWN sfu服务故障 HRTC_LEAVE_REASON_SE
RVICE_UNREACHABLE 服务不可达 HRTC_LEAVE_REASON_INT
ERNAL_ERROR 内部错误 HRTC_LEAVE_REASON_KIC
KED_OFF 被踢
HRTC_LEAVE_REASON_SIG
NATURE_EXPIRED 签名过期 HRTC_LEAVE_REASON_RE
CONNECT_FAILED 重连超时
HRTCVideoMirrorType
表3-58 视频镜像类型
枚举值 描述
HRTC_VIDEO_MIRROR_TY
PE_AUTO SDK决定镜像方式:前置摄像头镜像,后置摄像头不 镜像
HRTC_VIDEO_MIRROR_TY
PE_ENABLE 前置摄像头和后置摄像头都镜像 HRTC_VIDEO_MIRROR_TY
PE_DISABLE 前置摄像头和后置摄像头都不镜像
HRTCRemoteAudioStreamStateReason
表3-59 远端音频状态变化原因
枚举值 描述
HRTC_REMOTE_AUDIO_RE
ASON_REMOTE_OFFLINE 远端用户离线 HRTC_REMOTE_AUDIO_RE
ASON_REMOTE_MUTED 远端用户停止音频流发送 HRTC_REMOTE_AUDIO_RE
ASON_REMOTE_UNMUTE D
远端用户开启音频流发送
HRTCRemoteAudioStreamState
表3-60 远端音频状态
枚举值 描述
HRTC_REMOTE_VIDEO_ST
ATE_STOPPED 远端音频流关闭发送 HRTC_REMOTE_AUDIO_ST
ATE_STARTING 远端音频流开启发送
HRTCRemoteVideoStreamState
表3-61 远端视频状态
枚举值 描述
HRTC_REMOTE_VIDEO_ST
ATE_STOPPED 远端视频流关闭发送 HRTC_REMOTE_VIDEO_ST
ATE_STARTING 远端视频流开启发送
HRTCRemoteVideoStreamStateReason
表3-62 远端视频状态变化原因
枚举值 描述
HRTC_REMOTE_VIDEO_RE
ASON_REMOTE_OFFLINE 远端用户离线 HRTC_REMOTE_VIDEO_RE
ASON_REMOTE_MUTED 远端用户停止视频流发送 HRTC_REMOTE_VIDEO_RE
ASON_REMOTE_UNMUTE D
远端用户开启视频流发送
HRTC_REMOTE_VIDEO_RE
ASON_LOCAL_MUTED 本端已取消选看远端视频流 HRTC_REMOTE_VIDEO_RE
ASON_LOCAL_UNMUTED 本端已开启选看远端视频流
HRTCVolumeInfo
表3-63 发言人音量
属性 类型 描述
roomId String 房间ID userId String 用户ID
volume int 音量
HRTCNetworkTestConfig
表3-64 网络探测参数
属性 类型 描述
userId String 必选,用户ID
roomId String 房间ID,必选,建议值:userId+随机数拼接 signature String 签名,开启签名鉴权必选,否则可选
ctime long 时间戳,开启签名鉴权必选,否则可选 enableUplink
Test boolean 必选,是否开启上行流探测 enableDownli
nkTest boolean 必选,是否开启上行流探测 expectedUplin
kBitrate int 必选,用户期望的最高发送码率,单位为bps,范 围为0以及 [100000, 5000000],设为0表示由 SDK指定最高码率
expectedDow
nlinkBitrate int 必选,用户期望的最高接收码率,单位为bps,范 围为0以及 [100000, 5000000],设为0表示由 SDK指定最高码率
HRTCNetworkTestResult
表3-65 网络探测结果数据
属性 类型 描述