API 文档

数据结构

最近更新时间:2020-08-06 08:13:43

BandwidthInfo

带宽信息

被如下接口引用:DescribeDeliverBandwidthList。

名称 类型 描述
Time String 返回格式:
yyyy-mm-dd HH:MM:SS
根据粒度会有不同程度的缩减。
Bandwidth Float 带宽。

BillDataInfo

带宽和流量信息。

被如下接口引用:DescribeBillBandwidthAndFluxList。

名称 类型 描述
Time String 时间点,格式: yyyy-mm-dd HH:MM:SS。
Bandwidth Float 带宽,单位是 Mbps。
Flux Float 流量,单位是 MB。
PeakTime String 峰值时间点,格式: yyyy-mm-dd HH:MM:SS,原始数据为5分钟粒度,如果查询小时和天粒度数据,则返回对应粒度内的带宽峰值时间点。

CallBackRuleInfo

规则信息

被如下接口引用:DescribeLiveCallbackRules。

名称 类型 描述
CreateTime String 规则创建时间。
UpdateTime String 规则更新时间。
TemplateId Integer 模板 ID。
DomainName String 推流域名。
AppName String 推流路径。

CallBackTemplateInfo

回调模板信息。

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

名称 类型 描述
TemplateId Integer 模板 ID。
TemplateName String 模板名称。
Description String 描述信息。
StreamBeginNotifyUrl String 开播回调 URL。
StreamEndNotifyUrl String 断流回调 URL。
StreamMixNotifyUrl String 混流回调 URL。
RecordNotifyUrl String 录制回调 URL。
SnapshotNotifyUrl String 截图回调 URL。
PornCensorshipNotifyUrl String 鉴黄回调 URL。
CallbackKey String 回调的鉴权 key。

CdnPlayStatData

下行播放统计指标

被如下接口引用:DescribeGroupProIspPlayInfoList。

名称 类型 描述
Time String 时间点,格式: yyyy-mm-dd HH:MM:SS。
Bandwidth Float 带宽,单位: Mbps。
Flux Float 流量,单位: MB。
Request Integer 新增请求数。
Online Integer 并发连接数。

CertInfo

证书信息。

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

名称 类型 描述
CertId Integer 证书 ID。
CertName String 证书名称。
Description String 描述信息。
CreateTime String 创建时间,UTC 格式。
HttpsCrt String 证书内容。
CertType Integer 证书类型:
0:腾讯云托管证书。
1:用户添加证书。
CertExpireTime String 证书过期时间,UTC 格式。
DomainList Array of String 使用此证书的域名列表。

ClientIpPlaySumInfo

客户端ip播放汇总信息。

被如下接口引用:DescribeTopClientIpSumInfoList。

名称 类型 描述
ClientIp String 客户端 IP,点分型。
Province String 客户端所在省份。
TotalFlux Float 总流量。
TotalRequest Integer 总请求数。
TotalFailedRequest Integer 总失败请求数。
CountryArea String 客户端所在国家。

CommonMixControlParams

通用混流控制参数

被如下接口引用:CreateCommonMixStream。

名称 类型 必选 描述
UseMixCropCenter Integer 取值范围[0,1]。
填1时,当参数中图层分辨率参数与视频实际分辨率不一致时,自动从视频中按图层设置的分辨率比例进行裁剪。
AllowCopy Integer 取值范围[0,1]
填1时,当InputStreamList中个数为1时,且OutputParams.OutputStreamType为1时,不执行取消操作,执行拷贝流操作

CommonMixCropParams

通用混流输入裁剪参数。

被如下接口引用:CreateCommonMixStream。

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

CommonMixInputParam

通用混流输入参数。

被如下接口引用:CreateCommonMixStream。

名称 类型 必选 描述
InputStreamName String 输入流名称。80字节以内,仅含字母、数字以及下划线的字符串。
LayoutParams CommonMixLayoutParams 输入流布局参数。
CropParams CommonMixCropParams 输入流裁剪参数。

CommonMixLayoutParams

通用混流布局参数。

被如下接口引用:CreateCommonMixStream。

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

CommonMixOutputParams

通用混流输出参数。

