UNPKG

tencentcloud-sdk-nodejs

Version:
2,253 lines (2,251 loc) 720 kB
/** * 画布信息。制作视频时,如果源素材(视频或者图片)不能填满输出的视频窗口,将用设置的画布进行背景绘制。 */ export interface Canvas { /** * 背景颜色,取值有: <li>Black:黑色背景</li> <li>White:白色背景</li> 默认值:Black。 */ Color?: string; /** * 画布宽度,即输出视频的宽度,取值范围:0~ 3840,单位:px。 默认值:0,表示和第一个视频轨的第一个视频片段的视频宽度一致。 */ Width?: number; /** * 画布高度,即输出视频的高度(或长边),取值范围:0~ 3840,单位:px。 默认值:0,表示和第一个视频轨的第一个视频片段的视频高度一致。 */ Height?: number; } /** * ModifySampleSnapshotTemplate返回参数结构体 */ export interface ModifySampleSnapshotTemplateResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyWatermarkTemplate请求参数结构体 */ export interface ModifyWatermarkTemplateRequest { /** * 水印模板唯一标识。 */ Definition: number; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 水印模板名称,长度限制:64 个字符。 */ Name?: string; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; /** * 原点位置,可选值: <li>TopLeft:表示坐标原点位于视频图像左上角,水印原点为图片或文字的左上角;</li> <li>TopRight:表示坐标原点位于视频图像的右上角,水印原点为图片或文字的右上角;</li> <li>BottomLeft:表示坐标原点位于视频图像的左下角,水印原点为图片或文字的左下角;</li> <li>BottomRight:表示坐标原点位于视频图像的右下角,水印原点为图片或文字的右下角。</li> */ CoordinateOrigin?: string; /** * 水印原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式: <li>当字符串以 % 结尾,表示水印 XPos 为视频宽度指定百分比,如 10% 表示 XPos 为视频宽度的 10%;</li> <li>当字符串以 px 结尾,表示水印 XPos 为指定像素,如 100px 表示 XPos 为 100 像素。</li> */ XPos?: string; /** * 水印原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式: <li>当字符串以 % 结尾,表示水印 YPos 为视频高度指定百分比,如 10% 表示 YPos 为视频高度的 10%;</li> <li>当字符串以 px 结尾,表示水印 YPos 为指定像素,如 100px 表示 YPos 为 100 像素。</li> */ YPos?: string; /** * 图片水印模板,该字段仅对图片水印模板有效。 */ ImageTemplate?: ImageWatermarkInputForUpdate; /** * 文字水印模板,该字段仅对文字水印模板有效。 */ TextTemplate?: TextWatermarkTemplateInputForUpdate; /** * SVG 水印模板,该字段仅对 SVG 水印模板有效。 */ SvgTemplate?: SvgWatermarkInputForUpdate; } /** * 域名推送 CLS 目标。 */ export interface DomainCLSTargetInfo { /** * 域名。 */ Domain?: string; /** * 中国大陆地区的日志推送目标。 */ ChineseMainlandCLSTargetInfo?: AreaCLSTargetInfo; /** * 中国大陆以外地区的日志推送目标。 */ OutsideChineseMainlandCLSTargetInfo?: AreaCLSTargetInfo; } /** * CreateStorageRegion请求参数结构体 */ export interface CreateStorageRegionRequest { /** * 待开通的存储地域,必须是系统支持的地域。 */ StorageRegion: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; } /** * 语音全文识别片段。 */ export interface AiRecognitionTaskAsrFullTextSegmentItem { /** * 识别片段置信度。取值:0~100。 */ Confidence?: number; /** * 识别片段起始的偏移时间,单位:秒。 */ StartTimeOffset?: number; /** * 识别片段终止的偏移时间,单位:秒。 */ EndTimeOffset?: number; /** * 识别文本。 */ Text?: string; } /** * 获取文件属性任务信息 */ export interface DescribeFileAttributesTask { /** * 任务 ID。 */ TaskId?: string; /** * 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 */ Status?: string; /** * 错误码,0 表示成功,其他值表示失败: <li>40000:输入参数不合法,请检查输入参数;</li> <li>60000:源文件错误(如视频数据损坏),请确认源文件是否正常;</li> <li>70000:内部服务错误,建议重试。</li> */ ErrCode?: number; /** * 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。 */ ErrCodeExt?: string; /** * 错误信息。 */ Message?: string; /** * 任务进度,取值范围 [0-100] 。 */ Progress?: number; /** * 媒体文件 ID。 */ FileId?: string; /** * 获取媒体文件属性任务的输出。 注意:此字段可能返回 null,表示取不到有效值。 */ Output?: DescribeFileAttributesTaskOutput; /** * 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。 */ SessionId?: string; /** * 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。 */ SessionContext?: string; } /** * 视频画面质量评价的控制参数。 */ export interface QualityEvaluationConfigureInfo { /** * 视频画面质量评价检测开关,可选值: <li>ON:开启;</li> <li>OFF:关闭。</li> */ Switch: string; /** * 视频画面质量评价过滤阈值,结果只返回低于该值的时间段,默认值为 60。 */ Score?: number; } /** * 音视频审核任务的输入。 */ export interface ReviewAudioVideoTaskInput { /** * 媒体文件 ID。 */ FileId?: string; /** * 音视频审核模板 ID。 */ Definition?: number; /** * 审核的内容,可选值: <li>Media:原始音视频;</li> <li>Cover:封面。</li> */ ReviewContents?: Array<string>; } /** * DescribeAllClass请求参数结构体 */ export interface DescribeAllClassRequest { /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; } /** * DescribeRoundPlays请求参数结构体 */ export interface DescribeRoundPlaysRequest { /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 过滤条件:轮播播单标识,数组长度限制:100。 */ RoundPlayIds?: Array<string>; /** * 过滤条件,轮播播单状态,可选值: <li>Enabled:启动状态;</li> <li>Disabled:停止状态。</li> */ Status?: string; /** * 过滤条件:轮播播单创建时间。 */ CreateTime?: TimeRange; /** * 过滤条件:轮播播单更新时间。 */ UpdateTime?: TimeRange; /** * 翻页标识,分批拉取时使用:当单次请求无法拉取所有数据,接口将会返回 ScrollToken,下一次请求携带该 Token,将会从下一条记录开始获取。 */ ScrollToken?: string; /** * 分页偏移量,默认值:0。已经废弃,请根据 ScrollToken 参数进行分批次查询。 */ Offset?: number; /** * 返回记录条数,默认值:10,最大值:100。 */ Limit?: number; } /** * WeChatMiniProgramPublish请求参数结构体 */ export interface WeChatMiniProgramPublishRequest { /** * 媒体文件 ID。 */ FileId: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 发布视频所对应的转码模板 ID,为0代表原始视频。 */ SourceDefinition?: number; } /** * 智能分类任务输入类型 */ export interface AiAnalysisTaskClassificationInput { /** * 视频智能分类模板 ID。 */ Definition?: number; } /** * SVG水印模板输入参数 */ export interface SvgWatermarkInput { /** * 水印的宽度,支持 px,%,W%,H%,S%,L% 六种格式: <li>当字符串以 px 结尾,表示水印 Width 单位为像素,如 100px 表示 Width 为 100 像素;当填 0px 且 Height 不为 0px 时,表示水印的宽度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的宽度取原始 SVG 图像的宽度;</li> <li>当字符串以 W% 结尾,表示水印 Width 为视频宽度的百分比大小,如 10W% 表示 Width 为视频宽度的 10%;</li> <li>当字符串以 H% 结尾,表示水印 Width 为视频高度的百分比大小,如 10H% 表示 Width 为视频高度的 10%;</li> <li>当字符串以 S% 结尾,表示水印 Width 为视频短边的百分比大小,如 10S% 表示 Width 为视频短边的 10%;</li> <li>当字符串以 L% 结尾,表示水印 Width 为视频长边的百分比大小,如 10L% 表示 Width 为视频长边的 10%;</li> <li>当字符串以 % 结尾时,含义同 W%。</li> 默认值为 10W%。 */ Width?: string; /** * 水印的高度,支持 px,W%,H%,S%,L% 六种格式: <li>当字符串以 px 结尾,表示水印 Height 单位为像素,如 100px 表示 Height 为 100 像素;当填 0px 且 Width 不为 0px 时,表示水印的高度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的高度取原始 SVG 图像的高度;</li> <li>当字符串以 W% 结尾,表示水印 Height 为视频宽度的百分比大小,如 10W% 表示 Height 为视频宽度的 10%;</li> <li>当字符串以 H% 结尾,表示水印 Height 为视频高度的百分比大小,如 10H% 表示 Height 为视频高度的 10%;</li> <li>当字符串以 S% 结尾,表示水印 Height 为视频短边的百分比大小,如 10S% 表示 Height 为视频短边的 10%;</li> <li>当字符串以 L% 结尾,表示水印 Height 为视频长边的百分比大小,如 10L% 表示 Height 为视频长边的 10%;</li> <li>当字符串以 % 结尾时,含义同 H%。</li> 默认值为 0px。 */ Height?: string; } /** * CreateTranscodeTemplate请求参数结构体 */ export interface CreateTranscodeTemplateRequest { /** * 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a、wav。其中,mp3、flac、ogg、m4a、wav 为纯音频文件。 */ Container: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 转码模板名称,长度限制:64 个字符。 */ Name?: string; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; /** * 是否去除视频数据,可选值: <li>0:保留</li> <li>1:去除</li> 默认值:0。 */ RemoveVideo?: number; /** * 是否去除音频数据,可选值: <li>0:保留</li> <li>1:去除</li> 默认值:0。 */ RemoveAudio?: number; /** * 视频流配置参数,当 RemoveVideo 为 0,该字段必填。 */ VideoTemplate?: VideoTemplateInfo; /** * 音频流配置参数,当 RemoveAudio 为 0,该字段必填。 */ AudioTemplate?: AudioTemplateInfo; /** * 极速高清转码参数。 */ TEHDConfig?: TEHDConfig; /** * 切片类型,当 Container 为 hls 时有效,可选值: <li>ts:ts 切片;</li> <li>fmp4:fmp4 切片。</li> 默认值:ts。 */ SegmentType?: string; } /** * 转场操作 */ export interface TransitionOpertion { /** * 转场类型,取值有: <ul> <li>图像的转场操作,用于两个视频片段图像间的转场处理: <ul> <li>ImageFadeInFadeOut:图像淡入淡出。 </li> <li>BowTieHorizontal:水平蝴蝶结。 </li> <li>BowTieVertical:垂直蝴蝶结。 </li> <li>ButterflyWaveScrawler:晃动。 </li> <li>Cannabisleaf:枫叶。 </li> <li>Circle:弧形收放。 </li> <li>CircleCrop:圆环聚拢。 </li> <li>Circleopen:椭圆聚拢。 </li> <li>Crosswarp:横向翘曲。 </li> <li>Cube:立方体。 </li> <li>DoomScreenTransition:幕布。 </li> <li>Doorway:门廊。 </li> <li>Dreamy:波浪。 </li> <li>DreamyZoom:水平聚拢。 </li> <li>FilmBurn:火烧云。 </li> <li>GlitchMemories:抖动。 </li> <li>Heart:心形。 </li> <li>InvertedPageCurl:翻页。 </li> <li>Luma:腐蚀。 </li> <li>Mosaic:九宫格。 </li> <li>Pinwheel:风车。 </li> <li>PolarFunction:椭圆扩散。 </li> <li>PolkaDotsCurtain:弧形扩散。 </li> <li>Radial:雷达扫描 </li> <li>RotateScaleFade:上下收放。 </li> <li>Squeeze:上下聚拢。 </li> <li>Swap:放大切换。 </li> <li>Swirl:螺旋。 </li> <li>UndulatingBurnOutSwirl:水流蔓延。 </li> <li>Windowblinds:百叶窗。 </li> <li>WipeDown:向下收起。 </li> <li>WipeLeft:向左收起。 </li> <li>WipeRight:向右收起。 </li> <li>WipeUp:向上收起。 </li> <li>ZoomInCircles:水波纹。 </li> </ul> </li> <li>音频的转场操作,用于两个音频片段间的转场处理: <ul> <li>AudioFadeInFadeOut:声音淡入淡出。 </li> </ul> </li> </ul> */ Type: string; } /** * 音频轨道上的音频片段信息。 */ export interface AudioTrackItem { /** * 音频片段的媒体素材来源,可以是: <li>点播的媒体文件 ID;</li> <li>其他媒体文件的下载 URL。</li> 注意:当使用其他媒体文件的下载 URL 作为素材来源,且开启了访问控制(如防盗链)时,需要在 URL 携带访问控制参数(如防盗链签名)。 */ SourceMedia: string; /** * 音频片段取自素材文件的起始时间,单位为秒。0 表示从素材开始位置截取。默认为0。 */ SourceMediaStartTime?: number; /** * 音频片段的时长,单位为秒。默认和素材本身长度一致,表示截取全部素材。 */ Duration?: number; /** * 音频片段目标时长,单位为秒。 <li>当 TargetDuration 不填或填0时,表示目标时长和 Duration 一致;</li> <li>当 TargetDuration 取大于0的值时,将对音频片段做快进或慢放等处理,使得输出片段的时长等于 TargetDuration。</li> */ TargetDuration?: number; /** * 对音频片段进行的操作,如音量调节等。 */ AudioOperations?: Array<AudioTransform>; } /** * 智能精彩片段信息 */ export interface MediaAiAnalysisHighlightItem { /** * 智能精彩集锦地址。 */ HighlightUrl?: string; /** * 智能精彩集锦封面地址。 */ CovImgUrl?: string; /** * 智能精彩集锦的可信度,取值范围是 0 到 100。 */ Confidence?: number; /** * 智能精彩集锦持续时间。 */ Duration?: number; /** * 智能精彩集锦子片段列表,精彩集锦片段由这些子片段拼接生成。 */ SegmentSet?: Array<HighlightSegmentItem>; } /** * DescribeAnimatedGraphicsTemplates请求参数结构体 */ export interface DescribeAnimatedGraphicsTemplatesRequest { /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 转动图模板唯一标识过滤条件,数组长度限制:100。 */ Definitions?: Array<number | bigint>; /** * 分页偏移量,默认值:0。 */ Offset?: number; /** * 返回记录条数,默认值:10,最大值:100。 */ Limit?: number; /** * 模板类型过滤条件,可选值: <li>Preset:系统预置模板;</li> <li>Custom:用户自定义模板。</li> */ Type?: string; } /** * LiveRealTimeClip返回参数结构体 */ export interface LiveRealTimeClipResponse { /** * 剪辑后的视频播放 URL。 */ Url?: string; /** * 剪辑固化后的视频的媒体文件的唯一标识。 */ FileId?: string; /** * 剪辑固化后的视频任务流 ID。 */ VodTaskId?: string; /** * 剪辑后的视频元信息。 注意:此字段可能返回 null,表示取不到有效值。 */ MetaData?: MediaMetaData; /** * <span id="p_segmentset">剪辑后的视频片段信息。</span> */ SegmentSet?: Array<LiveRealTimeClipMediaSegmentInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 音视频审核 Asr 文字鉴违禁任务结果类型 */ export interface AiReviewTaskProhibitedAsrResult { /** * 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 */ Status?: string; /** * 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。 */ ErrCodeExt?: string; /** * 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 */ ErrCode?: number; /** * 错误信息。 */ Message?: string; /** * 音视频审核 Asr 文字鉴违禁任务输入。 */ Input?: AiReviewProhibitedAsrTaskInput; /** * 音视频审核 Asr 文字鉴违禁任务输出。 */ Output?: AiReviewProhibitedAsrTaskOutput; /** * 音视频审核 Asr 文字鉴违禁任务进度,取值范围 [0-100] 。 */ Progress?: number; } /** * 转自适应码流模板详情 */ export interface AdaptiveDynamicStreamingTemplate { /** * 转自适应码流模板唯一标识。 */ Definition?: number; /** * 模板类型,取值范围: <li>Preset:系统预置模板;</li> <li>Custom:用户自定义模板。</li> */ Type?: string; /** * 转自适应码流模板名称。 */ Name?: string; /** * 转自适应码流模板描述信息。 */ Comment?: string; /** * 自适应转码格式,取值范围: <li>HLS。</li> */ Format?: string; /** * DRM 类型,取值范围: <li>SimpleAES</li> <li>Widevine</li> <li>FairPlay</li> 如果取值为空字符串,代表不对视频做 DRM 保护。 */ DrmType?: string; /** * DRM 的密钥提供商,取值范围: <li>SDMC:华曦达;</li> <li>VOD:云点播。</li> 默认值为 VOD 。 */ DrmKeyProvider?: string; /** * 自适应转码输入流参数信息,最多输入10路流。 */ StreamInfos?: Array<AdaptiveStreamTemplate>; /** * 是否禁止视频低码率转高码率,取值范围: <li>0:否,</li> <li>1:是。</li> */ DisableHigherVideoBitrate?: number; /** * 是否禁止视频分辨率转高分辨率,取值范围: <li>0:否,</li> <li>1:是。</li> */ DisableHigherVideoResolution?: number; /** * 模板创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ CreateTime?: string; /** * 模板最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ UpdateTime?: string; /** * 切片类型,仅当 Format 为 HLS 时有效。 */ SegmentType?: string; } /** * DeleteJustInTimeTranscodeTemplate请求参数结构体 */ export interface DeleteJustInTimeTranscodeTemplateRequest { /** * 模板名字。 */ Name: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; } /** * DeleteAnimatedGraphicsTemplate返回参数结构体 */ export interface DeleteAnimatedGraphicsTemplateResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 音视频审核 Ocr 文字鉴违禁任务结果类型 */ export interface AiReviewTaskProhibitedOcrResult { /** * 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 */ Status?: string; /** * 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。 */ ErrCodeExt?: string; /** * 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 */ ErrCode?: number; /** * 错误信息。 */ Message?: string; /** * 音视频审核 Ocr 文字鉴违禁任务输入。 */ Input?: AiReviewProhibitedOcrTaskInput; /** * 音视频审核 Ocr 文字鉴违禁任务输出。 */ Output?: AiReviewProhibitedOcrTaskOutput; /** * 音视频审核 Ocr 文字鉴违禁任务进度,取值范围 [0-100] 。 */ Progress?: number; } /** * 语音全文识别结果。 */ export interface AiRecognitionTaskAsrFullTextResultOutput { /** * 语音全文识别片段列表。 <font color=red>注意</font> :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。 */ SegmentSet?: Array<AiRecognitionTaskAsrFullTextSegmentItem>; /** * 语音全文识别片段列表文件 URL。文件的内容为 JSON,数据结构与 SegmentSet 字段一致。 (文件不会永久存储,到达SegmentSetFileUrlExpireTime 时间点后文件将被删除)。 */ SegmentSetFileUrl?: string; /** * 语音全文识别片段列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ SegmentSetFileUrlExpireTime?: string; /** * 生成的字幕列表,对应 [语音全文识别任务控制参数](https://cloud.tencent.com/document/api/266/31773#AsrFullTextConfigureInfo) SubtitleFormats。 */ SubtitleSet?: Array<AiRecognitionTaskAsrFullTextResultOutputSubtitleItem>; /** * 生成的字幕文件 Url,对应 [语音全文识别任务控制参数](https://cloud.tencent.com/document/api/266/31773#AsrFullTextConfigureInfo) SubtitleFormat。 */ SubtitleUrl?: string; } /** * Ocr 文字涉违禁信息 */ export interface AiReviewProhibitedOcrTaskOutput { /** * Ocr 文字涉违禁评分,分值为0到100。 */ Confidence?: number; /** * Ocr 文字涉违禁结果建议,取值范围: <li>pass。</li> <li>review。</li> <li>block。</li> */ Suggestion?: string; /** * Ocr 文字有涉违禁嫌疑的视频片段列表。 <font color=red>注意</font> :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。 */ SegmentSet?: Array<MediaContentReviewOcrTextSegmentItem>; /** * Ocr 文字有涉违禁嫌疑的视频片段列表文件 URL。文件的内容为 JSON,数据结构与 SegmentSet 字段一致。 (文件不会永久存储,到达 SegmentSetFileUrlExpireTime 时间点后文件将被删除)。 */ SegmentSetFileUrl?: string; /** * Ocr 文字有涉违禁嫌疑的视频片段列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ SegmentSetFileUrlExpireTime?: string; } /** * 小程序音视频审核概要元信息 */ export interface MediaMiniProgramReviewElem { /** * 音视频审核类型。 <li>Porn:画面涉及令人反感的信息,</li> <li>Porn.Ocr:文字涉及令人反感的信息,</li> <li>Porn.Asr:声音涉及令人反感的信息,</li> <li>Terrorism:画面涉及令人不安全的信息,</li> <li>Political:画面涉及令人不适宜的信息,</li> <li>Political.Ocr:文字涉及令人不适宜的信息,</li> <li>Political.Asr:声音涉及令人不适宜的信息。</li> */ Type?: string; /** * 音视频审核意见。 <li>pass:确认正常,</li> <li>block:确认违规,</li> <li>review:疑似违规。</li> */ Suggestion?: string; /** * 音视频审核结果置信度。取值 0~100。 */ Confidence?: number; } /** * ManageTask返回参数结构体 */ export interface ManageTaskResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateImageProcessingTemplate请求参数结构体 */ export interface CreateImageProcessingTemplateRequest { /** * 图片处理操作数组,操作将以其在数组中的顺序执行。 <li>长度限制:10。</li> */ Operations: Array<ImageOperation>; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 图片处理模板名称,长度限制:64 个字符。 */ Name?: string; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; } /** * ModifyDefaultStorageRegion请求参数结构体 */ export interface ModifyDefaultStorageRegionRequest { /** * 默认的存储地域,必须是已经开通的地域(通过 DescribeStorageRegions 接口查询)。 */ StorageRegion: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; } /** * ModifyEventConfig返回参数结构体 */ export interface ModifyEventConfigResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 音画质检测任务的输出。 */ export interface QualityInspectTaskOutput { /** * 媒体文件是否无音频轨,取值范围: <li>0:否,即有音频轨;</li> <li>1:是,即无音频轨。</li> */ NoAudio?: number; /** * 媒体文件是否无视频轨,取值范围: <li>0:否,即有视频轨;</li> <li>1:是,即无视频轨。</li> */ NoVideo?: number; /** * 视频画面质量评分,取值范围:[0, 100]。 */ QualityEvaluationScore?: number; /** * 音画质检测出的异常项列表。 */ QualityInspectResultSet?: Array<QualityInspectResultItem>; } /** * 音画质重生任务的输入。 */ export interface QualityEnhanceTaskInput { /** * 媒体文件 ID。 */ FileId?: string; /** * 音画质重生模板 ID。 */ Definition?: number; } /** * ResetProcedureTemplate返回参数结构体 */ export interface ResetProcedureTemplateResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 点播文件指定时间点截图信息 */ export interface MediaSnapshotByTimeOffsetItem { /** * 指定时间点截图规格,参见[指定时间点截图参数模板](https://cloud.tencent.com/document/product/266/33480#.E6.97.B6.E9.97.B4.E7.82.B9.E6.88.AA.E5.9B.BE.E6.A8.A1.E6.9D.BF)。 */ Definition?: number; /** * 同一规格的截图信息集合,每个元素代表一张截图。 */ PicInfoSet?: Array<MediaSnapshotByTimePicInfoItem>; } /** * 画质重生目标参数 */ export interface RebuildMediaTargetInfo { /** * 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。 */ MediaName?: string; /** * 描述信息,最长 128 个字符。缺省描述信息为空。 */ Description?: string; /** * 分类ID,用于对媒体进行分类管理,可通过 [创建分类](/document/product/266/7812) 接口,创建分类,获得分类 ID。 <li>默认值:0,表示其他分类。</li> */ ClassId?: number; /** * 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。 */ ExpireTime?: string; /** * 输出文件封装格式,可选值:mp4、flv、hls。默认mp4。 */ Container?: string; /** * 输出的视频信息。 */ VideoStream?: RebuildMediaTargetVideoStream; /** * 输出的音频信息。 */ AudioStream?: RebuildMediaTargetAudioStream; /** * 是否去除视频数据,可选值: <li>0:保留</li> <li>1:去除</li> 默认值:0。 */ RemoveVideo?: number; /** * 是否去除音频数据,可选值: <li>0:保留</li> <li>1:去除</li> 默认值:0。 */ RemoveAudio?: number; } /** * ModifySampleSnapshotTemplate请求参数结构体 */ export interface ModifySampleSnapshotTemplateRequest { /** * 采样截图模板唯一标识。 */ Definition: number; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 采样截图模板名称,长度限制:64 个字符。 */ Name?: string; /** * 截图宽度(或长边)的最大值,取值范围:0 和 [32, 4096],单位:px。<li>当 Width、Height 均为 0,则分辨率同源;</li><li>当 Width 为 0,Height 非 0,则 Width 按比例缩放;</li><li>当 Width 非 0,Height 为 0,则 Height 按比例缩放;</li><li>当 Width、Height 均非 0,则分辨率按用户指定。</li>默认值:0。 */ Width?: number; /** * 截图高度(或短边)的最大值,取值范围:0 和 [32, 4096],单位:px。<li>当 Width、Height 均为 0,则分辨率同源;</li><li>当 Width 为 0,Height 非 0,则 Width 按比例缩放;</li><li>当 Width 非 0,Height 为 0,则 Height 按比例缩放;</li><li>当 Width、Height 均非 0,则分辨率按用户指定。</li>默认值:0。 */ Height?: number; /** * 分辨率自适应,可选值: <li>open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;</li> <li>close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。</li> 默认值:open。 */ ResolutionAdaptive?: string; /** * 采样截图类型,取值: <li>Percent:按百分比。</li> <li>Time:按时间间隔。</li> */ SampleType?: string; /** * 采样间隔。 <li>当 SampleType 为 Percent 时,指定采样间隔的百分比。</li> <li>当 SampleType 为 Time 时,指定采样间隔的时间,单位为秒。</li> */ SampleInterval?: number; /** * 图片格式,取值为 jpg 和 png。 */ Format?: string; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; /** * 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式: <li> stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;</li> <li>black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。</li> <li>white:留白,保持视频宽高比不变,边缘剩余部分使用白色填充。</li> <li>gauss:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊。</li> 默认值:black 。 */ FillType?: string; } /** * 音视频审核 Ocr 文字涉及令人不适宜信息的任务输入参数类型 */ export interface AiReviewPoliticalOcrTaskInput { /** * 鉴别涉及令人不适宜信息的模板 ID。 */ Definition?: number; } /** * ModifyJustInTimeTranscodeTemplate请求参数结构体 */ export interface ModifyJustInTimeTranscodeTemplateRequest { /** * 模板名字。 */ Name: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 视频参数配置。 */ VideoConfigure?: VideoConfigureInfoForUpdate; /** * 水印参数配置。 */ WatermarkConfigure?: WatermarkConfigureInfoForUpdate; /** * 模板描述,长度限制256个字符。 */ Comment?: string; } /** * DescribePrepaidProducts请求参数结构体 */ export declare type DescribePrepaidProductsRequest = null; /** * 要处理的源视频信息,视频名称、视频自定义 ID。 */ export interface MediaInputInfo { /** * 视频 URL。 */ Url: string; /** * 视频名称。 */ Name?: string; /** * 视频自定义 ID。 */ Id?: string; } /** * 视频截取雪碧图任务,该结构仅用于对 2017 版[截取雪碧图](https://cloud.tencent.com/document/product/266/8101)接口发起的任务。 */ export interface CreateImageSpriteTask2017 { /** * 截图雪碧图任务 ID。 */ TaskId?: string; /** * 错误码 <li>0:成功;</li> <li>其他值:失败。</li> */ ErrCode?: number; /** * 错误信息。 */ Message?: string; /** * 截取雪碧图文件 ID。 */ FileId?: string; /** * 雪碧图规格,参见[雪碧图截图模板](https://cloud.tencent.com/document/product/266/33480#.E9.9B.AA.E7.A2.A7.E5.9B.BE.E6.A8.A1.E6.9D.BF)。 */ Definition?: number; /** * 雪碧图小图总数量。 */ TotalCount?: number; /** * 截取雪碧图输出的地址。 */ ImageSpriteUrlSet?: Array<string>; /** * 雪碧图子图位置与时间关系 WebVtt 文件地址。 */ WebVttUrl?: string; } /** * 视频裁剪结果文件信息(2017 版) */ export interface ClipFileInfo2017 { /** * 错误码 <li>0:成功;</li> <li>其他值:失败。</li> */ ErrCode?: number; /** * 错误描述。 */ Message?: string; /** * 输出目标文件的文件 ID。 */ FileId?: string; /** * 输出目标文件的文件地址。 */ FileUrl?: string; /** * 输出目标文件的文件类型。 */ FileType?: string; } /** * 临时凭证 */ export interface TempCertificate { /** * 临时安全证书 Id。 */ SecretId?: string; /** * 临时安全证书 Key。 */ SecretKey?: string; /** * Token 值。 */ Token?: string; /** * 证书无效的时间,返回 Unix 时间戳,精确到秒。 */ ExpiredTime?: number; } /** * DescribeDefaultDistributionConfig请求参数结构体 */ export interface DescribeDefaultDistributionConfigRequest { /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; } /** * 音视频审核 Ocr 文字涉及令人不适宜信息、违规任务结果类型 */ export interface AiReviewTaskPoliticalOcrResult { /** * 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 */ Status?: string; /** * 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。 */ ErrCodeExt?: string; /** * 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 */ ErrCode?: number; /** * 错误信息。 */ Message?: string; /** * 音视频审核 Ocr 文字涉及令人不适宜信息的任务输入。 */ Input?: AiReviewPoliticalOcrTaskInput; /** * 音视频审核 Ocr 文字涉及令人不适宜信息的任务输出。 */ Output?: AiReviewPoliticalOcrTaskOutput; /** * 音视频审核 Ocr 文字涉及令人不适宜信息的任务进度,取值范围 [0-100] 。 */ Progress?: number; } /** * 音画质重生任务 */ export interface QualityEnhanceTask { /** * 任务 ID。 */ TaskId?: string; /** * 任务流状态,取值: <li>PROCESSING:处理中;</li> <li>FINISH:已完成。</li> */ Status?: string; /** * 错误码,0 表示成功,其他值表示失败: <li>40000:输入参数不合法,请检查输入参数;</li> <li>60000:源文件错误(如视频数据损坏),请确认源文件是否正常;</li> <li>70000:内部服务错误,建议重试。</li> */ ErrCode?: number; /** * 错误信息。 */ Message?: string; /** * 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。 */ ErrCodeExt?: string; /** * 音画质重生任务进度,取值范围 [0-100] 。 */ Progress?: number; /** * 音画质重生任务的输入。 */ Input?: QualityEnhanceTaskInput; /** * 音画质重生任务的输出。 */ Output?: QualityEnhanceTaskOutput; /** * 音画质重生输出视频的元信息。 */ MetaData?: MediaMetaData; /** * 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。 */ SessionId?: string; /** * 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。 */ SessionContext?: string; } /** * AI 样本管理,关键词输出信息。 */ export interface AiSampleWord { /** * 关键词。 */ Keyword?: string; /** * 关键词标签。 */ TagSet?: Array<string>; /** * 关键词应用场景。 */ UsageSet?: Array<string>; /** * 创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ CreateTime?: string; /** * 最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ UpdateTime?: string; } /** * CreateImageSpriteTemplate请求参数结构体 */ export interface CreateImageSpriteTemplateRequest { /** * 采样类型,取值: <li>Percent:按百分比。</li> <li>Time:按时间间隔。</li> */ SampleType: string; /** * 采样间隔。 <li>当 SampleType 为 Percent 时,指定采样间隔的百分比。</li> <li>当 SampleType 为 Time 时,指定采样间隔的时间,单位为秒。</li> */ SampleInterval: number; /** * 雪碧图中小图的行数。 注意:小图的行数会影响最终大图的高度,大图的高度最大为15000像素,其中大图的高度为小图行数与小图高度的乘积。 */ RowCount: number; /** * 雪碧图中小图的列数。 注意:小图的列数会影响最终大图的宽度,大图的宽度最大为15000像素,其中大图的宽度为小图列数与小图宽度的乘积。 */ ColumnCount: number; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 雪碧图模板名称,长度限制:64 个字符。 */ Name?: string; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; /** * 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式: <li> stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;</li> <li>black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。</li> 默认值:black 。 */ FillType?: string; /** * 雪碧图中小图的宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。 <li>当 Width、Height 均为 0,则分辨率同源;</li> <li>当 Width 为 0,Height 非 0,则 Width 按比例缩放;</li> <li>当 Width 非 0,Height 为 0,则 Height 按比例缩放;</li> <li>当 Width、Height 均非 0,则分辨率按用户指定。</li> 默认值:0。 注意:小图的宽度会影响最终大图的宽度,大图的宽度最大为15000像素,其中大图的宽度为小图列数与小图宽度的乘积。 */ Width?: number; /** * 雪碧图中小图的高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。 <li>当 Width、Height 均为 0,则分辨率同源;</li> <li>当 Width 为 0,Height 非 0,则 Width 按比例缩放;</li> <li>当 Width 非 0,Height 为 0,则 Height 按比例缩放;</li> <li>当 Width、Height 均非 0,则分辨率按用户指定。</li> 默认值:0。 注意:小图的高度会影响最终大图的高度,大图的高度最大为15000像素,其中大图的高度为小图行数与小图高度的乘积。 */ Height?: number; /** * 分辨率自适应,可选值: <li>open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;</li> <li>close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。</li> 默认值:open。 */ ResolutionAdaptive?: string; /** * 图片格式,取值: <li> jpg:jpg 格式;</li> <li> png:png 格式;</li> <li> webp:webp 格式。</li> 默认值:jpg。 */ Format?: string; } /** * 指定时间点截图信息 */ export interface MediaSnapshotByTimePicInfoItem { /** * 该张截图对应视频文件中的时间偏移,单位为<font color=red>毫秒</font>。 */ TimeOffset?: number; /** * 该张截图的 URL 地址。 */ Url?: string; /** * 截图如果被打上了水印,被打水印的模板 ID 列表。 */ WaterMarkDefinition?: Array<number | bigint>; } /** * DescribeDailyMostPlayedStat请求参数结构体 */ export interface DescribeDailyMostPlayedStatRequest { /** * 查询日期,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。该参数仅日期部分有效。 */ Date: string; /** * 域名。查询该域名播放 Top100 的媒体文件的统计数据。默认查询所有域名的播放统计数据。 */ DomainName?: string; /** * Top 数据的统计指标,取值有: <li>Traffic:播放流量,按播放流量统计 Top100 的数据。</li> <li>PlayTimes:播放次数,按播放次数统计播放 Top100 的数据。</li> 默认值为Traffic。 */ Metric?: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; } /** * 用户自定义人物音视频审核任务控制参数 */ export interface UserDefineFaceReviewTemplateInfo { /** * 用户自定义人物音视频审核任务开关,可选值: <li>ON:开启自定义人物音视频审核任务;</li> <li>OFF:关闭自定义人物音视频审核任务。</li> */ Switch: string; /** * 用户自定义人物过滤标签,音视频审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义人物库的时,需要添加对应人物标签。 标签个数最多 10 个,每个标签长度最多 16 个字符。 */ LabelSet?: Array<string>; /** * 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规,不填默认为 97 分。取值范围:0~100。 */ BlockConfidence?: number; /** * 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核,不填默认为 95 分。取值范围:0~100。 */ ReviewConfidence?: number; } /** * RefreshUrlCache请求参数结构体 */ export interface RefreshUrlCacheRequest { /** * 刷新的 URL 列表,单次最多指定20个 URL。 */ Urls: Array<string>; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; } /** * 音视频审核模板详情 */ export interface ContentReviewTemplateItem { /** * 音视频审核模板唯一标识。 */ Definition?: number; /** * 音视频审核模板名称,长度限制:64 个字符。 */ Name?: string; /** * 音视频审核模板描述信息,长度限制:256 个字符。 */ Comment?: string; /** * 鉴别涉及令人反感的信息的控制参数。 */ PornConfigure?: PornConfigureInfo; /** * 鉴别涉及令人不安全的信息的控制参数。 */ TerrorismConfigure?: TerrorismConfigureInfo; /** * 鉴别涉及令人不适宜的信息的控制参数。 */ PoliticalConfigure?: PoliticalConfigureInfo; /** * 违禁控制参数。违禁内容包括: <li>谩骂;</li> <li>涉毒违法。</li> */ ProhibitedConfigure?: ProhibitedConfigureInfo; /** * 用户自定义音视频审核控制参数。 */ UserDefineConfigure?: UserDefineConfigureInfo; /** * 音视频审核结果是否进入音视频审核墙(对音视频审核结果进行人工复核)的开关。 <li>ON:是;</li> <li>OFF:否。</li> */ ReviewWallSwitch?: string; /** * 截帧间隔,单位为秒。当不填时,默认截帧间隔为 1 秒,最小值为 0.5 秒。 */ ScreenshotInterval?: number; /** * 模板创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ CreateTime?: string; /** * 模板最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ UpdateTime?: string; } /** * DeleteAIRecognitionTemplate返回参数结构体 */ export interface DeleteAIRecognitionTemplateResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteContentReviewTemplate请求参数结构体 */ export interface DeleteContentReviewTemplateRequest { /** * 内容审核模板唯一标识。 */ Definition: number; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; } /** * 视频画面噪点检测的控制参数。 */ export interface NoiseConfigureInfo { /** * 视频画面噪点检测开关,可选值: <li>ON:开启;</li> <li>OFF:关闭。</li> */ Switch: string; } /** * 音视频审核涉及令人不适宜信息的任务输入参数类型 */ export interface AiReviewPoliticalTaskInput { /** * 鉴别涉及令人不适宜信息的模板 ID。 */ Definition?: number; } /** * VerifyDomainRecord返回参数结构体 */ export interface VerifyDomainRecordResponse { /** * 是否验证成功。 */ Result?: boolean; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 音频操作 */ export interface AudioTransform { /** * 音频操作类型,取值有: <li>Volume:音量调节。</li> */ Type: string; /** * 音量调节参数, 当 Type = Volume 时有效。 */ VolumeParam?: AudioVolumeParam; } /** * 视频转码任务信息,该结构仅用于对 2017 版[视频转码](https://cloud.tencent.com/document/product/266/7822)接口发起的任务。 */ export interface TranscodeTask2017 { /** * 转码任务 ID。 */ TaskId?: string; /** * 错误码 <li>0:成功;</li> <li>其他值:失败。</li> */ ErrCode?: number; /** * 错误信息。 */ Message?: string; /** * 被转码文件 ID。 */ FileId?: string; /** * 被转码文件名称。 */ FileName?: string; /** * 视频时长,单位:秒。 */ Duration?: number; /** * 封面地址。 */ CoverUrl?: string; /** * 视频转码后生成的播放信息。 */ PlayInfoSet?: Array<TranscodePlayInfo2017>; } /** * DescribeCurrentPlaylist返回参数结构体 */ export interface DescribeCurrentPlaylistResponse { /** * 当前播放列表信息。 */ CurrentPlaylist?: Array<RoundPlayFilePlayInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySuperPlayerConfig请求参数结构体 */ export interface ModifySuperPlayerConfigRequest { /** * 播放器配置名称。 */ Name: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 播放的音视频类型,可选值: <li>AdaptiveDynamicStream:自适应码流输出;</li> <li>Transcode:转码输出;</li> <li>Original:原始音视频。</li> */ AudioVideoType?: string; /** * 播放 DRM 保护的自适应码流开关: <li>ON:开启,表示仅播放 DRM 保护的自适应码流输出;</li> <li>OFF:关闭,表示播放未加密的自适应码流输出。</li> */ DrmSwitch?: string; /** * 允许输出的未加密的自适应码流模板 ID。 */ AdaptiveDynamicStreamingDefinition?: number; /** * 允许输出的 DRM 自适应码流模板内容。 */ DrmStreamingsInfo?: DrmStreamingsInfoForUpdate; /** * 允许输出的转码模板 ID。 */ TranscodeDefinition?: number; /** * 允许输出的雪碧图模板 ID。 */ ImageSpriteDefinition?: number; /** * 播放器对于不同分辨率的子流展示名字。 */ ResolutionNames?: Array<ResolutionNameInfo>; /** * 播放时使用的域名。填 Default 表示使用[默认分发配置](https://cloud.tencent.com/document/product/266/33373)中的域名。 */ Domain?: string; /** * 播放时使用的 Scheme。取值范围: <li>Default:使用[默认分发配置](https://cloud.tencent.com/document/product/266/33373)中的 Scheme;</li> <li>HTTP;</li> <li>HTTPS。</li> */ Scheme?: string; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; } /** * ResetProcedureTemplate请求参数结构体 */ export interface ResetProcedureTemplateRequest { /** * 任务流名字 */ Name: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; /** * 视频处理类型任务参数。 */ MediaProcessTask?: MediaProcessTaskInput; /** * AI 智能内容审核类型任务参数 \*。 <font color=red>\*:该参数用于发起旧版审核,不建议使用。推荐使用 ReviewAudioVideoTask 参数发起审核。</font> */ AiContentReviewTask?: AiContentReviewTaskInput; /** * AI 智能内容分析类型任务参数。 */ AiAnalysisTask?: AiAnalysisTaskInput; /** * AI 内容识别类型任务参数。 */ AiRecognitionTask?: AiRecognitionTaskInput; /** * 音视频审核类型任务参数。 */ ReviewAudioVideoTask?: ProcedureReviewAudioVideoTaskInput; } /** * 图片Ocr 文字鉴别信息的任务结果类型 */ export interface ContentReviewOcrResult { /** * Ocr 文字鉴别结果的评分,分值为0到100。 */ Confidence?: number; /** * Ocr 文字鉴别的结果建议,取值范围: <li>pass;</li> <li>review;</li> <li>block。</li> */ Suggestion?: string; /** * Ocr 文字鉴别的嫌疑关键词列表。 */ KeywordSet?: Array<string>; /** * Ocr 文字鉴别的嫌疑文字出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。 */ AreaCoordSet?: Array<number | bigint>; } /** * ComposeMedia返回参数结构体 */ export interface ComposeMediaResponse { /** * 制作媒体文件的任务 ID,可以通过该 ID 查询制作任务(任务类型为 MakeMedia)的状态。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 轮播任务信息 */ export interface RoundPlayInfo { /** * 轮播播单标识。 */ RoundPlayId?: string; /** * 启播时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52)。 */ StartTime?: string; /** * 轮播列表。 */ RoundPlaylist?: Array<RoundPlayListItemInfo>; /** * 轮播播单名称,长度限制:64 个字符。 */ Name?: string; /** * 轮播播单描述信息,长度限制:256 个字符。 */ Desc?: string; /** * 播放状态,可选值: <li>Enabled:启动状态;</li> <li>Disabled:停止状态。</li> 默认值:Enabled。 */ Status?: string; /** * 播放模式,可选值: <li>Loop:循环播放播单;</li> <li>Linear:单次播放,播单播放完停止播放。</li> 默认值:Loop。 */ PlayBackMode?: string; /** * 轮播播放地址。 */ Url?: string; /** * 创建时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52)。 */ CreateTime?: string; /** * 更新时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52)。 */ UpdateTime?: string; /** * 过期时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52),过期后将停止播单的播放。“9999-12-31T23:59:59+08:00”表示永不过期。 */ ExpiredTime?: string; } /** * DescribeLicenseUsageData返回参数结构体 */ export interface DescribeLicenseUsageDataResponse { /** * License 查询次数统计数据,展示所查询 License 次数的明细数据。 */ LicenseUsageDataSet?: Array<LicenseUsageDataItem>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DRM 自适应码流播放信息修改对象 */ export interface DrmStreamingsInfoForUpdate { /** * 保护类型为 SimpleAES 的转自适应码流模板 ID。 */ SimpleAesDefinition?: number; /** * 保护类型为 Widevine 的转自适应码流模板 ID。 */ WidevineDefinition?: number; /** * 保护类型为 FairPlay 的转自适应码流模板 ID。 */ FairPlayDefinition?: number; } /** * 智能分类任务控制参数 */ export interface ClassificationConfigureInfo { /** * 智能分类任务开关,可选值: <li>ON:开启智能分类任务;</li> <li>OFF:关闭智能分类任务。</li> */ Switch: string; } /** * 视频画面低光、过曝检测的控制参数。 */ export interface AbnormalLightingConfigureInfoForUpdate { /** * 视频画面低光、过曝检测开关,可选值: <li>ON:开启;</li> <li>OFF:关闭。</li> */ Switch?: string; } /** * ModifyWordSample返回参数结构体 */ export interface ModifyWordSampleResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 音频流配置参数 */ export interface AudioTemplateInfoForUpdate { /** * 音频流的编码格式。 当外层参数 Container 为 mp3 时,可选值为: <li>libmp3lame。</li> 当外层参数 Container 为 ogg 或 flac 时,可选值为: <li>flac。</li> 当外层参数 Container 为 m4a 时,可选值为: <li>libfdk_aac;</li> <li>libmp3lame;</li> <li>ac3。</li> 当外层参数 Container 为 mp4 或 flv 时,可选值为: <li>libfdk_aac:更适合 mp4;</li> <li>libmp3lame:更适合 flv;</li> <li>mp2。</li> 当外层参数 Container 为 hls 时,可选值为: <li>libfdk_aac。</li> 当外层参数 Format 为 HLS 或 MPEG-DASH 时,可选值为: <li>libfdk_aac。</li> 当外层参数 Container 为 wav 时,可选值为: <li>pcm16。</li> */ Codec?: string; /** * 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。 当取值为 0,表示音频码率和原始音频保持一致。 */ Bitrate?: number; /** * 音频流的采样率,可选值: <li>16000,仅当 Codec 为 pcm16 时可选。</li> <li>32000</li> <li>44100</li> <li>48000</li> 单位:Hz。 */ SampleRate?: number; /** * 音频通道,可选值: <li>1:单通道</li> <li>2:双通道</li> <li>6:立体声</li> <li>0:音频声道数和原始音频保持一致</li> 当媒体的封装格式是音频格式时(flac,ogg,mp3,m4a)时,声道数不允许设为立体声。 */ AudioChannel?: number; } /** * DescribeDailyMediaPlayStat返回参数结构体 */ export interface DescribeDailyMediaPlayStatResponse { /** * 播放统计数据。 */ DailyPlayStatInfoSet?: Array<DailyPlayStatInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySubAppIdInfo请求参数结构体 */ export interface ModifySubAppIdInfoRequest { /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId: number; /** * 应用名称,长度限制:40个字符。 */ Name?: string; /** * 应用简介,长度限制: 300个字符。 */ Description?: string; } /** * DeletePersonSample请求参数结构体 */ export interface DeletePersonSampleRequest { /** * 素材 ID。 */ PersonId: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; } /** * 任务流模板音视频审核输入参数类型。 */ export interface ProcedureReviewAudioVideoTaskInput { /** * 审核模板。 */ Definition: number; /** * 审核的内容,可选值: <li>Media:原始音视频;</li> <li>Cover:封面。</li> 不填或填空数组时,默认为审核 Media。 */ ReviewContents?: Array<string>; } /** * 语音识别片段。 */ export interface AiRecognitionTaskAsrWordsSegmentItem { /** * 识别片段起始的偏移时间,单位:秒。 */ StartTimeOffset?: number; /** * 识别片段终止的偏移时间,单位:秒。 */ EndTimeOffset?: number; /** * 识别片段置信度。取值:0~100。 */ Confidence?: number; } /** * 文字水印模板 */ export interface TextWatermarkTemplateInput { /** * 字体类型,目前可以支持两种: <li>simkai.ttf:可以支持中文和英文;</li> <li>arial.ttf:仅支持英文。</li> */ FontType: string; /** * 字体大小,格式:Npx,N 为数值。 */ FontSize: string; /** * 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)。 */ FontColor: string; /** * 文字透明度,取值范围:(0, 1] <li>0:完全透明</li> <li>1:完全不透明</li> 默认值:1。 */ FontAlpha: number; } /** * 用户自定义语音审核任务控制参数 */ export interface UserDefineAsrTextReviewTemplateInfoForUpdate { /** * 用户自定语音审核任务开关,可选值: <li>ON:开启自定义语音审核任务;</li> <li>OFF:关闭自定义语音审核任务。</li> */ Switch?: string; /** * 用户自定义语音过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义语音关键词素材时需要添加对应标签。 标签个数最多 10 个,每个标签长度最多 16 个字符。 */ LabelSet?: Array<string>; /** * 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 */ BlockConfidence?: number; /** * 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核。取值范围:0~100。 */ ReviewConfidence?: number; } /** * 视频画面质量评价的控制参数。 */ export interface QualityEvaluationConfigureInfoForUpdate { /** * 视频画面质量评价开关,可选值: <li>ON:开启;</li> <li>OFF:关闭。</li> */ Switch?: string; /** * 视频画面质量评价过滤阈值,结果只返回低于该值的时间段。 */ Score?: number; } /** * 视频内容识别输入参数类型 */ export interface AiRecognitionTaskInput { /** * 视频智能识别模板 ID 。 */ Definition: number; } /** * 音频流配置参数 */ export interface AudioTemplateInfo { /** * 音频流的编码格式。 当外层参数 Container 为 mp3 时,可选值为: <li>libmp3lame。</li> 当外层参数 Container 为 ogg 或 flac 时,可选值为: <li>flac。</li> 当外层参数 Container 为 m4a 时,可选值为: <li>libfdk_aac;</li> <li>libmp3lame;</li> <li>ac3。</li> 当外层参数 Container 为 mp4 或 flv 时,可选值为: <li>libfdk_aac:更适合 mp4;</li> <li>libmp3lame:更适合 flv;</li> <li>mp2。</li> 当外层参数 Container 为 hls 时,可选值为: <li>libfdk_aac。</li> 当外层参数 Format 为 HLS 或 MPEG-DASH 时,可选值为: <li>libfdk_aac。</li> 当外层参数 Container 为 wav 时,可选值为: <li>pcm16。</li> */ Codec: string; /** * 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。 当取值为 0,表示音频码率和原始音频保持一致。 */ Bitrate: number; /** * 音频流的采样率,可选值: <li>16000,仅当 Codec 为 pcm16 时可选。</li> <li>32000</li> <li>44100</li> <li>48000</li> 单位:Hz。 */ SampleRate: number; /** * 音频通道,可选值: <li>1:单通道</li> <li>2:双通道</li> <li>6:立体声</li> <li>0:音频声道数和原始音频保持一致</li> 当媒体的封装格式是音频格式时(flac,ogg,mp3,m4a)时,声道数不允许设为立体声。 默认值:2。 */ AudioChannel?: number; } /** * ExecuteFunction返回参数结构体 */ export interface ExecuteFunctionResponse { /** * 处理结果打包后的字符串,具体与后台一同协调。 */ Result?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 智能封面任务控制参数 */ export interface CoverConfigureInfo { /** * 智能封面任务开关,可选值: <li>ON:开启智能封面任务;</li> <li>OFF:关闭智能封面任务。</li> */ Switch: string; } /** * DescribeClientUploadAccelerationUsageData返回参数结构体 */ export interface DescribeClientUploadAccelerationUsageDataResponse { /** * 客户端上传加速统计数据。 */ ClientUploadAccelerationUsageDataSet?: Array<StatDataItem>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyRebuildMediaTemplate请求参数结构体 */ export interface ModifyRebuildMediaTemplateRequest { /** * 视频重生模板号。 */ Definition: number; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: string; /** * 视频重生模板名称。 */ Name?: string; /** * 视频重生模板描述。 */ Comment?: string; /** * 视频重生视频控制信息。 */ RebuildVideoInfo?: RebuildVideoInfo; /** * 视频重生音频控制信息。 */ RebuildAudioInfo?: RebuildAudioInfo; /** * 输出目标视频控制信息。 */ TargetVideoInfo?: RebuildMediaTargetVideoStream; /** * 输出目标音频控制信息。 */ TargetAudioInfo?: RebuildMediaTargetAudioStream; /** * 输出文件封装格式,可选值:mp4、flv、hls。 */ Container?: string; /** * 是否去除视频数据,可选值: <li>0:保留</li> <li>1:去除</li> */ RemoveVideo?: number; /** * 是否去除音频数据,可选值: <li>0:保留</li> <li>1:去除</li> */ RemoveAudio?: number; } /** * ComposeMedia请求参数结构体 */ export interface ComposeMediaRequest { /** * 输入的媒体轨道列表,包括视频、音频、图片等素材组成的多个轨道信息,其中:<li>输入的多个轨道在时间轴上和输出媒体文件的时间轴对齐;</li><li>时间轴上相同时间点的各个轨道的素材进行重叠,视频或者图片按轨道顺序进行图像的叠加,轨道顺序高的素材叠加在上面,音频素材进行混音;</li><li>视频、音频、图片,每一种类型的轨道最多支持 10 个。</li><li>所有类型的轨道上放置的媒体片段数量总和最多支持 500 个。</li> */ Tracks: Array<MediaTrack>; /** * 输出的媒体文件信息。 */ Output: ComposeMediaOutput; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 制作视频文件时使用的画布。 */ Canvas?: Canvas; /** * 标识来源上下文,用于透传用户请求信息,在ComposeMediaComplete回调将返回该字段值,最长 1000个字符。 */ SessionContext?: string; /** * 用于任务去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。 */ SessionId?: string; } /** * DescribeCLSTopics请求参数结构体 */ export interface DescribeCLSTopicsRequest { /** * 日志集所属的地域,取值有: <li>ap-guangzhou:广州;</li> <li>ap-beijing:北京;</li> <li>ap-chengdu:成都;</li> <li>ap-chongqing:重庆;</li> <li>ap-nanjing:南京;</li> <li>ap-shanghai:上海;</li> <li>ap-singapore:新加坡。</li> */ CLSRegion: string; /** * 日志主题所属日志集 ID。 */ LogsetId: string; /** * 日志主题 ID 列表。如果不填,表示查询所有的日志主题。 */ TopicIds?: Array<string>; /** * 分页偏移量,默认值:0。 */ Offset?: number; /** * 返回记录条数,默认值:20,最大值:100。 */ Limit?: number; } /** * 视频内容