数据结构

最近更新时间：2025-03-28 01:45:17

本页目录：

BackupStreamDetailData

主备流详细信息。

被如下接口引用：DescribeBackupStreamList。

名称	类型	描述
DomainName	String	推流域名。示例值：5000.livepush.com
AppName	String	推流路径。示例值：live
PublishTime	String	UTC 格式，例如：2018-06-29T19:00:00Z。注意：和北京时间相差8小时。示例值：2018-06-29T19:00:00Z
UpstreamSequence	String	推流唯一标识。示例值：710313341080024599
SourceFrom	String	推流来源。示例：直推流；拉流转推(1234)；注意：拉流转推来源括号中为拉流转推的任务 ID。示例值：直推流
MasterFlag	Integer	主备标识。当前流为主流：1，当前流为备流: 0。示例值：0

BackupStreamGroupInfo

主备流分组信息。

被如下接口引用：DescribeBackupStreamList。

名称	类型	描述
StreamName	String	流名称。示例值：stream1
BackupList	Array of BackupStreamDetailData	主备流信息。
OptimalEnable	Integer	是否对该流开启了择优调度。 0 - 未开启。 1 - 已开启。示例值：0
HostGroupName	String	域名分组的分组名称。示例值：groupname

BandwidthInfo

带宽信息

被如下接口引用：DescribeDeliverBandwidthList。

名称	类型	描述
Time	String	返回格式：使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。根据粒度会有不同程度的缩减。示例值：2022-11-06T16:50:00+08:00
Bandwidth	Float	带宽。示例值：0.01

BatchDomainOperateErrors

批量操作域名相关接口，若其中个别域名操作失败将会跳过，相应的域名错误信息将统一汇总在此类型中

被如下接口引用：ModifyLiveDomainCertBindings。

名称	类型	描述
DomainName	String	操作失败的域名。示例值：domain.com
Code	String	API3.0错误码。示例值：invalid
Message	String	API3.0错误信息。示例值：invalid

BillAreaInfo

海外分区直播带宽出参，分区信息

被如下接口引用：DescribeAreaBillBandwidthAndFluxList。

名称	类型	描述
Name	String	大区名称。示例值：中东/非洲
Countrys	Array of BillCountryInfo	国家或地区明细数据。

BillCountryInfo

海外分区直播带宽出参国家带宽信息

被如下接口引用：DescribeAreaBillBandwidthAndFluxList。

名称	类型	描述
Name	String	国家名称示例值：阿联酋
BandInfoList	Array of BillDataInfo	带宽明细数据信息。

BillDataInfo

带宽和流量信息。

被如下接口引用：DescribeAreaBillBandwidthAndFluxList, DescribeBillBandwidthAndFluxList, DescribePushBandwidthAndFluxList。

名称	类型	描述
Time	String	时间点，使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2022-11-14T16:40:00+08:00
Bandwidth	Float	带宽，单位是 Mbps。示例值：0.1
Flux	Float	流量，单位是 MB。示例值：0.1
PeakTime	String	峰值时间点，使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。原始数据为5分钟粒度，如果查询小时和天粒度数据，则返回对应粒度内的带宽峰值时间点。示例值：2022-11-14T16:40:00+08:00

CallBackRuleInfo

规则信息

被如下接口引用：DescribeLiveCallbackRules。

名称	类型	描述
CreateTime	String	规则创建时间。注：此字段为北京时间（UTC+8时区）。示例值：2022-05-16T10:59:38+08:00
UpdateTime	String	规则更新时间。注：此字段为北京时间（UTC+8时区）。示例值：2022-05-17T14:33:50+08:00
TemplateId	Integer	模板 ID。示例值：385622
DomainName	String	推流域名。示例值：7895.livepush.myqcloud.com
AppName	String	推流路径。示例值：trtc_140042

CallBackTemplateInfo

回调模板信息。

被如下接口引用：DescribeLiveCallbackTemplate, DescribeLiveCallbackTemplates。

名称	类型	描述
TemplateId	Integer	模板 ID。示例值：1
TemplateName	String	模板名称。示例值：回调模板1
Description	String	描述信息。示例值：场景1回调模版配置
StreamBeginNotifyUrl	String	开播回调 URL。示例值：http://abc.com/abc
StreamMixNotifyUrl	String	混流回调 URL。(参数已弃用)。
StreamEndNotifyUrl	String	断流回调 URL。示例值：http://abc.com/abc
RecordNotifyUrl	String	录制文件回调 URL。示例值：http://abc.com/abc
SnapshotNotifyUrl	String	截图回调 URL。示例值：http://abc.com/abc
PornCensorshipNotifyUrl	String	鉴黄回调 URL。示例值：http://abc.com/abc
CallbackKey	String	回调的鉴权 key。示例值：def
PushExceptionNotifyUrl	String	推流异常回调 URL。注意：此字段可能返回 null，表示取不到有效值。示例值：http://abc.com/abc
AudioAuditNotifyUrl	String	音频审核回调 URL。注意：此字段可能返回 null，表示取不到有效值。示例值：http://domain.com/path
RecordExceptionNotifyUrl	String	录制异常回调 URL。示例值：http://domain.com/path
RecordExceptionLevels	Array of String	录制异常回调级别，可选择：error: 错误。alarm: 告警。示例值：["error"]

CallbackEventInfo

回调事件信息

被如下接口引用：DescribeCallbackRecordsList。

名称	类型	描述
EventTime	String	事件时间。接口返回支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 ISO 日期格式说明 2）yyyy-MM-dd HH:mm:ss：使用此格式时，默认代表北京时间。接口返回的时间格式和查询请求传入的时间格式一致。示例值：2020-10-12T00:00:00+08:00
EventType	Integer	事件类型。示例值：1
Request	String	回调请求。示例值：request body
Response	String	回调响应。示例值：response body
ResponseTime	String	客户接口响应时间。接口返回支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见 ISO 日期格式说明 2）yyyy-MM-dd HH:mm:ss：使用此格式时，默认代表北京时间。接口返回的时间格式和查询请求传入的时间格式一致。示例值：2020-10-12T00:00:00+08:00
ResultCode	Integer	回调结果。示例值：1
StreamId	String	流名称。示例值：stream1

CasterBriefInfo

导播台简略信息

被如下接口引用：DescribeCasterList。

名称	类型	描述
CasterId	Integer	导播台ID 示例值：63501
CasterName	String	导播台名称示例值：example_caster_name
Description	String	导播台的描述示例值：example
StartBillingTime	Integer	开始计费时间，值为unix时间戳示例值：1740646000
StopBillingTime	Integer	结束计费时间，值为unix时间戳示例值：1740641000
CreateTime	Integer	创建时间，值为unix时间戳示例值：1740640000
Status	Integer	导播台状态 0：停止状态，无预监，无主监 1：无预监，有主监 2：有预监，无主监 3：有预监，有主监示例值：0
ExpireTime	Integer	导播台的过期时间，值为-1或unix时间戳。当值为-1时，代表永不过期。当值为特定unix时间戳时，代表过期时间为对应的时间，导播台在该时间自动停止。示例值：-1
FeeType	Integer	计费字段，该字段暂无作用示例值：0

CasterDisplayInfo

导播台展示信息，包括使用的布局、水印、字幕、转场、音频等信息

被如下接口引用：CreateCasterPgm, CreateCasterPvw, DescribeCasterDisplayInfo。

名称	类型	必选	描述
LayoutIndex	Integer	否	布局Index。如果使用自定义布局，为自定义布局下标。如果使用单输入布局，如使用输入1，则LayoutIndexType=1，且LayoutIndex=1，以此类推。示例值：1
MarkPicIndexList	Array of Integer	否	使用的水印Index列表。注：当作为入参使用时，列表中的水印Index需要已经存在。示例值：[1]
MarkWordIndexList	Array of Integer	否	使用的文字水印Index列表。注：作为入参使用时，列表中的Index需要已经存在。示例值：[1]
TransitionType	String	否	使用的转场类型。注：支持的转场类型可通过DescribeCasterTransitionTypes接口获取。示例值：heart
AudioIndexList	Array of Integer	否	使用的音频输入Index列表。注：当该字段非空时，表示使用布局中对应的输入源的视频，AudioIndexList中对应的输入源的音频。且这些输入源需已存在。示例值：[2]
InputStartType	Integer	否	作为入参时，表示使用点播输入源，单画面输入时，点播文件是否从头开始播放。默认为0。有效值，0,1。 0代表不从头播放 1代表从头播放示例值：0
LayoutIndexType	Integer	否	LayoutIndex类型，默认值:0 可选值[0,1] 0:默认类型，代表普通布局 1:单输入类型，代表单输入布局示例值：0

CasterInfo

导播台信息

被如下接口引用：DescribeCaster。

名称	类型	描述
CasterId	Integer	导播台ID 示例值：63501
CasterName	String	导播台名称示例值：example_name
StartLiveTime	Integer	导播台上一次启动pgm的时间，值为unix时间戳。示例值：0
Description	String	导播台的描述示例值：example description
CreateTime	Integer	导播台创建时间，值为unix时间戳。示例值：1603158528
Status	Integer	导播台状态 0：停止状态，无预监，无主监 1：无预监，有主监 2：有预监，无主监 3：有预监，有主监示例值：0
ExpireTime	Integer	导播台的过期时间戳。值为-1或unix时间戳。默认值为-1。当值为-1时，表示该导播台永不过期。当值为正常unix时间戳时，导播台将在该时间过期。导播台过期后，预监与主监画面将自动停止，转推自动停止。点播、直播url将停止转拉，推流url需自行停止推流。示例值：-1
DelayTime	Integer	导播台延时播放时间，单位为秒。示例值：0
PgmWidth	Integer	导播台主监输出的宽度，单位为像素。示例值：1280
PgmHeight	Integer	导播台主监输出的高度，单位为像素。示例值：720
PgmFps	Integer	导播台主监输出的帧率。示例值：25
PgmBitRate	Integer	导播台主监输出的码率，单位为kbps 示例值：2000
PgmAudioBitRate	Integer	导播台主监输出的音频码率，单位为kbps。示例值：256
FeeType	Integer	导播台的计费类型。 0 通用型 1 播单型。注：本参数暂无作用。示例值：0
RecordTemplateId	Integer	录制模板id。示例值：1
RecordStatus	Integer	录制状态。 0：未录制 1：录制中示例值：0
RecordTaskId	String	录制接口返回的taskid 示例值：UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb

CasterInputInfo

导播台输入信息参数

被如下接口引用：AddCasterInputInfo, DescribeCasterInputInfos, ModifyCasterInputInfo。

名称	类型	必选	描述
InputIndex	Integer	是	输入源Index。范围[1, 24] 示例值：1
InputType	Integer	否	输入源类型。范围[0,1,2,3,4]。 0：推流地址。 1：点播文件地址。 2：直播拉流地址。 3：图片地址。 4：webrtc协议推流地址。示例值：1
InputUrl	String	否	输入源的源地址。最大允许长度512。当InputType为0（推流地址），2（直播拉流地址），3（图片地址）,4（webrtc推流地址）这几种类型时，URL需填入该字段。示例值：http://example.domain.com/example.mp4
Description	String	否	输入源描述。最大允许长度256字符。示例值：example
InputUrls	Array of String	否	点播地址列表。仅当input type为1（点播地址）时，将一个或多个点播地址，填入该字段。单个地址最大允许长度512字符。最多允许同时填入5个地址。注：此时需保持InputUrl字段为空。示例值：["http://example.domain.com/example.mp4"]
LoopEnable	Boolean	否	是否启用点播无限循环播放。注：当前该字段未生效，默认为True。示例值：1
LoopNumber	Integer	否	点播循环次数。允许值-1或正整数。当值为-1时，表示无限循环。当值为其他正整数时，表示循环对应次数。注：该字段暂未生效。示例值：-1
PullPushEnable	Boolean	否	是否启用拉取到导播台。注：该字段默认强制为true。示例值：1
Volume	Integer	否	输入源音量百分比。默认为100。表示音量为原始大小。允许值[0,200]。示例值：100

CasterLayoutInfo

导播台布局参数。

被如下接口引用：AddCasterLayoutInfo, DescribeCasterLayoutInfos, ModifyCasterLayoutInfo。

名称	类型	必选	描述
LayoutIndex	Integer	是	布局Index。示例值：1
LayoutTemplateId	Integer	否	布局模板Id。有效值[1，20，21，31，32，41] 当使用布局模版时，无需LayoutParams参数，导播台将使用模版布局参数。示例值：21
InputIndexList	String	否	布局绑定的输入列表。按布局LayerId从小到大，按顺序排列。已有两个画面的布局为例，输入1对应LayerId为1，输入2对应的LayerId为2，该字段应该填入"1\|2"。示例值：1\|2
LayoutParams	Array of CasterLayoutParam	否	详细的布局参数列表。示例值：1
LayoutWidth	Integer	否	布局输出的宽度，单位为像素。默认为1280像素。注：该值仅在画中画布局，且未设置PgmWidth时生效。示例值：1080
LayoutHeight	Integer	否	布局输出的高度，单位为像素。注：该参数仅在画中画布局，且未设置PgmHeight时生效。示例值：1920

CasterLayoutParam

导播台布局详细参数。

被如下接口引用：AddCasterLayoutInfo, DescribeCasterLayoutInfos, ModifyCasterLayoutInfo。

名称	类型	必选	描述
LayerId	Integer	是	布局层ID。在画面最终渲染时，将按ID从小到大的顺序，由下至上渲染。示例值：1
LayerWidth	Float	是	布局层宽度。单位为百分比，范围[0.0,1.0]，表示该层在最终画面上所占的比例值。示例值：1.0
LayerHeight	Float	是	布局层高度。单位为百分比，范围[0.0,1.0]，表示该层在最终画面上所占的比例值。示例值：1.0
LayerLocationX	Float	是	布局层位置x坐标。单位为百分比，范围[0.0,1.0]，表示该层在最终画面上x坐标所占的比例值。示例值：0.0
LayerLocationY	Float	是	布局层位置Y坐标。单位为百分比，范围[0.0,1.0]，表示该层在最终画面Y坐标上所占的比例值。示例值：0.0
UsePortraitSegment	Boolean	否	是否启用抠图。示例值：False

CasterMarkPicInfo

导播台水印信息。

被如下接口引用：AddCasterMarkPicInfo, DescribeCasterMarkPicInfos, ModifyCasterMarkPicInfo。

名称	类型	必选	描述
MarkPicIndex	Integer	是	水印图片Index。示例值：1
MarkPicId	Integer	否	注：该字段已废弃。示例值：0
MarkPicWidth	Float	否	水印图片在输出时的宽度。当该值为大于1的整数值时，单位为像素，允许范围[1,1920]。当该值为小于1大于0的小数时，单位为百分比，表示水印在最终画面上所占的比例值。示例值：1.0
MarkPicHeight	Float	否	水印图片在输出时的高度。当该值为大于1的整数值时，单位为像素，允许范围[1,1080]。当该值为小于1大于0的小数时，单位为百分比，表示水印在输出上所占的比例值。示例值：1.0
MarkPicLocationX	Float	否	水印图片在输出时的X轴坐标。当该值为大于1的整数值时，单位为像素，允许范围[1,1920]。当该值为小于1大于0的小数时，单位为百分比，表示水印在最终画面上x坐标所占的比例值。示例值：0.5
MarkPicLocationY	Float	否	水印图片在输出时的Y坐标。当该值为大于1的整数值时，单位为像素，允许范围[1,1080]。当该值为小于1大于0的小数时，单位为百分比，表示水印在最终画面Y坐标上所占的比例值。示例值：0.5
MarkPicUrl	String	否	水印地址。最大长度256字符，且url需以jpg、jpeg、png、bmp、gif后缀结尾。示例值：http://www.example.com/pic.jpg
Description	String	否	水印描述。最大允许长度为256。示例值：example
IsEqualProportion	Boolean	否	是否启用了等比例缩放。注：该字段仅做状态保存，无实际效果。示例值：true

CasterMarkWordInfo

导播台文字水印配置。

被如下接口引用：AddCasterMarkWordInfo, DescribeCasterMarkWordInfos, ModifyCasterMarkWordInfo。

名称	类型	必选	描述
MarkWordIndex	Integer	是	文字水印Index。示例值：1
MarkWordText	String	否	文字水印内容。示例值：示例文字
MarkWordFontSize	Integer	否	文字水印的字号。范围[16, 60] 示例值：12
MarkWordFontColor	String	否	文字水印的颜色，值为HEX颜色代码示例值：0xffffff
MarkWordFontType	Integer	否	文字水印的字体类型。范围[1,2]。 1. 宋体 2. 黑体示例值：1
MarkWordLocationX	Float	否	文字水印的x坐标位置，单位百分比。范围[0.0, 1.0] 示例值：0.1
MarkWordLocationY	Float	否	文字水印的Y坐标位置，单位百分比。范围[0.0, 1.0] 示例值：0.1
MarkWordRollEnable	Boolean	否	是否开启文字跑马灯功能。默认为false。示例值：0
MarkWordRollOnceTime	Integer	否	跑马灯文字显示一遍的时间，单位为秒。默认为5s。范围[5, 600]。示例值：5
MarkWordRollDirection	Integer	否	跑马灯文字的方向。默认值为0。范围[0,1]。 0 从左到右 1 从右到左示例值：0
MarkWordRollStartLocationX	Float	否	跑马灯文字显示的起始x坐标，单位百分比。范围[0.0, 1.0] 示例值：0.0
MarkWordRollEndLocationX	Float	否	跑马灯文字显示的截止x坐标，单位百分比。范围[0.0, 1.0] 示例值：1.0

CasterOutputInfo

导播台推流信息。
当导播台主监启动后，系统将自动将主监推流到腾讯云和其他第三方平台。

被如下接口引用：AddCasterOutputInfo, DescribeCasterOutputInfos, ModifyCasterOutputInfo。

名称	类型	必选	描述
OutputIndex	Integer	是	推流信息Index。当OutputType为1（表示推流到腾讯云直播）时，该值固定为0。范围[0,10]。示例值：0
OutputUrl	String	否	rtmp协议推流地址。最大允许长度512字符。示例值：rtmp://www.example.com/live/example
Description	String	否	描述信息。示例值：example
OutputStreamId	String	否	推流到腾讯云直播源站时，使用的流ID。仅当OutputType为1时生效。最大允许128字符。示例值：caster_output
OutputType	Integer	否	推流类型。范围[1,2] 1. 推送到腾讯云直播源站。 2. 推送到第三方源站。示例值：1
OutputDomainName	String	否	推到腾讯云直播源站时，使用的域名。最大允许128字符，且域名需属于当前账号绑定的云直播推流域名。仅在OutputType为1时生效。示例值：1234.livepush.myqcloud.com
OutputAppName	String	否	推到腾讯云直播源站时，使用的AppName。最大允许64字符。仅在OutputType为1时生效。示例值：live
OutputParam	String	否	推到腾讯云直播源站时需要添加的推流参数。最大允许长度256字符。仅在OutputType为1时生效。示例值：example_param=xxx

CdnPlayStatData

下行播放统计指标

被如下接口引用：DescribeGroupProIspPlayInfoList。

名称	类型	描述
Time	String	时间点，使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2019-01-08T10:00:00Z
Bandwidth	Float	带宽，单位: Mbps。示例值：0.1
Flux	Float	流量，单位: MB。示例值：0.1
Request	Integer	新增请求数。示例值：1
Online	Integer	并发连接数。示例值：1

CertInfo

证书信息。

被如下接口引用：DescribeLiveCert, DescribeLiveCerts。

名称	类型	描述
CertId	Integer	证书 ID。示例值：25
CertName	String	证书名称。示例值：certname
Description	String	描述信息。示例值：describe
CreateTime	String	创建时间，UTC 格式。注：此字段为北京时间（UTC+8时区）。示例值：2023-09-07 14:36:56
HttpsCrt	String	证书内容。示例值：-----BEGIN CERTIFICATE-----\nMIIGkzCCBPugAwIBAgIbARReVnKfzs8qY4R\n7k3XSMi/bYK0DbRkrflzJviwZAAmyx24Y4W7byfTf6O9D8K56NDcMSv1xnWeWkkl\nYTmU+vZ9czFIGtbI0M6JHAdwjLBUOLZgDb0A7GGGhyByWaPqXftEqiUjC78/8pDL\nxviG4QhCkw==\n-----END CERTIFICATE-----
CertType	Integer	证书类型。 0：用户添加证书， 1：腾讯云托管证书。示例值：1
CertExpireTime	String	证书过期时间，UTC 格式。注：此字段为北京时间（UTC+8时区）。示例值：2024-09-07 07:59:59
DomainList	Array of String	使用此证书的域名列表。示例值：auto.liveplay.org