被如下接口引用:CreateCommonMixStream。

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

ConcurrentRecordStreamNum

并发录制路数

被如下接口引用:DescribeConcurrentRecordStreamNum。

名称 类型 描述
Time String 时间点。
Num Integer 路数。

DayStreamPlayInfo

流播放信息

被如下接口引用:DescribeStreamPlayInfoList。

名称 类型 描述
Time String 数据时间点,格式:yyyy-mm-dd HH:MM:SS。
Bandwidth Float 带宽(单位Mbps)。
Flux Float 流量 (单位MB)。
Request Integer 请求数。
Online Integer 在线人数。

DelayInfo

延播信息。

被如下接口引用:DescribeLiveDelayInfoList。

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

DomainCertInfo

域名证书信息

被如下接口引用:DescribeLiveDomainCert。

名称 类型 描述
CertId Integer 证书Id。
CertName String 证书名称。
Description String 描述信息。
CreateTime String 创建时间,UTC格式。
HttpsCrt String 证书内容。
CertType Integer 证书类型。
0:用户添加证书,
1:腾讯云托管证书。
CertExpireTime String 证书过期时间,UTC格式。
DomainName String 使用此证书的域名名称。
Status Integer 证书状态。

DomainDetailInfo

每个域名的统计信息。

被如下接口引用:DescribeLiveDomainPlayInfoList。

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

DomainInfo

直播域名信息

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

名称 类型 描述
Name String 直播域名。
Type Integer 域名类型:
0: 推流。
1: 播放。
Status Integer 域名状态:
0: 停用。
1: 启用。
CreateTime String 添加时间。
BCName Integer 是否有 CName 到固定规则域名:
0: 否。
1: 是。
TargetDomain String cname 对应的域名。
PlayType Integer 播放区域,只在 Type=1 时该参数有意义。
1: 国内。
2: 全球。
3: 海外。
IsDelayLive Integer 是否慢直播:
0: 普通直播。
1: 慢直播。
CurrentCName String 当前客户使用的 cname 信息。
RentTag Integer 失效参数,可忽略。
RentExpireTime String 失效参数,可忽略。
IsMiniProgramLive Integer 0: 标准直播。
1: 小程序直播。
注意:此字段可能返回 null,表示取不到有效值。

DomainInfoList

多个域名信息列表

被如下接口引用:DescribeLiveDomainPlayInfoList。

名称 类型 描述
Domain String 域名。
DetailInfoList Array of DomainDetailInfo 明细信息。

ForbidStreamInfo

禁推流列表

被如下接口引用:DescribeLiveForbidStreamList。

名称 类型 描述
StreamName String 流名称。
CreateTime String 创建时间。
ExpireTime String 禁推过期时间。

GroupProIspDataInfo

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

被如下接口引用:DescribeGroupProIspPlayInfoList。

名称 类型 描述
ProvinceName String 省份。
IspName String 运营商。
DetailInfoList Array of CdnPlayStatData 分钟维度的明细数据。

HlsSpecialParam

HLS专属录制参数

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

名称 类型 必选 描述
FlowContinueDuration Integer HLS续流超时时间。
取值范围[0,1800]。

HttpCodeInfo

HTTP返回码和统计数据

被如下接口引用:DescribePlayErrorCodeDetailInfoList。

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

HttpCodeValue

HTTP返回码数据信息

被如下接口引用:DescribePlayErrorCodeDetailInfoList。

名称 类型 描述
Time String 时间,格式:yyyy-mm-dd HH:MM:SS。
Numbers Integer 次数。
Percentage Float 占比。

HttpStatusData

播放错误码信息

被如下接口引用:DescribeHttpStatusInfoList。

名称 类型 描述
Time String 数据时间点,
格式:yyyy-mm-dd HH:MM:SS。
HttpStatusInfoList Array of HttpStatusInfo 播放状态码详细信息。

HttpStatusInfo

播放错误码信息

被如下接口引用:DescribeHttpStatusInfoList。

名称 类型 描述
HttpStatus String 播放HTTP状态码。
Num Integer 个数。

LivePackageInfo

直播包信息。

被如下接口引用:DescribeLivePackageInfo。

