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, StartMCUMixTranscodeByStrRoomId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
AudioSampleRate | Integer | 是 | 混流-输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000],单位是Hz。 |
AudioBitrate | Integer | 是 | 混流-输出流音频码率。取值范围[8,500],单位为kbps。 |
AudioChannels | Integer | 是 | 混流-输出流音频声道数,取值范围[1,2],1表示混流输出音频为单声道,2表示混流输出音频为双声道。 |
VideoWidth | Integer | 否 | 混流-输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。 |
VideoHeight | Integer | 否 | 混流-输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。 |
VideoBitrate | Integer | 否 | 混流-输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。 |
VideoFramerate | Integer | 否 | 混流-输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。 |
VideoGop | Integer | 否 | 混流-输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。 |
BackgroundColor | Integer | 否 | 混流-输出流背景色,取值是十进制整数。常用的颜色有: 红色:0xff0000,对应的十进制整数是16724736。 黄色:0xffff00。对应的十进制整数是16776960。 绿色:0x33cc00。对应的十进制整数是3394560。 蓝色:0x0066ff。对应的十进制整数是26367。 黑色:0x000000。对应的十进制整数是0。 白色:0xFFFFFF。对应的十进制整数是16777215。 灰色:0x999999。对应的十进制整数是10066329。 |
BackgroundImageId | Integer | 否 | 混流-输出流背景图片,取值为实时音视频控制台上传的图片ID。 |
AudioCodec | Integer | 否 | 混流-输出流音频编码类型,取值范围[0,1, 2],0为LC-AAC,1为HE-AAC,2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时,只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000] |
BackgroundImageUrl | String | 否 | 混流-输出流背景图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。BackgroundImageUrl和BackgroundImageId参数都填时,以BackgroundImageUrl为准。图片大小限制不超过2MB。 |
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, StartMCUMixTranscodeByStrRoomId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Template | Integer | 否 | 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 |
MainVideoUserId | String | 否 | 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 |
MainVideoStreamType | Integer | 否 | 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 |
SmallVideoLayoutParams | SmallVideoLayoutParams | 否 | 画中画模板中有效,代表小画面的布局参数。 |
MainVideoRightAlign | Integer | 否 | 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 |
MixVideoUids | Array of String | 否 | 悬浮模板、九宫格、屏幕分享模板有效。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。最多可设置16个用户。 |
PresetLayoutConfig | Array of PresetLayoutConfig | 否 | 自定义模板中有效,指定用户视频在混合画面中的位置。 |
PlaceHolderMode | Integer | 否 | 自定义模板中有效,设置为1时代表启用占位图功能,0时代表不启用占位图功能,默认为0。启用占位图功能时,在预设位置的用户没有上行视频时可显示对应的占位图。 |
PureAudioHoldPlaceMode | Integer | 否 | 悬浮模板、九宫格、屏幕分享模板生效,用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式,悬浮小画面占布局位置,九宫格画面占布局位置、屏幕分享小画面不占布局位置;设置为1时代表纯音频上行占布局位置;设置为2时代表纯音频上行不占布局位置。默认为0。 |
WaterMarkParams | WaterMarkParams | 否 | 水印参数。 |
OneSdkAppIdTranscodeTimeUsagesInfo
旁路转码时长的查询结果
被如下接口引用:DescribeTrtcMcuTranscodeTime。
名称 | 类型 | 描述 |
---|---|---|
SdkAppIdTranscodeTimeUsages | Array of SdkAppIdTrtcMcuTranscodeTimeUsage | 旁路转码时长查询结果数组 |
TotalNum | Integer | 查询记录数量 |
SdkAppId | String | 所查询的应用ID,可能值为:1-应用的应用ID,2-total,显示为total则表示查询的是所有应用的用量合计值。 |
OutputParams
MCU混流的输出参数
被如下接口引用:StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
StreamId | String | 是 | 直播流 ID,由用户自定义设置,该流 ID 不能与用户旁路的流 ID 相同。 |
PureAudioStream | Integer | 否 | 取值范围[0,1], 填0:直播流为音视频(默认); 填1:直播流为纯音频 |
RecordId | String | 否 | 自定义录制文件名称前缀。请先在实时音视频控制台开通录制功能,https://cloud.tencent.com/document/product/647/50768 |
RecordAudioOnly | Integer | 否 | 取值范围[0,1],填0无实际含义; 填1:指定录制文件格式为mp3。此参数不建议使用,建议在实时音视频控制台配置纯音频录制模板。 |
PictureInfo
图片列表信息
被如下接口引用:DescribePicture。
名称 | 类型 | 描述 |
---|---|---|
Height | Integer | 图片长度 |
Width | Integer | 图片宽度 |
XPosition | Integer | 显示位置x轴方向 |
YPosition | Integer | 显示位置y轴方向 |
SdkAppId | Integer | 应用id |
PictureId | Integer | 图片id |
PresetLayoutConfig
自定义模板中有效,指定用户视频在混合画面中的位置。
被如下接口引用:StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
UserId | String | 否 | 指定显示在该画面上的用户ID。如果不指定用户ID,会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。 |
StreamType | Integer | 否 | 当该画面指定用户时,代表用户的流类型。0为摄像头,1为屏幕分享。小画面为web用户时此值填0。 |
ImageWidth | Integer | 否 | 该画面在输出时的宽度,单位为像素值,不填默认为0。 |
ImageHeight | Integer | 否 | 该画面在输出时的高度,单位为像素值,不填默认为0。 |
LocationX | Integer | 否 | 该画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。 |
LocationY | Integer | 否 | 该画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。 |
ZOrder | Integer | 否 | 该画面在输出时的层级,不填默认为0。 |
RenderMode | Integer | 否 | 该画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底。不填默认为0。 |
MixInputType | Integer | 否 | 该当前位置用户混入的流类型:0为混入音视频,1为只混入视频,2为只混入音频。默认为0,建议配合指定用户ID使用。 |
PlaceImageId | Integer | 否 | 占位图ID。启用占位图功能时,在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M,在实时音视频控制台上传并生成,https://cloud.tencent.com/document/product/647/50769 |
PublishCdnParams
第三方CDN转推参数
被如下接口引用:StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
BizId | Integer | 是 | 腾讯云直播BizId。 |
PublishCdnUrls | Array of String | 是 | 第三方CDN转推的目的地址,同时只支持转推一个第三方CDN地址。 |
QualityData
Es返回的质量数据
被如下接口引用:DescribeCallDetail。
名称 | 类型 | 描述 |
---|---|---|
Content | Array of TimeValue | 数据内容 |
UserId | String | 用户ID |
PeerId | String | 对端Id,为空时表示上行数据 注意:此字段可能返回 null,表示取不到有效值。 |
DataType | String | 数据类型 |
RecordUsage
录制的使用信息。
被如下接口引用:DescribeRecordStatistic。
名称 | 类型 | 描述 |
---|---|---|
TimeKey | String | 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。 |
Class1VideoTime | Integer | 视频时长-标清SD,单位:秒。 |
Class2VideoTime | Integer | 视频时长-高清HD,单位:秒。 |
Class3VideoTime | Integer | 视频时长-超清HD,单位:秒。 |
AudioTime | Integer | 语音时长,单位:秒。 |
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,表示取不到有效值。 |
SdkAppIdNewTrtcTimeUsage
SdkAppId级别实时音视频的用量数据
被如下接口引用:DescribeExternalTrtcMeasure。
名称 | 类型 | 描述 |
---|---|---|
SdkAppId | String | SdkAppId的值。 |
TrtcTimeUsages | Array of TrtcTimeNewUsage | 统计的时间点数据。 |
AudienceTrtcTimeUsages | Array of TrtcTimeNewUsage | 统计的麦下用量的时间点数据。 |
SdkAppIdRecordUsage
SdkAppId级别录制时长数据。
被如下接口引用:DescribeRecordStatistic。
名称 | 类型 | 描述 |
---|---|---|
SdkAppId | String | SdkAppId的值。 |
Usages | Array of RecordUsage | 统计的时间点数据。 |
SdkAppIdTrtcMcuTranscodeTimeUsage
查询旁路转码计费时长。
查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。
被如下接口引用:DescribeTrtcMcuTranscodeTime。
名称 | 类型 | 描述 |
---|---|---|
TimeKey | String | 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。 |
AudioTime | Integer | 语音时长,单位:秒。 |
VideoTimeSd | Integer | 视频时长-标清SD,单位:秒。 |
VideoTimeHd | Integer | 视频时长-高清HD,单位:秒。 |
VideoTimeFhd | Integer | 视频时长-全高清FHD,单位:秒。 |
SmallVideoLayoutParams
画中画模板中有效,代表小画面的布局参数
被如下接口引用:StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
UserId | String | 是 | 代表小画面对应的用户ID。 |
StreamType | Integer | 是 | 代表小画面对应的流类型,0为摄像头,1为屏幕分享。小画面为web用户时此值填0。 |
ImageWidth | Integer | 否 | 小画面在输出时的宽度,单位为像素值,不填默认为0。 |
ImageHeight | Integer | 否 | 小画面在输出时的高度,单位为像素值,不填默认为0。 |
LocationX | Integer | 否 | 小画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。 |
LocationY | Integer | 否 | 小画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。 |
TimeValue
返回的质量数据,时间:值
被如下接口引用:DescribeCallDetail。
名称 | 类型 | 描述 |
---|---|---|
Time | Integer | 时间,unix时间戳(1590065877s) |
Value | Float | 当前时间返回参数取值,如(bigvCapFps在1590065877取值为0,则Value:0 ) |
TrtcTimeNewUsage
实时音视频用量的某一时间段的统计信息.
被如下接口引用:DescribeExternalTrtcMeasure。
名称 | 类型 | 描述 |
---|---|---|
TimeKey | String | 时间点。 |
VoiceUserNum | Integer | 通话人数。仅供参考。在线人数以仪表盘查询结果为准。 |
VideoTime | Integer | 音视频通话时长。单位:秒。 |
Class1VideoTime | Integer | 标清视频通话时长。单位:秒。 |
Class2VideoTime | Integer | 高清视频通话时长。单位:秒。 |
Class3VideoTime | Integer | 超高清视频通话时长。单位:秒。 |
AudioTime | Integer | 音频通话时长。单位:秒。 |
Bandwidth | Float | 带宽。单位:Mbps。 |
Video2KTime | Integer | 2k视频通话时长。单位:秒。 |
Video4KTime | Integer | 4k视频通话时长。单位:秒。 |
UserInformation
用户信息,包括用户进房时间,退房时间等
被如下接口引用:DescribeCallDetail, DescribeUserInformation。
名称 | 类型 | 描述 |
---|---|---|
RoomStr | String | 房间号 |
UserId | String | 用户Id |
JoinTs | Integer | 用户进房时间 |
LeaveTs | Integer | 用户退房时间,用户没有退房则返回当前时间 |
DeviceType | String | 终端类型 |
SdkVersion | String | Sdk版本号 |
ClientIp | String | 客户端IP地址 |
Finished | Boolean | 判断用户是否已经离开房间 |
WaterMarkParams
MCU混流水印参数
被如下接口引用:StartMCUMixTranscode, StartMCUMixTranscodeByStrRoomId。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
WaterMarkId | Integer | 是 | 混流-水印图片ID。取值为实时音视频控制台上传的图片ID。 |
WaterMarkWidth | Integer | 是 | 混流-水印宽。单位为像素值。水印宽+X偏移不能超过整个画布宽。 |
WaterMarkHeight | Integer | 是 | 混流-水印高。单位为像素值。水印高+Y偏移不能超过整个画布高。 |
LocationX | Integer | 是 | 水印在输出时的X偏移。单位为像素值。水印宽+X偏移不能超过整个画布宽。 |
LocationY | Integer | 是 | 水印在输出时的Y偏移。单位为像素值。水印高+Y偏移不能超过整个画布高。 |
WaterMarkUrl | String | 否 | 混流-水印图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。WaterMarkUrl和WaterMarkId参数都填时,以WaterMarkUrl为准。图片大小限制不超过2MB。 |