ClientIpPlaySumInfo

客户端ip播放汇总信息。

被如下接口引用：DescribeTopClientIpSumInfoList。

名称	类型	描述
ClientIp	String	客户端 IP，点分型。示例值：119.44.7.168
Province	String	客户端所在省份。示例值：湖南省
TotalFlux	Float	总流量。示例值：13321.099
TotalRequest	Integer	总请求数。示例值：740
TotalFailedRequest	Integer	总失败请求数。示例值：4
CountryArea	String	客户端所在国家。示例值：中国

CommonMixControlParams

通用混流控制参数

被如下接口引用：CreateCommonMixStream。

名称	类型	必选	描述
UseMixCropCenter	Integer	否	取值范围[0,1]。填1时，当参数中图层分辨率参数与视频实际分辨率不一致时，自动从视频中按图层设置的分辨率比例进行裁剪。示例值：0
AllowCopy	Integer	否	取值范围[0,1] 填1时，当InputStreamList中个数为1时，且OutputParams.OutputStreamType为1时，不执行取消操作，执行拷贝流操作示例值：0
PassInputSei	Integer	否	取值范围[0,1] 填1时，透传原始流的sei 示例值：0
UsePictureTransparent	Integer	否	取值范围[0,1] 填1时，图片输入中的透明通道生效。示例值：0

CommonMixCropParams

通用混流输入裁剪参数。

被如下接口引用：CreateCommonMixStream。

名称	类型	必选	描述
CropWidth	Float	否	裁剪的宽度。取值范围[0，2000]。示例值：0
CropHeight	Float	否	裁剪的高度。取值范围[0，2000]。示例值：0
CropStartLocationX	Float	否	裁剪的起始X坐标。取值范围[0，2000]。示例值：0
CropStartLocationY	Float	否	裁剪的起始Y坐标。取值范围[0，2000]。示例值：0

CommonMixInputParam

通用混流输入参数。

被如下接口引用：CreateCommonMixStream。

名称	类型	必选	描述
InputStreamName	String	是	输入流名称。80字节以内，仅含字母、数字以及下划线的字符串。当LayoutParams.InputType=0(音视频)/4(纯音频)/5(纯视频)时，该值为需要混流的流名称。当LayoutParams.InputType=2(图片)/3(画布)时，该值仅用作标识输入，可用类似Canvas1、Pictrue1的名称。示例值：ExampleStreamName1
LayoutParams	CommonMixLayoutParams	是	输入流布局参数。
CropParams	CommonMixCropParams	否	输入流裁剪参数。
PortraitSegmentParams	MixPortraitSegmentParams	否	抠图参数。

CommonMixLayoutParams

通用混流布局参数。

被如下接口引用：CreateCommonMixStream。

名称	类型	必选	描述
ImageLayer	Integer	是	输入图层。取值范围[1，16]。 1)背景流（即大主播画面或画布）的 image_layer 填1。 2)纯音频混流，该参数也需填。注意：不同输入，该值不可重复示例值：1
InputType	Integer	否	输入类型。取值范围[0，5]。不填默认为0。 0表示输入流为音视频。 2表示输入流为图片。 3表示输入流为画布。 4表示输入流为音频。 5表示输入流为纯视频。示例值：0
ImageHeight	Float	否	输入画面在输出时的高度。取值范围：像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的高度。使用百分比时，期望输出为（百分比 * 背景高）。示例值：720
ImageWidth	Float	否	输入画面在输出时的宽度。取值范围：像素：[0，2000] 百分比：[0.01，0.99] 不填默认为输入流的宽度。使用百分比时，期望输出为（百分比 * 背景宽）。示例值：1024
LocationX	Float	否	输入在输出画面的X偏移。取值范围：像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。相对于大主播背景画面左上角的横向偏移。使用百分比时，期望输出为（百分比 * 背景宽）。示例值：0
LocationY	Float	否	输入在输出画面的Y偏移。取值范围：像素：[0，2000] 百分比：[0.01，0.99] 不填默认为0。相对于大主播背景画面左上角的纵向偏移。使用百分比时，期望输出为（百分比 * 背景宽）示例值：0
Color	String	否	当InputType为3(画布)时，该值表示画布的颜色。常用的颜色有：红色：0xCC0033。黄色：0xCC9900。绿色：0xCCCC33。蓝色：0x99CCFF。黑色：0x000000。白色：0xFFFFFF。灰色：0x999999。示例值：0xFFFFFF
WatermarkId	Integer	否	当InputType为2(图片)时，该值是水印ID。示例值：0

CommonMixOutputParams

通用混流输出参数。

被如下接口引用：CreateCommonMixStream。

名称	类型	必选	描述
OutputStreamName	String	是	输出流名称。示例值：example_ourput_name
OutputStreamType	Integer	否	输出流类型，取值范围[0,1]。不填默认为0。当输出流为输入流 list 中的一条时，填写0。当期望生成的混流结果成为一条新流时，该值填为1。该值为1时，output_stream_id 不能出现在 input_stram_list 中，且直播后台中，不能存在相同 ID 的流。示例值：0
OutputStreamBitRate	Integer	否	输出流比特率。取值范围[1，10000]。不填的情况下，系统会自动判断。示例值：2000
OutputStreamGop	Integer	否	输出流GOP大小。取值范围[1,10]。不填的情况下，系统会自动判断。示例值：2
OutputStreamFrameRate	Integer	否	输出流帧率大小。取值范围[1,60]。不填的情况下，系统会自动判断。示例值：30
OutputAudioBitRate	Integer	否	输出流音频比特率。取值范围[1,500] 不填的情况下，系统会自动判断。示例值：256
OutputAudioSampleRate	Integer	否	输出流音频采样率。取值范围[96000, 88200, 64000, 48000, 44100, 32000,24000, 22050, 16000, 12000, 11025, 8000]。不填的情况下，系统会自动判断。示例值：48000
OutputAudioChannels	Integer	否	输出流音频声道数。取值范围[1,2]。不填的情况下，系统会自动判断。示例值：2
MixSei	String	否	输出流中的sei信息。如果无特殊需要，不填。示例值：example_sei

ConcurrentRecordStreamNum

并发录制路数

被如下接口引用：DescribeConcurrentRecordStreamNum, DescribeUploadStreamNums。

名称	类型	描述
Time	String	时间点。示例值：2019-03-01T01:00:00+08:00
Num	Integer	路数。示例值：100

DayStreamPlayInfo

流播放信息

被如下接口引用：DescribeStreamPlayInfoList。

名称	类型	描述
Time	String	数据时间点，接口返回支持两种时间格式： 1）YYYY-MM-DDThh:mm:ssZ：UTC时间格式，详见ISO日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2）yyyy-MM-dd HH:mm:ss：使用此格式时，默认代表北京时间。接口返回的时间格式和查询请求传入的时间格式一致。示例值：2019-01-08T10:00:00Z
Bandwidth	Float	带宽（单位Mbps）。示例值：1.0
Flux	Float	流量（单位MB）。示例值：1.0
Request	Integer	请求数。示例值：1
Online	Integer	在线人数。当前后端接口数据的统计方式与客户端侧不同，该数据仅供参考，具体数据请以业务客户端侧统计数据为准。示例值：1

DelayInfo

延播信息。

被如下接口引用：DescribeLiveDelayInfoList。

名称	类型	描述
DomainName	String	推流域名。示例值：5000.pushdomain.com
AppName	String	推流路径，与推流和播放地址中的 AppName 保持一致，默认为 live。示例值：live
StreamName	String	流名称。示例值：stream1
DelayInterval	Integer	延播时间，单位：秒。示例值：60
CreateTime	String	创建时间，UTC 时间。注意：UTC时间和北京时间相差8小时。例如：2019-06-18T12:00:00Z（为北京时间 2019 年 6 月 18 日 20 点 0 分 0 秒）。示例值：2019-06-14T00:00:00Z
ExpireTime	String	过期时间，UTC 时间。注意：UTC时间和北京时间相差8小时。例如：2019-06-18T12:00:00Z（为北京时间 2019 年 6 月 18 日 20 点 0 分 0 秒）。示例值：2019-06-15T00:00:00Z
Status	Integer	当前状态: -1：已过期。 1：生效中。示例值：1

DiagnoseResult

媒体诊断结果，包含断流信息、低帧率信息等

被如下接口引用：DescribeMonitorReport。

名称	类型	描述
StreamBrokenResults	Array of String	断流信息
LowFrameRateResults	Array of String	低帧率信息
StreamFormatResults	Array of String	流格式诊断信息

DomainCertInfo

域名证书信息

被如下接口引用：DescribeLiveDomainCert。

名称	类型	描述
CertId	Integer	证书Id。示例值：38518
CertName	String	证书名称。示例值：inkegd
Description	String	描述信息。示例值：describe
CreateTime	String	创建时间，UTC格式。注：此字段为北京时间（UTC+8时区）。示例值：2024-04-17 11:55:21
HttpsCrt	String	证书内容。示例值：-----BEGIN CERTIFICATE-----\nMIIGvjCCBaagAwIBAgIQByuQf2Ch2YzIRqKLw02HazANBgkqhkiG9w0BAQsFADBf\\ntVzBAiBjg8xWJzJq57oMQeYLYrdlR8MHqyfXcXqggvZ3TIgyNQB3AObSMYukn\nlA4=\n-----END CERTIFICATE----
CertType	Integer	证书类型。 0：用户添加证书， 1：腾讯云托管证书。示例值：1
CertExpireTime	String	证书过期时间，UTC格式。注：此字段为北京时间（UTC+8时区）。示例值：2025-04-17 11:55:21
DomainName	String	使用此证书的域名名称。示例值：iparty-pull.in.com
Status	Integer	证书状态。示例值：1
CertDomains	Array of String	证书本身标识的域名列表。比如: ["*.x.com"] 示例值：certname
CloudCertId	String	腾讯云ssl的证书Id 示例值：4512

DomainDetailInfo

每个域名的统计信息。

被如下接口引用：DescribeLiveDomainPlayInfoList。

名称	类型	描述
MainlandOrOversea	String	国内还是国外: Mainland: 表示国内数据。 Oversea: 表示国外数据。示例值：Mainland
Bandwidth	Float	带宽，单位: Mbps。示例值：309.998
Flux	Float	流量，单位: MB。示例值：18599.880
Online	Integer	人数。示例值：374
Request	Integer	请求数。示例值：175

