tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
1,885 lines (1,769 loc) • 282 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 直播审核关键词信息 */
declare interface AuditKeyword {
/** 关键词内容。 */
Content: string;
/** 关键词标签。可取值:Normal: 正常 ,Polity: 政治,Porn: 色情,Sexy:性感,Ad: 广告,Illegal: 违法,Abuse: 谩骂,Terror: 暴恐,Spam: 灌水,Moan:呻吟。 */
Label: string;
}
/** 直播审核删除关键词结果详情。 */
declare interface AuditKeywordDeleteDetail {
/** 关键词 Id。 */
KeywordId?: string;
/** 关键词内容。 */
Content?: string;
/** 是否删除成功。 */
Deleted?: boolean;
/** 如果删除失败,错误信息。 */
Error?: string;
}
/** 直播审核关键词查询信息。 */
declare interface AuditKeywordInfo {
/** 关键词 Id。 */
KeywordId?: string;
/** 关键词内容。 */
Content?: string;
/** 关键词标签。可取值:Normal: 正常 ,Polity: 政治,Porn: 色情,Sexy:性感,Ad: 广告,Illegal: 违法,Abuse: 谩骂,Terror: 暴恐,Spam: 灌水,Moan:呻吟。 */
Label?: string;
/** 创建时间。UTC 格式,例如:2018-11-29T19:00:00Z。注意:1. 北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示。 */
CreateTime?: string;
}
/** 主备流详细信息。 */
declare interface BackupStreamDetailData {
/** 推流域名。 */
DomainName?: string;
/** 推流路径。 */
AppName?: string;
/** UTC 格式,例如:2018-06-29T19:00:00Z。注意:和北京时间相差8小时。 */
PublishTime?: string;
/** 推流唯一标识。 */
UpstreamSequence?: string;
/** 推流来源。示例:直推流;拉流转推(1234);注意:拉流转推来源括号中为拉流转推的任务 ID。 */
SourceFrom?: string;
/** 主备标识。当前流为主流:1,当前流为备流: 0。 */
MasterFlag?: number;
}
/** 主备流分组信息。 */
declare interface BackupStreamGroupInfo {
/** 流名称。 */
StreamName?: string;
/** 主备流信息。 */
BackupList?: BackupStreamDetailData[];
/** 是否对该流开启了择优调度。0 - 未开启。1 - 已开启。 */
OptimalEnable?: number;
/** 域名分组的分组名称。 */
HostGroupName?: string;
}
/** 带宽信息 */
declare interface BandwidthInfo {
/** 返回格式:使用UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543)。根据粒度会有不同程度的缩减。 */
Time?: string;
/** 带宽。 */
Bandwidth?: number;
}
/** 批量操作域名相关接口,若其中个别域名操作失败将会跳过,相应的域名错误信息将统一汇总在此类型中 */
declare interface BatchDomainOperateErrors {
/** 操作失败的域名。 */
DomainName?: string;
/** API3.0错误码。 */
Code?: string;
/** API3.0错误信息。 */
Message?: string;
}
/** 海外分区直播带宽出参,分区信息 */
declare interface BillAreaInfo {
/** 大区名称。 */
Name: string;
/** 国家或地区明细数据。 */
Countrys: BillCountryInfo[];
}
/** 海外分区直播带宽出参国家带宽信息 */
declare interface BillCountryInfo {
/** 国家名称 */
Name?: string;
/** 带宽明细数据信息。 */
BandInfoList?: BillDataInfo[];
}
/** 带宽和流量信息。 */
declare interface BillDataInfo {
/** 时间点,使用UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
Time: string;
/** 带宽,单位是 Mbps。 */
Bandwidth: number;
/** 流量,单位是 MB。 */
Flux: number;
/** 峰值时间点,使用UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。原始数据为5分钟粒度,如果查询小时和天粒度数据,则返回对应粒度内的带宽峰值时间点。 */
PeakTime: string;
}
/** 规则信息 */
declare interface CallBackRuleInfo {
/** 规则创建时间。注:此字段为北京时间(UTC+8时区)。 */
CreateTime?: string;
/** 规则更新时间。注:此字段为北京时间(UTC+8时区)。 */
UpdateTime?: string;
/** 模板 ID。 */
TemplateId?: number;
/** 推流域名。 */
DomainName?: string;
/** 推流路径。 */
AppName?: string;
}
/** 回调模板信息。 */
declare interface CallBackTemplateInfo {
/** 模板 ID。 */
TemplateId?: number;
/** 模板名称。 */
TemplateName?: string;
/** 描述信息。 */
Description?: string;
/** 开播回调 URL。 */
StreamBeginNotifyUrl?: string;
/** 混流回调 URL。(参数已弃用)。 */
StreamMixNotifyUrl?: string;
/** 断流回调 URL。 */
StreamEndNotifyUrl?: string;
/** 录制文件回调 URL。 */
RecordNotifyUrl?: string;
/** 截图回调 URL。 */
SnapshotNotifyUrl?: string;
/** 鉴黄回调 URL。 */
PornCensorshipNotifyUrl?: string;
/** 回调的鉴权 key。 */
CallbackKey?: string;
/** 推流异常回调 URL。 */
PushExceptionNotifyUrl?: string | null;
/** 音频审核回调 URL。 */
AudioAuditNotifyUrl?: string | null;
/** 录制异常回调 URL。 */
RecordExceptionNotifyUrl?: string;
/** 录制异常回调级别,可选择:error: 错误。alarm: 告警。 */
RecordExceptionLevels?: string[];
}
/** 回调事件信息 */
declare interface CallbackEventInfo {
/** 事件时间。接口返回支持两种时间格式:1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。接口返回的时间格式和查询请求传入的时间格式一致。 */
EventTime?: string;
/** 事件类型。 */
EventType?: number;
/** 回调请求。 */
Request?: string;
/** 回调响应。 */
Response?: string;
/** 客户接口响应时间。接口返回支持两种时间格式:1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。接口返回的时间格式和查询请求传入的时间格式一致。 */
ResponseTime?: string;
/** 回调结果。 */
ResultCode?: number;
/** 流名称。 */
StreamId?: string;
}
/** 导播台简略信息 */
declare interface CasterBriefInfo {
/** 导播台ID */
CasterId?: number;
/** 导播台名称 */
CasterName?: string;
/** 导播台的描述 */
Description?: string;
/** 开始计费时间,值为unix时间戳 */
StartBillingTime?: number;
/** 结束计费时间,值为unix时间戳 */
StopBillingTime?: number;
/** 创建时间,值为unix时间戳 */
CreateTime?: number;
/** 导播台状态0:停止状态,无预监,无主监1:无预监,有主监2:有预监,无主监3:有预监,有主监 */
Status?: number;
/** 导播台的过期时间,值为-1或unix时间戳。当值为-1时,代表永不过期。当值为特定unix时间戳时,代表过期时间为对应的时间,导播台在该时间自动停止。 */
ExpireTime?: number;
/** 计费字段,该字段暂无作用 */
FeeType?: number;
}
/** 导播台展示信息,包括使用的布局、水印、字幕、转场、音频等信息 */
declare interface CasterDisplayInfo {
/** 布局Index。如果使用自定义布局,为自定义布局下标。如果使用单输入布局,如使用输入1,则LayoutIndexType=1, 且LayoutIndex=1,以此类推。 */
LayoutIndex?: number;
/** 使用的水印Index列表。注:当作为入参使用时,列表中的水印Index需要已经存在。 */
MarkPicIndexList?: number[];
/** 使用的文字水印Index列表。注:作为入参使用时,列表中的Index需要已经存在。 */
MarkWordIndexList?: number[];
/** 使用的转场类型。注:支持的转场类型可通过DescribeCasterTransitionTypes接口获取。 */
TransitionType?: string;
/** 使用的音频输入Index列表。注:当该字段非空时,表示使用布局中对应的输入源的视频,AudioIndexList中对应的输入源的音频。且这些输入源需已存在。 */
AudioIndexList?: number[];
/** 作为入参时,表示使用点播输入源,单画面输入时,点播文件是否从头开始播放。默认为0。有效值,0,1。0代表不从头播放1代表从头播放 */
InputStartType?: number;
/** LayoutIndex类型,默认值:0可选值[0,1]0:默认类型,代表普通布局1:单输入类型,代表单输入布局 */
LayoutIndexType?: number;
}
/** 导播台信息 */
declare interface CasterInfo {
/** 导播台ID */
CasterId?: number;
/** 导播台名称 */
CasterName?: string;
/** 导播台上一次启动pgm的时间,值为unix时间戳。 */
StartLiveTime?: number;
/** 导播台的描述 */
Description?: string;
/** 导播台创建时间,值为unix时间戳。 */
CreateTime?: number;
/** 导播台状态 0:停止状态,无预监,无主监1:无预监,有主监2:有预监,无主监3:有预监,有主监 */
Status?: number;
/** 导播台的过期时间戳。值为-1或unix时间戳。 默认值为-1。 当值为-1时,表示该导播台永不过期。 当值为正常unix时间戳时,导播台将在该时间过期。 导播台过期后,预监与主监画面将自动停止,转推自动停止。 点播、直播url将停止转拉,推流url需自行停止推流。 */
ExpireTime?: number;
/** 导播台延时播放时间,单位为秒。 */
DelayTime?: number;
/** 导播台主监输出的宽度,单位为像素。 */
PgmWidth?: number;
/** 导播台主监输出的高度,单位为像素。 */
PgmHeight?: number;
/** 导播台主监输出的帧率。 */
PgmFps?: number;
/** 导播台主监输出的码率,单位为kbps */
PgmBitRate?: number;
/** 导播台主监输出的音频码率,单位为kbps。 */
PgmAudioBitRate?: number;
/** 导播台的计费类型。 0 通用型 1 播单型。注: 本参数暂无作用。 */
FeeType?: number;
/** 录制模板id。 */
RecordTemplateId?: number;
/** 录制状态。 0:未录制 1:录制中 */
RecordStatus?: number;
/** 录制接口返回的taskid */
RecordTaskId?: string;
}
/** 导播台输入信息参数 */
declare interface CasterInputInfo {
/** 输入源Index。范围[1, 24] */
InputIndex: number;
/** 输入源类型。范围[0,1,2,3,4]。0:推流地址。1:点播文件地址。2:直播拉流地址。3:图片地址。4:webrtc协议推流地址。 */
InputType?: number;
/** 输入源的源地址。最大允许长度512。当InputType为0(推流地址),2(直播拉流地址),3(图片地址),4(webrtc推流地址)这几种类型时,URL需填入该字段。 */
InputUrl?: string;
/** 输入源描述。最大允许长度256字符。 */
Description?: string;
/** 点播地址列表。仅当input type为1(点播地址)时,将一个或多个点播地址,填入该字段。单个地址最大允许长度512字符。最多允许同时填入5个地址。注:此时需保持InputUrl字段为空。 */
InputUrls?: string[];
/** 是否启用点播无限循环播放。注:当前该字段未生效,默认为True。 */
LoopEnable?: boolean;
/** 点播循环次数。允许值-1或正整数。当值为-1时,表示无限循环。当值为其他正整数时,表示循环对应次数。注:该字段暂未生效。 */
LoopNumber?: number;
/** 是否启用拉取到导播台。注:该字段默认强制为true。 */
PullPushEnable?: boolean;
/** 输入源音量百分比。默认为100。表示音量为原始大小。允许值[0,200]。 */
Volume?: number;
}
/** 导播台布局参数。 */
declare interface CasterLayoutInfo {
/** 布局Index。 */
LayoutIndex: number;
/** 布局模板Id。有效值[1,20,21,31,32,41]当使用布局模版时,无需LayoutParams参数,导播台将使用模版布局参数。 */
LayoutTemplateId?: number;
/** 布局绑定的输入列表。按布局LayerId从小到大,按顺序排列。已有两个画面的布局为例,输入1对应LayerId为1,输入2对应的LayerId为2,该字段应该填入"1|2"。 */
InputIndexList?: string;
/** 详细的布局参数列表。 */
LayoutParams?: CasterLayoutParam[];
/** 布局输出的宽度,单位为像素。默认为1280像素。注:该值仅在画中画布局,且未设置PgmWidth时生效。 */
LayoutWidth?: number;
/** 布局输出的高度,单位为像素。注:该参数仅在画中画布局,且未设置PgmHeight时生效。 */
LayoutHeight?: number;
}
/** 导播台布局详细参数。 */
declare interface CasterLayoutParam {
/** 布局层ID。在画面最终渲染时,将按ID从小到大的顺序,由下至上渲染。 */
LayerId: number;
/** 布局层宽度。单位为百分比,范围[0.0,1.0],表示该层在最终画面上所占的比例值。 */
LayerWidth: number;
/** 布局层高度。单位为百分比,范围[0.0,1.0], 表示该层在最终画面上所占的比例值。 */
LayerHeight: number;
/** 布局层位置x坐标。单位为百分比,范围[0.0,1.0],表示该层在最终画面上x坐标所占的比例值。 */
LayerLocationX: number;
/** 布局层位置Y坐标。单位为百分比,范围[0.0,1.0], 表示该层在最终画面Y坐标上所占的比例值。 */
LayerLocationY: number;
/** 是否启用抠图。 */
UsePortraitSegment?: boolean;
}
/** 导播台水印信息。 */
declare interface CasterMarkPicInfo {
/** 水印图片Index。 */
MarkPicIndex: number;
/** 注:该字段已废弃。 */
MarkPicId?: number;
/** 水印图片在输出时的宽度。当该值为大于1的整数值时,单位为像素,允许范围[1,1920]。 当该值为小于1大于0的小数时,单位为百分比,表示水印在最终画面上所占的比例值。 */
MarkPicWidth?: number;
/** 水印图片在输出时的高度。当该值为大于1的整数值时,单位为像素,允许范围[1,1080]。 当该值为小于1大于0的小数时,单位为百分比,表示水印在输出上所占的比例值。 */
MarkPicHeight?: number;
/** 水印图片在输出时的X轴坐标。当该值为大于1的整数值时,单位为像素,允许范围[1,1920]。 当该值为小于1大于0的小数时,单位为百分比,表示水印在最终画面上x坐标所占的比例值。 */
MarkPicLocationX?: number;
/** 水印图片在输出时的Y坐标。当该值为大于1的整数值时,单位为像素,允许范围[1,1080]。 当该值为小于1大于0的小数时,单位为百分比,表示水印在最终画面Y坐标上所占的比例值。 */
MarkPicLocationY?: number;
/** 水印地址。最大长度256字符,且url需以jpg、jpeg、png、bmp、gif后缀结尾。 */
MarkPicUrl?: string;
/** 水印描述。最大允许长度为256。 */
Description?: string;
/** 是否启用了等比例缩放。注:该字段仅做状态保存,无实际效果。 */
IsEqualProportion?: boolean;
}
/** 导播台文字水印配置。 */
declare interface CasterMarkWordInfo {
/** 文字水印Index。 */
MarkWordIndex: number;
/** 文字水印内容。 */
MarkWordText?: string;
/** 文字水印的字号。范围[16, 60] */
MarkWordFontSize?: number;
/** 文字水印的颜色,值为HEX颜色代码 */
MarkWordFontColor?: string;
/** 文字水印的字体类型。范围[1,2]。1. 宋体2. 黑体 */
MarkWordFontType?: number;
/** 文字水印的x坐标位置,单位百分比。范围[0.0, 1.0] */
MarkWordLocationX?: number;
/** 文字水印的Y坐标位置,单位百分比。范围[0.0, 1.0] */
MarkWordLocationY?: number;
/** 是否开启文字跑马灯功能。默认为false。 */
MarkWordRollEnable?: boolean;
/** 跑马灯文字显示一遍的时间,单位为秒。默认为5s。范围[5, 600]。 */
MarkWordRollOnceTime?: number;
/** 跑马灯文字的方向。默认值为0。范围[0,1]。0 从左到右1 从右到左 */
MarkWordRollDirection?: number;
/** 跑马灯文字显示的起始x坐标,单位百分比。范围[0.0, 1.0] */
MarkWordRollStartLocationX?: number;
/** 跑马灯文字显示的截止x坐标,单位百分比。范围[0.0, 1.0] */
MarkWordRollEndLocationX?: number;
}
/** 导播台推流信息。当导播台主监启动后,系统将自动将主监推流到腾讯云和其他第三方平台。 */
declare interface CasterOutputInfo {
/** 推流信息Index。当OutputType为1(表示推流到腾讯云直播)时,该值固定为0。范围[0,10]。 */
OutputIndex: number;
/** rtmp协议推流地址。最大允许长度512字符。 */
OutputUrl?: string;
/** 描述信息。 */
Description?: string;
/** 推流到腾讯云直播源站时,使用的流ID。仅当OutputType为1时生效。最大允许128字符。 */
OutputStreamId?: string;
/** 推流类型。范围[1,2]1. 推送到腾讯云直播源站。2. 推送到第三方源站。 */
OutputType?: number;
/** 推到腾讯云直播源站时,使用的域名。最大允许128字符,且域名需属于当前账号绑定的云直播推流域名。仅在OutputType为1时生效。 */
OutputDomainName?: string;
/** 推到腾讯云直播源站时,使用的AppName。最大允许64字符。仅在OutputType为1时生效。 */
OutputAppName?: string;
/** 推到腾讯云直播源站时需要添加的推流参数。最大允许长度256字符。仅在OutputType为1时生效。 */
OutputParam?: string;
}
/** 下行播放统计指标 */
declare interface CdnPlayStatData {
/** 时间点,使用UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
Time: string;
/** 带宽,单位: Mbps。 */
Bandwidth: number;
/** 流量,单位: MB。 */
Flux: number;
/** 新增请求数。 */
Request: number;
/** 并发连接数。 */
Online: number;
}
/** 证书信息。 */
declare interface CertInfo {
/** 证书 ID。 */
CertId?: number;
/** 证书名称。 */
CertName?: string;
/** 描述信息。 */
Description?: string;
/** 创建时间,UTC 格式。注:此字段为北京时间(UTC+8时区)。 */
CreateTime?: string;
/** 证书内容。 */
HttpsCrt?: string;
/** 证书类型。0:用户添加证书,1:腾讯云托管证书。 */
CertType?: number;
/** 证书过期时间,UTC 格式。注:此字段为北京时间(UTC+8时区)。 */
CertExpireTime?: string;
/** 使用此证书的域名列表。 */
DomainList?: string[];
}
/** 自适应码率转码模板,子模板,出入参数。 */
declare interface ChildTemplateInfo {
/** 自适应码率转码模板,子模板Id。入参时候,填写此字段,表示更新子模板,否则是新增子模板。 */
TemplateId?: number | null;
/** 子模板名称。 */
TemplateName?: string | null;
/** 视频编码:h264/h265/origin,默认origin。origin: 保持原始编码格式。 */
Vcodec?: string | null;
/** 视频码率。范围:0kbps - 8000kbps。0为保持原始码率。注: 转码模板有码率唯一要求,最终保存的码率可能与输入码率有所差别。 */
VideoBitrate?: number | null;
/** 宽,默认0。范围[0-3000]。数值必须是2的倍数,0是原始宽度。 */
Width?: number | null;
/** 高,默认0。范围[0-3000]数值必须是2的倍数,0是原始高度。 */
Height?: number | null;
/** 帧率,默认0。范围0-60fps。 */
Fps?: number | null;
/** 关键帧间隔,单位:秒。默认原始的间隔。范围2-6。同一个父模板下面的所有子模板,gop必须相等且存在。 */
Gop?: number | null;
/** 是否保留视频,0:否,1:是。默认1。 */
NeedVideo?: number | null;
/** 是否保留音频,0:否,1:是。默认1。 */
NeedAudio?: number | null;
/** 当设置的码率>原始码率时,是否以原始码率为准。0:否, 1:是默认 0。 */
BitrateToOrig?: number | null;
/** 当设置的高度>原始高度时,是否以原始高度为准。0:否, 1:是默认 0。 */
HeightToOrig?: number | null;
/** 当设置的帧率>原始帧率时,是否以原始帧率为准。0:否, 1:是默认 0。 */
FpsToOrig?: number | null;
/** 是否以短边作为高度,0:否,1:是。默认0。 */
ShortEdgeAsHeight?: number | null;
/** HLS 分片类型。可选值:ts、fmp4。注:编码方式为 H.265 时生效。 */
HlsContainerFormat?: string | null;
/** 编码标签。可选值:hvc1、hev1。注:HLS 分片类型选择 fmp4 时生效。 */
HlsMp4VideoCodecTag?: string | null;
}
/** 客户端ip播放汇总信息。 */
declare interface ClientIpPlaySumInfo {
/** 客户端 IP,点分型。 */
ClientIp?: string;
/** 客户端所在省份。 */
Province?: string;
/** 总流量。 */
TotalFlux?: number;
/** 总请求数。 */
TotalRequest?: number;
/** 总失败请求数。 */
TotalFailedRequest?: number;
/** 客户端所在国家。 */
CountryArea?: string;
}
/** 云端特效信息。 */
declare interface CloudEffectInfo {
/** 云端特效 ID。 */
Id?: string;
/** 云端特效描述词。 */
Prompt?: string;
/** 云端特效标签。 */
Flag?: string;
/** 云端特效生成状态。生成中 - GENERATING。处理中 - PROCESSING。生成失败 - FAILED。已完成 - FINISH。 */
Status?: string;
/** 特效信息,生成失败时,此处返回失败原因。 */
Message?: string;
/** 云端特效预览图片。 */
PreviewImageUrl?: string;
/** 云端特效类型。PGC : 官方精品特效。AIGC : AI生成的特效。UGC : 用户上传特效。 */
Type?: string;
/** 云端特效创建时间。 */
CreateTime?: string;
/** 云端特效更新时间。 */
UpdateTime?: string;
}
/** 通用混流控制参数 */
declare interface CommonMixControlParams {
/** 取值范围[0,1]。填1时,当参数中图层分辨率参数与视频实际分辨率不一致时,自动从视频中按图层设置的分辨率比例进行裁剪。 */
UseMixCropCenter?: number;
/** 取值范围[0,1]填1时,当InputStreamList中个数为1时,且OutputParams.OutputStreamType为1时,不执行取消操作,执行拷贝流操作 */
AllowCopy?: number;
/** 取值范围[0,1]填1时,透传原始流的sei */
PassInputSei?: number;
/** 取值范围[0,1]填1时,图片输入中的透明通道生效。 */
UsePictureTransparent?: number;
}
/** 通用混流输入裁剪参数。 */
declare interface CommonMixCropParams {
/** 裁剪的宽度。取值范围[0,2000]。 */
CropWidth?: number;
/** 裁剪的高度。取值范围[0,2000]。 */
CropHeight?: number;
/** 裁剪的起始X坐标。取值范围[0,2000]。 */
CropStartLocationX?: number;
/** 裁剪的起始Y坐标。取值范围[0,2000]。 */
CropStartLocationY?: number;
}
/** 通用混流输入参数。 */
declare interface CommonMixInputParam {
/** 输入流名称。80字节以内,仅含字母、数字以及下划线的字符串。当LayoutParams.InputType=0(音视频)/4(纯音频)/5(纯视频)时,该值为需要混流的流名称。当LayoutParams.InputType=2(图片)/3(画布)时,该值仅用作标识输入,可用类似Canvas1、Pictrue1的名称。 */
InputStreamName: string;
/** 输入流布局参数。 */
LayoutParams: CommonMixLayoutParams;
/** 输入流裁剪参数。 */
CropParams?: CommonMixCropParams;
/** 抠图参数。 */
PortraitSegmentParams?: MixPortraitSegmentParams;
}
/** 通用混流布局参数。 */
declare interface CommonMixLayoutParams {
/** 输入图层。取值范围[1,16]。1)背景流(即大主播画面或画布)的 image_layer 填1。2)纯音频混流,该参数也需填。注意:不同输入,该值不可重复 */
ImageLayer: number;
/** 输入类型。取值范围[0,5]。不填默认为0。0表示输入流为音视频。2表示输入流为图片。3表示输入流为画布。 4表示输入流为音频。5表示输入流为纯视频。 */
InputType?: number;
/** 输入画面在输出时的高度。取值范围:像素:[0,2000]百分比:[0.01,0.99]不填默认为输入流的高度。使用百分比时,期望输出为(百分比 * 背景高)。 */
ImageHeight?: number;
/** 输入画面在输出时的宽度。取值范围:像素:[0,2000]百分比:[0.01,0.99]不填默认为输入流的宽度。使用百分比时,期望输出为(百分比 * 背景宽)。 */
ImageWidth?: number;
/** 输入在输出画面的X偏移。取值范围:像素:[0,2000]百分比:[0.01,0.99]不填默认为0。相对于大主播背景画面左上角的横向偏移。 使用百分比时,期望输出为(百分比 * 背景宽)。 */
LocationX?: number;
/** 输入在输出画面的Y偏移。取值范围:像素:[0,2000]百分比:[0.01,0.99]不填默认为0。相对于大主播背景画面左上角的纵向偏移。 使用百分比时,期望输出为(百分比 * 背景宽) */
LocationY?: number;
/** 当InputType为3(画布)时,该值表示画布的颜色。常用的颜色有:红色:0xCC0033。黄色:0xCC9900。绿色:0xCCCC33。蓝色:0x99CCFF。黑色:0x000000。白色:0xFFFFFF。灰色:0x999999。 */
Color?: string;
/** 当InputType为2(图片)时,该值是水印ID。 */
WatermarkId?: number;
}
/** 通用混流输出参数。 */
declare interface CommonMixOutputParams {
/** 输出流名称。 */
OutputStreamName: string;
/** 输出流类型,取值范围[0,1]。不填默认为0。当输出流为输入流 list 中的一条时,填写0。当期望生成的混流结果成为一条新流时,该值填为1。该值为1时,output_stream_id 不能出现在 input_stram_list 中,且直播后台中,不能存在相同 ID 的流。 */
OutputStreamType?: number;
/** 输出流比特率。取值范围[1,10000]。不填的情况下,系统会自动判断。 */
OutputStreamBitRate?: number;
/** 输出流GOP大小。取值范围[1,10]。不填的情况下,系统会自动判断。 */
OutputStreamGop?: number;
/** 输出流帧率大小。取值范围[1,60]。不填的情况下,系统会自动判断。 */
OutputStreamFrameRate?: number;
/** 输出流音频比特率。取值范围[1,500]不填的情况下,系统会自动判断。 */
OutputAudioBitRate?: number;
/** 输出流音频采样率。取值范围[96000, 88200, 64000, 48000, 44100, 32000,24000, 22050, 16000, 12000, 11025, 8000]。不填的情况下,系统会自动判断。 */
OutputAudioSampleRate?: number;
/** 输出流音频声道数。取值范围[1,2]。不填的情况下,系统会自动判断。 */
OutputAudioChannels?: number;
/** 输出流中的sei信息。如果无特殊需要,不填。 */
MixSei?: string;
}
/** 并发录制路数 */
declare interface ConcurrentRecordStreamNum {
/** 时间点。 */
Time?: string;
/** 路数。 */
Num?: number;
}
/** 流播放信息 */
declare interface DayStreamPlayInfo {
/** 数据时间点,接口返回支持两种时间格式:1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见ISO日期格式说明文档: https://cloud.tencent.com/document/product/266/11732 */
Time?: string;
/** 带宽(单位Mbps)。 */
Bandwidth?: number;
/** 流量 (单位MB)。 */
Flux?: number;
/** 请求数。 */
Request?: number;
/** 在线人数。当前后端接口数据的统计方式与客户端侧不同,该数据仅供参考,具体数据请以业务客户端侧统计数据为准。 */
Online?: number;
}
/** 延播信息。 */
declare interface DelayInfo {
/** 推流域名。 */
DomainName?: string;
/** 推流路径,与推流和播放地址中的 AppName 保持一致,默认为 live。 */
AppName?: string;
/** 流名称。 */
StreamName?: string;
/** 延播时间,单位:秒。 */
DelayInterval?: number;
/** 创建时间,UTC 时间。注意:UTC时间和北京时间相差8小时。例如:2019-06-18T12:00:00Z(为北京时间 2019 年 6 月 18 日 20 点 0 分 0 秒)。 */
CreateTime?: string;
/** 过期时间,UTC 时间。注意:UTC时间和北京时间相差8小时。例如:2019-06-18T12:00:00Z(为北京时间 2019 年 6 月 18 日 20 点 0 分 0 秒)。 */
ExpireTime?: string;
/** 当前状态:-1:已过期。1: 生效中。 */
Status?: number;
}
/** 媒体诊断结果,包含断流信息、低帧率信息等 */
declare interface DiagnoseResult {
/** 断流信息 */
StreamBrokenResults?: string[];
/** 低帧率信息 */
LowFrameRateResults?: string[];
/** 流格式诊断信息 */
StreamFormatResults?: string[];
}
/** 域名证书信息 */
declare interface DomainCertInfo {
/** 证书Id。 */
CertId?: number;
/** 证书名称。 */
CertName?: string;
/** 描述信息。 */
Description?: string;
/** 创建时间,UTC格式。注:此字段为北京时间(UTC+8时区)。 */
CreateTime?: string;
/** 证书内容。 */
HttpsCrt?: string;
/** 证书类型。0:用户添加证书,1:腾讯云托管证书。 */
CertType?: number;
/** 证书过期时间,UTC格式。注:此字段为北京时间(UTC+8时区)。 */
CertExpireTime?: string;
/** 使用此证书的域名名称。 */
DomainName?: string;
/** 证书状态。 */
Status?: number;
/** 证书本身标识的域名列表。比如: ["*.x.com"] */
CertDomains?: string[];
/** 腾讯云ssl的证书Id */
CloudCertId?: string;
}
/** 每个域名的统计信息。 */
declare interface DomainDetailInfo {
/** 国内还是国外:Mainland: 表示国内数据。Oversea: 表示国外数据。 */
MainlandOrOversea?: string;
/** 带宽,单位: Mbps。 */
Bandwidth?: number;
/** 流量,单位: MB。 */
Flux?: number;
/** 人数。 */
Online?: number;
/** 请求数。 */
Request?: number;
}
/** 直播域名信息 */
declare interface DomainInfo {
/** 直播域名。 */
Name?: string;
/** 域名类型:0: 推流。1: 播放。 */
Type?: number;
/** 域名状态:0: 停用。1: 启用。 */
Status?: number;
/** 添加时间。注:此字段为北京时间(UTC+8时区)。 */
CreateTime?: string;
/** 是否有 CName 到固定规则域名:0: 否。1: 是。 */
BCName?: number;
/** cname 对应的域名。 */
TargetDomain?: string;
/** 播放区域,只在 Type=1 时该参数有意义。1: 国内。2: 全球。3: 海外。 */
PlayType?: number;
/** 是否慢直播:0: 普通直播。1: 慢直播。 */
IsDelayLive?: number;
/** 当前客户使用的 cname 信息。 */
CurrentCName?: string;
/** 失效参数,可忽略。 */
RentTag?: number;
/** 失效参数,可忽略。注:此字段为北京时间(UTC+8时区)。 */
RentExpireTime?: string;
/** 0: 标准直播。1: 小程序直播。 */
IsMiniProgramLive?: number;
}
/** 多个域名信息列表 */
declare interface DomainInfoList {
/** 域名。 */
Domain?: string;
/** 明细信息。 */
DetailInfoList?: DomainDetailInfo[];
}
/** flv格式特殊配置 */
declare interface FlvSpecialParam {
/** 是否开启边录边传,仅flv格式有效。 */
UploadInRecording?: boolean;
}
/** 禁推流列表 */
declare interface ForbidStreamInfo {
/** 流名称。 */
StreamName?: string;
/** 创建时间。注:此字段为北京时间(UTC+8时区)。 */
CreateTime?: string;
/** 禁推过期时间。注:此字段为北京时间(UTC+8时区)。 */
ExpireTime?: string;
/** 推流路径。 */
AppName?: string | null;
/** 推流域名。 */
DomainName?: string | null;
}
/** 某省份某运营商在某段时间内的带宽,流量,请求数和并发数 */
declare interface GroupProIspDataInfo {
/** 省份。 */
ProvinceName?: string;
/** 运营商。 */
IspName?: string;
/** 分钟维度的明细数据。 */
DetailInfoList?: CdnPlayStatData[];
}
/** HLS专属录制参数 */
declare interface HlsSpecialParam {
/** HLS续流超时时间。取值范围[0,1800]。 */
FlowContinueDuration?: number | null;
}
/** HTTP返回码和统计数据 */
declare interface HttpCodeInfo {
/** HTTP协议返回码。例:"2xx", "3xx", "4xx", "5xx"。 */
HttpCode?: string;
/** 统计信息,对于无数据的时间点,会补0。 */
ValueList?: HttpCodeValue[];
}
/** HTTP返回码数据信息 */
declare interface HttpCodeValue {
/** 时间,使用UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
Time: string;
/** 次数。 */
Numbers: number;
/** 占比。 */
Percentage: number;
}
/** 播放错误码信息 */
declare interface HttpStatusData {
/** 数据时间点,使用UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
Time: string;
/** 播放状态码详细信息。 */
HttpStatusInfoList: HttpStatusInfo[];
}
/** 播放错误码信息 */
declare interface HttpStatusInfo {
/** 播放HTTP状态码。 */
HttpStatus?: string;
/** 个数。 */
Num?: number;
}
/** 用作批量绑定域名和证书。 */
declare interface LiveCertDomainInfo {
/** 域名。 */
DomainName: string;
/** 是否启用域名的https规则。1:启用0:禁用-1:保持不变 */
Status: number;
}
/** DescribeLiveDomainCertBindings, DescribeLiveDomainCertBindingsGray接口返回的域名证书信息 */
declare interface LiveDomainCertBindings {
/** 域名。 */
DomainName?: string;
/** 证书备注。与CertName同义。 */
CertificateAlias?: string;
/** 证书类型。0:自有证书1:腾讯云ssl托管证书 */
CertType?: number;
/** https状态。1:已开启。0:已关闭。 */
Status?: number;
/** 证书过期时间。注:此字段为北京时间(UTC+8时区)。 */
CertExpireTime?: string;
/** 证书Id。 */
CertId?: number;
/** 腾讯云ssl的证书Id。 */
CloudCertId?: string;
/** 规则最后更新时间。注:此字段为北京时间(UTC+8时区)。 */
UpdateTime?: string | null;
}
/** 直播增强计费信息。 */
declare interface LiveEnhanceInfo {
/** 域名。 */
Domain?: string;
/** 时间。 */
Time?: string;
/** 计费时长,单位分钟。 */
Duration?: number;
/** 帧率。 */
Fps?: string;
/** 分辨率。 */
Resolution?: string;
/** 增强服务类型。 */
Type?: string;
}
/** 直播包信息。 */
declare interface LivePackageInfo {
/** 包 ID。 */
Id?: string;
/** 总量。注意:当为流量包时单位为字节。当为转码包时单位为分钟。 */
Total?: number;
/** 使用量。注意:当为流量包时单位为字节。当为转码包时单位为分钟。当为连麦包时单位为小时。 */
Used?: number;
/** 剩余量。注意:当为流量包时单位为字节。当为转码包时单位为分钟。当为连麦包时单位为小时。 */
Left?: number;
/** 购买时间。注:此字段为北京时间(UTC+8时区)。 */
BuyTime?: string;
/** 过期时间。注:此字段为北京时间(UTC+8时区)。 */
ExpireTime?: string;
/** 包类型,可选值:0: 流量包。1: 普通转码包。2: 极速高清包。3: 连麦包。 */
Type?: number;
/** 包状态,可选值:0: 未使用。1: 使用中。2: 已过期。3: 已冻结。4: 已耗尽。5: 已退款 */
Status?: number;
/** 是否自动续购。 */
WillRenew?: number | null;
/** 续购状态。1 :续购成功。0 :尚未续购。<0 : 续购失败。 */
RenewalResult?: number | null;
}
/** 直播监播任务信息。 */
declare interface LiveStreamMonitorInfo {
/** 监播任务ID。 */
MonitorId: string;
/** 监播任务名称。128字节以内。 */
MonitorName?: string;
/** 监播任务输出信息。 */
OutputInfo?: LiveStreamMonitorOutputInfo;
/** 待监播的输入流信息。 */
InputList?: LiveStreamMonitorInputInfo[];
/** 监播任务状态。0: 代表空闲1: 代表监播中。 */
Status?: number;
/** 上一次的启动时间,unix时间戳。 */
StartTime?: number;
/** 上一次的停止时间,unix时间戳。 */
StopTime?: number;
/** 监播任务创建时间,unix时间戳 */
CreateTime?: number;
/** 监播任务更新时间,unix时间戳 */
UpdateTime?: number;
/** 监播事件通知策略。 */
NotifyPolicy?: LiveStreamMonitorNotifyPolicy;
/** 输出音频的输入Index列表。 */
AudibleInputIndexList?: number[];
/** 开启智能语音识别的输入Index列表 */
AiAsrInputIndexList?: number[];
/** 是否开启断流检测 */
CheckStreamBroken?: number;
/** 是否开启低帧率检测 */
CheckStreamLowFrameRate?: number;
/** 智能语音识别语种:0 关闭 1 中文 2 英文 3日文 4 韩文 */
AsrLanguage?: number;
/** 智能文字识别语种:0 关闭 1 中、英文 */
OcrLanguage?: number;
/** 开启智能文字识别的输入Index列表 */
AiOcrInputIndexList?: number[];
/** 是否存储监播事件到监播报告,以及是否允许查询监播报告 */
AllowMonitorReport?: number;
/** 是否开启格式诊断 */
AiFormatDiagnose?: number;
/** 是否开启内容质检。 */
AiQualityControl?: number;
/** 导播台监播对应的导播台场次id */
CasterId?: string;
/** 拉流转推监播对应的拉流转推任务id */
PullPushTaskId?: string;
}
/** 直播监播功能输入流信息 */
declare interface LiveStreamMonitorInputInfo {
/** 待监播的输入流名称。256字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。 */
InputStreamName: string;
/** 待监播的输入流推流域名。128字节以内,只允许填处于启用状态的推流域名。 */
InputDomain?: string;
/** 待监播的输入流推流路径。32字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。 */
InputApp?: string;
/** 待监播的输入流推流url。一般场景下,无需该参数。 */
InputUrl?: string;
/** 描述。256字节以内。 */
Description?: string;
/** 导播台输入源索引(10000 pvw, 10001 pgm, 其余代表输入下标) */
CasterInputIndex?: number;
/** 该输入源是否正在监播 */
NeedMonitor?: boolean;
/** 导播台pvw pgm的cdn流id */
CdnStreamId?: string;
}
/** 直播流监播通知策略 */
declare interface LiveStreamMonitorNotifyPolicy {
/** 通知策略类型:范围[0,1]0:代表不使用任何通知策略1:代表使用全局回调策略,所有事件通知到CallbackUrl。 */
NotifyPolicyType?: number;
/** 回调URL:长度[0,512]只支持http和https类型的url。 */
CallbackUrl?: string;
}
/** 直播流监播输出流信息 */
declare interface LiveStreamMonitorOutputInfo {
/** 监播任务输出流宽度像素。范围[1,1920]。建议至少大于100像素。 */
OutputStreamWidth: number;
/** 监播任务输出流长度像素。范围[1,1080],建议至少大于100像素。 */
OutputStreamHeight: number;
/** 监播任务输出流名称。不填时,系统会自动生成。256字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。 */
OutputStreamName?: string;
/** 监播任务播放域名。128字节以内,只允许填处于启用状态的播放域名。 */
OutputDomain?: string;
/** 监播任务播放路径。32字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。 */
OutputApp?: string;
}
/** 日志url信息。 */
declare interface LogInfo {
/** 日志名称。 */
LogName?: string;
/** 日志 URL。 */
LogUrl?: string;
/** 日志生成时间。注:此字段为北京时间(UTC+8时区)。 */
LogTime?: string;
/** 文件大小。 */
FileSize?: number;
}
/** 媒体处理结果,包含智能语音识别、智能文字识别结果 */
declare interface MPSResult {
/** 智能语音识别结果。 */
AiAsrResults?: string[];
/** 智能文字识别结果。 */
AiOcrResults?: string[];
/** 内容质检结果。 */
StreamQuaCtrlResults?: string[];
}
/** 混流抠图参数 */
declare interface MixPortraitSegmentParams {
/** 抠图背景颜色,常用的颜色有:红色:0xcc0033。黄色:0xcc9900。绿色:0xcccc33。蓝色:0x99CCFF。黑色:0x000000。白色:0xFFFFFF。灰色:0x999999。 */
Color?: string;
}
/** 监控播放数据 */
declare interface MonitorStreamPlayInfo {
/** 播放域名。 */
PlayDomain?: string;
/** 流id。 */
StreamName?: string;
/** 播放码率,0表示原始码率。 */
Rate?: number;
/** 播放协议,可选值包括 Unknown,Flv,Hls,Rtmp,Huyap2p。 */
Protocol?: string;
/** 带宽,单位是Mbps。 */
Bandwidth?: number;
/** 在线人数,1分钟采样一个点,统计采样点的tcp链接数目。 */
Online?: number;
/** 请求数。 */
Request?: number;
}
/** 查询当前垫片流的信息 */
declare interface PadStreamInfo {
/** 流名称。 */
StreamName?: string;
/** 应用名称。 */
AppName?: string;
/** 推流域名。 */
DomainName?: string;
/** 垫片流类型。0-自动垫片;1-手动切入垫片。 */
PadStreamType?: string;
/** 垫片流开始时间。UTC时间,示例:2025-04-10T00:01:00Z。注意:该时间与北京时间相差八小时。 */
PublishTime?: string;
}
/** 直播垫片模板。 */
declare interface PadTemplate {
/** 模板id。 */
TemplateId: number;
/** 模板名称。 */
TemplateName: string;
/** 垫片内容。 */
Url: string;
/** 模板创建时间。 */
CreateTime: string;
/** 模板修改时间。 */
UpdateTime: string;
/** 模板描述。 */
Description?: string;
/** 断流等待时间。取值范围:0-30000。单位:ms。 */
WaitDuration?: number;
/** 最大垫片时长。取值范围:0 - 正无穷。单位:ms。 */
MaxDuration?: number;
/** 垫片内容类型: 1:图片,2:视频。 默认值:1。 */
Type?: number;
}
/** 播放鉴权key信息。 */
declare interface PlayAuthKeyInfo {
/** 域名。 */
DomainName?: string;
/** 是否启用:0: 关闭。1: 启用。 */
Enable?: number;
/** 鉴权 Key。 */
AuthKey?: string;
/** 有效时间,单位:秒。 */
AuthDelta?: number;
/** 鉴权 BackKey。 */
AuthBackKey?: string;
}
/** 各状态码的总次数,支持大多数的 HTTP 协议返回码。 */
declare interface PlayCodeTotalInfo {
/** HTTP code,可选值包括:400,403,404,500,502,503,504。 */
Code?: string;
/** 总次数。 */
Num?: number;
}
/** 流维度的播放信息。 */
declare interface PlayDataInfoByStream {
/** 流名称。 */
StreamName?: string;
/** 总流量,单位: MB。 */
TotalFlux?: number;
}
/** 按省份运营商查询的播放信息。 */
declare interface PlayStatInfo {
/** 数据时间点。 */
Time?: string;
/** 带宽/流量/请求数/并发连接数/下载速度的值,若没数据返回时该值为0。 */
Value?: number;
}
/** 播放汇总统计信息。 */
declare interface PlaySumStatInfo {
/** 域名或流 ID。 */
Name?: string;
/** 平均下载速度,单位: MB/s。计算公式: 每分钟的下载速度求平均值。 */
AvgFluxPerSecond?: number;
/** 总流量,单位: MB。 */
TotalFlux?: number;
/** 总请求数。 */
TotalRequest?: number;
}
/** 播放错误码信息 */
declare interface ProIspPlayCodeDataInfo {
/** 国家或地区。 */
CountryAreaName?: string;
/** 省份。 */
ProvinceName?: string;
/** 运营商。 */
IspName?: string;
/** 错误码为2开头的次数。 */
Code2xx?: number;
/** 错误码为3开头的次数。 */
Code3xx?: number;
/** 错误码为4开头的次数。 */
Code4xx?: number;
/** 错误码为5开头的次数。 */
Code5xx?: number;
}
/** 获取省份/运营商的播放信息。 */
declare interface ProIspPlaySumInfo {
/** 省份/运营商/国家或地区。 */
Name?: string;
/** 总流量,单位: MB。 */
TotalFlux?: number;
/** 总请求数。 */
TotalRequest?: number;
/** 平均下载流量,单位: MB/s。 */
AvgFluxPerSecond?: number;
}
/** 推流时间。 */
declare interface PublishTime {
/** 推流时间。UTC 格式,例如:2018-06-29T19:00:00Z。 */
PublishTime?: string;
}
/** 云转推水印信息。 */
declare interface PullPushWatermarkInfo {
/** 水印图片 URL。URL中禁止包含的字符:;(){}$>`#"'| */
PictureUrl: string;
/** 显示位置,X轴偏移,单位是百分比,默认 0。 */
XPosition: number;
/** 显示位置,Y轴偏移,单位是百分比,默认 0。 */
YPosition: number;
/** 水印宽度,占直播原始画面宽度百分比,建议高宽只设置一项,另外一项会自适应缩放,避免变形。默认原始宽度。 */
Width: number;
/** 水印高度,占直播原始画面高度百分比,建议高宽只设置一项,另外一项会自适应缩放,避免变形。默认原始高度。 */
Height: number;
/** 水印位置,默认 0。0:左上角。1:右上角。2:右下角。3:左下角。 */
Location: number;
}
/** 拉流配置。 */
declare interface PullStreamConfig {
/** 拉流配置 ID。 */
ConfigId?: string;
/** 源 URL。 */
FromUrl?: string;
/** 目的 URL。 */
ToUrl?: string;
/** 区域名。 */
AreaName?: string;
/** 运营商名。 */
IspName?: string;
/** 开始时间。UTC格式时间,例如: 2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
StartTime?: string;
/** 结束时间。UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
EndTime?: string;
/** 状态:0: 无效。1: 初始状态。2: 正在运行。3: 拉起失败。4: 暂停。 */
Status?: string;
}
/** 直播拉流任务信息。 */
declare interface PullStreamTaskInfo {
/** 拉流任务Id。 */
TaskId?: string;
/** 拉流源的类型:PullLivePushLive -直播,PullVodPushLive -点播,PullPicPushLive -图片。 */
SourceType?: string;
/** 拉流源url列表。SourceType为直播(PullLiveToLive)只可以填1个,SourceType为点播(PullVodToLive)可以填多个,上限10个。 */
SourceUrls?: string[];
/** 推流域名。将拉到的源推到该域名。 */
DomainName?: string;
/** 推流路径。将拉到的源推到该路径。 */
AppName?: string;
/** 流名称。将拉到的源推到该流名称。 */
StreamName?: string;
/** 推流参数。推流携带的自定义参数。 */
PushArgs?: string;
/** 开始时间。使用UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
StartTime?: string;
/** 结束时间,注意:1. 结束时间必须大于开始时间;2. 结束时间和开始时间必须大于当前时间;3. 结束时间 和 开始时间 间隔必须小于七天。使用UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
EndTime?: 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 - 日本。 */
Region?: string;
/** 点播拉流转推循环次数。-1:无限循环,直到任务结束。0:不循环。>0:具体循环次数。次数和时间以先结束的为准。注意:拉流源为点播,该配置生效。 */
VodLoopTimes?: number;
/** 点播更新SourceUrls后的播放方式:ImmediateNewSource:立即从更新的拉流源开始播放;ContinueBreakPoint:从上次断流url源的断点处继续,结束后再使用新的拉流源。注意:拉流源为点播,该配置生效。 */
VodRefreshType?: string;
/** 任务创建时间。使用UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
CreateTime?: string;
/** 任务更新时间。使用UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
UpdateTime?: string;
/** 创建任务的操作者。 */
CreateBy?: string;
/** 最后更新任务的操作者。 */
UpdateBy?: string;
/** 回调地址。 */
CallbackUrl?: string;
/** 选择需要回调的事件:TaskStart:任务启动回调,TaskExit:任务停止回调,VodSourceFileStart:从点播源文件开始拉流回调,VodSourceFileFinish:从点播源文件拉流结束回调,ResetTaskConfig:任务更新回调。 */
CallbackEvents?: string[];
/** 注意:该信息暂不返回。最后一次回调信息。 */
CallbackInfo?: string;
/** 注意:该信息暂不返回。错误信息。 */
ErrorInfo?: string;
/** 状态。enable:生效中。pause:暂停中。 */
Status?: string;
/** 注意:该信息仅在查询单个任务时返回。任务最新拉流信息。包含:源 url,偏移时间,上报时间。 */
RecentPullInfo?: RecentPullInfo;
/** 任务备注信息。 */
Comment?: string;
/** 备源类型:PullLivePushLive -直播,PullVodPushLive -点播。 */
BackupSourceType?: string;
/** 备源URL。 */
BackupSourceUrl?: string;
/** 水印信息列表。 */
WatermarkList?: PullPushWatermarkInfo[];
/** 点播源是否启用本地推流模式,默认0,不启用。0 - 不启用。1 - 启用。 */
VodLocalMode?: number;
/** 录制模板 ID。 */
RecordTemplateId?: string;
/** 新增的推流地址。用于单任务推两路场景。 */
BackupToUrl?: string;
/** 直播转码模板。 */
TranscodeTemplateName?: string;
}
/** 推流鉴权key信息。 */
declare interface PushAuthKeyInfo {
/** 域名。 */
DomainName?: string;
/** 是否启用,0:关闭,1:启用。 */
Enable?: number;
/** 主鉴权 Key。 */
MasterAuthKey?: string;
/** 备鉴权 Key。 */
BackupAuthKey?: string;
/** 有效时间,单位:秒。 */
AuthDelta?: number;
}
/** 推流数据信息 */
declare interface PushDataInfo {
/** 流名称。 */
StreamName: string;
/** 推流路径。 */
AppName: string;
/** 推流客户端 IP。 */
ClientIp: string;
/** 接流服务器 IP。 */
ServerIp: string;
/** 推流视频帧率,单位: Hz。 */
VideoFps: number;
/** 推流视频码率,单位: bps。 */
VideoSpeed: number;
/** 推流音频帧率,单位: Hz。 */
AudioFps: number;
/** 推流音频码率,单位: bps。 */
AudioSpeed: number;
/** 推流域名。 */
PushDomain: string;
/** 推流开始时间。 */
BeginPushTime: string;
/** 音频编码格式,例:"AAC"。 */
Acodec: string;
/** 视频编码格式,例:"H264"。 */
Vcodec: string;
/** 分辨率。 */
Resolution: string;
/** 采样率。 */
AsampleRate: number;
/** metadata 中的音频码率,单位: bps。 */
MetaAudioSpeed: number;
/** metadata 中的视频码率,单位: bps。 */
MetaVideoSpeed: number;
/** metadata 中的帧率。 */
MetaFps: number;
}
/** 推流域名日志信息。 */
declare interface PushLogInfo {
/** 日志名称。 */
LogName: string;
/** 日志下载地址。 */
LogUrl: string;
/** 日志时间。UTC 格式,例如:2018-11-29T19:00:00Z。注意:1. 北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
LogTime: string;
/** 文件大小,单位字节。 */
FileSize: number;
}
/** 某条流的推流质量详情数据。 */
declare interface PushQualityData {
/** 数据时间,使用UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
Time?: string;
/** 推流域名。 */
PushDomain?: string;
/** 推流路径。 */
AppName?: string;
/** 推流客户端 IP。 */
ClientIp?: string;
/** 开始推流时间,格式: %Y-%m-%d %H:%M:%S.%ms,精确到毫秒级。 */
BeginPushTime?: string;
/** 分辨率信息。 */
Resolution?: string;
/** 视频编码格式。 */
VCodec?: string;
/** 音频编码格式。 */
ACodec?: string;
/** 推流序列号,用来唯一的标志一次推流。 */
Sequence?: string;
/** 视频帧率。 */
VideoFps?: number;
/** 视频码率,单位: bps。 */
VideoRate?: number;
/** 音频帧率。 */
AudioFps?: number;
/** 音频码率,单位: bps。 */
AudioRate?: number;
/** 本地流逝时间,单位: ms,音视频流逝时间与本地流逝时间的差距越大表示推流质量越差,上行卡顿越严重。 */
LocalTs?: number;
/** 视频流逝时间,单位: ms。 */
VideoTs?: number;
/** 音频流逝时间,单位: ms。 */
AudioTs?: number;
/** metadata 中的视频码率,单位: kbps。 */
MetaVideoRate?: number;
/** metadata 中的音频码率,单位: kbps。 */
MetaAudioRate?: number;
/** metadata 中的帧率。 */
MateFps?: number;
/** 推流参数 */
StreamParam?: string;
/** 带宽,单位Mbps。 */
Bandwidth?: number;
/** 流量,单位MB。 */
Flux?: number;
/** 推流服务端 IP。 */
ServerIp?: string;
/** 关键帧间隔 GOP ,单位:ms。 */
GopSize?: number;
}
/** 直播拉流当前正在拉的文件信息。 */
declare interface RecentPullInfo {
/** 当前正在拉的文件地址。 */
FileUrl: string;
/** 当前正在拉的文件偏移,单位:秒。 */
OffsetTime: number;
/** 最新上报偏移信息时间。UTC格式。如:2020-07-23T03:20:39Z。注意:与北京时间相差八小时。 */
ReportTime: string;
/** 已经轮播的次数。 */
LoopedTimes: number;
}
/** 录制模板参数。 */
declare interface RecordParam {
/** 录制间隔。单位秒,默认:1800。取值范围:30-7200。此参数对 HLS 无效,当录制 HLS 时从推流到断流生成一个文件。 */
RecordInterval?: number;
/** 录制存储时长。单位秒,取值范围: 0 - 1500天。0:表示永久存储。 */
StorageTime?: number;
/** 是否开启当前格式录制,默认值为0,0:否, 1:是。 */
Enable?: number;
/** 点播子应用 ID。 */
VodSubAppId?: number;
/** 录制文件名。支持的特殊占位符有:{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} */
VodFileName?: string;
/** 任务流 */
Procedure?: string | null;
/** 视频存储策略。normal:标准存储。cold:低频存储。 */
StorageMode?: string | null;
/** 点播应用分类 */
ClassId?: number | null;
/** 存储至 cos 的 bucket 桶名称。注:CosBucketName参数值不能包含-[appid] 部分。 */
CosBucketName?: string | null;
/** 存储至 cos 的 bucket 区域。 */
CosBucketRegion?: string | null;
/** 存储至 cos 的 bucket 路径。 */
CosBucketPath?: string | null;
}
/** 录制任务 */
declare interface RecordTask {
/** 录制任务ID。 */
TaskId?: string;
/** 推流域名。 */
DomainName?: string;
/** 推流路径。 */
AppName?: string;
/** 流名称。 */
StreamName?: string;
/** 任务开始时间,Unix时间戳。 */
StartTime?: number;
/** 任务结束时间,Unix时间戳。 */
EndTime?: number;
/** 录制模板ID。 */
TemplateId?: number;
/** 调用 StopRecordTask 停止任务时间,Unix时间戳。值为0表示未曾调用接口停止任务。 */
Stopped?: number;
}
/** 录制模板信息 */
declare interface RecordTemplateInfo {
/** 模板 ID。 */
TemplateId?: number;
/** 模板名称。 */
TemplateName?: string;
/** 描述信息。 */
Description?: string;
/** FLV 录制参数。 */
FlvParam?: RecordParam;
/** HLS 录制参数。 */
HlsParam?: RecordParam;
/** MP4 录制参数。 */
Mp4Param?: RecordParam;
/** AAC 录制参数。 */
AacParam?: RecordParam;
/** 0:普通直播,1:慢直播。 */
IsDelayLive?: number;
/** HLS 录制定制参数。 */
HlsSpecialParam?: HlsSpecialParam;
/** MP3 录制参数。 */
Mp3Param?: RecordParam;
/** 是否去除水印。 */
RemoveWatermark?: boolean | null;
/** 是否存储至cos */
CosStore?: number | null;
/** FLV 录制定制参数。 */
FlvSpecialParam?: FlvSpecialParam | null;
}
/** 直播域名Referer黑白名单配置 */
declare interface RefererAuthConfig {
/** 域名。 */
DomainName?: string;
/** 是否启用,0:关闭,1:启用。 */
Enable?: number;
/** 名单类型,0:黑名单,1:白名单。 */
Type?: number;
/** 是否允许空Referer,0:不允许,1:允许。 */
AllowEmpty?: number;
/** 名单列表,以分号(;)分隔。 */
Rules?: string;
}
/** 规则信息。 */
declare interface RuleInfo {
/** 规则创建时间。注:此字段为北京时间(UTC+8时区)。 */
CreateTime?: string;
/** 规则更新时间。注:此字段为北京时间(UTC+8时区)。 */
UpdateTime?: string;
/** 模板 ID。 */
TemplateId?: number;
/** 推流域名。 */
DomainName?: string;
/** 推流路径。 */
AppName?: string;
/** 流名称。 */
StreamName?: string;
}
/** 截图任务 */
declare interface ScreenshotTask {
/** 截图任务ID。 */
TaskId?: string;
/** 推流域名。 */
DomainName?: string;
/** 推流路径。 */
AppName?: string;
/** 流名称。 */
StreamName?: string;
/** 任务开始时间,Unix时间戳。 */
StartTime?: number;
/** 任务结束时间,Unix时间戳。 */
EndTime?: number;
/** 截图模板ID。 */
TemplateId?: number;
/** 调用 StopScreenshotTask 停止任务时间,Unix时间戳。值为0表示未曾调用接口停止任务。 */
Stopped?: number;
}
/** 截图模板信息。 */
declare interface SnapshotTemplateInfo {
/** 模板 ID。 */
TemplateId?: number;
/** 模板名称。 */
TemplateName?: string;
/** 截图时间间隔,5-300秒。 */
SnapshotInterval?: number;
/** 截图宽度,范围:0-3000。 0:原始宽度并适配原始比例。 */
Width?: number;
/** 截图高度,范围:0-2000。0:原始高度并适配原始比例。 */
Height?: number;
/** 是否开启鉴黄,0:不开启,1:开启。 */
PornFlag?: number;
/** Cos 应用 ID。 */
CosAppId?: number;
/** Cos Bucket名称。 */
CosBucket?: string;
/** Cos 地域。 */
CosRegion?: string;
/** 模板描述。 */
Description?: string;
/** Cos Bucket文件夹前缀。 */
CosPrefix?: string | null;
/** Cos 文件名称。 */
CosFileName?: string | null;
}
/** 推断流事件信息。 */
declare interface StreamEventInfo {
/** 应用名称。 */
AppName?: string;
/** 推流域名。 */
DomainName?: string;
/** 流名称。 */
StreamName?: string;
/** 推流开始时间。UTC 格式时间,例如:2019-01-07T12:00:00Z。 */
StreamStartTime?: string;
/** 推流结束时间。UTC 格式时间,例如:2019-01-07T15:00:00Z。 */
StreamEndTime?: string;
/** 停止原因。 */
StopReason?: string;
/** 推流持续时长,单位:秒。 */
Duration?: number;
/** 主播 IP。当客户端为内网推流时,展示为: - 。 */
ClientIp?: string;
/** 分辨率。 */
Resolution?: string;
}
/** 流名称列表。 */
declare interface StreamName {
/** 流名称。 */
StreamName?: string;
/** 应用名称。 */
AppName?: string;
/** 推流域名。 */
DomainName?: string;
/** 推流开始时间。UTC格式时间,例如:2019-01-07T12:00:00Z。 */
StreamStartTime?: string;
/** 推流结束时间。UTC格式时间,例如:2019-01-07T15:00:00Z。 */
StreamEndTime?: string;
/** 停止原因。 */
StopReason?: string;
/** 推流持续时长,单位:秒。 */
Duration?: number;
/** 主播 IP。 */
ClientIp?: string;
/** 分辨率。 */
Resolution?: string;
}
/** 查询当前正在推流的信息 */
declare interface StreamOnlineInfo {
/** 流名称。 */
StreamName?: string;
/** 推流时间列表 */
PublishTimeList?: PublishTime[];
/** 应用名称。 */
AppName?: string;
/** 推流域名。 */
DomainName?: string;
/** 流是否推送到延播。0 - 无延播,1 - 有延播。 */
PushToDelay?: number;
}
/** 拉流转推任务的时长分布信息 */
declare interface TaskDurationInfo {
/** 拉流转推任务的时间点 */
Time?: string;
/** 拉流转推任务的时长,单位为分钟 */
Duration?: number;
/** 拉流转推任务的时长,单位为秒 */
DurationSecond?: number;
}
/** 直播拉流任务状态信息。 */
declare interface TaskStatusInfo {
/** 当前使用的源 URL。 */
FileUrl: string;
/** 点播源任务的轮播次数。 */
LoopedTimes: number;
/** 点播源的播放偏移,单位:秒。 */
OffsetTime: number;
/** 最新心跳上报时间。UTC时间,例如:2022-02-11T10:00:00Z。注意:UTC时间与北京时间相差八小时。 */
ReportTime: string;
/** 实际运行状态:active - 活跃,inactive - 不活跃。 */
RunStatus: string;
/** 点播源的文件时长,单位:秒。 */
FileDuration: number;
/** 下一进度点播文件 URL。 */
NextFileUrl: string;
}
/** 转码模板信息。 */
declare interface TemplateInfo {
/** 视频编码:h264/h265/origin,默认h264。origin: 保持原始编码格式 */
Vcodec?: string;
/** 视频码率。范围:0kbps - 8000kbps。0为保持原始码率。注: 转码模板有码率唯一要求,最终保存的码率可能与输入码率有所差别。 */
VideoBitrate?: number;
/** 音频编码:aac,默认aac。注意:当前该参数未生效,待后续支持! */
Acodec?: string;
/** 音频码率。取值范围:0kbps - 500kbps。默认0。 */
AudioBitrate?: number;
/** 宽,默认0。范围[0-3000]数值必须是2的倍数,0是原始宽度 */
Width?: number;
/** 高,默认0。范围[0-3000]数值必须是2的倍数,0是原始宽度 */
Height?: number;
/** 帧率,默认0。范围0-60fps */
Fps?: number;
/** 关键帧间隔,单位:秒。默认原始的间隔范围2-6 */
Gop?: number;
/** 旋转角度,默认0。可取值:0,90,180,270 */
Rotate?: number;
/** 编码质量:baseline/main/high。默认baseline */
Profile?: string;
/** 当设置的码率>原始码率时,是否以原始码率为准。0:否, 1:是默认 0。 */
BitrateToOrig?: number;
/** 当设置的高度>原始高度时,是否以原始高度为准。0:否, 1:是默认 0。 */
HeightToOrig?: number;
/** 当设置的帧率>原始帧率时,是否以原始帧率为准。0:否, 1:是默认 0。 */
FpsToOrig?: number;
/** 是否保留视频。0:否,1:是。 */
NeedVideo?: number;
/** 是否保留音频。0:否,1:是。 */
NeedAudio?: number;
/** 模板 ID。 */
TemplateId?: number;
/** 模板名称。 */
TemplateName?: string;
/** 模板描述。 */
Description?: string;
/** 是否是极速高清模板,0:否,1:是。默认0。 */
AiTransCode?: number;
/** 极速高清视频码率压缩比。极速高清目标码率=VideoBitrate * (1-AdaptBitratePercent)取值范围:0.0到0.5 */
AdaptBitratePercent?: number;
/** 是否以短边作为高度,0:否,1:是。默认0。 */
ShortEdgeAsHeight?: number | null;
/** DRM 加密类型,可选值:fairplay、normalaes、widevine。 */
DRMType?: string | null;
/** DRM 加密项,多个用|分割,可选值:AUDIO、SD、HD、UHD1、UHD2,后四个为一组,同组中的内容只能选一个。 */
DRMTracks?: string | null;
/** 是否创建自适应码率,默认值 0。0:否。1:是。 */
IsAdaptiveBitRate?: number | null;
/** 自适应码率,子转码模板信息,当 IsAdaptiveBitRate 为 1 时有效。 */
AdaptiveChildren?: ChildTemplateInfo[] | null;
}
/** 时移计费明细数据。 */
declare interface TimeShiftBillData {
/** 推流域名。 */
Domain: string;
/** 时移文件时长,单位分钟。 */
Duration: number;
/** 时移配置天数,单位天。 */
StoragePeriod: number;
/** 时间点,格式: yyyy-mm-ddTHH:MM:SSZ。 */
Time: string;
/** 时移总时长,单位分钟。 */
TotalDuration: number;
}
/** 时移录制段。 */
declare interface TimeShiftRecord {
/** 时移录制会话标识。 */
Sid?: string;
/** 录制会话开始时间,Unix 时间戳。 */
StartTime?: number;
/** 录制会话结束时间,Unix 时间戳。 */
EndTime?: number;
}
/** 时移流。 */
declare interface TimeShiftStreamInfo {
/** 推流域名所属组。 */
DomainGroup?: string | null;
/** 推流域名。 */
Domain?: string;
/** 推流路径。 */
AppName?: string;
/** 流名称。 */
StreamName?: string;
/** 流起始时间,Unix 时间戳。 */
StartTime?: number;
/** 截止查询时流结束时间,Unix 时间戳。 */
EndTime?: number;
/** 转码模板ID。 */
TransCodeId?: number | null;
/** 流类型,取值0为原始流,1为水印流,2为转码流。 */
StreamType?: number;
/** 时移数据存储时长,单位秒。 */
Duration?: number | null;
/** 时移自适应码率子流列表。 */
TimeShiftSubStreams?: TimeShiftSubStream[] | null;
}
/** 时移自适应码率子流信息。 */
declare interface TimeShiftSubStream {
/** 时移自适应码率子流转码模板ID。 */
TransCodeId?: number;
}
/** 直播时移模板配置 */
declare interface TimeShiftTemplate {
/** 模板名称。 */
TemplateName: string;
/** 时移时长。单位:秒。 */
Duration: number;
/** 分片时长。可取3-10。单位:s。默认值:5。 */
ItemDuration: number;
/** 模板id。 */
TemplateId?: number;
/** 模板描述。 */
Description?: string;
/** 地域:Mainland:中国大陆;Overseas:海外及港澳台地区;默认值:Mainland。 */
Area?: string;
/** 是否去除水印。为true则将录制原始流。默认值:false。 */
RemoveWatermark?: boolean;
/** 转码流id列表。此参数仅在 RemoveWatermark为false时生效。 */
TranscodeTemplateIds?: number[];
}
/** 直播时移写入量数据。 */
declare interface TimeShiftWriteSizeData {
/** 区域。 */
Area: string;
/** 时间,格式为:yyyy-mm-ddTHH:MM:SSZ。 */
Time: string;
/** 写入量(单位:字节) */
WriteSize: number;
/** 域名。 */
Domain: string;
/** 时移天数。 */
StorageDays: number;
}
/** 某个时间点的指标的数值是多少。 */
declare interface TimeValue {
/** UTC 时间,时间格式:yyyy-mm-ddTHH:MM:SSZ。 */
Time?: string;
/** 数值。 */
Num?: number;
}
/** 转码详细信息。 */
declare interface TranscodeDetailInfo {
/** 流名称。 */
StreamName?: string;
/** 开始时间(北京时间),格式:yyyy-mm-dd HH:MM。 */
StartTime?: string;
/** 结束时间(北京时间),格式:yyyy-mm-dd HH:MM。 */
EndTime?: string;
/** 转码时长,单位:分钟。注意:因推流过程中可能有中断重推情况,此处时长为真实转码时长累加值,并非结束时间和开始时间的间隔。 */
Duration?: number;
/** 编码方式,带模块,示例:liveprocessor_ACC: 音频转码,liveprocessor_H264:直播转码-H264,liveprocessor_H265: 直播转码-H265,topspeed_H264:极速高清-H264,topspeed_H265:极速高清-H265。 */
ModuleCodec?: string;
/** 码率。 */
Bitrate?: number;
/** 类型,包含:转码(Transcode),混流(MixStream),水印(WaterMark),快直播(Webrtc)。 */
Type?: string;
/** 推流域名。 */
PushDomain?: string;
/** 分辨率。 */
Resolution?: string;
/** 地域:Mainland:国内。Overseas:海外。 */
MainlandOrOversea?: string;
}
/** 转码任务数。 */
declare interface TranscodeTaskNum {
/** 时间点。 */
Time: string;
/** 码率。 */
CodeRate: number;
/** 任务数。 */
Num: number;
}
/** 转码总量数据 */
declare interface TranscodeTotalInfo {
/** 时间点,使用UTC格式时间,例如:2019-01-08T10:00:00Z。注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732)。 */
Time: string;
/** 转码时长,单位:分钟。 */
Duration: number;
/** 编码方式,带模块,示例:liveprocessor_H264 =》直播转码-H264,liveprocessor_H265 =》 直播转码-H265,topspeed_H264 =》极速高清-H264,topspeed_H265 =》极速高清-H265。 */
ModuleCodec: string;
/** 分辨率,示例:540*480。 */
Resolution: string;
}
/** 转场信息 */
declare interface TransitionTypeInfo {
/** 转场名称 */
TransitionType?: string;
/** 素材url */
SourceUrl?: string;
/** 转场的下标,可用来排序,从1开始递增 */
Index?: number;
}
/** 水印信息。 */
declare interface WatermarkInfo {
/** 水印 ID。 */
WatermarkId?: number;
/** 水印图片 URL。 */
PictureUrl?: string;
/** 显示位置,X 轴偏移。 */
XPosition?: number;
/** 显示位置,Y 轴偏移。 */
YPosition?: number;
/** 水印名称。 */
WatermarkName?: string;
/** 当前状态。0:未使用,1:使用中。 */
Status?: number;
/** 添加时间。注:此字段为北京时间(UTC+8时区)。 */
CreateTime?: string;
/** 水印宽。 */
Width?: number;
/** 水印高。 */
Height?: number;
/** 背景水印宽。 */
BackgroundWidth?: number;
/** 背景水印高。 */
BackgroundHeight?: number;
}
/** P2P流信息。 */
declare interface XP2PDetailInfo {
/** CDN流量。 */
CdnBytes?: number;
/** P2P流量。 */
P2pBytes?: number;
/** 卡播人数。 */
StuckPeople?: number;
/** 卡播次数。 */
StuckTimes?: number;
/** 在线人数。 */
OnlinePeople?: number;
/** 起播请求次数 */
Request?: number;
/** 起播成功次数 */
RequestSuccess?: number;
/** 时间,一分钟粒度,utc格式:yyyy-mm-ddTHH:MM:SSZ,参考https://cloud.tencent.com/document/product/266/11732 */
Time?: string;
/** 类型,分live和vod两种。 */
Type?: string;
/** 流ID。 */
StreamName?: string;
/** AppId。 */
AppId?: string;
}
declare interface AddCasterInputInfoRequest {
/** 导播台ID。 */
CasterId: number;
/** 导播台输入源详细信息。 */
InputInfo: CasterInputInfo;
}
declare interface AddCasterInputInfoResponse {
/** rtmp协议输入源播放地址。注:仅可作为预览使用,不可分发。 */
InputPlayUrl?: string;
/** webrtc协议播放地址。注:1. 需配合使用腾讯云快直播播放SDK使用才可正常播放。2. 仅作为预览使用,不可分发。 */
InputWebRTCPlayUrl?: string;
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddCasterLayoutInfoRequest {
/** 导播台ID */
CasterId: number;
/** 导播台布局参数信息。 */
LayoutInfo: CasterLayoutInfo;
}
declare interface AddCasterLayoutInfoResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddCasterMarkPicInfoRequest {
/** 导播台ID */
CasterId: number;
/** 图片水印详细参数。 */
MarkPicInfo: CasterMarkPicInfo;
}
declare interface AddCasterMarkPicInfoResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddCasterMarkWordInfoRequest {
/** 导播台ID。 */
CasterId: number;
/** 文本的详细配置。 */
MarkWordInfo: CasterMarkWordInfo;
}
declare interface AddCasterMarkWordInfoResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddCasterOutputInfoRequest {
/** 导播台ID */
CasterId: number;
/** 导播台推流参数信息。 */
OutputInfo: CasterOutputInfo;
}
declare interface AddCasterOutputInfoResponse {
/** 唯一请求 ID,每次请求都会返回。 */
RequestId?: string;
}
declare interface AddDelayLiveStreamRequest {
/** 推流路径,与推流和播放地址中的 AppName 保持一致,默认为 live。 */
AppName: string;
/** 推流域名。 */
DomainName: string;
/** 流名称。 */
StreamName: string;
/** 延播时间,单位:秒,上限:600秒。 */
DelayTime: number;
/** 延播设置的过期时间。UTC 格式,例如:2018-11-29T19:00:00Z。注意:1. 默认7天后过期,且最长支持7天内生效。2. 北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543)。 */
ExpireTime?: st