UNPKG

@nocobase/plugin-verification

Version:

User identity verification management, including SMS, TOTP authenticator, with extensibility.

2,628 lines (2,623 loc) 245 kB
/** * DescribeLiveXP2PDetailInfoList返回参数结构体 */ export interface DescribeLiveXP2PDetailInfoListResponse { /** * P2P流统计信息。 */ DataInfoList?: Array<XP2PDetailInfo>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveWatermarkRules返回参数结构体 */ export interface DescribeLiveWatermarkRulesResponse { /** * 水印规则列表。 */ Rules: Array<RuleInfo>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyPullStreamStatus请求参数结构体 */ export interface ModifyPullStreamStatusRequest { /** * 配置 ID 列表。 */ ConfigIds: Array<string>; /** * 目标状态。0无效,2正在运行,4暂停。 */ Status: string; } /** * DeleteLiveRecordTemplate请求参数结构体 */ export interface DeleteLiveRecordTemplateRequest { /** * DescribeRecordTemplates接口获取到的模板 ID。 */ TemplateId: number; } /** * DescribeLiveTranscodeTemplates请求参数结构体 */ export declare type DescribeLiveTranscodeTemplatesRequest = null; /** * DescribeBackupStreamList返回参数结构体 */ export interface DescribeBackupStreamListResponse { /** * 主备流分组信息列表。 注意:此字段可能返回 null,表示取不到有效值。 */ StreamInfoList?: Array<BackupStreamGroupInfo>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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; } /** * DescribeBillBandwidthAndFluxList请求参数结构体 */ export interface DescribeBillBandwidthAndFluxListRequest { /** * 起始时间点,接口查询支持两种时间格式: 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。 */ StartTime: string; /** * 结束时间点,接口查询支持两种时间格式: 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。 起始和结束时间跨度不支持超过31天。支持最近3年的数据查询 */ EndTime: string; /** * 直播播放域名,若不填,表示总体数据。 */ PlayDomains?: Array<string>; /** * 可选值: Mainland:查询国内数据, Oversea:则查询国外数据, 默认:查询国内+国外的数据。 注:LEB(快直播)只支持国内+国外数据查询。 */ MainlandOrOversea?: string; /** * 数据粒度,支持如下粒度: 5:5分钟粒度,(跨度不支持超过1天), 60:1小时粒度(跨度不支持超过一个月), 1440:天粒度(跨度不支持超过一个月)。 默认值:5。 */ Granularity?: number; /** * 服务名称,可选值包括LVB(标准直播),LEB(快直播),不填则查LVB+LEB总值。 */ ServiceName?: string; /** * 大区,映射表如下: China Mainland 中国大陆 Asia Pacific I 亚太一区 Asia Pacific II 亚太二区 Asia Pacific III 亚太三区 Europe 欧洲 North America 北美 South America 南美 Middle East 中东 Africa 非洲。 */ RegionNames?: Array<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; } /** * DescribeLiveTranscodeDetailInfo返回参数结构体 */ export interface DescribeLiveTranscodeDetailInfoResponse { /** * 统计数据列表。 */ DataInfoList?: Array<TranscodeDetailInfo>; /** * 页码。 */ PageNum?: number; /** * 每页个数。 */ PageSize?: number; /** * 总个数。 */ TotalNum?: number; /** * 总页数。 */ TotalPage?: number; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveStreamPublishedList请求参数结构体 */ export interface DescribeLiveStreamPublishedListRequest { /** * 您的推流域名。 */ DomainName: string; /** * 结束时间。 UTC 格式,例如:2016-06-30T19:00:00Z。 不超过当前时间。 注意:EndTime和StartTime相差不可超过30天。 */ EndTime: string; /** * 起始时间。 UTC 格式,例如:2016-06-29T19:00:00Z。 最长支持查询60天内数据。 */ 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?: string; } /** * DescribeLiveTranscodeDetailInfo请求参数结构体 */ export interface DescribeLiveTranscodeDetailInfoRequest { /** * 推流域名。 */ PushDomain?: string; /** * 流名称。 */ StreamName?: string; /** * 查询时间,北京时间, 格式:yyyymmdd。 注意:支持查询近1个月内某天的详细数据,截止到昨天。 */ DayTime?: string; /** * 页数,默认1, 不超过100页。 */ PageNum?: number; /** * 每页个数,默认20, 范围:[10,1000]。 */ PageSize?: number; /** * 起始天时间,北京时间, 格式:yyyymmdd。 注意:支持查询近1个月内的详细数据。 */ StartDayTime?: string; /** * 结束天时间,北京时间, 格式:yyyymmdd。 注意:支持查询近1个月内的详细数据,截止到昨天,注意DayTime 与(StartDayTime,EndDayTime)必须要传一个,如果都传,会以DayTime为准 。 */ EndDayTime?: string; } /** * DescribeLiveSnapshotTemplates请求参数结构体 */ export declare type DescribeLiveSnapshotTemplatesRequest = null; /** * CreateLiveWatermarkRule返回参数结构体 */ export interface CreateLiveWatermarkRuleResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDeliverBandwidthList请求参数结构体 */ export interface DescribeDeliverBandwidthListRequest { /** * 起始时间点,接口查询支持两种时间格式: 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。 */ StartTime: string; /** * 结束时间点,接口查询支持两种时间格式: 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。 支持最近三个月的数据查询,时间跨度最大是1个月。 */ EndTime: string; } /** * 各状态码的总次数,支持大多数的 HTTP 协议返回码。 */ export interface PlayCodeTotalInfo { /** * HTTP code,可选值包括: 400,403,404,500,502,503,504。 */ Code: string; /** * 总次数。 */ Num: number; } /** * AddLiveWatermark请求参数结构体 */ export interface AddLiveWatermarkRequest { /** * 水印图片 URL。 URL中禁止包含的字符: ;(){}$>`#"\'| */ PictureUrl: string; /** * 水印名称。 最长16字节。 */ WatermarkName: string; /** * 显示位置,X轴偏移,单位是百分比,默认 0。 */ XPosition?: number; /** * 显示位置,Y轴偏移,单位是百分比,默认 0。 */ YPosition?: number; /** * 水印宽度,占直播原始画面宽度百分比,建议高宽只设置一项,另外一项会自适应缩放,避免变形。默认原始宽度。 */ Width?: number; /** * 水印高度,占直播原始画面高度百分比,建议高宽只设置一项,另外一项会自适应缩放,避免变形。默认原始高度。 */ Height?: number; /** * 背景水印宽度。默认宽度1920。 */ BackgroundWidth?: number; /** * 背景水印高度。默认高度1080。 */ BackgroundHeight?: number; } /** * 通用混流布局参数。 */ export 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; } /** * DescribeLiveDomainCert请求参数结构体 */ export interface DescribeLiveDomainCertRequest { /** * 播放域名。 */ DomainName: string; } /** * 媒体诊断结果,包含断流信息、低帧率信息等 */ export interface DiagnoseResult { /** * 断流信息 注意:此字段可能返回 null,表示取不到有效值。 */ StreamBrokenResults?: Array<string>; /** * 低帧率信息 注意:此字段可能返回 null,表示取不到有效值。 */ LowFrameRateResults?: Array<string>; /** * 流格式诊断信息 注意:此字段可能返回 null,表示取不到有效值。 */ 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; } /** * DescribeMonitorReport返回参数结构体 */ export interface DescribeMonitorReportResponse { /** * 媒体处理结果信息。 注意:此字段可能返回 null,表示取不到有效值。 */ MPSResult?: MPSResult; /** * 媒体诊断结果信息。 注意:此字段可能返回 null,表示取不到有效值。 */ DiagnoseResult?: DiagnoseResult; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CancelCommonMixStream返回参数结构体 */ export interface CancelCommonMixStreamResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveCerts返回参数结构体 */ export interface DescribeLiveCertsResponse { /** * 证书信息列表。 */ CertInfoSet?: Array<CertInfo>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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 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?: string; } /** * DescribeLiveStreamState返回参数结构体 */ export interface DescribeLiveStreamStateResponse { /** * 流状态, active:活跃, inactive:非活跃, forbid:禁播。 */ StreamState?: string; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLiveWatermarkRule请求参数结构体 */ export interface DeleteLiveWatermarkRuleRequest { /** * 推流域名。 */ DomainName: string; /** * 推流路径。与推流和播放地址中的 AppName 保持一致,默认为live。 */ AppName: string; /** * 流名称。 */ StreamName: string; } /** * DescribeLiveWatermarks请求参数结构体 */ export declare type DescribeLiveWatermarksRequest = null; /** * DescribeLiveWatermarkRules请求参数结构体 */ export declare type DescribeLiveWatermarkRulesRequest = null; /** * EnableOptimalSwitching请求参数结构体 */ export interface EnableOptimalSwitchingRequest { /** * 针对该流 ID 启用择优调度。 */ StreamName: string; /** * 启用开关,默认为启用。 0 - 禁用。 1 - 启用。 */ EnableSwitch?: number; /** * 要启用自动择优的流所属的域名分组名称。 */ HostGroupName?: string; } /** * 获取省份/运营商的播放信息。 */ export interface ProIspPlaySumInfo { /** * 省份/运营商/国家或地区。 */ Name: string; /** * 总流量,单位: MB。 */ TotalFlux: number; /** * 总请求数。 */ TotalRequest: number; /** * 平均下载流量,单位: MB/s。 */ AvgFluxPerSecond: number; } /** * ModifyLiveTranscodeTemplate返回参数结构体 */ export interface ModifyLiveTranscodeTemplateResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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; } /** * 时移流。 */ 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; } /** * DescribeLivePadRules返回参数结构体 */ export interface DescribeLivePadRulesResponse { /** * 规则信息列表。 */ Rules: Array<RuleInfo>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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 declare type DescribeLiveCertsRequest = null; /** * DescribeLiveCert返回参数结构体 */ export interface DescribeLiveCertResponse { /** * 证书信息。 */ CertInfo?: CertInfo; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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; } /** * 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?: string; } /** * DescribeLiveStreamOnlineList返回参数结构体 */ export interface DescribeLiveStreamOnlineListResponse { /** * 符合条件的总个数。 */ TotalNum: number; /** * 总页数。 */ TotalPage: number; /** * 分页的页码。 */ PageNum: number; /** * 每页显示的条数。 */ PageSize: number; /** * 正在推送流的信息列表。 */ OnlineInfo: Array<StreamOnlineInfo>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeStreamPushInfoList返回参数结构体 */ export interface DescribeStreamPushInfoListResponse { /** * 返回的数据列表。 */ DataInfoList?: Array<PushQualityData>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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>; } /** * DeleteLiveWatermarkRule返回参数结构体 */ export interface DeleteLiveWatermarkRuleResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLogDownloadList返回参数结构体 */ export interface DescribeLogDownloadListResponse { /** * 日志信息列表。 */ LogInfoList?: Array<LogInfo>; /** * 总条数。 */ TotalNum?: number; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLivePadTemplate返回参数结构体 */ export interface DeleteLivePadTemplateResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLiveSnapshotRule返回参数结构体 */ export interface DeleteLiveSnapshotRuleResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 带宽信息 */ 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像素。 注意:此字段可能返回 null,表示取不到有效值。 */ OutputStreamWidth: number; /** * 监播任务输出流长度像素。范围[1,1080],建议至少大于100像素。 注意:此字段可能返回 null,表示取不到有效值。 */ OutputStreamHeight: number; /** * 监播任务输出流名称。 不填时,系统会自动生成。 256字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。 注意:此字段可能返回 null,表示取不到有效值。 */ OutputStreamName?: string; /** * 监播任务播放域名。128字节以内,只允许填处于启用状态的播放域名。 注意:此字段可能返回 null,表示取不到有效值。 */ OutputDomain?: string; /** * 监播任务播放路径。32字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。 注意:此字段可能返回 null,表示取不到有效值。 */ OutputApp?: string; } /** * DeleteLiveTranscodeTemplate请求参数结构体 */ export interface DeleteLiveTranscodeTemplateRequest { /** * 模板 ID。 1. 在创建转码模板接口 [CreateLiveTranscodeTemplate](/document/product/267/32646) 调用的返回值中获取模板 ID。 2. 可以从接口 [DescribeLiveTranscodeTemplates](/document/product/267/32641) 查询已经创建过的模板列表。 */ TemplateId: number; } /** * StopRecordTask返回参数结构体 */ export interface StopRecordTaskResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 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; } /** * DescribeTranscodeTaskNum返回参数结构体 */ export interface DescribeTranscodeTaskNumResponse { /** * 任务数列表。 */ DataInfoList: Array<TranscodeTaskNum>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLivePullStreamTaskStatus返回参数结构体 */ export interface DescribeLivePullStreamTaskStatusResponse { /** * 任务状态信息。 */ TaskStatusInfo: TaskStatusInfo; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyLiveStreamMonitor返回参数结构体 */ export interface ModifyLiveStreamMonitorResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLivePadRule返回参数结构体 */ export interface DeleteLivePadRuleResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveRecordTemplate请求参数结构体 */ export interface DescribeLiveRecordTemplateRequest { /** * [DescribeLiveRecordTemplates](/document/product/267/32609)接口获取到的模板 ID。 */ TemplateId: number; } /** * 播放错误码信息 */ export interface HttpStatusInfo { /** * 播放HTTP状态码。 */ HttpStatus: string; /** * 个数。 */ Num: number; } /** * CreateLiveTranscodeTemplate请求参数结构体 */ export interface CreateLiveTranscodeTemplateRequest { /** * 模板名称,例: 900p 仅支持字母和数字的组合。 长度限制: 标准转码:1-10个字符 极速高清转码:3-10个字符 */ TemplateName: string; /** * 视频码率。范围:0kbps - 8000kbps。 0为保持原始码率。 注: 转码模板有码率唯一要求,最终保存的码率可能与输入码率有所差别。 */ VideoBitrate: number; /** * 音频编码:aac,默认aac。 注意:当前该参数未生效,待后续支持! */ Acodec?: string; /** * 音频码率,默认0。 范围:0-500。 */ AudioBitrate?: number; /** * 视频编码:h264/h265/origin,默认origin。 origin: 保持原始编码格式 */ Vcodec?: string; /** * 模板描述。 */ Description?: string; /** * 是否保留视频,0:否,1:是。默认1。 */ NeedVideo?: number; /** * 宽,默认0。 范围[0-3000] 数值必须是2的倍数,0是原始宽度 */ Width?: number; /** * 是否保留音频,0:否,1:是。默认1。 */ NeedAudio?: number; /** * 高,默认0。 范围[0-3000] 数值必须是2的倍数,0是原始高度。 极速高清模板(AiTransCode = 1 的时候)必须传。 */ 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:是。默认0。 */ AiTransCode?: number; /** * 极速高清视频码率压缩比。 极速高清目标码率=VideoBitrate * (1-AdaptBitratePercent) 取值范围:0.0到0.5 */ AdaptBitratePercent?: number; /** * 是否以短边作为高度,0:否,1:是。默认0。 */ ShortEdgeAsHeight?: number; /** * DRM 加密类型,可选值:fairplay、normalaes、widevine。 不传递或者为空字符串,清空之前的DRM配置。 */ DRMType?: string; /** * DRM 加密项,可选值:AUDIO、SD、HD、UHD1、UHD2,后四个为一组,同组中的内容只能选一个。 不传递或者为空字符串,清空之前的DRM配置。 */ DRMTracks?: string; } /** * 媒体处理结果,包含智能语音识别、智能文字识别结果 */ export interface MPSResult { /** * 智能语音识别结果 注意:此字段可能返回 null,表示取不到有效值。 */ AiAsrResults?: Array<string>; /** * 智能文字识别结果 注意:此字段可能返回 null,表示取不到有效值。 */ AiOcrResults?: Array<string>; } /** * DescribeLiveTimeShiftTemplates返回参数结构体 */ export interface DescribeLiveTimeShiftTemplatesResponse { /** * 直播时移模板信息。 */ Templates: Array<TimeShiftTemplate>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 播放鉴权key信息。 */ export interface PlayAuthKeyInfo { /** * 域名。 */ DomainName: string; /** * 是否启用: 0: 关闭。 1: 启用。 */ Enable: number; /** * 鉴权 Key。 */ AuthKey: string; /** * 有效时间,单位:秒。 */ AuthDelta: number; /** * 鉴权 BackKey。 */ AuthBackKey: string; } /** * ModifyLiveTranscodeTemplate请求参数结构体 */ export interface ModifyLiveTranscodeTemplateRequest { /** * 模板 Id。 */ TemplateId: number; /** * 视频编码:h264/h265/origin,默认origin。 origin: 保持原始编码格式 */ Vcodec?: string; /** * 音频编码:aac,默认aac。 注意:当前该参数未生效,待后续支持! */ Acodec?: string; /** * 音频码率,默认0。 范围:0-500。 */ AudioBitrate?: number; /** * 模板描述。 */ Description?: string; /** * 视频码率。范围:0kbps - 8000kbps。 0为保持原始码率。 注: 转码模板有码率唯一要求,最终保存的码率可能与输入码率有所差别。 */ VideoBitrate?: number; /** * 宽。0-3000。 数值必须是2的倍数,0是原始宽度 */ Width?: number; /** * 是否保留视频,0:否,1:是。默认1。 */ NeedVideo?: number; /** * 是否保留音频,0:否,1:是。默认1。 */ NeedAudio?: number; /** * 高。0-3000。 数值必须是2的倍数,0是原始宽度 */ Height?: number; /** * 帧率,默认0。 范围0-60 */ Fps?: number; /** * 关键帧间隔,单位:秒。 范围2-6 */ Gop?: number; /** * 旋转角度,默认0。 可取值:0,90,180,270 */ Rotate?: number; /** * 编码质量: baseline/main/high。 */ Profile?: string; /** * 当设置的码率>原始码率时,是否以原始码率为准。 0:否, 1:是 默认 0。 */ BitrateToOrig?: number; /** * 当设置的高度>原始高度时,是否以原始高度为准。 0:否, 1:是 默认 0。 */ HeightToOrig?: number; /** * 当设置的帧率>原始帧率时,是否以原始帧率为准。 0:否, 1:是 默认 0。 */ FpsToOrig?: number; /** * 极速高清视频码率压缩比。 极速高清目标码率=VideoBitrate * (1-AdaptBitratePercent) 取值范围:0.0到0.5 */ AdaptBitratePercent?: number; /** * 是否以短边作为高度,0:否,1:是。默认0。 */ ShortEdgeAsHeight?: number; /** * DRM 加密类型,可选值:fairplay、normalaes、widevine。 不传递或者为空字符串,清空之前的DRM配置。 */ DRMType?: string; /** * DRM 加密项,可选值:AUDIO、SD、HD、UHD1、UHD2,后四个为一组,同组中的内容只能选一个。 不传递或者为空字符串,清空之前的DRM配置。 */ DRMTracks?: string; } /** * ForbidLiveDomain返回参数结构体 */ export interface ForbidLiveDomainResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateRecordTask请求参数结构体 */ export interface CreateRecordTaskRequest { /** * 流名称。 */ StreamName: string; /** * 推流域名。 */ DomainName: string; /** * 推流路径。 */ AppName: string; /** * 录制任务结束时间,Unix时间戳。设置时间必须大于StartTime及当前时间,且EndTime - StartTime不能超过24小时。 */ EndTime: number; /** * 录制任务开始时间,Unix时间戳。如果不填表示立即启动录制。StartTime不能超过当前时间+6天。 */ StartTime?: number; /** * 推流类型,默认0。取值: 0-直播推流。 1-合成流,即 A+B=C 类型混流。 */ StreamType?: number; /** * 录制模板ID,CreateLiveRecordTemplate 返回值。如果不填或者传入错误ID,则默认录制HLS格式、永久存储。 */ TemplateId?: number; /** * 扩展字段,暂无定义。默认为空。 */ Extension?: string; } /** * 规则信息 */ export interface CallBackRuleInfo { /** * 规则创建时间。 注:此字段为北京时间(UTC+8时区)。 */ CreateTime?: string; /** * 规则更新时间。 注:此字段为北京时间(UTC+8时区)。 */ UpdateTime?: string; /** * 模板 ID。 */ TemplateId?: number; /** * 推流域名。 */ DomainName?: string; /** * 推流路径。 */ AppName?: string; } /** * DescribeLivePadTemplate返回参数结构体 */ export interface DescribeLivePadTemplateResponse { /** * 直播垫片模板信息。 */ Template: PadTemplate; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ResumeLiveStream请求参数结构体 */ export interface ResumeLiveStreamRequest { /** * 推流路径,与推流和播放地址中的AppName保持一致,默认为 live。 */ AppName: string; /** * 您的推流域名。 */ DomainName: string; /** * 流名称。 */ StreamName: string; } /** * DescribeBillBandwidthAndFluxList返回参数结构体 */ export interface DescribeBillBandwidthAndFluxListResponse { /** * 峰值带宽所在时间点,接口返回支持两种时间格式(与接口请求传递的时间格式一致): 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。 */ PeakBandwidthTime?: string; /** * 峰值带宽,单位是Mbps。 */ PeakBandwidth?: number; /** * 95峰值带宽所在时间点,接口返回支持两种时间格式(与接口请求传递的时间格式一致): 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。 */ P95PeakBandwidthTime?: string; /** * 95峰值带宽,单位是Mbps。 */ P95PeakBandwidth?: number; /** * 总流量,单位是MB。 */ SumFlux?: number; /** * 明细数据信息。 */ DataInfoList?: Array<BillDataInfo>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveDomainPlayInfoList返回参数结构体 */ export interface DescribeLiveDomainPlayInfoListResponse { /** * 数据时间,格式为yyyy-mm-dd HH:MM:SS。 */ Time?: string; /** * 实时总带宽。 */ TotalBandwidth?: number; /** * 实时总流量。 */ TotalFlux?: number; /** * 总请求数。 */ TotalRequest?: number; /** * 实时总连接数。 */ TotalOnline?: number; /** * 分域名的数据情况。 */ DomainInfoList?: Array<DomainInfoList>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveStreamMonitorList请求参数结构体 */ export interface DescribeLiveStreamMonitorListRequest { /** * 查询列表时的起始偏移。 */ Index: number; /** * 本次查询的记录个数。最小值为1。 */ Count: number; } /** * HTTP返回码数据信息 */ export interface HttpCodeValue { /** * 时间, 使用UTC格式时间, 例如:2019-01-08T10:00:00Z。 注意:北京时间值为 UTC 时间值 + 8 小时,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。 */ Time: string; /** * 次数。 */ Numbers: number; /** * 占比。 */ Percentage: number; } /** * DeleteLiveStreamMonitor返回参数结构体 */ export interface DeleteLiveStreamMonitorResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLiveCallbackTemplate请求参数结构体 */ export interface DeleteLiveCallbackTemplateRequest { /** * 模板 ID。 1. 在创建回调模板接口 [CreateLiveCallbackTemplate](/document/product/267/32637) 调用的返回值中获取模板 ID。 2. 可以从接口 [DescribeLiveCallbackTemplates](/document/product/267/32632) 查询已经创建的过的模板列表。 */ TemplateId: number; } /** * CreateLiveCallbackTemplate返回参数结构体 */ export interface CreateLiveCallbackTemplateResponse { /** * 模板ID。 */ TemplateId?: number; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveCallbackTemplate请求参数结构体 */ export interface DescribeLiveCallbackTemplateRequest { /** * 模板 ID。 1. 在创建回调模板接口 [CreateLiveCallbackTemplate](/document/product/267/32637) 调用的返回值中获取模板 ID。 2. 可以从接口 [DescribeLiveCallbackTemplates](/document/product/267/32632) 查询已经创建的过的模板列表。 */ TemplateId: number; } /** * CreateLiveStreamMonitor请求参数结构体 */ export interface CreateLiveStreamMonitorRequest { /** * 监播任务的输出信息。 */ OutputInfo: LiveStreamMonitorOutputInfo; /** * 待监播的输入流信息列表。 */ InputList: Array<LiveStreamMonitorInputInfo>; /** * 监播任务名称。字段长度小于128字节(一个汉字两个字节)。 */ MonitorName?: string; /** * 监播事件通知策略。 不填默认为没有任何通知。 */ NotifyPolicy?: LiveStreamMonitorNotifyPolicy; /** * 智能语音识别语种设置: 0 关闭 1 中文 2 英文 3 日文 4 韩文。 */ AsrLanguage?: number; /** * 智能文字识别语种设置: 0 关闭 1 中、英文。 */ OcrLanguage?: number; /** * 智能语音识别的输入列表,若开启语音识别则必填。 (第1条输入流index为1) */ AiAsrInputIndexList?: Array<number | bigint>; /** * 智能文字识别的输入列表,若开启文字识别则必填。 (第1条输入流index为1) */ AiOcrInputIndexList?: Array<number | bigint>; /** * 是否开启断流检测。 */ CheckStreamBroken?: number; /** * 是否开启低帧率检测。 */ CheckStreamLowFrameRate?: number; /** * 是否存储监播事件到监播报告,以及是否允许查询监播报告。 */ AllowMonitorReport?: number; /** * 是否开启格式诊断。 */ AiFormatDiagnose?: number; } /** * DescribeScreenShotSheetNumList请求参数结构体 */ export interface DescribeScreenShotSheetNumListRequest { /** * 起始时间点,接口查询支持两种时间格式: 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。 */ StartTime: string; /** * 结束时间点,接口查询支持两种时间格式: 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2)YYYY-MM-DD hh:mm:ss:使用此格式时,默认代表北京时间。 支持最近三个月的查询,查询开始和结束时间跨度不支持超过31天。 */ EndTime: string; /** * 地域信息,可选值包括Mainland,Oversea,前者是查询中国大陆范围内的数据,后者是除中国大陆范围之外的数据,若不传该参数,则查询所有地区的数据。 */ Zone?: string; /** * 推流域名(支持查询2019年11 月1日之后的域名维度数据)。 */ PushDomains?: Array<string>; /** * 数据维度,数据延迟1个半小时,可选值包括:1、Minute(5分钟粒度,最大支持查询时间范围是31天),2、Day(天粒度,默认值,按照北京时间做跨天处理,最大支持查询时间范围是186天当天)。 */ Granularity?: string; } /** * DescribeLiveTranscodeTemplate请求参数结构体 */ export interface DescribeLiveTranscodeTemplateRequest { /** * 模板 ID。 注意:在创建转码模板接口 [CreateLiveTranscodeTemplate](/document/product/267/32646) 调用的返回值中获取模板 ID。 */ TemplateId: number; } /** * 监控播放数据 */ export 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; } /** * CreateLiveWatermarkRule请求参数结构体 */ export interface CreateLiveWatermarkRuleRequest { /** * 推流域名。 */ DomainName: string; /** * 推流路径,与推流和播放地址中的AppName保持一致,默认为live。 */ AppName: string; /** * 流名称。 */ StreamName: string; /** * 水印Id,即调用[AddLiveWatermark](/document/product/267/30154)接口返回的WatermarkId。 */ TemplateId: number; } /** * DeleteRecordTask请求参数结构体 */ export interface DeleteRecordTaskRequest { /** * 任务ID,CreateRecordTask返回。删除TaskId指定的录制任务。 */ TaskId: string; } /** * DescribeStreamDayPlayInfoList返回参数结构体 */ export interface DescribeStreamDayPlayInfoListResponse { /** * 播放数据信息列表。 */ DataInfoList?: Array<PlayDataInfoByStream>; /** * 总数量。 */ TotalNum?: number; /** * 总页数。 */ TotalPage?: number; /** * 当前数据所处页码。 */ PageNum?: number; /** * 每页个数。 */ PageSize?: number; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLivePadRule请求参数结构体 */ export interface DeleteLivePadRuleRequest { /** * 推流域名。 域名+AppName+StreamName唯一标识单个转码规则,如需删除需要强匹配,例如AppName为空也需要传空字符串进行强匹配。 */ DomainName: string; /** * 推流路径,与推流和播放地址中的AppName保持一致,默认为 live。 域名+AppName+StreamName唯一标识单个转码规则,如需删除需要强匹配,例如AppName为空也需要传空字符串进行强匹配。 */ AppName: string; /** * 流名称。 域名+AppName+StreamName唯一标识单个转码规则,如需删除需要强匹配,例如AppName为空也需要传空字符串进行强匹配。 */ StreamName: string; /** * 直播垫片模板id。 */ TemplateId: number; } /** * CreateLiveSnapshotRule返回参数结构体 */ export interface CreateLiveSnapshotRuleResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveStreamEventList返回参数结构体 */ export interface DescribeLiveStreamEventListResponse { /** * 推断流事件列表。 */ EventList: Array<StreamEventInfo>; /** * 分页的页码。 */ PageNum: number; /** * 每页大小。 */ PageSize: number; /** * 符合条件的总个数。 */ TotalNum: number; /** * 总页数。 */ TotalPage: number; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveTranscodeTotalInfo请求参数结构体 */ export interface DescribeLiveTranscodeTotalInfoRequest { /** * 开始时间,支持最近三个月的数据查询,起始时间和结束时间跨度不能超过三个月。接口查询支持两种时间格式: 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:使用此格式时,默认代表北京时间。 */ EndTime: string; /** * 推流域名列表,若不填,表示查询所有域名总体数据。 指定域名时返回1小时粒度数据。 */ PushDomains?: Array<string>; /** * 可选值: Mainland:查询中国大陆(境内)数据, Oversea:则查询国际/港澳台(境外)数据, 默认:查询全球地区(境内+境外)的数据。 */ MainlandOrOversea?: string; } /** * DescribeLiveDomainCertBindings, DescribeLiveDomainCertBindingsGray接口返回的域名证书信息 */ export 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时区)。 注意:此字段可能返回 null,表示取不到有效值。 */ UpdateTime?: string; } /** * DescribeLivePushAuthKey请求参数结构体 */ export interface DescribeLivePushAuthKeyRequest { /** * 推流域名。 */ DomainName: string; } /** * DescribeUploadStreamNums返回参数结构体 */ export interface DescribeUploadStreamNumsResponse { /** * 明细数据信息 */ DataInfoList?: Array<ConcurrentRecordStreamNum>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLiveTranscodeTemplate返回参数结构体 */ export interface DeleteLiveTranscodeTemplateResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateScreenshotTask返回参数结构体 */ export interface CreateScreenshotTaskResponse { /** * 任务ID,全局唯一标识截图任务。返回TaskId字段说明截图任务创建成功。 */ TaskId: string; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLiveCallbackRule返回参数结构体 */ export interface DeleteLiveCallbackRuleResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeStreamPlayInfoList请求参数结构体 */ export interface DescribeStreamPlayInfoListRequest { /** * 起始时间点,接口查询支持两种时间格式: 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。 开始时间和结束时间的格式需要保持一致。 */ StartTime: string; /** * 结束时间点,接口查询支持两种时间格式: 1)YYYY-MM-DDThh:mm:ssZ:UTC时间格式,详见IOS日期格式说明文档: https://cloud.tencent.com/document/product/266/11732#I 2)yyyy-MM-dd HH:mm:ss:使用此格式时,默认代表北京时间。 开始时间和结束时间的格式需要保持一致。结束时间和开始时间跨度不支持超过24小时,支持距当前时间一个月内的数据查询。 */ EndTime: string; /** * 播放域名, 若不填,则为查询所有播放域名的在线流数据。 */ PlayDomain?: string; /** * 流名称,精确匹配。 若不填,则为查询总体播放数据。 */ StreamName?: string; /** * 推流路径,与播放地址中的AppName保持一致,会精确匹配,在同时传递了StreamName时生效。 若不填,则为查询总体播放数据。 */ AppName?: string; /** * 服务名称,可选值包括LVB(标准直播),LEB(快直播),不填则查LVB+LEB总值。 */ ServiceName?: string; } /** * 推流鉴权key信息。 */ export interface PushAuthKeyInfo { /** * 域名。 */ DomainName: string; /** * 是否启用,0:关闭,1:启用。 */ Enable: number; /** * 主鉴权 Key。 */ MasterAuthKey: string; /** * 备鉴权 Key。 */ BackupAuthKey: string; /** * 有效时间,单位:秒。 */ AuthDelta: number; } /** * DescribeLivePlayAuthKey请求参数结构体 */ export interface DescribeLivePlayAuthKeyRequest { /** * 域名。 */ DomainName: string; } /** * CreateLiveTimeShiftRule返回参数结构体 */ export interface CreateLiveTimeShiftRuleResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLiveTranscodeRule返回参数结构体 */ export interface DeleteLiveTranscodeRuleResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLivePadTemplates返回参数结构体 */ export interface DescribeLivePadTemplatesResponse { /** * 直播垫片模板信息。 */ Templates: Array<PadTemplate>; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 直播域名信息 */ export 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: 小程序直播。 注意:此字段可能返回 null,表示取不到有效值。 */ IsMiniProgramLive?: number; } /** * DescribeLiveTranscodeRules请求参数结构体 */ export interface DescribeLiveTranscodeRulesRequest { /** * 要筛选的模板ID数组。 */ TemplateIds?: Array<number | bigint>; /** * 要筛选的域名数组。 */ DomainNames?: Array<string>; } /** * 流维度的播放信息。 */ export interface PlayDataInfoByStream { /** * 流名称。 */ StreamName: string; /** * 总流量,单位: MB。 */ TotalFlux: number; } /** * 直播监播功能输入流信息 */ export interface LiveStreamMonitorInputInfo { /** * 待监播的输入流名称。256字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。 注意:此字段可能返回 null,表示取不到有效值。 */ InputStreamName: string; /** * 待监播的输入流推流域名。128字节以内,只允许填处于启用状态的推流域名。 注意:此字段可能返回 null,表示取不到有效值。 */ InputDomain?: string; /** * 待监播的输入流推流路径。32字节以内,只允许包含字母、数字、‘-’,‘_’,'.'字符。 注意:此字段可能返回 null,表示取不到有效值。 */ InputApp?: string; /** * 待监播的输入流推流url。一般场景下,无需该参数。 注意:此字段可能返回 null,表示取不到有效值。 */ InputUrl?: string; /** * 描述。256字节以内。 注意:此字段可能返回 null,表示取不到有效值。 */ Description?: string; } /** * DeleteLivePullStreamTask请求参数结构体 */ export interface DeleteLivePullStreamTaskRequest { /** * 任务 Id。 */ TaskId: string; /** * 操作人姓名。 */ Operator: string; } /** * RestartLivePullStreamTask返回参数结构体 */ export interface RestartLivePullStreamTaskResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StopLiveRecord返回参数结构体 */ export interface StopLiveRecordResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteScreenshotTask请求