UNPKG

tencentcloud-sdk-nodejs

Version:
2,380 lines (2,377 loc) 390 kB
/** * DescribeCasterDisplayInfo返回参数结构体 */ export interface DescribeCasterDisplayInfoResponse { /** * 导播台状态 0:停止状态,无预监,无主监 1:无预监,有主监 2:有预监,无主监 3:有预监,有主监 */ Status?: number; /** * 预监使用的展示参数。 */ PvwDisplayInfo?: CasterDisplayInfo; /** * 主监使用的展示参数。 */ PgmDisplayInfo?: CasterDisplayInfo; /** * 启动直播的时间,值为unix时间戳。 */ StartLiveTime?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveXP2PDetailInfoList返回参数结构体 */ export interface DescribeLiveXP2PDetailInfoListResponse { /** * P2P流统计信息。 */ DataInfoList?: Array<XP2PDetailInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 数字人形象信息。 */ export interface AvatarImageInfo { /** * 数字人原始缩放系数。数字人展示大小=原始大小*缩放系数。 */ OriginZoom?: number; /** * 数字人KEY。 */ AvatarKey?: string; /** * 分辨率。 */ Resolution?: string; } /** * DescribeOriginStreamInfo返回参数结构体 */ export interface DescribeOriginStreamInfoResponse { /** * <p>配置状态信息:0 配置中,1 成功,2 关闭中,3 关闭成功。</p> */ Status?: number; /** * <p>播放类型。</p> */ CdnStreamPlayType?: Array<string>; /** * <p>原站配置类型:1 直播原站。<br>2 streamPackage。</p> */ OriginStreamType?: number; /** * <p>原站播放类型。</p> */ OriginStreamPlayType?: string; /** * <p>原站地址类型:1 ip,2 域名。</p> */ OriginAddressType?: number; /** * <p>原站地址信息,每项用分号分割域名(ip)、端口信息。<br>端口为空也要带上分号,表示取默认端口。</p> */ OriginAddress?: Array<string>; /** * <p>超时时间,单位 ms。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ OriginTimeout?: number; /** * <p>重试次数,单位 次。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ OriginRetryTimes?: number; /** * <p>时间戳修正,可取值:on、off。<br>当原站播放协议为 rtmp、flv 时,传递该字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ TimeJitter?: string; /** * <p>分片数,单位 个。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ HlsPlayFragmentCount?: number; /** * <p>分片时长,单位 ms。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ HlsPlayFragmentDuration?: number; /** * <p>是否透传 http 头信息,可取值:on、off。<br>当原站播放协议为 hls 时,传递该字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ PassThroughHttpHeader?: string; /** * <p>是否透传相应,可取值:on、off。<br>当原站播放协议为 hls 时,传递该字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ PassThroughResponse?: string; /** * <p>是否透传参数,可取值:on、off。<br>当原站播放协议为 hls 时,传递该字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ PassThroughParam?: string; /** * <p>原站 host。<br>当原站播放协议为 hls 时,传递该字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ OriginHost?: string; /** * <p>索引缓存,单位 ms。<br>当原站播放协议为 hls 时,传递该字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ IndexerCache?: number; /** * <p>分片缓存,单位 ms。<br>当原站播放协议为 hls 时,传递该字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ FragmentCache?: number; /** * <p>域名。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ DomainName?: string; /** * <p>https 回源,可取值:on、off。<br>当原站播放协议为flv、hls时,传递此字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ UsingHttps?: string; /** * <p>是否遵循原站,可取值:on、off。<br>当原站播放协议为hls时,此字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ CacheFollowOrigin?: string; /** * <p>状态码缓存,数组元素格式:<br>cacheKey:interval<br>cacheKey 可取值:cache_400_sec、cache_403_sec、cache_404_sec、cache_405_sec、cache_500_sec、cache_503_sec、cache_504_sec。<br>interval 单位 ms。<br>当原站播放协议为hls时,此字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ CacheStatusCode?: Array<string>; /** * <p>url改写, 格式为: url1&lt;|&gt;url2; 其中,&lt;|&gt; 为分隔符。<br>url1、url2 长度限制100,不可包含特殊字符。<br>当原站播放协议为hls时,此字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ UrlReplaceRules?: Array<string>; /** * <p>是否 options 支持,可取值:on、off。<br>当原站播放协议为hls时,此字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ OptionsRequest?: string; /** * <p>是否 follow 301/302,可取值:on、off。<br>当原站播放协议为hls时,此字段才会生效。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ FollowRedirect?: string; /** * <p>源站类型 OriginStreamType 为 2 时,该字段有效。 代表源站地址 OriginAddress 对应的地区 region。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ StreamPackageRegion?: Array<string>; /** * <p>客户名。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ CustomerName?: string; /** * <p>当 OriginStreamPlayType 为 hls 时生效,设置索引缓存保留指定参数列表,最多支持 30 组,每个参数小于等于 20 字符。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ IndexerKeepParam?: Array<string>; /** * <p>当 OriginStreamPlayType 为 hls 时生效,设置分片缓存保留指定参数列表,最多支持 30 组,每个参数小于等于 20 字符。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ FragmentKeepParam?: Array<string>; /** * <p>当 OriginStreamType = 2 时有效,表示 mediapackage 具体类型:<br>media_package =&gt; 仅配置普通频道。<br>media_package_pure_ad =&gt; 仅配置广告。<br>media_package_mix_ad =&gt; 同时配置普通频道和广告。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ MediaPackageType?: string; /** * <p>当 OriginStreamType = 2 且 MediaPackageType = media_package 时有效,表示 mediapackage 频道类型,可组合如下值:normal(频道)、ssai(广告)、linear_assembly(线性组装)。</p> */ MediaPackageChannelTypes?: Array<string>; /** * <p>当 OriginStreamPlayType 为 hls 时生效,设置索引自定义 header,每一组参数、取值用空格分开。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ IndexerHeader?: Array<string>; /** * <p>当 OriginStreamPlayType 为 hls 时生效,设置分片自定义 header,每一组参数、取值用空格分开。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ FragmentHeader?: Array<string>; /** * <p>自定义规则列表。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ CustomizationRules?: Array<OriginStreamCustomizationRule>; /** * <p>缓存格式规则。<br>0:默认格式。<br>1:云直播源站格式。<br>当 OriginStreamPlayType 为 customization 时候生效。</p> */ CacheFormatRule?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveWatermarkRules返回参数结构体 */ export interface DescribeLiveWatermarkRulesResponse { /** * 水印规则列表。 */ Rules: Array<RuleInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StartLiveAvatarRoom请求参数结构体 */ export interface StartLiveAvatarRoomRequest { /** * <p>数字人直播间 ID。</p> */ RoomId: string; /** * <p>目标地址描述。</p> */ Comment: string; /** * <p>推流目标地址。</p> */ ToUrl: string; /** * <p>操作者。</p> */ Operator?: string; /** * <p>房间类型。AIGC:AIGC形象房间;PRESET:预设形象房间</p><p>枚举值:</p><ul><li>AIGC: AIGC形象房间</li><li>PRESET: 预设形象房间</li></ul> */ RoomType?: string; } /** * 导播台水印信息。 */ export 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; } /** * ModifyPullStreamStatus请求参数结构体 */ export interface ModifyPullStreamStatusRequest { /** * 配置 ID 列表。 */ ConfigIds: Array<string>; /** * 目标状态。0无效,2正在运行,4暂停。 */ Status: string; } /** * DeleteLiveRecordTemplate请求参数结构体 */ export interface DeleteLiveRecordTemplateRequest { /** * DescribeRecordTemplates接口获取到的模板 ID。 */ TemplateId: number; } /** * ModifyLiveTimeShiftTemplate返回参数结构体 */ export interface ModifyLiveTimeShiftTemplateResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveTranscodeTemplates请求参数结构体 */ export interface DescribeLiveTranscodeTemplatesRequest { /** * 转码模板类型,默认0。 0:普通转码模板。 1:自适应码率转码模板。 */ TemplateType?: number; } /** * DescribeBackupStreamList返回参数结构体 */ export interface DescribeBackupStreamListResponse { /** * 主备流分组信息列表。 */ StreamInfoList?: Array<BackupStreamGroupInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveSnapshotTemplate请求参数结构体 */ export interface DescribeLiveSnapshotTemplateRequest { /** * 模板 ID。 调用 [CreateLiveSnapshotTemplate](/document/product/267/32624) 时返回的模板 ID。 */ TemplateId: number; } /** * DescribePlayErrorCodeDetailInfoList请求参数结构体 */ export interface DescribePlayErrorCodeDetailInfoListRequest { /** * 起始时间, 使用UTC格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 */ StartTime: string; /** * 结束时间, 使用UTC格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 注:EndTime 和 StartTime 只支持最近1天的数据查询。 */ EndTime: string; /** * 查询粒度: 1-1分钟粒度。 */ Granularity: number; /** * 是,可选值包括”4xx”,”5xx”,支持”4xx,5xx”等这种混合模式。 */ StatType: string; /** * 播放域名列表。 */ PlayDomains?: Array<string>; /** * 地域,可选值:Mainland,Oversea,China,Foreign,Global(默认值);如果为空,查询总的数据;如果为“Mainland”,查询中国大陆的数据;如果为“Oversea”,则查询中国大陆以外的数据;如果为China,查询中国的数据(包括港澳台);如果为Foreign,查询国外的数据(不包括港澳台)。 */ MainlandOrOversea?: string; } /** * 推流时间。 */ export interface PublishTime { /** * 推流时间。 UTC 格式,例如:2018-06-29T19:00:00Z。 */ PublishTime?: string; } /** * 通用混流输出参数。 */ export 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; } /** * DescribeAuditKeywords返回参数结构体 */ export interface DescribeAuditKeywordsResponse { /** * 关键词总条数。 */ Total?: number; /** * 关键词详情列表。 */ Infos?: Array<AuditKeywordInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCasterOutputInfos返回参数结构体 */ export interface DescribeCasterOutputInfosResponse { /** * 导播台的推流信息列表。 */ OutputInfos?: Array<CasterOutputInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveStreamPublishedList请求参数结构体 */ export interface DescribeLiveStreamPublishedListRequest { /** * 您的推流域名。 */ DomainName: string; /** * 结束时间。UTC 格式,例如:2016-06-30T19:00:00Z。不超过当前时间。注意:EndTime和StartTime相差不可超过1个月。 */ EndTime: string; /** * 起始时间。 UTC 格式,例如:2016-06-29T19:00:00Z。最长支持查询2个月内数据。 */ StartTime: string; /** * 推流路径,与推流和播放地址中的 AppName 保持一致,默认为 live。不支持模糊匹配。 */ AppName?: string; /** * 取得第几页。 默认值:1。 */ PageNum?: number; /** * 分页大小。 最大值:100。 取值范围:10~100 之前的任意整数。 默认值:10。 */ PageSize?: number; /** * 流名称,支持模糊匹配。 */ StreamName?: string; } /** * DescribeGroupProIspPlayInfoList返回参数结构体 */ export interface DescribeGroupProIspPlayInfoListResponse { /** * 数据内容。 */ DataInfoList?: Array<GroupProIspDataInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDeliverBandwidthList返回参数结构体 */ export interface DescribeDeliverBandwidthListResponse { /** * 转推计费带宽数据 */ DataInfoList?: Array<BandwidthInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveTranscodeDetailInfo请求参数结构体 */ export interface DescribeLiveTranscodeDetailInfoRequest { /** * <p>推流域名。</p> */ PushDomain?: string; /** * <p>流名称。</p> */ StreamName?: string; /** * <p>查询时间,北京时间,<br>格式:yyyymmdd。<br>注意:支持查询近1个月内某天的详细数据,截止到昨天。</p> */ DayTime?: string; /** * <p>页数,默认1,<br>不超过100页。</p> */ PageNum?: number; /** * <p>每页个数,默认20,<br>范围:[10,1000]。</p> */ PageSize?: number; /** * <p>起始天时间,北京时间,<br>格式:yyyymmdd。<br>注意:支持查询近1个月内的详细数据。</p> */ StartDayTime?: string; /** * <p>结束天时间,北京时间,<br>格式:yyyymmdd。<br>注意:支持查询近1个月内的详细数据,截止到昨天,注意DayTime 与(StartDayTime,EndDayTime)必须要传一个,如果都传,会以DayTime为准 。</p> */ EndDayTime?: string; } /** * DescribeLiveSnapshotTemplates请求参数结构体 */ export type DescribeLiveSnapshotTemplatesRequest = null; /** * CreateLiveWatermarkRule返回参数结构体 */ export interface CreateLiveWatermarkRuleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateCasterPvw返回参数结构体 */ export interface CreateCasterPvwResponse { /** * 预监任务的画面rtmp协议预览地址。 注:该预览地址仅供画面预览,不可分发。 */ PvwPlayUrl?: string; /** * 预监任务的webrtc协议预览画面。 注: 1. 该预览地址仅供预览,不可分发。 2. webrtc播放地址,需配合腾讯云快直播播放sdk使用 */ PvwWebRTCPlayUrl?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCasterMarkPicInfos请求参数结构体 */ export interface DescribeCasterMarkPicInfosRequest { /** * 导播台ID。 */ CasterId: number; } /** * 各状态码的总次数,支持大多数的 HTTP 协议返回码。 */ export interface PlayCodeTotalInfo { /** * HTTP code,可选值包括: 400,403,404,500,502,503,504。 */ Code?: string; /** * 总次数。 */ Num?: number; } /** * AddLiveWatermark请求参数结构体 */ export interface AddLiveWatermarkRequest { /** * <p>水印图片 URL。<br>URL中禁止包含的字符:<br> ;(){}$&gt;`#&quot;'|</p> */ PictureUrl: string; /** * <p>水印名称。<br>最长30字节。</p> */ WatermarkName: string; /** * <p>显示位置,X轴偏移,单位是百分比,默认 0。</p> */ XPosition?: number; /** * <p>显示位置,Y轴偏移,单位是百分比,默认 0。</p> */ YPosition?: number; /** * <p>水印宽度,占直播原始画面宽度百分比,建议高宽只设置一项,另外一项会自适应缩放,避免变形。默认原始宽度。</p> */ Width?: number; /** * <p>水印高度,占直播原始画面高度百分比,建议高宽只设置一项,另外一项会自适应缩放,避免变形。默认原始高度。</p> */ Height?: number; /** * <p>背景水印宽度。默认宽度1920。</p><p>取值范围:[360, 4096]</p><p>单位:px</p> */ BackgroundWidth?: number; /** * <p>背景水印高度。默认高度1080。</p><p>取值范围:[360, 4096]</p><p>单位:px</p> */ BackgroundHeight?: number; } /** * 通用混流布局参数。 */ export interface CommonMixLayoutParams { /** * <p>输入图层。取值范围[1,16]。<br>1)背景流(即大主播画面或画布)的 image_layer 填1。<br>2)纯音频混流,该参数也需填。<br>注意:不同输入,该值不可重复</p> */ ImageLayer: number; /** * <p>输入类型。取值范围[0,5]。<br>不填默认为0。<br>0表示输入流为音视频。<br>2表示输入流为图片。<br>3表示输入流为画布。<br>4表示输入流为音频。<br>5表示输入流为纯视频。</p> */ InputType?: number; /** * <p>输入画面在输出时的高度。取值范围:<br>像素:[0,2000]<br>百分比:[0.01,0.99]<br>不填默认为输入流的高度。<br>使用百分比时,期望输出为(百分比 * 背景高)。</p> */ ImageHeight?: number; /** * <p>输入画面在输出时的宽度。取值范围:<br>像素:[0,2000]<br>百分比:[0.01,0.99]<br>不填默认为输入流的宽度。<br>使用百分比时,期望输出为(百分比 * 背景宽)。</p> */ ImageWidth?: number; /** * <p>输入在输出画面的X偏移。取值范围:<br>像素:[0,2000]<br>百分比:[0.01,0.99]<br>不填默认为0。<br>相对于大主播背景画面左上角的横向偏移。<br>使用百分比时,期望输出为(百分比 * 背景宽)。</p> */ LocationX?: number; /** * <p>输入在输出画面的Y偏移。取值范围:<br>像素:[0,2000]<br>百分比:[0.01,0.99]<br>不填默认为0。<br>相对于大主播背景画面左上角的纵向偏移。<br>使用百分比时,期望输出为(百分比 * 背景宽)</p> */ LocationY?: number; /** * <p>当InputType为3(画布)时,该值表示画布的颜色。<br>常用的颜色有:<br>红色:0xCC0033。<br>黄色:0xCC9900。<br>绿色:0xCCCC33。<br>蓝色:0x99CCFF。<br>黑色:0x000000。<br>白色:0xFFFFFF。<br>灰色:0x999999。</p> */ Color?: string; /** * <p>当InputType为2(图片)时,该值是水印ID。</p> */ WatermarkId?: number; /** * <p>当InputType为8时,该值是动效贴片的URL</p> */ WebPageUrl?: string; } /** * DescribeLiveDomainCert请求参数结构体 */ export interface DescribeLiveDomainCertRequest { /** * 播放域名。 */ DomainName: string; } /** * DescribeLiveEnhanceInfoList请求参数结构体 */ export interface DescribeLiveEnhanceInfoListRequest { /** * 起始时间点,使用ISO格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见[ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 接口支持最近三个月的查询,开始时间和结束时间查询跨度不能超过三十天。 */ StartTime: string; /** * 结束时间点,使用ISO格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见[ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 接口支持最近三个月的查询,开始时间和结束时间查询跨度不能超过三十天。 */ EndTime: string; /** * 查询粒度,支持5,60分钟。 */ Granularity?: number; /** * 查询域名,如果不填则默认查全部的数据。 */ DomainNames?: Array<string>; /** * 增强服务类型,如果不填则默认查全部的数据。 */ Type?: Array<string>; /** * 分辨率,如果不填则默认查全部的数据。 */ Resolution?: Array<string>; /** * 帧率,如果不填则默认查全部的数据。 */ Fps?: Array<string>; } /** * 媒体诊断结果,包含断流信息、低帧率信息等 */ export interface DiagnoseResult { /** * 断流信息 */ StreamBrokenResults?: Array<string>; /** * 低帧率信息 */ LowFrameRateResults?: Array<string>; /** * 流格式诊断信息 */ StreamFormatResults?: Array<string>; } /** * StopRecordTask请求参数结构体 */ export interface StopRecordTaskRequest { /** * 录制任务ID。 */ TaskId: string; } /** * 规则信息。 */ export interface RuleInfo { /** * 规则创建时间。 注:此字段为北京时间(UTC+8时区)。 */ CreateTime?: string; /** * 规则更新时间。 注:此字段为北京时间(UTC+8时区)。 */ UpdateTime?: string; /** * 模板 ID。 */ TemplateId?: number; /** * 推流域名。 */ DomainName?: string; /** * 推流路径。 */ AppName?: string; /** * 流名称。 */ StreamName?: string; } /** * ModifyLiveDomainCertBindings请求参数结构体 */ export interface ModifyLiveDomainCertBindingsRequest { /** * 要绑定证书的播放域名/状态 信息列表。 如果CloudCertId和证书公钥私钥对均不传,且域名列表已有绑定规则,只批量更新域名https规则的启用状态,并把未上传至腾讯云ssl的已有自有证书上传。 */ DomainInfos: Array<LiveCertDomainInfo>; /** * 腾讯云ssl的证书Id。 见 https://cloud.tencent.com/document/api/400/41665 */ CloudCertId?: string; /** * 证书公钥。 CloudCertId和公钥私钥对二选一,若CloudCertId将会舍弃公钥和私钥参数,否则将自动先把公钥私钥对上传至ssl新建证书,并使用上传成功后返回的CloudCertId。 */ CertificatePublicKey?: string; /** * 证书私钥。 CloudCertId和公钥私钥对二选一,若传CloudCertId将会舍弃公钥和私钥参数,否则将自动先把公钥私钥对上传至ssl新建证书,并使用上传成功后返回的CloudCertId。 */ CertificatePrivateKey?: string; /** * 上传至ssl证书中心的备注信息,只有新建证书时有效。传CloudCertId时会忽略。 */ CertificateAlias?: string; } /** * StopCasterPgm返回参数结构体 */ export interface StopCasterPgmResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateCasterPgm请求参数结构体 */ export interface CreateCasterPgmRequest { /** * 导播台展示信息参数。 */ PgmDisplayInfo: CasterDisplayInfo; /** * 导播台ID。 */ CasterId: number; } /** * SendLiveCloudEffect请求参数结构体 */ export interface SendLiveCloudEffectRequest { /** * 推流路径,与推流和播放地址中的AppName保持一致,默认为 live。 */ AppName: string; /** * 您的推流域名。 */ PushDomainName: string; /** * 流名称。 */ StreamName: string; /** * 云端特效 ID。 */ Id: string; /** * 默认随系统配置,云端特效循环 少于5次。可自定义指定礼物循环次数,不超过100次。 */ LoopTimes?: number; /** * 操作人备注信息。 */ Operator?: string; /** * 缩小比例,默认0 不缩放。 可选值:0-9, 值越大,越缩小。 */ ZoomFactor?: number; /** * 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角,该参数指定特效渲染离原点的横向比例,可选值 0 - 100。 */ XPosition?: string; /** * 指定云端特效渲染位置百分比。默认居中显示。 原点为画面左上角,该参数指定特效渲染离原点的纵向比例,可选值 0 - 100。 */ YPosition?: string; } /** * DescribeCasterPlayUrl返回参数结构体 */ export interface DescribeCasterPlayUrlResponse { /** * 播放url。 当导播台不存在预监或主监时,若请求预监或主监的播放地址,该字段为空。 */ PlayUrl?: string; /** * webrtc协议播放地址。 当导播台不存在预监或主监时,若请求预监或主监的webrtc播放地址,该字段为空。 注:webrtc协议播放地址需配合腾讯云快直播播放sdk方可使用。 */ WebRTCPlayUrl?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CancelCommonMixStream返回参数结构体 */ export interface CancelCommonMixStreamResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveCerts返回参数结构体 */ export interface DescribeLiveCertsResponse { /** * 证书信息列表。 */ CertInfoSet?: Array<CertInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 直播增强计费信息。 */ export interface LiveEnhanceInfo { /** * 域名。 */ Domain?: string; /** * 时间。 */ Time?: string; /** * 计费时长,单位分钟。 */ Duration?: number; /** * 帧率。 */ Fps?: string; /** * 分辨率。 */ Resolution?: string; /** * 增强服务类型。 */ Type?: string; } /** * ResumeDelayLiveStream请求参数结构体 */ export interface ResumeDelayLiveStreamRequest { /** * 推流路径,与推流和播放地址中的AppName保持一致,默认为live。 */ AppName: string; /** * 推流域名。 */ DomainName: string; /** * 流名称。 */ StreamName: string; } /** * DescribeCallbackRecordsList请求参数结构体 */ export interface DescribeCallbackRecordsListRequest { /** * 起始时间点,接口查询支持两种时间格式: 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F) 2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。 */ StartTime: string; /** * 结束时间点,接口查询支持两种时间格式: 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F) 2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。 查询的起始和结束时间跨度不支持超过1天。仅支持查询最近14天的数据。 */ EndTime: string; /** * 流名称,精确匹配。 */ StreamName: string; /** * 页码。 */ PageNum: number; /** * 每页条数。 */ PageSize: number; /** * 事件类型。 0: "断流", 1: "推流", 100: "录制" 200: "截图回调"。 */ EventType?: number; /** * 回调结果。 0为成功,其他为失败。 */ ResultCode?: number; } /** * 导播台展示信息,包括使用的布局、水印、字幕、转场、音频等信息 */ export interface CasterDisplayInfo { /** * 布局Index。 如果使用自定义布局,为自定义布局下标。 如果使用单输入布局,如使用输入1,则LayoutIndexType=1, 且LayoutIndex=1,以此类推。 */ LayoutIndex?: number; /** * 使用的水印Index列表。 注:当作为入参使用时,列表中的水印Index需要已经存在。 */ MarkPicIndexList?: Array<number | bigint>; /** * 使用的文字水印Index列表。 注:作为入参使用时,列表中的Index需要已经存在。 */ MarkWordIndexList?: Array<number | bigint>; /** * 使用的转场类型。 注:支持的转场类型可通过DescribeCasterTransitionTypes接口获取。 */ TransitionType?: string; /** * 使用的音频输入Index列表。 注:当该字段非空时,表示使用布局中对应的输入源的视频,AudioIndexList中对应的输入源的音频。且这些输入源需已存在。 */ AudioIndexList?: Array<number | bigint>; /** * 作为入参时,表示使用点播输入源,单画面输入时,点播文件是否从头开始播放。 默认为0。 有效值,0,1。 0代表不从头播放 1代表从头播放 */ InputStartType?: number; /** * LayoutIndex类型, 默认值:0 可选值[0,1] 0:默认类型,代表普通布局 1:单输入类型,代表单输入布局 */ LayoutIndexType?: number; } /** * 回调事件信息 */ export interface CallbackEventInfo { /** * 事件时间。 接口返回支持两种时间格式: 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I) 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#I) 2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。 接口返回的时间格式和查询请求传入的时间格式一致。 */ ResponseTime?: string; /** * 回调结果。 */ ResultCode?: number; /** * 流名称。 */ StreamId?: string; } /** * DescribeTopClientIpSumInfoList返回参数结构体 */ export interface DescribeTopClientIpSumInfoListResponse { /** * 页号,范围是[1,1000],默认值是1。 */ PageNum?: number; /** * 每页个数,范围是[1,1000],默认值是20。 */ PageSize?: number; /** * 排序指标,可选值包括”TotalRequest”,”FailedRequest”,“TotalFlux”。 */ OrderParam?: string; /** * 记录总数。 */ TotalNum?: number; /** * 记录总页数。 */ TotalPage?: number; /** * 数据内容。 */ DataInfoList?: Array<ClientIpPlaySumInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveStreamState返回参数结构体 */ export interface DescribeLiveStreamStateResponse { /** * 流状态, active:活跃, inactive:非活跃, forbid:禁播。 */ StreamState?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLiveWatermarkRule请求参数结构体 */ export interface DeleteLiveWatermarkRuleRequest { /** * 推流域名。 */ DomainName: string; /** * 推流路径。与推流和播放地址中的 AppName 保持一致,默认为live。 */ AppName: string; /** * 流名称。 */ StreamName: string; } /** * DescribeLiveWatermarks请求参数结构体 */ export interface DescribeLiveWatermarksRequest { /** * 水印名称 */ Name?: string; /** * 分页的索引参数,从1开始 */ PageNo?: number; /** * 分页的大小参数,默认值500 */ PageSize?: number; } /** * DescribeLiveWatermarkRules请求参数结构体 */ export type DescribeLiveWatermarkRulesRequest = null; /** * EnableOptimalSwitching请求参数结构体 */ export interface EnableOptimalSwitchingRequest { /** * 针对该流 ID 启用择优调度。 */ StreamName: string; /** * 启用开关,默认为启用。 0 - 禁用。 1 - 启用。 */ EnableSwitch?: number; /** * 要启用自动择优的流所属的域名分组名称。 */ HostGroupName?: string; } /** * DescribeCasterInputInfos返回参数结构体 */ export interface DescribeCasterInputInfosResponse { /** * 导播台输入源信息列表。 */ InputInfos?: Array<CasterInputInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * AddCasterMarkWordInfo返回参数结构体 */ export interface AddCasterMarkWordInfoResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 获取省份/运营商的播放信息。 */ export interface ProIspPlaySumInfo { /** * 省份/运营商/国家或地区。 */ Name?: string; /** * 总流量,单位: MB。 */ TotalFlux?: number; /** * 总请求数。 */ TotalRequest?: number; /** * 平均下载流量,单位: MB/s。 */ AvgFluxPerSecond?: number; } /** * ModifyLiveTranscodeTemplate返回参数结构体 */ export interface ModifyLiveTranscodeTemplateResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeStreamDayPlayInfoList请求参数结构体 */ export interface DescribeStreamDayPlayInfoListRequest { /** * 日期,格式:YYYY-mm-dd。 第二天凌晨3点出昨天的数据,建议在这个时间点之后查询最新数据。支持最近3个月的数据查询。 */ DayTime: string; /** * 播放域名。 */ PlayDomain?: string; /** * 页号,范围[1,1000],默认值是1。 */ PageNum?: number; /** * 每页个数,范围[100,1000],默认值是1000。 */ PageSize?: number; /** * 可选值: Mainland:查询国内数据, Oversea:则查询国外数据, 默认:查询国内+国外的数据。 */ MainlandOrOversea?: string; /** * 服务名称,可选值包括LVB(标准直播),LEB(快直播),不填则查LVB+LEB总值。 */ ServiceName?: string; } /** * DeleteLiveTimeShiftRule返回参数结构体 */ export interface DeleteLiveTimeShiftRuleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeSceneVideoTask返回参数结构体 */ export interface DescribeSceneVideoTaskResponse { /** * <p>一些特殊场景的返回信息。</p> */ InfoList?: Array<SceneVideoOutputInfo>; /** * <p>任务状态。</p><p>枚举值:</p><ul><li>DONE: 任务结束。</li><li>RUN: 任务运行中。</li><li>WAIT: 任务准备中。</li><li>FAIL: 任务失败。</li></ul> */ Status?: string; /** * <p>输出视频的分辨率。示例:720x1280。</p> */ Resolution?: string; /** * <p>错误信息。</p> */ Message?: string; /** * <p>输出的视频Url。默认过期时间:12小时,请尽快拉取并转存。也可以使用私有Cos桶长期存储。</p> */ VideoUrls?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 时移流。 */ export interface TimeShiftStreamInfo { /** * 推流域名所属组。 注意:此字段可能返回 null,表示取不到有效值。 */ DomainGroup?: string; /** * 推流域名。 */ Domain?: string; /** * 推流路径。 */ AppName?: string; /** * 流名称。 */ StreamName?: string; /** * 流起始时间,Unix 时间戳。 */ StartTime?: number; /** * 截止查询时流结束时间,Unix 时间戳。 */ EndTime?: number; /** * 转码模板ID。 注意:此字段可能返回 null,表示取不到有效值。 */ TransCodeId?: number; /** * 流类型,取值0为原始流,1为水印流,2为转码流。 */ StreamType?: number; /** * 时移数据存储时长,单位秒。 注意:此字段可能返回 null,表示取不到有效值。 */ Duration?: number; /** * 时移自适应码率子流列表。 注意:此字段可能返回 null,表示取不到有效值。 */ TimeShiftSubStreams?: Array<TimeShiftSubStream>; } /** * DescribeLivePadRules返回参数结构体 */ export interface DescribeLivePadRulesResponse { /** * 规则信息列表。 */ Rules?: Array<RuleInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreatePullStreamConfig请求参数结构体 */ export interface CreatePullStreamConfigRequest { /** * 源 Url ,用于拉流的地址。目前可支持直播流及点播文件。 注意: 1. 多个点播url之间使用空格拼接。 2. 目前上限支持10个url。 3. 目前不支持https协议。 4. 支持拉流文件格式:flv,rtmp,hls,mp4。 */ FromUrl: string; /** * 目的 Url ,用于推流的地址,目前限制该目标地址为腾讯域名。 仅支持:rtmp 协议。 */ ToUrl: string; /** * 选择完成转拉推的服务所在区域: 1-深圳, 2-上海, 3-天津, 4-中国香港。 */ AreaId: number; /** * 选择完成转拉推服务使用的运营商网络: 1-电信, 2-移动, 3-联通, 4-其他。 注:AreaId 为4的时候,IspId 只能为其他。 */ IspId: number; /** * 开始时间。 使用 UTC 格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。 */ StartTime: string; /** * 结束时间,注意: 1. 结束时间必须大于开始时间; 2. 结束时间和开始时间必须大于当前时间; 3. 结束时间 和 开始时间 间隔必须小于七天。 使用 UTC 格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。 */ EndTime: string; } /** * DescribeLiveCerts请求参数结构体 */ export type DescribeLiveCertsRequest = null; /** * DescribeLiveCert返回参数结构体 */ export interface DescribeLiveCertResponse { /** * 证书信息。 */ CertInfo?: CertInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 直播审核关键词查询信息。 */ export 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; } /** * DescribeVisitTopSumInfoList请求参数结构体 */ export interface DescribeVisitTopSumInfoListRequest { /** * 起始时间点,格式为yyyy-mm-dd HH:MM:SS。 */ StartTime: string; /** * 结束时间点,格式为yyyy-mm-dd HH:MM:SS 时间跨度在(0,4小时],支持最近1天数据查询。 */ EndTime: string; /** * 峰值指标,可选值包括”Domain”,”StreamId”。 */ TopIndex: string; /** * 播放域名,默认为不填,表示求总体数据。 */ PlayDomains?: Array<string>; /** * 页号, 范围是[1,1000], 默认值是1。 */ PageNum?: number; /** * 每页个数,范围是[1,1000], 默认值是20。 */ PageSize?: number; /** * 排序指标,可选值包括” AvgFluxPerSecond”,”TotalRequest”(默认),“TotalFlux”。 */ OrderParam?: string; } /** * StopLivePadStream返回参数结构体 */ export interface StopLivePadStreamResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePushBandwidthAndFluxList返回参数结构体 */ export interface DescribePushBandwidthAndFluxListResponse { /** * 峰值带宽所在时间点, 使用UTC格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。 */ PeakBandwidthTime?: string; /** * 峰值带宽,单位是 Mbps。 */ PeakBandwidth?: number; /** * 95峰值带宽所在时间点, 使用UTC格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。 */ P95PeakBandwidthTime?: string; /** * 95峰值带宽,单位是 Mbps。 */ P95PeakBandwidth?: number; /** * 总流量,单位是 MB。 */ SumFlux?: number; /** * 明细数据信息。 */ DataInfoList?: Array<BillDataInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveStreamOnlineList返回参数结构体 */ export interface DescribeLiveStreamOnlineListResponse { /** * 符合条件的总个数。 */ TotalNum?: number; /** * 总页数。 */ TotalPage?: number; /** * 分页的页码。 */ PageNum?: number; /** * 每页显示的条数。 */ PageSize?: number; /** * 正在推送流的信息列表。 */ OnlineInfo?: Array<StreamOnlineInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCasterMarkWordInfos返回参数结构体 */ export interface DescribeCasterMarkWordInfosResponse { /** * 导播台的文本信息列表。 */ MarkWordInfos?: Array<CasterMarkWordInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 拉流转推任务流数据信息。 */ export interface TurnPushInfo { /** * 视频帧率,单位fps。 */ VideoFps: number; /** * 音频帧率,单位fps。 */ AudioFps: number; /** * 视频码率,单位bps。 */ VideoRate: number; /** * 音频码率,单位bps。 */ AudioRate: number; /** * 流标识。 */ StreamFlag: string; /** * 时间,utc格式:yyyy-mm-ddTHH:MM:SSZ,参考https://cloud.tencent.com/document/product/266/11732#I。 */ Time: string; } /** * DescribeStreamPushInfoList返回参数结构体 */ export interface DescribeStreamPushInfoListResponse { /** * 返回的数据列表。 */ DataInfoList?: Array<PushQualityData>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 直播时移模板配置 */ export 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?: Array<number | bigint>; } /** * 水印信息。 */ export 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; } /** * DescribeLiveDomainPlayInfoList请求参数结构体 */ export interface DescribeLiveDomainPlayInfoListRequest { /** * 播放域名列表。 */ PlayDomains?: Array<string>; } /** * 导播台输入信息参数 */ export interface CasterInputInfo { /** * <p>输入源Index。范围[1, 24]</p> */ InputIndex: number; /** * <p>输入源类型。范围[0,1,2,3,4]。0:推流地址。1:点播文件地址。2:直播拉流地址。3:图片地址。4:webrtc协议推流地址。</p> */ InputType?: number; /** * <p>输入源的源地址。最大允许长度512。当InputType为0(推流地址),2(直播拉流地址),3(图片地址),4(webrtc推流地址)这几种类型时,URL需填入该字段。</p> */ InputUrl?: string; /** * <p>输入源描述。最大允许长度256字符。</p> */ Description?: string; /** * <p>点播地址列表。仅当input type为1(点播地址)时,将一个或多个点播地址,填入该字段。单个地址最大允许长度512字符。最多允许同时填入5个地址。注:此时需保持InputUrl字段为空。</p> */ InputUrls?: Array<string>; /** * <p>是否启用点播无限循环播放。注:当前该字段未生效,默认为True。</p> */ LoopEnable?: boolean; /** * <p>点播循环次数。允许值-1或正整数。当值为-1时,表示无限循环。当值为其他正整数时,表示循环对应次数。注:该字段暂未生效。</p> */ LoopNumber?: number; /** * <p>是否启用拉取到导播台。注:该字段默认强制为true。</p> */ PullPushEnable?: boolean; /** * <p>输入源音量百分比。默认为100。表示音量为原始大小。允许值[0,200]。</p> */ Volume?: number; } /** * DeleteLiveWatermarkRule返回参数结构体 */ export interface DeleteLiveWatermarkRuleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自适应码率转码模板,子模板,出入参数。 */ export interface ChildTemplateInfo { /** * 自适应码率转码模板,子模板Id。 入参时候,填写此字段,表示更新子模板,否则是新增子模板。 注意:此字段可能返回 null,表示取不到有效值。 */ TemplateId?: number; /** * 子模板名称。 注意:此字段可能返回 null,表示取不到有效值。 */ TemplateName?: string; /** * 视频编码:h264/h265/origin,默认origin。 origin: 保持原始编码格式。 注意:此字段可能返回 null,表示取不到有效值。 */ Vcodec?: string; /** * 视频码率。范围:0kbps - 8000kbps。 0为保持原始码率。 注: 转码模板有码率唯一要求,最终保存的码率可能与输入码率有所差别。 注意:此字段可能返回 null,表示取不到有效值。 */ VideoBitrate?: number; /** * 宽,默认0。 范围[0-3000]。 数值必须是2的倍数,0是原始宽度。 注意:此字段可能返回 null,表示取不到有效值。 */ Width?: number; /** * 高,默认0。 范围[0-3000] 数值必须是2的倍数,0是原始高度。 注意:此字段可能返回 null,表示取不到有效值。 */ Height?: number; /** * 帧率,默认0。 范围0-60fps。 注意:此字段可能返回 null,表示取不到有效值。 */ Fps?: number; /** * 关键帧间隔,单位:秒。 默认原始的间隔。 范围2-6。 同一个父模板下面的所有子模板,gop必须相等且存在。 注意:此字段可能返回 null,表示取不到有效值。 */ Gop?: number; /** * 是否保留视频,0:否,1:是。默认1。 注意:此字段可能返回 null,表示取不到有效值。 */ NeedVideo?: number; /** * 是否保留音频,0:否,1:是。默认1。 注意:此字段可能返回 null,表示取不到有效值。 */ NeedAudio?: number; /** * 当设置的码率>原始码率时,是否以原始码率为准。 0:否, 1:是 默认 0。 注意:此字段可能返回 null,表示取不到有效值。 */ BitrateToOrig?: number; /** * 当设置的高度>原始高度时,是否以原始高度为准。 0:否, 1:是 默认 0。 注意:此字段可能返回 null,表示取不到有效值。 */ HeightToOrig?: number; /** * 当设置的帧率>原始帧率时,是否以原始帧率为准。 0:否, 1:是 默认 0。 注意:此字段可能返回 null,表示取不到有效值。 */ FpsToOrig?: number; /** * 是否以短边作为高度,0:否,1:是。默认0。 注意:此字段可能返回 null,表示取不到有效值。 */ ShortEdgeAsHeight?: number; /** * HLS 分片类型。 可选值:ts、fmp4。 注:编码方式为 H.265 时生效。 注意:此字段可能返回 null,表示取不到有效值。 */ HlsContainerFormat?: string; /** * 编码标签。 可选值:hvc1、hev1。 注:HLS 分片类型选择 fmp4 时生效。 注意:此字段可能返回 null,表示取不到有效值。 */ HlsMp4VideoCodecTag?: string; } /** * DeleteCasterMarkWordInfo返回参数结构体 */ export interface DeleteCasterMarkWordInfoResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveTranscodeTemplates返回参数结构体 */ export interface DescribeLiveTranscodeTemplatesResponse { /** * 转码模板列表。 */ Templates?: Array<TemplateInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLogDownloadList返回参数结构体 */ export interface DescribeLogDownloadListResponse { /** * 日志信息列表。 */ LogInfoList?: Array<LogInfo>; /** * 总条数。 */ TotalNum?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ReleaseCaster请求参数结构体 */ export interface ReleaseCasterRequest { /** * 导播台ID。 */ CasterId: number; } /** * 转场信息 */ export interface TransitionTypeInfo { /** * 转场名称 */ TransitionType?: string; /** * 素材url */ SourceUrl?: string; /** * 转场的下标,可用来排序,从1开始递增 */ Index?: number; } /** * DeleteLivePadTemplate返回参数结构体 */ export interface DeleteLivePadTemplateResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 域名证书信息 */ export 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?: Array<string>; /** * 腾讯云ssl的证书Id */ CloudCertId?: string; } /** * DescribeLiveAvatarTemporaryScriptList返回参数结构体 */ export interface DescribeLiveAvatarTemporaryScriptListResponse { /** * 临时话术列表。 */ InfoList?: Array<AvatarTemporaryScriptInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateVideoRedrawTask请求参数结构体 */ export interface CreateVideoRedrawTaskRequest { /** * <p>输入待转绘视频url信息</p> */ Input: VideoRedrawInput; /** * <p>用户自定义cos信息</p> */ CosInfo?: VideoRedrawCosInfo; /** * <p>转绘任务参数</p> */ TaskInfo?: VideoRedrawTaskInfo; } /** * 带宽信息 */ export interface BandwidthInfo { /** * 返回格式: 使用UTC格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/267/38543#:~:text=I-,ISO,-%E6%97%A5%E6%9C%9F%E6%A0%BC%E5%BC%8F)。 根据粒度会有不同程度的缩减。 */ Time?: string; /** * 带宽。 */ Bandwidth?: number; } /** * 直播流监播输出流信息 */ export interface LiveStreamMonitorOutputInfo { /** * 监播任务输出流宽度像素。范围[1,1920]。建议至少大于100像素。 */ OutputStreamWidth: number; /** * 监播任务输出流长度像素。范围[1,1080],建议至少大于100像素。 */ OutputStreamHeight: number; /** * 监播任务输出流名称。 不填时,系统会自动生成。 256字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。 */ OutputStreamName?: string; /** * 监播任务播放域名。128字节以内,只允许填处于启用状态的播放域名。 */ OutputDomain?: string; /** * 监播任务播放路径。32字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。 */ OutputApp?: string; } /** * DeleteLiveTranscodeTemplate请求参数结构体 */ export interface DeleteLiveTranscodeTemplateRequest { /** * 模板 ID。 1. 在创建转码模板接口 [CreateLiveTranscodeTemplate](/document/product/267/32646) 调用的返回值中获取模板 ID。 2. 可以从接口 [DescribeLiveTranscodeTemplates](/document/product/267/32641) 查询已经创建过的模板列表。 */ TemplateId: number; } /** * StopLiveAvatarRoom返回参数结构体 */ export interface StopLiveAvatarRoomResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StopRecordTask返回参数结构体 */ export interface StopRecordTaskResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 通用混流控制参数 */ export 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; } /** * DescribeTranscodeTaskNum返回参数结构体 */ export interface DescribeTranscodeTaskNumResponse { /** * 任务数列表。 */ DataInfoList: Array<TranscodeTaskNum>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeStreamPlayInfoList返回参数结构体 */ export interface DescribeStreamPlayInfoListResponse { /** * <p>统计信息列表,时间粒度是1分钟。</p> */ DataInfoList?: Array<DayStreamPlayInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLivePullStreamTaskStatus返回参数结构体 */ export interface DescribeLivePullStreamTaskStatusResponse { /** * 任务状态信息。 */ TaskStatusInfo?: TaskStatusInfo; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyLiveTranscodeTemplate请求参数结构体 */ export interface ModifyLiveTranscodeTemplateRequest { /** * <p>模板 Id。</p> */ TemplateId: number; /** * <p>视频编码:h264/h265/origin,默认origin。</p><p>origin: 保持原始编码格式</p> */ Vcodec?: string; /** * <p>音频编码:aac,默认aac。<br>注意:当前该参数未生效,待后续支持!</p> */ Acodec?: string; /** * <p>音频码率,默认0。<br>范围:0-500。</p> */ AudioBitrate?: number; /** * <p>模板描述。</p> */ Description?: string; /** * <p>视频码率。范围:0kbps - 8000kbps。<br>0为保持原始码率。<br>注: 转码模板有码率唯一要求,最终保存的码率可能与输入码率有所差别。</p> */ VideoBitrate?: number; /** * <p>宽。0-3000。<br>数值必须是2的倍数,0是原始宽度</p> */ Width?: number; /** * <p>是否保留视频,0:否,1:是。默认1。</p> */ NeedVideo?: number; /** * <p>是否保留音频,0:否,1:是。默认1。</p> */ NeedAudio?: number; /** * <p>高。0-3000。<br>数值必须是2的倍数,0是原始宽度</p> */ Height?: number; /** * <p>帧率,默认0。<br>范围0-60</p> */ Fps?: number; /** * <p>关键帧间隔,单位:秒。<br>范围2-6</p> */ Gop?: number; /** * <p>旋转角度,默认0。<br>可取值:0,90,180,270</p> */ Rotate?: number; /** * <p>编码质量:<br>baseline/main/high。</p> */ Profile?: string; /** * <p>当设置的码率&gt;原始码率时,是否以原始码率为准。<br>0:否, 1:是<br>默认 0。</p> */ BitrateToOrig?: number; /** * <p>当设置的高度&gt;原始高度时,是否以原始高度为准。<br>0:否, 1:是<br>默认 0。</p> */ HeightToOrig?: number; /** * <p>当设置的帧率&gt;原始帧率时,是否以原始帧率为准。<br>0:否, 1:是<br>默认 0。</p> */ FpsToOrig?: number; /** * <p>极速高清视频码率压缩比。<br>极速高清目标码率=VideoBitrate * (1-AdaptBitratePercent)</p><p>取值范围:0.0 到 0.5<br>智能降码:0.5 到 0.9</p> */ AdaptBitratePercent?: number; /** * <p>是否以短边作为高度,0:否,1:是。默认0。</p> */ ShortEdgeAsHeight?: number; /** * <p>DRM 加密类型,可选值:fairplay、normalaes、widevine。<br>不传递或者为空字符串,清空之前的DRM配置。</p> */ DRMType?: string; /** * <p>DRM 加密项,可选值:AUDIO、SD、HD、UHD1、UHD2,后四个为一组,同组中的内容只能选一个。<br>不传递或者为空字符串,清空之前的DRM配置。</p> */ DRMTracks?: string; /** * <p>是否创建自适应码率,默认值 0。<br>0:否。<br>1:是。</p> */ IsAdaptiveBitRate?: number; /** * <p>自适应码率,子转码模板信息,当 IsAdaptiveBitRate 为 1 时有效。</p> */ AdaptiveChildren?: Array<ChildTemplateInfo>; /** * <p>是否智能降码,1 表示智能降码。</p> */ AudienceDrivenTranscode?: number; /** * <p>智能降码人数阈值,当 Audienc