名称 类型 描述
Id String 包 ID。
Total Integer 总量。
注意:当为流量包时单位为字节。
当为转码包时单位为分钟。
Used Integer 使用量。
注意:当为流量包时单位为字节。
当为转码包时单位为分钟。
Left Integer 剩余量。
注意:当为流量包时单位为字节。
当为转码包时单位为分钟。
BuyTime String 购买时间。
ExpireTime String 过期时间。
Type Integer 包类型,可选值:
0: 流量包。
1: 普通转码包。
2: 极速高清包。
Status Integer 包状态,可选值:
0: 未使用。
1: 使用中。
2: 已过期。

LogInfo

日志url信息。

被如下接口引用:DescribeLogDownloadList。

名称 类型 描述
LogName String 日志名称。
LogUrl String 日志 URL。
LogTime String 日志生成时间。
FileSize Integer 文件大小。

MonitorStreamPlayInfo

监控播放数据

被如下接口引用:DescribeAllStreamPlayInfoList。

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

PlayAuthKeyInfo

播放鉴权key信息。

被如下接口引用:DescribeLivePlayAuthKey。

名称 类型 描述
DomainName String 域名。
Enable Integer 是否启用:
0: 关闭。
1: 启用。
AuthKey String 鉴权 Key。
AuthDelta Integer 有效时间,单位:秒。
AuthBackKey String 鉴权 BackKey。

PlayCodeTotalInfo

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

被如下接口引用:DescribePlayErrorCodeSumInfoList。

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

PlayDataInfoByStream

流维度的播放信息。

被如下接口引用:DescribeStreamDayPlayInfoList。

名称 类型 描述
StreamName String 流名称。
TotalFlux Float 总流量,单位: MB。

PlayStatInfo

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

被如下接口引用:DescribeProvinceIspPlayInfoList。

名称 类型 描述
Time String 数据时间点。
Value Float 带宽/流量/请求数/并发连接数/下载速度的值,若没数据返回时该值为0。
注意:此字段可能返回 null,表示取不到有效值。

PlaySumStatInfo

播放汇总统计信息。

被如下接口引用:DescribeVisitTopSumInfoList。

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

ProIspPlayCodeDataInfo

播放错误码信息

被如下接口引用:DescribePlayErrorCodeSumInfoList。

名称 类型 描述
CountryAreaName String 国家或地区。
ProvinceName String 省份。
IspName String 运营商。
Code2xx Integer 错误码为2开头的次数。
Code3xx Integer 错误码为3开头的次数。
Code4xx Integer 错误码为4开头的次数。
Code5xx Integer 错误码为5开头的次数。

ProIspPlaySumInfo

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

被如下接口引用:DescribeProIspPlaySumInfoList。

名称 类型 描述
Name String 省份/运营商/国家或地区。
TotalFlux Float 总流量,单位: MB。
TotalRequest Integer 总请求数。
AvgFluxPerSecond Float 平均下载流量,单位: MB/s。

PublishTime

推流时间。

被如下接口引用:DescribeLiveStreamOnlineList。

名称 类型 描述
PublishTime String 推流时间。
UTC 格式,例如:2018-06-29T19:00:00Z。

PullStreamConfig

拉流配置。

被如下接口引用:DescribePullStreamConfigs。

名称 类型 描述
ConfigId String 拉流配置 ID。
FromUrl String 源 URL。
ToUrl String 目的 URL。
AreaName String 区域名。
IspName String 运营商名。
StartTime String 开始时间。
UTC格式时间,例如: 2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
EndTime String 结束时间。

UTC格式时间,例如:2019-01-08T10:00:00Z。
注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 ISO 日期格式说明
Status String 状态:
0: 无效。
1: 初始状态。
2: 正在运行。
3: 拉起失败。
4: 暂停。

PushAuthKeyInfo

推流鉴权key信息。

被如下接口引用:DescribeLivePushAuthKey。

名称 类型 描述
DomainName String 域名。
Enable Integer 是否启用,0:关闭,1:启用。
MasterAuthKey String 主鉴权 Key。
BackupAuthKey String 备鉴权 Key。
AuthDelta Integer 有效时间,单位:秒。

PushDataInfo