DomainInfo

直播域名信息

被如下接口引用：DescribeLiveDomain, DescribeLiveDomains。

名称	类型	描述
Name	String	直播域名。示例值：abc.com
Type	Integer	域名类型: 0: 推流。 1: 播放。示例值：1
Status	Integer	域名状态: 0: 停用。 1: 启用。示例值：1
CreateTime	String	添加时间。注：此字段为北京时间（UTC+8时区）。示例值：2011-09-09 11:11:11
BCName	Integer	是否有 CName 到固定规则域名: 0: 否。 1: 是。示例值：1
TargetDomain	String	cname 对应的域名。示例值：abc.com
PlayType	Integer	播放区域，只在 Type=1 时该参数有意义。 1: 国内。 2: 全球。 3: 海外。示例值：2
IsDelayLive	Integer	是否慢直播: 0: 普通直播。 1: 慢直播。示例值：0
CurrentCName	String	当前客户使用的 cname 信息。示例值：abc.com
RentTag	Integer	失效参数，可忽略。示例值：1
RentExpireTime	String	失效参数，可忽略。注：此字段为北京时间（UTC+8时区）。示例值：2011-09-09 11:11:11
IsMiniProgramLive	Integer	0: 标准直播。 1: 小程序直播。示例值：0

DomainInfoList

多个域名信息列表

被如下接口引用：DescribeLiveDomainPlayInfoList。

名称	类型	描述
Domain	String	域名。示例值：123.tencent.com
DetailInfoList	Array of DomainDetailInfo	明细信息。

FlvSpecialParam

flv格式特殊配置

被如下接口引用：CreateLiveRecordTemplate, DescribeLiveRecordTemplate, DescribeLiveRecordTemplates, ModifyLiveRecordTemplate。

名称	类型	必选	描述
UploadInRecording	Boolean	否	是否开启边录边传，仅flv格式有效。示例值：false

ForbidStreamInfo

禁推流列表

被如下接口引用：DescribeLiveForbidStreamList。

名称	类型	描述
StreamName	String	流名称。示例值：test
CreateTime	String	创建时间。注：此字段为北京时间（UTC+8时区）。示例值：2020-01-01 12:12:12
ExpireTime	String	禁推过期时间。注：此字段为北京时间（UTC+8时区）。示例值：2020-01-01 12:12:12
AppName	String	推流路径。注意：此字段可能返回 null，表示取不到有效值。示例值：test
DomainName	String	推流域名。注意：此字段可能返回 null，表示取不到有效值。示例值：test

GroupProIspDataInfo

某省份某运营商在某段时间内的带宽，流量，请求数和并发数

被如下接口引用：DescribeGroupProIspPlayInfoList。

名称	类型	描述
ProvinceName	String	省份。示例值：广东省
IspName	String	运营商。示例值：联通
DetailInfoList	Array of CdnPlayStatData	分钟维度的明细数据。

HlsSpecialParam

HLS专属录制参数

被如下接口引用：CreateLiveRecordTemplate, DescribeLiveRecordTemplate, DescribeLiveRecordTemplates, ModifyLiveRecordTemplate。

名称	类型	必选	描述
FlowContinueDuration	Integer	否	HLS续流超时时间。取值范围[0，1800]。注意：此字段可能返回 null，表示取不到有效值。

HttpCodeInfo

HTTP返回码和统计数据

被如下接口引用：DescribePlayErrorCodeDetailInfoList。

名称	类型	描述
HttpCode	String	HTTP协议返回码。例："2xx", "3xx", "4xx", "5xx"。示例值：3xx
ValueList	Array of HttpCodeValue	统计信息，对于无数据的时间点，会补0。

HttpCodeValue

HTTP返回码数据信息

被如下接口引用：DescribePlayErrorCodeDetailInfoList。

名称	类型	描述
Time	String	时间，使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2022-11-14T16:38:00+08:00
Numbers	Integer	次数。示例值：1
Percentage	Float	占比。示例值：0.1

HttpStatusData

播放错误码信息

被如下接口引用：DescribeHttpStatusInfoList。

名称	类型	描述
Time	String	数据时间点，使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2019-03-01T00:00:00+08:00
HttpStatusInfoList	Array of HttpStatusInfo	播放状态码详细信息。

HttpStatusInfo

播放错误码信息

被如下接口引用：DescribeHttpStatusInfoList。

名称	类型	描述
HttpStatus	String	播放HTTP状态码。示例值：200
Num	Integer	个数。示例值：50

LiveCertDomainInfo

用作批量绑定域名和证书。

被如下接口引用：ModifyLiveDomainCertBindings。

名称	类型	必选	描述
DomainName	String	是	域名。示例值：domain.com
Status	Integer	是	是否启用域名的https规则。 1：启用 0：禁用 -1：保持不变示例值：1

LiveDomainCertBindings

DescribeLiveDomainCertBindings, DescribeLiveDomainCertBindingsGray接口返回的域名证书信息

被如下接口引用：DescribeLiveDomainCertBindings。

名称	类型	描述
DomainName	String	域名。示例值：iparty-pull.in.com
CertificateAlias	String	证书备注。与CertName同义。示例值：cert
CertType	Integer	证书类型。 0：自有证书 1：腾讯云ssl托管证书示例值：1
Status	Integer	https状态。 1：已开启。 0：已关闭。示例值：1
CertExpireTime	Timestamp	证书过期时间。注：此字段为北京时间（UTC+8时区）。示例值：2024-04-17 11:55:21
CertId	Integer	证书Id。示例值：453612
CloudCertId	String	腾讯云ssl的证书Id。示例值：85212
UpdateTime	Timestamp	规则最后更新时间。注：此字段为北京时间（UTC+8时区）。注意：此字段可能返回 null，表示取不到有效值。示例值：2020-05-06 17:00:00

LiveEnhanceInfo

直播增强计费信息。

被如下接口引用：DescribeLiveEnhanceInfoList。

名称	类型	描述
Domain	String	域名。示例值：5000.livepull.stream.com
Time	String	时间。示例值：2024-12-25T10:43:22+08:00
Duration	Integer	计费时长，单位分钟。示例值：10
Fps	String	帧率。示例值：25
Resolution	String	分辨率。示例值：720P
Type	String	增强服务类型。示例值：SUPER_RESOLUTION

LivePackageInfo

直播包信息。

被如下接口引用：DescribeLivePackageInfo。

名称	类型	描述
Id	String	包 ID。示例值：4512
Total	Integer	总量。注意：当为流量包时单位为字节。当为转码包时单位为分钟。示例值：500000
Used	Integer	使用量。注意：当为流量包时单位为字节。当为转码包时单位为分钟。当为连麦包时单位为小时。示例值：200000
Left	Integer	剩余量。注意：当为流量包时单位为字节。当为转码包时单位为分钟。当为连麦包时单位为小时。示例值：300000
BuyTime	String	购买时间。注：此字段为北京时间（UTC+8时区）。示例值：2024-04-17 11:55:21
ExpireTime	String	过期时间。注：此字段为北京时间（UTC+8时区）。示例值：2025-04-17 11:55:21
Type	Integer	包类型，可选值: 0: 流量包。 1: 普通转码包。 2: 极速高清包。 3: 连麦包。示例值：0
Status	Integer	包状态，可选值: 0: 未使用。 1: 使用中。 2: 已过期。 3: 已冻结。 4: 已耗尽。 5: 已退款示例值：0
WillRenew	Integer	是否自动续购。注意：此字段可能返回 null，表示取不到有效值。示例值：0
RenewalResult	Integer	续购状态。 1 ：续购成功。 0 ：尚未续购。 <0 : 续购失败。注意：此字段可能返回 null，表示取不到有效值。示例值：0

LiveStreamMonitorInfo

直播监播任务信息。

被如下接口引用：DescribeLiveStreamMonitor, DescribeLiveStreamMonitorList。

名称	类型	必选	描述
MonitorId	String	是	监播任务ID。示例值：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
MonitorName	String	否	监播任务名称。128字节以内。示例值：ExampleMonitorName
OutputInfo	LiveStreamMonitorOutputInfo	否	监播任务输出信息。示例值： output_info
InputList	Array of LiveStreamMonitorInputInfo	否	待监播的输入流信息。示例值： input_list
Status	Integer	否	监播任务状态。 0：代表空闲 1：代表监播中。示例值：0
StartTime	Integer	否	上一次的启动时间，unix时间戳。示例值：1640763135
StopTime	Integer	否	上一次的停止时间，unix时间戳。示例值：1640763135
CreateTime	Integer	否	监播任务创建时间，unix时间戳示例值：1640763135
UpdateTime	Integer	否	监播任务更新时间，unix时间戳示例值：1640763135
NotifyPolicy	LiveStreamMonitorNotifyPolicy	否	监播事件通知策略。
AudibleInputIndexList	Array of Integer	否	输出音频的输入Index列表。示例值：[1]
AiAsrInputIndexList	Array of Integer	否	开启智能语音识别的输入Index列表示例值：[1]
CheckStreamBroken	Integer	否	是否开启断流检测示例值：0
CheckStreamLowFrameRate	Integer	否	是否开启低帧率检测示例值：0
AsrLanguage	Integer	否	智能语音识别语种： 0 关闭 1 中文 2 英文 3日文 4 韩文示例值：0
OcrLanguage	Integer	否	智能文字识别语种： 0 关闭 1 中、英文示例值：0
AiOcrInputIndexList	Array of Integer	否	开启智能文字识别的输入Index列表示例值：[1]
AllowMonitorReport	Integer	否	是否存储监播事件到监播报告，以及是否允许查询监播报告示例值：0
AiFormatDiagnose	Integer	否	是否开启格式诊断示例值：0
AiQualityControl	Integer	否	是否开启内容质检。示例值：0
CasterId	String	否	导播台监播对应的导播台场次id 示例值："101"
PullPushTaskId	String	否	拉流转推监播对应的拉流转推任务id 示例值："xxxx"

LiveStreamMonitorInputInfo

直播监播功能输入流信息

被如下接口引用：CreateLiveStreamMonitor, DescribeLiveStreamMonitor, DescribeLiveStreamMonitorList, ModifyLiveStreamMonitor。

