数据结构

最近更新时间:2020-07-02 08:21:04

AbnormalEvent

造成异常体验可能的异常事件类型

被如下接口引用:DescribeAbnormalEvent。

名称 类型 描述
AbnormalEventId Integer 异常事件ID,具体值查看附录:异常体验ID映射表:https://cloud.tencent.com/document/product/647/44916
PeerId String 远端用户ID,"":表示异常事件不是由远端用户产生
注意:此字段可能返回 null,表示取不到有效值。

AbnormalExperience

用户的异常体验及可能的原因

被如下接口引用:DescribeAbnormalEvent。

名称 类型 描述
UserId String 用户ID
ExperienceId Integer 异常体验ID
RoomId String 字符串房间号
AbnormalEventList Array of AbnormalEvent 异常事件数组
EventTime Integer 异常事件的上报时间

EncodeParams

MCU混流输出流编码参数

被如下接口引用:StartMCUMixTranscode。

名称 类型 必选 描述
AudioSampleRate Integer 混流-输出流音频采样率。取值为[96000, 88200, 64000, 48000, 44100, 32000,24000, 22050, 16000, 12000, 11025, 8000]。
AudioBitrate Integer 混流-输出流音频码率。取值范围[8,500],单位为Kbps。
AudioChannels Integer 混流-输出流音频声道数,取值范围[1,2]。
VideoWidth Integer 混流-输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。
VideoHeight Integer 混流-输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。
VideoBitrate Integer 混流-输出流码率,音视频输出时必填。取值范围[1,10000],单位为Kbps。
VideoFramerate Integer 混流-输出流帧率,音视频输出时必填。取值为[6,12,15,24,30,48,60],不在上述帧率值内系统会自动调整。
VideoGop Integer 混流-输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。
BackgroundColor Integer 混流-输出流背景色。
BackgroundImageId Integer 混流-输出流背景图片,取值为实时音视频控制台上传的图片ID。

EventList

sdk或webrtc的事件列表。

被如下接口引用:DescribeDetailEvent。

名称 类型 描述
Content Array of EventMessage 数据内容
PeerId String 发送端的userId

EventMessage

事件信息,包括,事件时间戳,事件ID,

被如下接口引用:DescribeDetailEvent。

名称 类型 描述
Type Integer 视频流类型:
0:与视频无关的事件;
2:视频为大画面;
3:视频为小画面;
7:视频为旁路画面;
Time Integer 事件上报的时间戳,unix时间(1589891188801ms)
EventId Integer 事件Id:分为sdk的事件和webrtc的事件,详情见:附录/事件 ID 映射表:https://cloud.tencent.com/document/product/647/44916
ParamOne Integer 事件的第一个参数,如视频分辨率宽
ParamTwo Integer 事件的第二个参数,如视频分辨率高

LayoutParams

MCU混流布局参数

被如下接口引用:StartMCUMixTranscode。

名称 类型 必选 描述
Template Integer 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板
MainVideoUserId String 屏幕分享模板中有效,代表左侧大画面对应的用户ID
MainVideoStreamType Integer 屏幕分享模板中有效,代表左侧大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0

OutputParams

MCU混流的输出参数

被如下接口引用:StartMCUMixTranscode。

名称 类型 必选 描述
StreamId String 直播流 ID,由用户自定义设置,该流 ID 不能与用户旁路的流 ID 相同。
PureAudioStream Integer 取值范围[0,1], 填0:直播流为音视频(默认); 填1:直播流为纯音频
RecordId String 自定义录制文件名
RecordAudioOnly Integer 取值范围[0,1],填0无实际含义; 填1:指定录制文件格式为mp3

QualityData

Es返回的质量数据

被如下接口引用:DescribeCallDetail。

名称 类型 描述
Content Array of TimeValue 数据内容
UserId String 用户ID
PeerId String 对端Id,为空时表示上行数据
注意:此字段可能返回 null,表示取不到有效值。
DataType String 数据类型

RealtimeData

查询秒级监控返回的数据

被如下接口引用:DescribeRealtimeNetwork、DescribeRealtimeQuality、DescribeRealtimeScale。

名称 类型 描述
Content Array of TimeValue 返回的数据
注意:此字段可能返回 null,表示取不到有效值。
DataType String 数据类型字段

RoomState

房间信息列表

被如下接口引用:DescribeRoomInformation。

名称 类型 描述
CommId String 通话ID(唯一标识一次通话)
RoomString String 房间号
CreateTime Integer 房间创建时间
DestroyTime Integer 房间销毁时间
IsFinished Boolean 房间是否已经结束
UserId String 房间创建者Id

ScaleInfomation

历史规模信息

被如下接口引用:DescribeHistoryScale。

名称 类型 描述
Time Integer 每天开始的时间
UserNumber Integer 房间人数,用户重复进入同一个房间为1次
注意:此字段可能返回 null,表示取不到有效值。
UserCount Integer 房间人次,用户每次进入房间为一次
注意:此字段可能返回 null,表示取不到有效值。
RoomNumbers Integer sdkappid下一天内的房间数
注意:此字段可能返回 null,表示取不到有效值。

TimeValue

返回的质量数据,时间:值

被如下接口引用:DescribeCallDetail、DescribeRealtimeNetwork、DescribeRealtimeQuality、DescribeRealtimeScale。

名称 类型 描述
Time Integer 时间
Value Float 当前时间取值,unix时间戳

UserInformation

用户信息,包括用户进房时间,退房时间等

被如下接口引用:DescribeCallDetail。

名称 类型 描述
RoomStr String 房间号
UserId String 用户Id
JoinTs Integer 用户进房时间
LeaveTs Integer 用户退房时间
DeviceType String 终端类型
SdkVersion String Sdk版本号
ClientIp String 客户端IP地址
Finished Boolean 判断用户是否已经离开房间
目录