推流数据信息

被如下接口引用:DescribeLiveStreamPushInfoList。

名称 类型 描述
StreamName String 流名称。
AppName String 推流路径。
ClientIp String 推流客户端 IP。
ServerIp String 接流服务器 IP。
VideoFps Integer 推流视频帧率,单位: Hz。
VideoSpeed Integer 推流视频码率,单位: bps。
AudioFps Integer 推流音频帧率,单位: Hz。
AudioSpeed Integer 推流音频码率,单位: bps。
PushDomain String 推流域名。
BeginPushTime String 推流开始时间。
Acodec String 音频编码格式,
例:"AAC"。
Vcodec String 视频编码格式,
例:"H264"。
Resolution String 分辨率。
AsampleRate Integer 采样率。
MetaAudioSpeed Integer metadata 中的音频码率,单位: Kbps。
MetaVideoSpeed Integer metadata 中的视频码率,单位: Kbps。
MetaFps Integer metadata 中的帧率。

PushQualityData

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

被如下接口引用:DescribeStreamPushInfoList。

名称 类型 描述
Time String 数据时间,格式: %Y-%m-%d %H:%M:%S.%ms,精确到毫秒级。
PushDomain String 推流域名。
AppName String 推流路径。
ClientIp String 推流客户端 IP。
BeginPushTime String 开始推流时间,格式: %Y-%m-%d %H:%M:%S.%ms,精确到毫秒级。
Resolution String 分辨率信息。
VCodec String 视频编码格式。
ACodec String 音频编码格式。
Sequence String 推流序列号,用来唯一的标志一次推流。
VideoFps Integer 视频帧率。
VideoRate Integer 视频码率,单位: bps。
AudioFps Integer 音频帧率。
AudioRate Integer 音频码率,单位: bps。
LocalTs Integer 本地流逝时间,单位: ms,音视频流逝时间与本地流逝时间的差距越大表示推流质量越差,上行卡顿越严重。
VideoTs Integer 视频流逝时间,单位: ms。
AudioTs Integer 音频流逝时间,单位: ms。
MetaVideoRate Integer metadata 中的视频码率,单位: kbps。
MetaAudioRate Integer metadata 中的音频码率,单位: kbps。
MateFps Integer metadata 中的帧率。

RecordParam

录制模板参数。

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

名称 类型 必选 描述
RecordInterval Integer 录制间隔。
单位秒,默认:1800。
取值范围:300-7200。
此参数对 HLS 无效,当录制 HLS 时从推流到断流生成一个文件。
StorageTime Integer 录制存储时长。
单位秒,取值范围: 0 - 93312000。
0:表示永久存储。
Enable Integer 是否开启当前格式录制,默认值为0,0:否, 1:是。
VodSubAppId Integer 点播子应用 ID。
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}

RecordTemplateInfo

录制模板信息

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

名称 类型 描述
TemplateId Integer 模板 ID。
TemplateName String 模板名称。
Description String 描述信息。
FlvParam RecordParam FLV 录制参数。
HlsParam RecordParam HLS 录制参数。
Mp4Param RecordParam MP4 录制参数。
AacParam RecordParam AAC 录制参数。
IsDelayLive Integer 0:普通直播,
1:慢直播。
HlsSpecialParam HlsSpecialParam HLS 录制定制参数
Mp3Param RecordParam MP3 录制参数。

RuleInfo

规则信息。

被如下接口引用:DescribeLiveRecordRules, DescribeLiveSnapshotRules, DescribeLiveTranscodeRules, DescribeLiveWatermarkRules。

名称 类型 描述
CreateTime String 规则创建时间。
UpdateTime String 规则更新时间。
TemplateId Integer 模板 ID。
DomainName String 推流域名。
AppName String 推流路径。
StreamName String 流名称。

SnapshotTemplateInfo

截图模板信息。

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

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

StreamEventInfo

推断流事件信息。

被如下接口引用:DescribeLiveStreamEventList。

