UNPKG

tencentcloud-sdk-nodejs

Version:
1,941 lines (1,938 loc) 1.06 MB
/** * ProcessMedia请求参数结构体 */ export interface ProcessMediaRequest { /** * <p>媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 <a href="/document/product/266/7830">视频上传完成事件通知</a> 或 <a href="https://console.cloud.tencent.com/vod/media">云点播控制台</a> 获取该字段。<br>FileId和MediaStoragePath必须提供其中一个。</p> */ FileId?: string; /** * <p>媒体的存储路径。<br>只有<a href="https://cloud.tencent.com/document/product/266/126825">FileID + Path 模式</a>的子应用可以通过MediaStoragePath发起任务。<br>FileId和MediaStoragePath必须提供其中一个。</p> */ MediaStoragePath?: string; /** * <p><b>点播<a href="/document/product/266/14574">应用</a> ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b></p> */ SubAppId?: number; /** * <p>视频处理类型任务参数。</p> */ MediaProcessTask?: MediaProcessTaskInput; /** * <p>音视频内容审核类型任务参数 *。<br><font color="red">* 不建议使用</font>,推荐使用 <a href="https://cloud.tencent.com/document/api/266/80283">音视频审核(ReviewAudioVideo)</a> 或 <a href="https://cloud.tencent.com/document/api/266/73217">图片审核(ReviewImage)</a>。</p> */ AiContentReviewTask?: AiContentReviewTaskInput; /** * <p>音视频内容分析类型任务参数。</p> */ AiAnalysisTask?: AiAnalysisTaskInput; /** * <p>音视频内容识别类型任务参数。</p> */ AiRecognitionTask?: AiRecognitionTaskInput; /** * <p>任务流的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。</p> */ TasksPriority?: number; /** * <p>任务流状态变更通知模式,可取值有 Finish,Change 和 None,不填代表 Finish。</p> */ TasksNotifyMode?: string; /** * <p>来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。</p> */ SessionContext?: string; /** * <p>用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。</p> */ SessionId?: string; /** * <p>保留字段,特殊用途时使用。</p> */ ExtInfo?: string; /** * <p>FileID为空时有效,拉取Url生成新媒资产生新FileID,媒体处理产物将作为新媒资的附属产物。</p><p>注意:新媒资会产生存储费用</p> */ Url?: string; /** * <p>媒体处理转码结果输出为独立媒资, 开启该选项会使产物输出为独立媒资,生成全新FileID,目前仅支持TranscodeTask转码任务输出为独立媒资。</p><p>枚举值:</p><ul><li>ON: 开启</li><li>OFF: 关闭</li></ul><p>默认值:OFF</p><p>注意:新媒资会产生存储费用,转码任务中片头片尾、溯源水印等暂不支持开启该选项。</p> */ OutputAsIndependentMedia?: string; } /** * 画布信息。制作视频时,如果源素材(视频或者图片)不能填满输出的视频窗口,将用设置的画布进行背景绘制。 */ 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; } /** * AIGC 生视频任务的输出媒体文件配置。 */ export interface AigcVideoOutputConfig { /** * <p>存储模式</p><p>枚举值:</p><ul><li>Temporary: 临时存储,生成的视频文件不会存储到云点播,可在事件通知中获取到临时访问的 URL,有效期 7 天</li><li>Permanent: 永久存储,生成的视频文件将存储到云点播,可在事件通知中获取到 FileId</li></ul><p>默认值:Temporary</p> */ StorageMode?: string; /** * <p>输出媒体文件名,最长 64 个字符。缺省由系统指定生成文件名。</p> */ MediaName?: string; /** * <p>分类ID,用于对媒体进行分类管理,可通过 <a href="/document/product/266/7812">创建分类</a> 接口,创建分类,获得分类 ID。</p><li>默认值:0,表示其他分类。</li> */ ClassId?: number; /** * <p>输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 <a href="https://cloud.tencent.com/document/product/266/11732#I">ISO 日期格式说明</a>。</p> */ ExpireTime?: string; /** * <p>生成视频的时长,单位:秒。</p><li>当 ModelName 是 Kling,可选值为3-15,默认为 5;</li><li>当 ModelName 是 Hailuo,可选值为 6、10,默认为 6;</li><li>当 ModelName 是 Vidu,可指定1-10;</li><li>当 ModelName 是 GV,可选值为 8,默认为 8;</li><li>当 ModelName 是 OS,可选值为 4、8、12,默认为 8;</li><li>当 ModelName 是 PixVerse,可指定1-15,默认为5;</li> */ Duration?: number; /** * <p>生成视频的分辨率。</p><li>当 ModelName 是 Kling,可选值为 720P、1080P,默认为 720P;</li><li>当 ModelName 是 Hailuo,可选值为 768P、1080P,默认为 768P;</li><li>当 ModelName 是 Vidu,可选值为 720P、1080P,默认为 720P;</li><li>当 ModelName 是 GV,可选值为 720P、1080P,默认为 720P;</li><li>当 ModelName 是 OS,可选值为 720P;</li><li>当 ModelName 是 PixVerse,可选值为 540p、720p、1080p、2k、4k,默认为720p;</li> */ Resolution?: string; /** * <p>指定所生成视频的宽高比。</p><li>当 ModelName 是 Kling,当文生视频时,则可选值为 16:9、9:16、 1:1,默认为16:9;</li><li>当 ModelName 是 Vidu,当文生视频时和使用参考图片生成时,则可选值为 16:9、9:16、4:3、3:4、1:1,其中仅版本q2支持4:3、3:4</li><li>当 ModelName 是 GV,则可选值为 16:9、9:16,默认为 16:9;</li><li>当 ModelName 是 OS,当文生视频时,则可选值为 16:9、9:16,默认为 16:9;</li><li>当 ModelName 是 Hailuo,则暂不支持;</li><li>当 ModelName 是PixVerse,则可选值为 16:9,4:3,1:1,3:4,9:16,2:3,3:2,21:9;</li> */ AspectRatio?: string; /** * <p>是否生成音频。支持的模型包括 GV、OS、Vidu、Jimeng、Kling。</p><p>枚举值:</p><ul><li>Enabled: 开启</li><li>Disabled: 关闭</li></ul><p>默认值:Disabled</p> */ AudioGeneration?: string; /** * <p>是否允许人物或人脸生成。取值有: <li>AllowAdult:允许生成成人;</li> <li>Disallowed:禁止在图片中包含人物或人脸;</li></p> */ PersonGeneration?: string; /** * <p>是否开启输入内容的合规性检查。取值有: <li>Enabled:开启;</li> <li>Disabled:关闭;</li></p> */ InputComplianceCheck?: string; /** * <p>是否开启输出内容的合规性检查。取值有: <li>Enabled:开启;</li> <li>Disabled:关闭;</li></p> */ OutputComplianceCheck?: string; /** * <p>是否启用视频增强。取值有: <li>Enabled:开启;</li> <li>Disabled:关闭;</li><br>说明:</p><ol><li>对于选择的分辨率超过模型可生成分辨率时,默认会启用增强。</li><li>对于模型可以直出的分辨率,也可以主动选择模型直出低分辨率,使用增强获得指定分辨率。</li></ol> */ EnhanceSwitch?: string; /** * <p>是否开启错峰。取值有: <li>Enabled:开启;</li> <li>Disabled:关闭;</li></p> */ OffPeak?: string; /** * <p>是否开启vidu智能插帧。取值有: <li>Enabled:开启;</li> <li>Disabled:关闭;</li></p> */ FrameInterpolate?: string; /** * <p>是否开启图标水印。取值有: <li>Enabled:开启;</li> <li>Disabled:关闭;</li><br>目前支持的模型有 Vidu,其他模型暂不支持。</p> */ LogoAdd?: string; /** * <p>是否为生成的视频添加背景音乐。</p><p>枚举值:</p><ul><li>Enabled: 系统将从预设 BGM 库中自动挑选合适的音乐并添加。</li><li>Disabled: 不添加BGM。</li></ul><p>默认值:Disabled</p> */ EnableBGM?: string; } /** * CreateAigcVideoRedrawTask请求参数结构体 */ export interface CreateAigcVideoRedrawTaskRequest { /** * <p><b>点播<a href="https://cloud.tencent.com/document/product/266/14574">应用</a> ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b></p> */ SubAppId: number; /** * <p>AIGC 视频转绘任务的输入视频的文件信息。输入视频时长需短于 90 秒,大小在2GB内。</p> */ FileInfo?: AigcVideoRedrawTaskInputFileInfo; /** * <p>AIGC 视频转绘任务参数信息。</p> */ TaskInfo?: AigcVideoRedrawTaskInfo; /** * <p>AIGC 视频转绘任务的输出媒体文件配置。</p> */ OutputConfig?: AigcVideoRedrawOutputConfig; /** * <p>用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。</p> */ SessionId?: string; /** * <p>来源上下文,用于透传用户请求信息,音画质重生完成回调将返回该字段值,最长 1000 个字符。</p> */ SessionContext?: string; /** * <p>任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。</p> */ TasksPriority?: number; /** * <p>保留字段,特殊用途时使用。</p> */ ExtInfo?: string; } /** * 图片编码格式参数。 */ export interface ImageSceneAigcEncodeConfig { /** * 图片格式,取值范围:JPEG、PNG,缺省为原图格式。不支持动画。 */ Format?: string; /** * 图片的相对质量,取值范围:1 - 100,数值以原图质量为标准,缺省为原图质量。 */ Quality?: number; } /** * 域名推送 CLS 目标。 */ export interface DomainCLSTargetInfo { /** * 域名。 */ Domain?: string; /** * 中国大陆地区的日志推送目标。 */ ChineseMainlandCLSTargetInfo?: AreaCLSTargetInfo; /** * 中国大陆以外地区的日志推送目标。 */ OutsideChineseMainlandCLSTargetInfo?: AreaCLSTargetInfo; } /** * 截图输出信息(2017 版) */ export interface SnapshotByTimeOffset2017 { /** * 错误码 <li>0:成功;</li> <li>其他值:失败。</li> */ ErrCode?: number; /** * 截图的具体时间点,单位:毫秒。 */ TimeOffset?: number; /** * 截图输出文件地址。 */ Url?: string; } /** * CreateStorageRegion请求参数结构体 */ export interface CreateStorageRegionRequest { /** * <p>待开通的存储地域,必须是系统支持的地域。</p><p>取值参考:<a href="https://cloud.tencent.com/document/product/266/9760">已支持地域列表</a></p> */ StorageRegion: string; /** * <p><b>点播<a href="/document/product/266/14574">应用</a> ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b></p> */ 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; } /** * ExtractBlindWatermark请求参数结构体 */ export interface ExtractBlindWatermarkRequest { /** * 数字水印类型,可选值:<li>blind-basic:基础版权数字水印;</li><li>blind-trace:溯源ab序列水印;</li> */ Type: string; /** * 媒体处理的文件输入信息。 */ InputInfo: ExtractBlindWatermarkInputInfo; /** * 添加水印时的点播应用 ID。注意不管是传入FILEID还是URL,都必须与添加水印时的SubAppId吻合才能提取到水印。 */ SubAppId: number; /** * 提取数字水印任务配置 */ ExtractBlindWatermarkConfig?: ExtractBlindWatermarkTaskConfig; /** * 标识来源上下文,用于透传用户请求信息,在 ExtractBlindWatermarkComplete 回调和任务流状态变更回调将返回该字段值,最长 1000 个字符。 */ SessionContext?: string; /** * 用于任务去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。 */ SessionId?: string; /** * 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。 */ TasksPriority?: 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; } /** * AIGC 生图任务的输出。 */ export interface AigcImageTaskOutput { /** * AIGC 生图任务的输出文件信息。 */ FileInfos?: Array<AigcImageTaskOutputFileInfo>; } /** * CreateAigcVideoRedrawTask返回参数结构体 */ export interface CreateAigcVideoRedrawTaskResponse { /** * <p>任务 ID。</p> */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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 参数进行分批次查询。 * @deprecated */ Offset?: number; /** * 返回记录条数,默认值:10,最大值:100。 */ Limit?: number; } /** * 审核信息。 */ export interface ReviewInfo { /** * 审核模板 ID。 */ Definition?: number; /** * 审核的结果建议,取值范围: <li>pass:建议通过;</li> <li>review:建议复审;</li> <li>block:建议封禁。</li> */ Suggestion?: string; /** * 审核类型,当 Suggestion 为 review 或 block 时有效,格式为:Form.Label。 Form 表示违禁的形式,取值范围: <li>Image:画面上的人物或图标;</li> <li>OCR:画面上的文字;</li> <li>ASR:语音中的文字;</li> <li>Voice:声音。</li> Label 表示违禁的标签,取值范围: <li>Porn:色情;</li> <li>Terror:暴力;</li> <li>Polity:不适宜的信息;</li> <li>Ad:广告;</li> <li>Illegal:违法;</li> <li>Abuse:谩骂;</li> <li>Moan:娇喘。</li> */ TypeSet?: Array<string>; /** * 审核时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。 */ ReviewTime?: string; } /** * WeChatMiniProgramPublish请求参数结构体 */ export interface WeChatMiniProgramPublishRequest { /** * 媒体文件 ID。 */ FileId: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 发布视频所对应的转码模板 ID,为 0 代表原始视频。支持的视频格式: <li>当 SourceDefinition 为 0 时,视频格式支持 MP4、3GP 格式;</li> <li>当 SourceDefinition 大于 0 时,视频格式支持 MP4、3GP 及 M3U8 格式。</li>不填默认值为 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 { /** * <p>封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a、wav。其中,mp3、flac、ogg、m4a、wav 为纯音频文件。</p> */ Container: string; /** * <p><b>点播<a href="/document/product/266/14574">应用</a> ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b></p> */ SubAppId?: number; /** * <p>转码模板名称,长度限制:64 个字符。</p> */ Name?: string; /** * <p>模板描述信息,长度限制:256 个字符。</p> */ Comment?: string; /** * <p>是否去除视频数据,可选值:</p><li>0:保留</li><li>1:去除</li>默认值:0。 */ RemoveVideo?: number; /** * <p>是否去除音频数据,可选值:</p><li>0:保留</li><li>1:去除</li>默认值:0。 */ RemoveAudio?: number; /** * <p>视频流配置参数,当 RemoveVideo 为 0,该字段必填。</p> */ VideoTemplate?: VideoTemplateInfo; /** * <p>音频流配置参数,当 RemoveAudio 为 0,该字段必填。</p> */ AudioTemplate?: AudioTemplateInfo; /** * <p>极速高清转码参数。</p> */ TEHDConfig?: TEHDConfig; /** * <p>音视频增强配置。</p> */ EnhanceConfig?: EnhanceConfig; /** * <p>切片类型,当 Container 为 hls 时有效,可选值:</p><li>ts:ts 切片;</li><li>fmp4:fmp4 切片。</li>默认值:ts。 */ SegmentType?: string; /** * <p>扩展参数。</p> */ StdExtInfo?: 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 { /** * <p>智能精彩集锦地址。</p> */ HighlightUrl?: string; /** * <p>智能精彩集锦封面地址。</p> */ CovImgUrl?: string; /** * <p>智能精彩集锦的可信度,取值范围是 0 到 100。</p> */ Confidence?: number; /** * <p>智能精彩集锦持续时间。</p><p>单位:秒</p> */ Duration?: number; /** * <p>智能精彩集锦子片段列表,精彩集锦片段由这些子片段拼接生成。</p> */ 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 { /** * <p>剪辑后的视频播放 URL。</p> */ Url?: string; /** * <p>剪辑固化后的视频的媒体文件的唯一标识。</p> */ FileId?: string; /** * <p>剪辑固化后的视频任务流 ID。</p> */ VodTaskId?: string; /** * <p>剪辑后的视频元信息。</p> 注意:此字段可能返回 null,表示取不到有效值。 */ MetaData?: MediaMetaData; /** * <p><span id="p_segmentset">剪辑后的视频片段信息。</span></p> */ 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 { /** * <p>转自适应码流模板唯一标识。</p> */ Definition?: number; /** * <p>模板类型,取值范围:</p><li>Preset:系统预置模板;</li><li>Custom:用户自定义模板。</li> */ Type?: string; /** * <p>转自适应码流模板名称。</p> */ Name?: string; /** * <p>转自适应码流模板描述信息。</p> */ Comment?: string; /** * <p>自适应转码格式,取值范围:</p><li>HLS。</li> */ Format?: string; /** * <p>DRM 类型,取值范围:</p><li>SimpleAES</li><li>Widevine</li><li>FairPlay</li><li>Widevine+FairPlay</li>如果取值为空字符串,代表不对视频做 DRM 保护。 */ DrmType?: string; /** * <p>DRM 的密钥提供商,取值范围:</p><li>SDMC:华曦达;</li><li>VOD:云点播。</li>默认值为 VOD 。<p>华曦达服务后续逐步下线,请使用VOD DRM加密服务。</p> */ DrmKeyProvider?: string; /** * <p>DRM的加密类型,取值范围:{&quot;cbcs&quot;, &quot;cenc&quot;}</p> */ DrmEncryptType?: string; /** * <p>自适应转码输入流参数信息,最多输入10路流。</p> */ StreamInfos?: Array<AdaptiveStreamTemplate>; /** * <p>是否禁止视频低码率转高码率,取值范围:</p><li>0:否,</li><li>1:是。</li> */ DisableHigherVideoBitrate?: number; /** * <p>是否禁止视频分辨率转高分辨率,取值范围:</p><li>0:否,</li><li>1:是。</li> */ DisableHigherVideoResolution?: number; /** * <p>模板创建时间,使用 <a href="https://cloud.tencent.com/document/product/266/11732#I">ISO 日期格式</a>。</p> */ CreateTime?: string; /** * <p>模板最后修改时间,使用 <a href="https://cloud.tencent.com/document/product/266/11732#I">ISO 日期格式</a>。</p> */ UpdateTime?: string; /** * <p>切片类型。</p><p>ts: HLS,内部映射为ts-segment</p><p>fmp4: HLS/DASH,HLS情况下内部映射为mp4-mp4-segment,DASH情况下内部映射为mp4-mp4-byterange</p><p>ts-segment:HLS+TS 切片</p><p>ts-byterange:HLS+TS byte range</p><p>mp4-segment:HLS+MP4 切片</p><p>mp4-byterange:HLS+MP4 byte range</p><p>ts-packed-audio:HLS+TS+Packed Audio 切片</p><p>mp4-packed-audio:HLS+MP4+Packed Audio 切片</p><p>ts-ts-segment:HLS+TS+TS 切片</p><p>ts-ts-byterange:HLS+TS+TS byte range</p><p>mp4-mp4-segment:HLS+MP4+MP4 切片</p><p>mp4-mp4-byterange:HLS/DASH+MP4+MP4 byte range</p><p>ts-packed-audio-byterange:HLS+TS+Packed Audio byte range</p><p>mp4-packed-audio-byterange:HLS+MP4+Packed Audio byte range<br> 默认值:ts-segment 注:自适应码流的分片格式以此字段为准。DASH格式下SegmentType只能为mp4-mp4-byterange。</p> */ SegmentType?: string; /** * <p>切片平均时长</p><p>单位:秒</p><p>默认值:6</p><p>转自适应码流使用SegmentDuration设置分片时长,而非HlsTime字段.</p> */ SegmentDuration?: number; } /** * 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; } /** * DescribeAigcFaceInfo请求参数结构体 */ export interface DescribeAigcFaceInfoRequest { /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId: number; /** * 需要获取人脸信息的输入视频信息,最多包含一个文件。 */ FileInfos?: Array<AigcFaceInputFileInfo>; } /** * 视频画面噪点检测的控制参数。 */ export interface NoiseConfigureInfo { /** * 视频画面噪点检测开关,可选值: <li>ON:开启;</li> <li>OFF:关闭。</li> */ Switch: string; } /** * DescribeAigcFaceInfoAsync返回参数结构体 */ export interface DescribeAigcFaceInfoAsyncResponse { /** * <p>任务 ID。</p> */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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; } /** * DeleteLLMComprehendTemplate请求参数结构体 */ export interface DeleteLLMComprehendTemplateRequest { /** * 大模型理解模板的唯一标识 */ Definition: number; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; } /** * 音画质检测任务的输出。 */ export interface QualityInspectTaskOutput { /** * <p>媒体文件是否无音频轨,取值范围:</p><li>0:否,即有音频轨;</li><li>1:是,即无音频轨。</li> */ NoAudio?: number; /** * <p>媒体文件是否无视频轨,取值范围:</p><li>0:否,即有视频轨;</li><li>1:是,即无视频轨。</li> */ NoVideo?: number; /** * <p>视频画面质量评分,取值范围:[0, 100]。</p> */ QualityEvaluationScore?: number; /** * <p>音画质检测出的异常项列表。</p> */ QualityInspectResultSet?: Array<QualityInspectResultItem>; /** * <p>视频无参考质量评分,MOS分数。</p> */ QualityEvaluationMeanOpinionScore?: number; /** * <p>视频美学评分,范围:[0,100]。</p> */ AestheticEvaluationScore?: number; /** * <p>格式诊断检出异常项。</p> */ ContainerDiagnoseResultSet?: Array<QualityInspectContainerDiagnoseResultItem>; /** * <p>LLM 大模型 AIGC 质量检测结果。</p> */ LLMDetectionReport?: QualityInspectLLMDetectionReport; } /** * 音画质重生任务的输入。 */ export interface QualityEnhanceTaskInput { /** * 媒体文件 ID。 */ FileId?: string; /** * 音画质重生模板 ID。 */ Definition?: number; } /** * CreateAigcAdvancedCustomElement请求参数结构体 */ export interface CreateAigcAdvancedCustomElementRequest { /** * <p><b>点播<a href="https://cloud.tencent.com/document/product/266/14574">应用</a> ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b></p> */ SubAppId?: number; /** * <p>主体名称,不能超过20个字符。</p> */ ElementName?: string; /** * <p>主体描述,不能超过100个字符。</p> */ ElementDescription?: string; /** * <p>主体参考方式。通过视频定制的主体和通过图片定制的主体的可用范围不同。</p><p>枚举值:</p><ul><li>video_refer: 视频角色主体,此时将参考element_video_list定义主体外表。</li><li>image_refer: 多图主体,此时将参考element_image_list定义主体外表。</li></ul> */ ReferenceType?: string; /** * <p>主体音色,可绑定音色库中已有音色。</p><ul><li>当前参数为空时,当前主体不绑定音色。</li><li>仅视频定制的主体支持绑定音色。</li></ul> */ ElementVoiceId?: string; /** * <p>主体参考视频,可通过视频设定主体及其细节。</p><ul><li>可上传有声视频,有声视频包含人声则触发音色定制(定制+入音色库+与主体绑定)</li><li>参考视频时当前参数必填,参考图片时当前参数无效</li><li>用key:value承载,如下:<br><pre><code>{ &quot;refer_videos&quot;:[ { &quot;video_url&quot;:&quot;video_url_1&quot; } ]}</code></pre>● 视频格式仅支持MP4/MOV<br>● 仅支持时长介于3s~8s之间、宽高比例需为16:9或9:16的1080P视频<br>● 至多仅支持上传1段视频,视频大小不超过200MB<br>● video_url参数值不得为空</li></ul> */ ElementVideoList?: string; /** * <p>主体参考图,可通过多张图片设定主体及其细节。</p><ul><li>包括正面参考图和其他角度或特写参考图,其中:<ul><li>至少包括1张正面参考图,由frontal_image参数定义。</li><li>需包括1~3张其他参考图,需与正面参考图有差异,由image_url参数定义。</li></ul></li><li>用key:value承载,如下:<br><pre><code>{ &quot;frontal_image&quot;:&quot;image_url_0&quot;, &quot;refer_images&quot;:[ { &quot;image_url&quot;:&quot;image_url_1&quot; }, { &quot;image_url&quot;:&quot;image_url_2&quot; }, { &quot;image_url&quot;:&quot;image_url_3&quot; } ]}</code></pre></li></ul> */ ElementImageList?: string; /** * <p>为主体配置标签,一个主体可以配置多个标签。</p><ul><li>用key:value承载,其中具体如下:</li></ul><p><pre><code>[ { &quot;tag_id&quot;: &quot;o_101&quot; }, { &quot;tag_id&quot;: &quot;o_102&quot; }]</code></pre></p> */ TagList?: string; /** * <p>若已开通海外自定义主体库,可传入<code>True</code>使用海外自定义主体库。</p><p>枚举值:</p><ul><li>True: 使用海外自定义主体库。</li><li>False: 不使用海外自定义主体库。</li></ul> */ DisableModeration?: string; /** * <p>用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。</p> */ SessionId?: string; /** * <p>来源上下文,用于透传用户请求信息,任务完成回调将返回该字段值,最长 1000 个字符。</p> */ SessionContext?: string; /** * <p>任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。</p> */ TasksPriority?: number; } /** * 人脸识别的媒体信息 */ export interface FaceRecognitionInfo { /** * <p>人脸识别任务列表</p> */ FaceRecognitionTasks?: Array<FaceRecognitionTask>; } /** * 画质重生目标参数 */ 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 type DescribePrepaidProductsRequest = null; /** * ManageTask请求参数结构体 */ export interface ManageTaskRequest { /** * 视频处理的任务 ID。 */ TaskId: string; /** * 操作类型,取值范围: <li>Abort:终止任务。只能终止已发起且状态为等待中(WAITING)的任务。</li> */ OperationType: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; } /** * 音视频增强配置 */ export interface EnhanceConfig { /** * 视频增强配置。 注意:此字段可能返回 null,表示取不到有效值。 */ VideoEnhance?: VideoEnhanceConfig; /** * 音频增强配置。 注意:此字段可能返回 null,表示取不到有效值。 */ AudioEnhance?: AudioEnhanceConfig; } /** * 要处理的源视频信息,视频名称、视频自定义 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; } /** * DescribeImageReviewUsageData返回参数结构体 */ export interface DescribeImageReviewUsageDataResponse { /** * 图片审核次数统计数据,展示查询时间范围内的图片审核次数的概览数据。 */ ImageReviewUsageDataSet?: Array<ImageReviewUsageDataItem>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 临时凭证 */ export interface TempCertificate { /** * 临时安全证书 Id。 */ SecretId?: string; /** * 临时安全证书 Key。 */ SecretKey?: string; /** * Token 值。 */ Token?: string; /** * 证书无效的时间,返回 Unix 时间戳,精确到秒。 */ ExpiredTime?: number; } /** * RebuildMedia请求参数结构体 */ export interface RebuildMediaRequest { /** * 媒体文件 ID。 */ FileId: string; /** * <b>点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。</b> */ SubAppId?: number; /** * 起始偏移时间,单位:秒,不填表示从视频开始截取。 */ StartTimeOffset?: number; /** * 结束偏移时间,单位:秒,不填表示截取到视频末尾。 */ EndTimeOffset?: number; /** * 画质修复控制参数。 */ RepairInfo?: RepairInfo; /** * 智能插帧控制参数。 */ VideoFrameInterpolationInfo?: VideoFrameInterpolationInfo; /** * 画面超分控制参数。 */ SuperResolutionInfo?: SuperResolutionInfo; /** * 高动态范围类型控制参数。 */ HDRInfo?: HDRInfo; /** * 视频降噪控制参数。 */ VideoDenoiseInfo?: VideoDenoiseInfo; /** * 音频降噪控制参数。 */ AudioDenoiseInfo?: AudioDenoiseInfo; /** * 色彩增强控制参数。 */ ColorInfo?: ColorEnhanceInfo; /** * 细节增强控制参数。 */ SharpInfo?: SharpEnhanceInfo; /** * 人脸增强控制参数。 */ FaceInfo?: FaceEnhanceInfo; /** * 低光照控制参数。 */ LowLightInfo?: LowLightEnhanceInfo; /** * 去划痕控制参数。 */ ScratchRepairInfo?: ScratchRepairInfo; /** * 去伪影(毛刺)控制参数。 */ ArtifactRepairInfo?: ArtifactRepairInfo; /** * 音画质重生输出目标参数。 */ TargetInfo?: RebuildMediaTargetInfo; /** * 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。 */ SessionId?: string; /** * 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。 */ SessionContext?: string; /** * 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。 */ TasksPriority?: number; /** * 保留字段,特殊用途时使用。 */ ExtInfo?: string; } /** * 智能擦除模板去水印配置 */ export interface MPSSmartEraseWatermarkConfig { /** * <p>水印擦除方式。 <strong>自动擦除:</strong>通过A模型自动识别视频中的水印,擦除后生成新的视频。适用于动态水印。 当使用自动擦除时,若您不指定AutoAreas,将对视频全屏进行自动擦除;若指定AutoAreas,将改为对您指定的区域进行自动擦除。 <strong>指定区域擦除:</strong>针对位置较固定的静态水印,建议您直接指定擦除区域。 当您选择指定区域擦除时,请至少传入一个指定区域。 - auto 自动擦除 - custom 指定区域擦除</p> */ WatermarkEraseMethod: string; /** * <p>水印擦除模型。 基础版:效果一般,性价比高,适合动画或背景较干净的视频。 高级版:效果更好,适合短剧等现实风格视频。 - basic 基础版 - advanced 高级版</p> */ WatermarkModel: string; /** * <p>自动擦除自定义区域。 对选定区域,利用AI模型自动检测其中存在的擦除目标并擦除。 注意,当擦除方式为custom时,此参数将不会生效。清除区域请传入[],不传时将保持模板区域信息不变。</p> */ AutoAreas?: Array<MPSEraseArea>; /** * <p>指定擦除自定义区域。 对选定区域,在选定时间段内不进行检测识别直接进行擦除。 注意:清除区域请传入[],不传时将保持模板区域信息不变。</p> */ CustomAreas?: Array<MPSEraseTimeArea>; } /** * 大模型解析分段摘要解析配置 */ export interface LLMComprehendSummary { /** * 分段摘要任务开关,可选值: - ON:开启分段摘要任务; - OFF:关闭分段摘要任 */ Switch: string; /** * 扩展参数,其值为序列化的 json字符串。可参考[扩展参数说明](/document/product/862/104493#note) */ ExtendedParameter?: string; } /** * 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; } /** * 自定义视频转码参数。 */ export interface OverrideTranscodeParameter { /** * 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a、wav。其中,mp3、flac、ogg、m4a、wav 为纯音频文件。 */ Container?: string; /** * 是否去除视频数据,取值: <li>0:保留;<\li> <li>1:去除。<\li> */ RemoveVideo?: number; /** * 是否去除音频数据,取值: <li>0:保留;<\li> <li>1:去除。<\li> */ RemoveAudio?: number; /** * 视频流配置参数。 注意:此字段可能返回 null,表示取不到有效值。 */ VideoTemplate?: VideoTemplateInfoForUpdate; /** * 音频流配置参数。 注意:此字段可能返回 null,表示取不到有效值。 */ AudioTemplate?: AudioTemplateInfoForUpdate; /** * 极速高清转码配置参数。 注意:此字段可能返回 null,表示取不到有效值。 */ TEHDConfig?: TEHDConfigForUpdate; } /** * 文本鉴别涉及令人不适宜的信息的任务控制参数 */ export interface PoliticalOcrReviewTemplateInfo { /** * 文本鉴别涉及令人不适宜的信息的任务开关,可选值: <li>ON:开启文本鉴别涉及令人不适宜的信息的任务;</li> <li>OFF:关闭文本鉴别涉及令人不适宜的信息的任务。</li> */ Switch: string; /** * 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 */ BlockConfidence?: number; /** * 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 */ ReviewConfidence?: number; } /** * 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 AigcAudioReferenceAudioInfo { /** * <p>可访问的文件 URL。当 Type 取值为 Url 时,本参数有效。说明:1. 推荐使用小于7M的图片;2. 图片格式的取值为:jpeg,jpg, png, webp。</p> */ Type?: string; /** * <p>音频文件的媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 <a href="/document/product/266/7830">视频上传完成事件通知</a> 或 <a href="https://console.cloud.tencent.com/vod/media">云点播控制台</a> 获取该字段。当 Type 取值为 File 时,本参数有效。</p> */ FileId?: string; /** * <p>音频文件 URL,需要外网可访问。当 Type 取值为 Url 时,本参数有效。</p> */ Url?: string; } /** * 指定时间点截图信息 */ export interface MediaSnapshotByTimePicInfoItem { /** * 该张截图对应视频文件中的时间偏移,单位为<font color=red>毫秒</font>。 */ TimeOffset?: number; /** * 该张截图的 URL 地址。 */ Url?: string; /** * 截图如果被打上了水印,被打水印的模板 ID 列表。 */ WaterMarkDefinition?: Array<number | bigint>; } /** * DeleteProcessImageAsyncTemplate返回参数结构体 */ export interface DeleteProcessImageAsyncTemplateResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用户自定义人物音视频审核任务控制参数 */ 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; } /** * AIGC场景化生图任务输入文件信息 */ export interface SceneAigcVideoTaskInputFileInfo { /** * 输入的视频文件类型。取值有: <li>File:点播媒体文件;</li> <li>Url:可访问的 URL;</li> */ Type?: string; /** * 图片文件的媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 [视频上传完成事件通知](/document/product/266/7830) 或 [云点播控制台](https://console.cloud.tencent.com/vod/media) 获取该字段。当 Type 取值为 File 时,本参数有效。 说明: 1. 推荐使用小于7M的图片; 2. 图片格式的取值为:jpeg,jpg, png, webp。 */ FileId?: string; /** * 可访问的文件 URL。当 Type 取值为 Url 时,本参数有效。 说明: 1. 推荐使用小于7M的图片; 2. 图片格式的取值为:jpeg,jpg, png, webp。 */ Url?: string; } /** * 人脸识别任务控制参数 */ export interface FaceConfigureInfoForUpdate { /** * 人脸识别任务开关,可选值: <li>ON:开启智能人脸识别任务;</li> <li>OFF:关闭智能人脸识别任务。</li> */ Switch?: string;