名称	类型	必选	描述
InputStreamName	String	是	待监播的输入流名称。256字节以内，只允许包含字母、数字、‘-’，‘_’，'.'字符。示例值：ExampleStreamName
InputDomain	String	否	待监播的输入流推流域名。128字节以内，只允许填处于启用状态的推流域名。示例值：ExampleDomain
InputApp	String	否	待监播的输入流推流路径。32字节以内，只允许包含字母、数字、‘-’，‘_’，'.'字符。示例值：Live
InputUrl	String	否	待监播的输入流推流url。一般场景下，无需该参数。示例值：rtmp://ExampleDomain/Live/ExampleStreamName
Description	String	否	描述。256字节以内。示例值：Input1
CasterInputIndex	Integer	否	导播台输入源索引（10000 pvw， 10001 pgm，其余代表输入下标）示例值：1
NeedMonitor	Boolean	否	该输入源是否正在监播示例值：True
CdnStreamId	String	否	导播台pvw pgm的cdn流id 示例值：ExampleStreamName

LiveStreamMonitorNotifyPolicy

直播流监播通知策略

被如下接口引用：CreateLiveStreamMonitor, DescribeLiveStreamMonitor, DescribeLiveStreamMonitorList, ModifyLiveStreamMonitor。

名称	类型	必选	描述
NotifyPolicyType	Integer	否	通知策略类型：范围[0,1] 0:代表不使用任何通知策略 1:代表使用全局回调策略，所有事件通知到CallbackUrl。示例值：0
CallbackUrl	String	否	回调URL：长度[0,512] 只支持http和https类型的url。示例值：http://notify.example.com/notify

LiveStreamMonitorOutputInfo

直播流监播输出流信息

被如下接口引用：CreateLiveStreamMonitor, DescribeLiveStreamMonitor, DescribeLiveStreamMonitorList, ModifyLiveStreamMonitor。

名称	类型	必选	描述
OutputStreamWidth	Integer	是	监播任务输出流宽度像素。范围[1,1920]。建议至少大于100像素。示例值：1920
OutputStreamHeight	Integer	是	监播任务输出流长度像素。范围[1,1080]，建议至少大于100像素。示例值：1080
OutputStreamName	String	否	监播任务输出流名称。不填时，系统会自动生成。 256字节以内，只允许包含字母、数字、‘-’，‘_’，'.'字符。示例值：OutputExampleName
OutputDomain	String	否	监播任务播放域名。128字节以内，只允许填处于启用状态的播放域名。示例值：OutputExampleDomain
OutputApp	String	否	监播任务播放路径。32字节以内，只允许包含字母、数字、‘-’，‘_’，'.'字符。示例值：Live

LogInfo

日志url信息。

被如下接口引用：DescribeLogDownloadList。

名称	类型	描述
LogName	String	日志名称。示例值：logname
LogUrl	String	日志 URL。示例值：http://abc.ab.com
LogTime	String	日志生成时间。注：此字段为北京时间（UTC+8时区）。示例值：2024-04-17 11:55:21
FileSize	Integer	文件大小。示例值：10000

MPSResult

媒体处理结果，包含智能语音识别、智能文字识别结果

被如下接口引用：DescribeMonitorReport。

名称	类型	描述
AiAsrResults	Array of String	智能语音识别结果。
AiOcrResults	Array of String	智能文字识别结果。
StreamQuaCtrlResults	Array of String	内容质检结果。

MixPortraitSegmentParams

混流抠图参数

被如下接口引用：CreateCommonMixStream。

名称	类型	必选	描述
Color	String	否	抠图背景颜色，常用的颜色有：红色：0xcc0033。黄色：0xcc9900。绿色：0xcccc33。蓝色：0x99CCFF。黑色：0x000000。白色：0xFFFFFF。灰色：0x999999。示例值：0xcccc33

MonitorStreamPlayInfo

监控播放数据

被如下接口引用：DescribeAllStreamPlayInfoList。

名称	类型	描述
PlayDomain	String	播放域名。示例值：domain.test1.com
StreamName	String	流id。示例值：stream1
Rate	Integer	播放码率，0表示原始码率。示例值：0
Protocol	String	播放协议，可选值包括 Unknown，Flv，Hls，Rtmp，Huyap2p。示例值：Hls
Bandwidth	Float	带宽，单位是Mbps。示例值：1.82
Online	Integer	在线人数，1分钟采样一个点，统计采样点的tcp链接数目。示例值：2
Request	Integer	请求数。示例值：19

PadTemplate

直播垫片模板。

被如下接口引用：DescribeLivePadTemplate, DescribeLivePadTemplates。

名称	类型	必选	描述
TemplateId	Integer	是	模板id。示例值：1
TemplateName	String	是	模板名称。示例值：templatename
Url	String	是	垫片内容。示例值：https://test.com/a.mp4
CreateTime	String	是	模板创建时间。示例值：2020-01-01 08:00:00
UpdateTime	String	是	模板修改时间。示例值：2020-01-01 08:00:00
Description	String	否	模板描述。示例值：description
WaitDuration	Integer	否	断流等待时间。取值范围：0-30000。单位：ms。示例值：0
MaxDuration	Integer	否	最大垫片时长。取值范围：0 - 正无穷。单位：ms。示例值：0
Type	Integer	否	垫片内容类型： 1：图片，2：视频。默认值：1。示例值：1

PlayAuthKeyInfo

播放鉴权key信息。

被如下接口引用：DescribeLivePlayAuthKey。

名称	类型	描述
DomainName	String	域名。示例值：5000.livepush.myqcloud.com
Enable	Integer	是否启用: 0: 关闭。 1: 启用。示例值：1
AuthKey	String	鉴权 Key。示例值：AKID0QJ82oYdLJ
AuthDelta	Integer	有效时间，单位：秒。示例值：300
AuthBackKey	String	鉴权 BackKey。示例值：lbPUl5VIKKFB1KazNB

PlayCodeTotalInfo

各状态码的总次数，支持大多数的 HTTP 协议返回码。

被如下接口引用：DescribePlayErrorCodeSumInfoList。

名称	类型	描述
Code	String	HTTP code，可选值包括: 400，403，404，500，502，503，504。示例值：200
Num	Integer	总次数。示例值：11

PlayDataInfoByStream

流维度的播放信息。

被如下接口引用：DescribeStreamDayPlayInfoList。

名称	类型	描述
StreamName	String	流名称。示例值：stream1
TotalFlux	Float	总流量，单位: MB。示例值：500.0

PlayStatInfo

按省份运营商查询的播放信息。

被如下接口引用：DescribeProvinceIspPlayInfoList。

名称	类型	描述
Time	String	数据时间点。示例值：2019-02-01T00:00:00+08:00
Value	Float	带宽/流量/请求数/并发连接数/下载速度的值，若没数据返回时该值为0。示例值：500.0

PlaySumStatInfo

播放汇总统计信息。

被如下接口引用：DescribeVisitTopSumInfoList。

名称	类型	描述
Name	String	域名或流 ID。示例值：CSZFMPP360
AvgFluxPerSecond	Float	平均下载速度，单位: MB/s。计算公式: 每分钟的下载速度求平均值。示例值：4.773
TotalFlux	Float	总流量，单位: MB。示例值：69023.772
TotalRequest	Integer	总请求数。示例值：36590

ProIspPlayCodeDataInfo

播放错误码信息

被如下接口引用：DescribePlayErrorCodeSumInfoList。

名称	类型	描述
CountryAreaName	String	国家或地区。示例值：中国
ProvinceName	String	省份。示例值：山东省
IspName	String	运营商。示例值：中国移动
Code2xx	Integer	错误码为2开头的次数。示例值：11
Code3xx	Integer	错误码为3开头的次数。示例值：12
Code4xx	Integer	错误码为4开头的次数。示例值：10
Code5xx	Integer	错误码为5开头的次数。示例值：19

ProIspPlaySumInfo

获取省份/运营商的播放信息。

被如下接口引用：DescribeProIspPlaySumInfoList。

名称	类型	描述
Name	String	省份/运营商/国家或地区。示例值：山东省
TotalFlux	Float	总流量，单位: MB。示例值：50.0
TotalRequest	Integer	总请求数。示例值：50
AvgFluxPerSecond	Float	平均下载流量，单位: MB/s。示例值：10.1

PublishTime

推流时间。

被如下接口引用：DescribeLiveStreamOnlineList。

名称	类型	描述
PublishTime	String	推流时间。 UTC 格式，例如：2018-06-29T19:00:00Z。示例值：2017-10-24T12:00:00Z

PullPushWatermarkInfo

云转推水印信息。

被如下接口引用：CreateLivePullStreamTask, DescribeLivePullStreamTasks, ModifyLivePullStreamTask。