名称 类型 描述
AppName String 应用名称。
DomainName String 推流域名。
StreamName String 流名称。
StreamStartTime String 推流开始时间。
UTC 格式时间,例如:2019-01-07T12:00:00Z。
StreamEndTime String 推流结束时间。
UTC 格式时间,例如:2019-01-07T15:00:00Z。
StopReason String 停止原因。
Duration Integer 推流持续时长,单位:秒。
ClientIp String 主播 IP。
Resolution String 分辨率。

StreamName

流名称列表。

被如下接口引用:DescribeLiveStreamPublishedList。

名称 类型 描述
StreamName String 流名称。
AppName String 应用名称。
DomainName String 推流域名。
StreamStartTime String 推流开始时间。
UTC格式时间,例如:2019-01-07T12:00:00Z。
StreamEndTime String 推流结束时间。
UTC格式时间,例如:2019-01-07T15:00:00Z。
StopReason String 停止原因。
Duration Integer 推流持续时长,单位:秒。
ClientIp String 主播 IP。
Resolution String 分辨率。

StreamOnlineInfo

查询当前正在推流的信息

被如下接口引用:DescribeLiveStreamOnlineList。

名称 类型 描述
StreamName String 流名称。
PublishTimeList Array of PublishTime 推流时间列表
AppName String 应用名称。
DomainName String 推流域名。

TemplateInfo

转码模板信息。

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

名称 类型 描述
Vcodec String 视频编码:
h264/h265。
VideoBitrate Integer 视频码率,取值范围:100kbps - 8000kbps。
Acodec String 音频编码,可选 aac 或 mp3。
AudioBitrate Integer 音频码率。取值范围:0kbps - 500kbps。
Width Integer 宽,取值范围:0-3000。
Height Integer 高,取值范围:0-3000。
Fps Integer 帧率。取值范围:0fps - 200fps。
Gop Integer 关键帧间隔,取值范围:1秒 - 50秒。
Rotate Integer 旋转角度。可选择:0 90 180 270。
Profile String 编码质量,可选择:
baseline,main,high。
BitrateToOrig Integer 是否不超过原始码率。0:否,1:是。
HeightToOrig Integer 是否不超过原始高度。0:否,1:是。
FpsToOrig Integer 是否不超过原始帧率。0:否,1:是。
NeedVideo Integer 是否保留视频。0:否,1:是。
NeedAudio Integer 是否保留音频。0:否,1:是。
TemplateId Integer 模板 ID。
TemplateName String 模板名称。
Description String 模板描述。
AiTransCode Integer 是否是极速高清模板,0:否,1:是。默认0。
AdaptBitratePercent Float 极速高清相比 VideoBitrate 少多少码率,0.1到0.5。

TimeValue

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

被如下接口引用:DescribeScreenShotSheetNumList。

名称 类型 描述
Time String UTC 时间,时间格式:yyyy-mm-ddTHH:MM:SSZ。
Num Integer 数值。

TranscodeDetailInfo

转码详细信息。

被如下接口引用:DescribeLiveTranscodeDetailInfo。

名称 类型 描述
StreamName String 流名称。
StartTime String 开始时间(北京时间),格式:yyyy-mm-dd HH:MM。
EndTime String 结束时间(北京时间),格式:yyyy-mm-dd HH:MM。
Duration Integer 转码时长,单位:分钟。
注意:因推流过程中可能有中断重推情况,此处时长为真实转码时长累加值,并非结束时间和开始时间的间隔。
ModuleCodec String 编码方式,带模块,
示例:
liveprocessor_H264:直播转码-H264,
liveprocessor_H265: 直播转码-H265,
topspeed_H264:极速高清-H264,
topspeed_H265:极速高清-H265。
Bitrate Integer 码率。
Type String 类型,包含:转码(Transcode),混流(MixStream),水印(WaterMark)。
PushDomain String 推流域名。
Resolution String 分辨率。

WatermarkInfo

水印信息。

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

名称 类型 描述
WatermarkId Integer 水印 ID。
PictureUrl String 水印图片 URL。
XPosition Integer 显示位置,X 轴偏移。
YPosition Integer 显示位置,Y 轴偏移。
WatermarkName String 水印名称。
Status Integer 当前状态。0:未使用,1:使用中。
CreateTime String 添加时间。
Width Integer 水印宽。
Height Integer 水印高。
目录