名称	类型	必选	描述
PictureUrl	String	是	水印图片 URL。 URL中禁止包含的字符： ;(){}$>`#"'\| 示例值：http://xxx.gifshow/pic.jpg
XPosition	Integer	是	显示位置，X轴偏移，单位是百分比，默认 0。示例值：0
YPosition	Integer	是	显示位置，Y轴偏移，单位是百分比，默认 0。示例值：0
Width	Integer	是	水印宽度，占直播原始画面宽度百分比，建议高宽只设置一项，另外一项会自适应缩放，避免变形。默认原始宽度。示例值：100
Height	Integer	是	水印高度，占直播原始画面高度百分比，建议高宽只设置一项，另外一项会自适应缩放，避免变形。默认原始高度。示例值：100
Location	Integer	是	水印位置，默认 0。 0：左上角。 1：右上角。 2：右下角。 3：左下角。示例值：0

PullStreamConfig

拉流配置。

被如下接口引用：DescribePullStreamConfigs。

名称	类型	描述
ConfigId	String	拉流配置 ID。示例值：5674
FromUrl	String	源 URL。示例值：rtmp://5000.liveplay.myqcloud.com/txlive
ToUrl	String	目的 URL。示例值：rtmp://5000.livepush2.myqcloud.com/live/3954_462724865?&txSecret=xx
AreaName	String	区域名。示例值：深圳
IspName	String	运营商名。示例值：电信
StartTime	String	开始时间。 UTC格式时间，例如: 2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2018-07-06T14:40:23Z
EndTime	String	结束时间。 UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2018-07-06T18:05:23Z
Status	String	状态: 0: 无效。 1: 初始状态。 2: 正在运行。 3: 拉起失败。 4: 暂停。示例值：2

PullStreamTaskInfo

直播拉流任务信息。

被如下接口引用：DescribeLivePullStreamTasks。

名称	类型	描述
TaskId	String	拉流任务Id。示例值：564214
SourceType	String	拉流源的类型： PullLivePushLive -直播， PullVodPushLive -点播， PullPicPushLive -图片。示例值：PullLivePushLive
SourceUrls	Array of String	拉流源url列表。 SourceType为直播（PullLiveToLive）只可以填1个， SourceType为点播（PullVodToLive）可以填多个，上限10个。示例值：http://test.domain/live/test.flv?txSecret=xx&txTime=xxx
DomainName	String	推流域名。将拉到的源推到该域名。示例值：5000.livepush.qcloud.com
AppName	String	推流路径。将拉到的源推到该路径。示例值：live
StreamName	String	流名称。将拉到的源推到该流名称。示例值：teststream
PushArgs	String	推流参数。推流携带的自定义参数。示例值：secret=abc&time=F7F78AE7
StartTime	String	开始时间。使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2021-02-24T00:00:00Z
EndTime	String	结束时间，注意： 1. 结束时间必须大于开始时间； 2. 结束时间和开始时间必须大于当前时间； 3. 结束时间和开始时间间隔必须小于七天。使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2021-02-28T00:00:00Z
Region	String	任务创建所在地域： ap-beijing - 华北地区(北京)， ap-shanghai -华东地区(上海)， ap-guangzhou -华南地区(广州)， ap-mumbai - 印度， ap-hongkong - 香港， eu-frankfurt - 德国， ap-seoul - 韩国， ap-bangkok - 泰国， ap-singapore - 新加坡， na-siliconvalley - 美西， na-ashburn - 美东， ap-tokyo - 日本。示例值：ap-guangzhou
VodLoopTimes	Integer	点播拉流转推循环次数。 -1：无限循环，直到任务结束。 0：不循环。 >0：具体循环次数。次数和时间以先结束的为准。注意：拉流源为点播，该配置生效。示例值：-1
VodRefreshType	String	点播更新SourceUrls后的播放方式： ImmediateNewSource：立即从更新的拉流源开始播放； ContinueBreakPoint：从上次断流url源的断点处继续，结束后再使用新的拉流源。注意：拉流源为点播，该配置生效。示例值：ImmediateNewSource
CreateTime	String	任务创建时间。使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2021-02-23T00:00:00Z
UpdateTime	String	任务更新时间。使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2021-02-24T10:00:00Z
CreateBy	String	创建任务的操作者。示例值：admin
UpdateBy	String	最后更新任务的操作者。示例值：admin
CallbackUrl	String	回调地址。示例值：http://you.callback.url
CallbackEvents	Array of String	选择需要回调的事件： TaskStart：任务启动回调， TaskExit：任务停止回调， VodSourceFileStart：从点播源文件开始拉流回调， VodSourceFileFinish：从点播源文件拉流结束回调， ResetTaskConfig：任务更新回调。示例值：["TaskStart"]
CallbackInfo	String	注意：该信息暂不返回。最后一次回调信息。示例值：null
ErrorInfo	String	注意：该信息暂不返回。错误信息。示例值：null
Status	String	状态。 enable：生效中。 pause：暂停中。示例值：enable
RecentPullInfo	RecentPullInfo	注意：该信息仅在查询单个任务时返回。任务最新拉流信息。包含：源 url，偏移时间，上报时间。
Comment	String	任务备注信息。示例值：直播活动任务
BackupSourceType	String	备源类型： PullLivePushLive -直播， PullVodPushLive -点播。注意：此字段可能返回 null，表示取不到有效值。示例值：PullLivePushLive
BackupSourceUrl	String	备源URL。注意：此字段可能返回 null，表示取不到有效值。示例值：http://test.domain/live/test.flv?txSecret=xx&txTime=xxx
WatermarkList	Array of PullPushWatermarkInfo	水印信息列表。注意：此字段可能返回 null，表示取不到有效值。
VodLocalMode	Integer	点播源是否启用本地推流模式，默认0，不启用。 0 - 不启用。 1 - 启用。注意：此字段可能返回 null，表示取不到有效值。示例值：0
RecordTemplateId	String	录制模板 ID。注意：此字段可能返回 null，表示取不到有效值。示例值：8452
BackupToUrl	String	新增的推流地址。用于单任务推两路场景。注意：此字段可能返回 null，表示取不到有效值。示例值：rtmp://5000.livepush.myqcloud.com/live/vinback?txSecret=6e9797ce
TranscodeTemplateName	String	直播转码模板。注意：此字段可能返回 null，表示取不到有效值。示例值：hevc760

PushAuthKeyInfo

推流鉴权key信息。

被如下接口引用：DescribeLivePushAuthKey。

名称	类型	描述
DomainName	String	域名。示例值：push.tlivecloud.com
Enable	Integer	是否启用，0：关闭，1：启用。示例值：1
MasterAuthKey	String	主鉴权 Key。示例值：29077666814d739e801ceb5
BackupAuthKey	String	备鉴权 Key。示例值：78895532321114d739e801ceb5
AuthDelta	Integer	有效时间，单位：秒。示例值：0

PushDataInfo

推流数据信息

被如下接口引用：DescribeLiveStreamPushInfoList。

名称	类型	描述
StreamName	String	流名称。示例值：test1
AppName	String	推流路径。示例值：live
ClientIp	String	推流客户端 IP。示例值：127.0.0.1
ServerIp	String	接流服务器 IP。示例值：127.0.0.1
VideoFps	Integer	推流视频帧率，单位: Hz。示例值：100
VideoSpeed	Integer	推流视频码率，单位: bps。示例值：100
AudioFps	Integer	推流音频帧率，单位: Hz。示例值：40
AudioSpeed	Integer	推流音频码率，单位: bps。示例值：40
PushDomain	String	推流域名。示例值：5000.pushdomain.com
BeginPushTime	String	推流开始时间。示例值：2019-02-01 00:00:00
Acodec	String	音频编码格式，例："AAC"。示例值：AAC
Vcodec	String	视频编码格式，例："H264"。示例值：H264
Resolution	String	分辨率。示例值：350*350
AsampleRate	Integer	采样率。示例值：48000
MetaAudioSpeed	Integer	metadata 中的音频码率，单位: bps。示例值：22
MetaVideoSpeed	Integer	metadata 中的视频码率，单位: bps。示例值：4885
MetaFps	Integer	metadata 中的帧率。示例值：30

PushLogInfo

推流域名日志信息。

被如下接口引用：DescribeDeliverLogDownList。

名称	类型	描述
LogName	String	日志名称。示例值：pushlog-xxx
LogUrl	String	日志下载地址。示例值：https://livelog-down.cdn.qcloud.com/20220804/11/202208041125-pul
LogTime	String	日志时间。UTC 格式，例如：2018-11-29T19:00:00Z。注意： 1. 北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2022-02-09T12:36:42Z
FileSize	Integer	文件大小，单位字节。示例值：1222

PushQualityData

某条流的推流质量详情数据。

被如下接口引用：DescribeStreamPushInfoList。

名称	类型	描述
Time	String	数据时间，使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2021-03-01T00:00:00+08:00
PushDomain	String	推流域名。示例值：test.com
AppName	String	推流路径。示例值：live
ClientIp	String	推流客户端 IP。示例值：0.0.0.0
BeginPushTime	String	开始推流时间，格式: %Y-%m-%d %H:%M:%S.%ms，精确到毫秒级。示例值：2021-03-01 00:00:00
Resolution	String	分辨率信息。示例值：480*864
VCodec	String	视频编码格式。示例值：H264
ACodec	String	音频编码格式。示例值：AAC
Sequence	String	推流序列号，用来唯一的标志一次推流。示例值：4543453324532
VideoFps	Integer	视频帧率。示例值：1
VideoRate	Integer	视频码率，单位: bps。示例值：1
AudioFps	Integer	音频帧率。示例值：1
AudioRate	Integer	音频码率，单位: bps。示例值：1
LocalTs	Integer	本地流逝时间，单位: ms，音视频流逝时间与本地流逝时间的差距越大表示推流质量越差，上行卡顿越严重。示例值：10
VideoTs	Integer	视频流逝时间，单位: ms。示例值：10
AudioTs	Integer	音频流逝时间，单位: ms。示例值：10
MetaVideoRate	Integer	metadata 中的视频码率，单位: kbps。示例值：1
MetaAudioRate	Integer	metadata 中的音频码率，单位: kbps。示例值：1
MateFps	Integer	metadata 中的帧率。示例值：1
StreamParam	String	推流参数示例值：&test=1
Bandwidth	Float	带宽，单位Mbps。示例值：0.1
Flux	Float	流量，单位MB。示例值：0.1
ServerIp	String	推流服务端 IP。示例值：192.1.1.1

RecentPullInfo

直播拉流当前正在拉的文件信息。

被如下接口引用：DescribeLivePullStreamTasks。

名称	类型	描述
FileUrl	String	当前正在拉的文件地址。示例值：http://youfile.domain.com/vod/file.mp4
OffsetTime	Integer	当前正在拉的文件偏移，单位：秒。示例值：2300
ReportTime	String	最新上报偏移信息时间。UTC格式。如：2020-07-23T03:20:39Z。注意：与北京时间相差八小时。示例值：2022-10-20T03:35:11Z
LoopedTimes	Integer	已经轮播的次数。示例值：2

RecordParam

录制模板参数。

被如下接口引用：CreateLiveRecordTemplate, DescribeLiveRecordTemplate, DescribeLiveRecordTemplates, ModifyLiveRecordTemplate。

名称	类型	必选	描述
RecordInterval	Integer	否	录制间隔。单位秒，默认：1800。取值范围：30-7200。此参数对 HLS 无效，当录制 HLS 时从推流到断流生成一个文件。示例值：400
StorageTime	Integer	否	录制存储时长。单位秒，取值范围： 0 - 1500天。 0：表示永久存储。示例值：800
Enable	Integer	否	是否开启当前格式录制，默认值为0，0：否， 1：是。示例值：0
VodSubAppId	Integer	否	点播子应用 ID。示例值：1
VodFileName	String	否	录制文件名。支持的特殊占位符有： {StreamID}: 流ID {StartYear}: 开始时间-年 {StartMonth}: 开始时间-月 {StartDay}: 开始时间-日 {StartHour}: 开始时间-小时 {StartMinute}: 开始时间-分钟 {StartSecond}: 开始时间-秒 {StartMillisecond}: 开始时间-毫秒 {EndYear}: 结束时间-年 {EndMonth}: 结束时间-月 {EndDay}: 结束时间-日 {EndHour}: 结束时间-小时 {EndMinute}: 结束时间-分钟 {EndSecond}: 结束时间-秒 {EndMillisecond}: 结束时间-毫秒若未设置默认录制文件名为{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond} 示例值：{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}
Procedure	String	否	任务流注意：此字段可能返回 null，表示取不到有效值。示例值：liu
StorageMode	String	否	视频存储策略。 normal：标准存储。 cold：低频存储。注意：此字段可能返回 null，表示取不到有效值。示例值：normal
ClassId	Integer	否	点播应用分类注意：此字段可能返回 null，表示取不到有效值。示例值：4512
CosBucketName	String	否	存储至 cos 的 bucket 桶名称。注意：此字段可能返回 null，表示取不到有效值。示例值：bucket
CosBucketRegion	String	否	存储至 cos 的 bucket 区域。注意：此字段可能返回 null，表示取不到有效值。示例值：bucket
CosBucketPath	String	否	存储至 cos 的 bucket 路径。注意：此字段可能返回 null，表示取不到有效值。示例值：bucket

RecordTask

录制任务

被如下接口引用：DescribeRecordTask。

名称	类型	描述
TaskId	String	录制任务ID。示例值：UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb
DomainName	String	推流域名。示例值：5000.live.push.com
AppName	String	推流路径。示例值：live
StreamName	String	流名称。示例值：livetest
StartTime	Integer	任务开始时间，Unix时间戳。示例值：1589904000
EndTime	Integer	任务结束时间，Unix时间戳。示例值：1589889600
TemplateId	Integer	录制模板ID。示例值：0
Stopped	Integer	调用 StopRecordTask 停止任务时间，Unix时间戳。值为0表示未曾调用接口停止任务。示例值：0

RecordTemplateInfo

录制模板信息

被如下接口引用：DescribeLiveRecordTemplate, DescribeLiveRecordTemplates。

名称	类型	描述
TemplateId	Integer	模板 ID。示例值：1
TemplateName	String	模板名称。示例值：test-1
Description	String	描述信息。示例值：test
FlvParam	RecordParam	FLV 录制参数。
HlsParam	RecordParam	HLS 录制参数。
Mp4Param	RecordParam	MP4 录制参数。
AacParam	RecordParam	AAC 录制参数。
IsDelayLive	Integer	0：普通直播， 1：慢直播。示例值：1
HlsSpecialParam	HlsSpecialParam	HLS 录制定制参数。
Mp3Param	RecordParam	MP3 录制参数。
RemoveWatermark	Boolean	是否去除水印。注意：此字段可能返回 null，表示取不到有效值。示例值：false
CosStore	Integer	是否存储至cos 注意：此字段可能返回 null，表示取不到有效值。示例值：1
FlvSpecialParam	FlvSpecialParam	FLV 录制定制参数。注意：此字段可能返回 null，表示取不到有效值。

RefererAuthConfig

直播域名Referer黑白名单配置

被如下接口引用：DescribeLiveDomainReferer。

名称	类型	描述
DomainName	String	域名。示例值：domainname
Enable	Integer	是否启用，0：关闭，1：启用。示例值：0
Type	Integer	名单类型，0：黑名单，1：白名单。示例值：0
AllowEmpty	Integer	是否允许空Referer，0：不允许，1：允许。示例值：1
Rules	String	名单列表，以分号(;)分隔。示例值：(rule1;rule2)

RuleInfo

规则信息。

被如下接口引用：DescribeLivePadRules, DescribeLiveRecordRules, DescribeLiveSnapshotRules, DescribeLiveTimeShiftRules, DescribeLiveTranscodeRules, DescribeLiveWatermarkRules。

名称	类型	描述
CreateTime	String	规则创建时间。注：此字段为北京时间（UTC+8时区）。示例值：2024-04-17 11:55:21
UpdateTime	String	规则更新时间。注：此字段为北京时间（UTC+8时区）。示例值：2024-04-17 11:55:21
TemplateId	Integer	模板 ID。示例值：8252
DomainName	String	推流域名。示例值：push.domain.com
AppName	String	推流路径。示例值：live
StreamName	String	流名称。示例值：stream

ScreenshotTask

截图任务

被如下接口引用：DescribeScreenshotTask。

名称	类型	描述
TaskId	String	截图任务ID。示例值：UpTbk5RSVhRQFkAAfHwQCCjcRD0lRFcZ0xTSlNTQltlRVRLU1JAWW9EUb
DomainName	String	推流域名。示例值：5000.live.push.com
AppName	String	推流路径。示例值：live
StreamName	String	流名称。示例值：livetest
StartTime	Integer	任务开始时间，Unix时间戳。示例值：1589904000
EndTime	Integer	任务结束时间，Unix时间戳。示例值：1589889600
TemplateId	Integer	截图模板ID。示例值：0
Stopped	Integer	调用 StopScreenshotTask 停止任务时间，Unix时间戳。值为0表示未曾调用接口停止任务。示例值：0

SnapshotTemplateInfo

截图模板信息。

被如下接口引用：DescribeLiveSnapshotTemplate, DescribeLiveSnapshotTemplates。

名称	类型	描述
TemplateId	Integer	模板 ID。示例值：85421
TemplateName	String	模板名称。示例值：templatename
SnapshotInterval	Integer	截图时间间隔，5-300秒。示例值：5
Width	Integer	截图宽度，范围：0-3000。 0：原始宽度并适配原始比例。示例值：5
Height	Integer	截图高度，范围：0-2000。 0：原始高度并适配原始比例。示例值：5
PornFlag	Integer	是否开启鉴黄，0：不开启，1：开启。示例值：0
CosAppId	Integer	Cos 应用 ID。示例值：746113
CosBucket	String	Cos Bucket名称。示例值：cosbucket
CosRegion	String	Cos 地域。示例值：ap-nanjing
Description	String	模板描述。示例值：测试模板
CosPrefix	String	Cos Bucket文件夹前缀。注意：此字段可能返回 null，表示取不到有效值。示例值：prefix_
CosFileName	String	Cos 文件名称。注意：此字段可能返回 null，表示取不到有效值。示例值：testname

StreamEventInfo

推断流事件信息。

被如下接口引用：DescribeLiveStreamEventList。

名称	类型	描述
AppName	String	应用名称。示例值：live
DomainName	String	推流域名。示例值：yourdomain.test.com
StreamName	String	流名称。示例值：stream1
StreamStartTime	String	推流开始时间。 UTC 格式时间，例如：2019-01-07T12:00:00Z。示例值：2019-01-04T11:59:58Z
StreamEndTime	String	推流结束时间。 UTC 格式时间，例如：2019-01-07T15:00:00Z。示例值：2019-01-04T11:59:58Z
StopReason	String	停止原因。示例值：客户端主动断流
Duration	Integer	推流持续时长，单位：秒。示例值：60
ClientIp	String	主播 IP。当客户端为内网推流时，展示为: - 。示例值：180.163.8.244
Resolution	String	分辨率。示例值：640*352

StreamName

流名称列表。

被如下接口引用：DescribeLiveStreamPublishedList。

名称	类型	描述
StreamName	String	流名称。示例值：stream1
AppName	String	应用名称。示例值：live
DomainName	String	推流域名。示例值：5000.livepush.myqcloud.com
StreamStartTime	String	推流开始时间。 UTC格式时间，例如：2019-01-07T12:00:00Z。示例值：2022-11-04T08:42:06Z
StreamEndTime	String	推流结束时间。 UTC格式时间，例如：2019-01-07T15:00:00Z。示例值：2022-11-04T09:10:58Z
StopReason	String	停止原因。示例值：推流客户端主动断流
Duration	Integer	推流持续时长，单位：秒。示例值：1732
ClientIp	String	主播 IP。示例值：127.0.0.1
Resolution	String	分辨率。示例值：640*360

StreamOnlineInfo

查询当前正在推流的信息

被如下接口引用：DescribeLiveStreamOnlineList。

名称	类型	描述
StreamName	String	流名称。示例值：stream1
PublishTimeList	Array of PublishTime	推流时间列表示例值：[{"PublishTime":"2022-07-11T08:56:36Z"}]
AppName	String	应用名称。示例值：live
DomainName	String	推流域名。示例值：5000.livepush.myqcloud.com
PushToDelay	Integer	流是否推送到延播。 0 - 无延播， 1 - 有延播。示例值：0

TaskDurationInfo

拉流转推任务的时长分布信息

被如下接口引用：DescribePullTransformPushInfo。

名称	类型	描述
Time	String	拉流转推任务的时间点示例值：2021-05-21 00:00:00
Duration	Integer	拉流转推任务的时长，单位为分钟示例值：5
DurationSecond	Integer	拉流转推任务的时长，单位为秒示例值：5

TaskStatusInfo

直播拉流任务状态信息。

被如下接口引用：DescribeLivePullStreamTaskStatus。

名称	类型	描述
FileUrl	String	当前使用的源 URL。示例值：http://live.push.com/live/stream.flv
LoopedTimes	Integer	点播源任务的轮播次数。示例值：2
OffsetTime	Integer	点播源的播放偏移，单位：秒。示例值：1500
ReportTime	String	最新心跳上报时间。UTC时间，例如： 2022-02-11T10:00:00Z。注意：UTC时间与北京时间相差八小时。示例值：2022-02-11T10:00:00Z
RunStatus	String	实际运行状态： active - 活跃， inactive - 不活跃。示例值：active
FileDuration	Integer	点播源的文件时长，单位：秒。示例值：56000
NextFileUrl	String	下一进度点播文件 URL。示例值：http://vod.play.com/live/stream.flv

TemplateInfo

转码模板信息。

被如下接口引用：DescribeLiveTranscodeTemplate, DescribeLiveTranscodeTemplates。

名称	类型	描述
Vcodec	String	视频编码：h264/h265/origin，默认h264。 origin: 保持原始编码格式示例值：h264
VideoBitrate	Integer	视频码率。范围：0kbps - 8000kbps。 0为保持原始码率。注: 转码模板有码率唯一要求，最终保存的码率可能与输入码率有所差别。示例值：0
Acodec	String	音频编码：aac，默认aac。注意：当前该参数未生效，待后续支持！示例值：aac
AudioBitrate	Integer	音频码率。取值范围：0kbps - 500kbps。默认0。示例值：0
Width	Integer	宽，默认0。范围[0-3000] 数值必须是2的倍数，0是原始宽度示例值：0
Height	Integer	高，默认0。范围[0-3000] 数值必须是2的倍数，0是原始宽度示例值：0
Fps	Integer	帧率，默认0。范围0-60fps 示例值：0
Gop	Integer	关键帧间隔，单位：秒。默认原始的间隔范围2-6 示例值：3
Rotate	Integer	旋转角度，默认0。可取值：0，90，180，270 示例值：0
Profile	String	编码质量： baseline/main/high。默认baseline 示例值：baseline
BitrateToOrig	Integer	当设置的码率>原始码率时，是否以原始码率为准。 0：否， 1：是默认 0。示例值：0
HeightToOrig	Integer	当设置的高度>原始高度时，是否以原始高度为准。 0：否， 1：是默认 0。示例值：0
FpsToOrig	Integer	当设置的帧率>原始帧率时，是否以原始帧率为准。 0：否， 1：是默认 0。示例值：0
NeedVideo	Integer	是否保留视频。0：否，1：是。示例值：0
NeedAudio	Integer	是否保留音频。0：否，1：是。示例值：0
TemplateId	Integer	模板 ID。示例值：855123
TemplateName	String	模板名称。示例值：templatename
Description	String	模板描述。示例值：description
AiTransCode	Integer	是否是极速高清模板，0：否，1：是。默认0。示例值：0
AdaptBitratePercent	Float	极速高清视频码率压缩比。极速高清目标码率=VideoBitrate * (1-AdaptBitratePercent) 取值范围：0.0到0.5 示例值：0.5
ShortEdgeAsHeight	Integer	是否以短边作为高度，0：否，1：是。默认0。注意：此字段可能返回 null，表示取不到有效值。示例值：0
DRMType	String	DRM 加密类型，可选值：fairplay、normalaes、widevine。注意：此字段可能返回 null，表示取不到有效值。示例值：widevine
DRMTracks	String	DRM 加密项，多个用\|分割，可选值：AUDIO、SD、HD、UHD1、UHD2，后四个为一组，同组中的内容只能选一个。注意：此字段可能返回 null，表示取不到有效值。示例值：AUDIO\|UHD2

TimeShiftBillData

时移计费明细数据。

被如下接口引用：DescribeLiveTimeShiftBillInfoList。

名称	类型	描述
Domain	String	推流域名。示例值："5000.playdomain.com"
Duration	Float	时移文件时长，单位分钟。示例值：3.25
StoragePeriod	Float	时移配置天数，单位天。示例值：1
Time	String	时间点，格式: yyyy-mm-ddTHH:MM:SSZ。示例值：2022-02-21T17:37:43+08:00
TotalDuration	Float	时移总时长，单位分钟。示例值：67.43

TimeShiftRecord

时移录制段。

被如下接口引用：DescribeTimeShiftRecordDetail。

名称	类型	描述
Sid	String	时移录制会话标识。示例值：46545
StartTime	Integer	录制会话开始时间，Unix 时间戳。示例值：1285512
EndTime	Integer	录制会话结束时间，Unix 时间戳。示例值：1295512

TimeShiftStreamInfo

时移流。

被如下接口引用：DescribeTimeShiftStreamList。

名称	类型	描述
DomainGroup	String	推流域名所属组。注意：此字段可能返回 null，表示取不到有效值。示例值：group
Domain	String	推流域名。示例值：push.domain.com
AppName	String	推流路径。示例值：live
StreamName	String	流名称。示例值：stream
StartTime	Integer	流起始时间，Unix 时间戳。示例值：15424755
EndTime	Integer	截止查询时流结束时间，Unix 时间戳。示例值：16424755
TransCodeId	Integer	转码模板ID。注意：此字段可能返回 null，表示取不到有效值。示例值：45223
StreamType	Integer	流类型，取值0为原始流，1为水印流，2为转码流。示例值：0
Duration	Integer	时移数据存储时长，单位秒。注意：此字段可能返回 null，表示取不到有效值。示例值：45562
TimeShiftSubStreams	Array of TimeShiftSubStream	时移自适应码率子流列表。注意：此字段可能返回 null，表示取不到有效值。

TimeShiftSubStream

时移自适应码率子流信息。

被如下接口引用：DescribeTimeShiftStreamList。

名称	类型	描述
TransCodeId	Integer	时移自适应码率子流转码模板ID。

TimeShiftTemplate

直播时移模板配置

被如下接口引用：DescribeLiveTimeShiftTemplates。

名称	类型	必选	描述
TemplateName	String	是	模板名称。示例值：mytemplate
Duration	Integer	是	时移时长。单位：秒。示例值：6000
ItemDuration	Integer	是	分片时长。可取3-10。单位：s。默认值：5。示例值：5
TemplateId	Integer	否	模板id。示例值：1
Description	String	否	模板描述。示例值：模板
Area	String	否	地域： Mainland：中国大陆； Overseas：海外及港澳台地区；默认值：Mainland。示例值：Mainland
RemoveWatermark	Boolean	否	是否去除水印。为true则将录制原始流。默认值：false。示例值：false
TranscodeTemplateIds	Array of Integer	否	转码流id列表。此参数仅在 RemoveWatermark为false时生效。示例值：[1]

TimeShiftWriteSizeData

直播时移写入量数据。

被如下接口引用：DescribeLiveTimeShiftWriteSizeInfoList。

名称	类型	描述
Area	String	区域。示例值：中国大陆
Time	String	时间，格式为：yyyy-mm-ddTHH:MM:SSZ。示例值：2022-11-18T15:00:00+08:00
WriteSize	Float	写入量（单位：字节）示例值：370390080
Domain	String	域名。示例值：5000.livepush.myqcloud.com
StorageDays	Integer	时移天数。示例值：7

TimeValue

某个时间点的指标的数值是多少。

被如下接口引用：DescribeScreenShotSheetNumList。

名称	类型	描述
Time	String	UTC 时间，时间格式：yyyy-mm-ddTHH:MM:SSZ。示例值：2019-11-07T16:00:00Z
Num	Integer	数值。示例值：41876427

TranscodeDetailInfo

转码详细信息。

被如下接口引用：DescribeLiveTranscodeDetailInfo。

名称	类型	描述
StreamName	String	流名称。示例值：streamname
StartTime	String	开始时间（北京时间），格式：yyyy-mm-dd HH:MM。示例值：2019-03-01 01:00
EndTime	String	结束时间（北京时间），格式：yyyy-mm-dd HH:MM。示例值：2019-03-01 01:00
Duration	Integer	转码时长，单位：分钟。注意：因推流过程中可能有中断重推情况，此处时长为真实转码时长累加值，并非结束时间和开始时间的间隔。示例值：8
ModuleCodec	String	编码方式，带模块，示例： liveprocessor_ACC: 音频转码， liveprocessor_H264：直播转码-H264， liveprocessor_H265：直播转码-H265， topspeed_H264：极速高清-H264， topspeed_H265：极速高清-H265。示例值：liveprocessor_H265
Bitrate	Integer	码率。示例值：1
Type	String	类型，包含：转码（Transcode），混流（MixStream），水印（WaterMark），快直播（Webrtc）。示例值：Transcode
PushDomain	String	推流域名。示例值：5000.livepush.com
Resolution	String	分辨率。示例值：720p
MainlandOrOversea	String	地域： Mainland：国内。 Overseas：海外。示例值：Mainland

TranscodeTaskNum

转码任务数。

被如下接口引用：DescribeTranscodeTaskNum。

名称	类型	描述
Time	String	时间点。示例值：2022-01-09 21:45
CodeRate	Integer	码率。示例值：2000
Num	Integer	任务数。示例值：1

TranscodeTotalInfo

转码总量数据

被如下接口引用：DescribeLiveTranscodeTotalInfo。

名称	类型	描述
Time	String	时间点，使用UTC格式时间，例如：2019-01-08T10:00:00Z。注意：北京时间值为 UTC 时间值 + 8 小时，格式按照 ISO 8601 标准表示，详见 ISO 日期格式说明。示例值：2022-11-14T14:04:59+08:00
Duration	Integer	转码时长，单位：分钟。示例值：1
ModuleCodec	String	编码方式，带模块，示例： liveprocessor_H264 =》直播转码-H264， liveprocessor_H265 =》直播转码-H265， topspeed_H264 =》极速高清-H264， topspeed_H265 =》极速高清-H265。示例值：liveprocessor_H264
Resolution	String	分辨率，示例：540*480。示例值：720P

TransitionTypeInfo

转场信息

被如下接口引用：DescribeCasterTransitionTypes。

名称	类型	描述
TransitionType	String	转场名称示例值：heart
SourceUrl	String	素材url 示例值：http://www.example.com/url/example
Index	Integer	转场的下标，可用来排序，从1开始递增示例值：1

WatermarkInfo

水印信息。

被如下接口引用：DescribeLiveWatermark, DescribeLiveWatermarks。

名称	类型	描述
WatermarkId	Integer	水印 ID。示例值：45621
PictureUrl	String	水印图片 URL。示例值：http://picture.com.url
XPosition	Integer	显示位置，X 轴偏移。示例值：45
YPosition	Integer	显示位置，Y 轴偏移。示例值：25
WatermarkName	String	水印名称。示例值：watername
Status	Integer	当前状态。0：未使用，1:使用中。示例值：0
CreateTime	String	添加时间。注：此字段为北京时间（UTC+8时区）。示例值：2024-04-17 11:55:21
Width	Integer	水印宽。示例值：54
Height	Integer	水印高。示例值：52
BackgroundWidth	Integer	背景水印宽。示例值：65
BackgroundHeight	Integer	背景水印高。示例值：56

XP2PDetailInfo

P2P流信息。

被如下接口引用：DescribeLiveXP2PDetailInfoList。

名称	类型	描述
CdnBytes	Integer	CDN流量。示例值：2825
P2pBytes	Integer	P2P流量。示例值：4785
StuckPeople	Integer	卡播人数。示例值：23
StuckTimes	Integer	卡播次数。示例值：75
OnlinePeople	Integer	在线人数。示例值：28
Request	Integer	起播请求次数示例值：66
RequestSuccess	Integer	起播成功次数示例值：21
Time	String	时间，一分钟粒度，utc格式：yyyy-mm-ddTHH:MM:SSZ，参考https://cloud.tencent.com/document/product/266/11732#I。。示例值：2022-08-03T16:00:00Z
Type	String	类型，分live和vod两种。示例值：live
StreamName	String	流ID。示例值：7852921
AppId	String	AppId。示例值：appidtest