{ "name": "mps", "display_name": "媒体处理", "description": "介绍如何使用API对视频处理进行操作，如AI样本管理、工作流管理、视频处理等。", "domain": "other", "api_version": "2019-06-12", "endpoint": "mps.tencentcloudapi.com", "actions": [ { "name": "BatchDeleteStreamLinkFlow", "description": "批量删除媒体传输流。", "status": "online", "parameters": [ { "name": "EventId", "type": "string", "required": true, "description": "EventId。", "example": "0195179307c109dc0f32331b341f" }, { "name": "FlowIds", "type": "array", "required": false, "description": "Event关联的流Id数组，如果不传默认删除Event下面的所有媒体传输流。", "example": "[\"01941bb7827509dc0f320a9d3426\"]", "item_type": "string" } ], "required": [ "EventId" ] }, { "name": "BatchProcessMedia", "description": "对 URL视频链接批量发起处理任务，功能包括： 智能字幕（语音全文、语音热词、语音翻译）", "status": "online", "parameters": [ { "name": "InputInfo", "type": "array", "required": true, "description": "媒体处理的文件输入信息。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输入来源对象的类型，支持： COS：COS源 URL：URL源 AWS-S3：AWS 源，目前只支持转码任务 VOD：点播专业版", "example": "NULL" }, { "name": "CosInputInfo", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 对象信息。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": true, "description": "媒体处理对象文件的输入路径，如`/movie/201907/WildAnimal.mov`。", "example": "/movie/201907/WildAnimal.mov" } ] }, { "name": "UrlInputInfo", "type": "object", "required": false, "description": "当 Type 为 URL 时有效，则该项为必填，表示媒体处理 URL 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频的 URL。", "example": "NULL" } ] }, { "name": "S3InputInfo", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-us-125678" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域，目前支持： us-east-1 eu-west-3 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1 " }, { "name": "S3Object", "type": "string", "required": true, "description": "S3 bucket 中的媒体资源路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/test.mp4" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bb5******eff" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bbc5******eff" } ] }, { "name": "VODInputInfo", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理对象文件所在的 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理对象文件所在的 Bucket 所属园区", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": false, "description": "媒体处理对象文件的输入路径", "example": "/movie/201907/WildAnimal.mov" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "媒体处理输出文件的目标存储。不填则继承 InputInfo 中的存储位置。 注意：当InputInfo.Type为URL时，该参数是必填项，目前只支持COS输出", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputDir", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标目录，必选以 / 开头和结尾，如`/movie/201907/`。 如果不填，表示与 InputInfo 中文件所在的目录一致。", "example": "/movie/test/" }, { "name": "SmartSubtitlesTask", "type": "object", "required": false, "description": "智能字幕", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": false, "description": "智能字幕模板 ID 。", "example": "110167" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "用户扩展字段，一般场景不用填。", "example": "用户扩展字段" }, { "name": "RawParameter", "type": "object", "required": false, "description": "智能字幕自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定智能字幕参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SubtitleType", "type": "integer", "required": true, "description": "智能字幕字幕语言类型 0: 源语言 1: 翻译语言 2: 源语言+翻译语言 当TranslateSwitch为OFF时仅支持取0 当TranslateSwitch为ON时仅支持取1或2", "example": "0" }, { "name": "VideoSrcLanguage", "type": "string", "required": true, "description": "智能字幕视频源语言 OCR识别仅支持以下语言： `zh_en`：中英 `multi`：其他 ASR识别和纯字幕翻译当前支持以下语言： `auto`：自动识别（仅在纯字幕翻译中支持） `zh`：简体中文 `en`：英语 `ja`：日语 `ko`：韩语 `zh-PY`：中英粤 `zh_medical`：中文医疗 `vi`：越南语 `ms`：马来语 `id`：印度尼西亚语 `fil`：菲律宾语 `th`：泰语 `pt`：葡萄牙语 `tr`：土耳其语 `ar`：阿拉伯语 `es`：西班牙语 `hi`\ufffd\ufffd...", "example": "zh" }, { "name": "SubtitleFormat", "type": "string", "required": false, "description": "智能字幕文件格式: - ASR识别翻译处理类型下： - vtt: WebVTT 格式字幕 - srt: SRT 格式字幕 - 不填或填空：不生成字幕文件 - 纯字幕翻译处理类型下： - original：与源文件一致 - vtt: WebVTT 格式字幕 - srt: SRT 格式字幕 - OCR识别翻译处理类型下： - vtt: WebVTT 格式字幕 - srt: SRT 格式字幕 **注意**： - ASR识别方式下，翻译大于等于2种语言时不允许传空或不传； - 纯字幕翻译和OCR识别翻译方式\ufffd\ufffd...", "example": "vtt" }, { "name": "TranslateSwitch", "type": "string", "required": false, "description": "字幕翻译开关 `ON`: 开启翻译 `OFF`: 关闭翻译 **注意**：纯字幕翻译方式下，不传默认是打开的，不允许传空或`OFF`； 注意：此字段可能返回 null，表示取不到有效值。", "example": "OFF" }, { "name": "TranslateDstLanguage", "type": "string", "required": false, "description": "字幕翻译目标语言 当TranslateSwitch为ON的时候生效，翻译语言列表： `ab`：阿布哈兹语 `ace`：亚齐语 `ach`：阿乔利语 `af`：南非荷兰语 `ak`：契维语（阿坎语） `am`：Amharic `ar`：阿拉伯语 `as`：阿萨姆语 `ay`：艾马拉语 `az`：阿塞拜疆语 `ba`：巴什基尔语 `ban`：巴厘语 `bbc`：巴塔克托巴语 `bem`：Bemba `bew`：Betawi `bg`：保加利亚语 `bho`：博杰普尔语 `bik`：Bikol `bm`：班巴拉语 `bn`：孟加拉语...", "example": "en" }, { "name": "AsrHotWordsConfigure", "type": "object", "required": false, "description": "ASR热词库参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "热词开关 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" }, { "name": "LibraryId", "type": "string", "required": false, "description": "热词库ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "hwd-2670a776bb5eccccc324" } ] }, { "name": "ExtInfo", "type": "string", "required": false, "description": "自定义参数", "example": "\"{}\"" }, { "name": "ProcessType", "type": "integer", "required": false, "description": "字幕处理类型： - 0：ASR识别字幕 - 1：纯字幕翻译 - 2：OCR识别字幕 **注意**：不传的情况下默认类型为 ASR识别字幕", "example": "0" }, { "name": "SelectingSubtitleAreasConfig", "type": "object", "required": false, "description": "字幕OCR提取框选区域配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "AutoAreas", "type": "array", "required": false, "description": "自动选择自定义区域。 对选定区域，利用AI模型自动检测其中存在的选择目标并提取。", "example": "无", "item_type": "string" }, { "name": "SampleWidth", "type": "integer", "required": false, "description": "示例视频或图片的宽，单位像素值", "example": "200" }, { "name": "SampleHeight", "type": "integer", "required": false, "description": "示例视频或图片的高，单位像素值", "example": "1000" } ] } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "媒体处理输出文件的目标存储。不填则继承 InputInfo 中的存储位置。 **注意**：当InputInfo.Type为URL时，该参数是必填项。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{ \"Type\": \"COS\", \"CosOutputStorage\": { \"Bucket\": \"xxxx-yyy\", \"Region\": \"region\" } }", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "生成字幕文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例: - 文件名_{变量名}.{format} - 文件名.{format} 绝对路径示例： - /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径: `{inputName}_smartsubtitle_{definition}.{format}`。", "example": "/storage/{inputName}_smartsubtitle_{definition}.{format}" } ] }, { "name": "TaskNotifyConfig", "type": "object", "required": false, "description": "任务的事件通知信息，不填代表不获取事件通知。", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型，可选值： CMQ：已下线，建议切换到TDMQ-CMQ TDMQ-CMQ：消息队列 URL：指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同解析事件通知接口的输出参数 SCF：不推荐使用，需要在控制台额外配置SCF AWS-SQS：AWS 队列，只适用于 AWS 任务，且要求同区域 注：不填或为空时默认 TDMQ-CMQ，如需采用其他类型需填写对应类型值；如果使用TDMQ-CMQ消息队列，任务\ufffd...", "example": "URL" }, { "name": "NotifyMode", "type": "string", "required": false, "description": "工作流通知的模式，可取值有 Finish 和 Change，不填代表 Finish。", "example": "Finish " }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的模型，有 Queue 和 Topic 两种。", "example": "Queue " }, { "name": "CmqRegion", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。", "example": "mps_notify" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。", "example": "mps_que" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "AWS SQS 回调，NotifyType为 AWS-SQS 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NULL", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的key。", "example": "0se***9idaY" } ] }, { "name": "TasksPriority", "type": "integer", "required": false, "description": "任务流的优先级，数值越大优先级越高，取值范围是-10到 10，不填代表0。", "example": "0" }, { "name": "SessionContext", "type": "string", "required": false, "description": "来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。", "example": "UserDefinedInfo" }, { "name": "ResourceId", "type": "string", "required": false, "description": "资源ID，需要保证对应资源是开启状态。默认为账号主资源ID。", "example": "vts-24000123-0" }, { "name": "SkipMateData", "type": "integer", "required": false, "description": "是否跳过元信息获取，可选值： 0：表示不跳过 1：表示跳过 默认值：0", "example": "0" } ], "required": [ "InputInfo" ] }, { "name": "BatchStartStreamLinkFlow", "description": "批量启动媒体传输流。", "status": "online", "parameters": [ { "name": "EventId", "type": "string", "required": true, "description": "EventId。", "example": "019202e96d9f09dc0f325e7f7a2a" }, { "name": "FlowIds", "type": "array", "required": false, "description": "Event关联的流Id数组，如果不传默认启动Event下面的所有媒体传输流。", "example": "[\"01937702c54509dc0f3269ca341f\"]", "item_type": "string" } ], "required": [ "EventId" ] }, { "name": "BatchStopStreamLinkFlow", "description": "批量停止媒体传输流。", "status": "online", "parameters": [ { "name": "EventId", "type": "string", "required": true, "description": "EventId。", "example": "01937702ecc509dc0f3269ca3420" }, { "name": "FlowIds", "type": "array", "required": false, "description": "流Id，如果不传默认停止Event下所有的媒体传输流。", "example": "[\"019202e96d9f09dc0f325e7f7a2a\"]", "item_type": "string" } ], "required": [ "EventId" ] }, { "name": "CreateAIAnalysisTemplate", "description": "创建用户自定义内容分析模板，数量上限：50。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "视频内容分析模板名称，长度限制：64 个字符。", "example": "智能分析模板" }, { "name": "Comment", "type": "string", "required": false, "description": "视频内容分析模板描述信息，长度限制：256 个字符。", "example": "模板1" }, { "name": "ClassificationConfigure", "type": "object", "required": false, "description": "智能分类任务控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "智能分类任务开关，可选值： ON：开启智能分类任务； OFF：关闭智能分类任务。", "example": "ON" } ] }, { "name": "TagConfigure", "type": "object", "required": false, "description": "智能标签任务控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "智能标签任务开关，可选值： ON：开启智能标签任务； OFF：关闭智能标签任务。", "example": "ON" } ] }, { "name": "CoverConfigure", "type": "object", "required": false, "description": "智能封面任务控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "智能封面任务开关，可选值： ON：开启智能封面任务； OFF：关闭智能封面任务。", "example": "ON" } ] }, { "name": "FrameTagConfigure", "type": "object", "required": false, "description": "智能按帧标签任务控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "智能按帧标签任务开关，可选值： ON：开启智能按帧标签任务； OFF：关闭智能按帧标签任务。", "example": "ON" } ] } ], "required": [] }, { "name": "CreateAIRecognitionTemplate", "description": "创建用户自定义内容识别模板，数量上限：50。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "视频内容识别模板名称，长度限制：64 个字符。", "example": "智能识别模板" }, { "name": "Comment", "type": "string", "required": false, "description": "视频内容识别模板描述信息，长度限制：256 个字符。", "example": "模板2" }, { "name": "FaceConfigure", "type": "object", "required": false, "description": "人脸识别控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "人脸识别任务开关，可选值： ON：开启智能人脸识别任务； OFF：关闭智能人脸识别任务。", "example": "ON" }, { "name": "Score", "type": "float", "required": false, "description": "人脸识别过滤分数，当识别结果达到该分数以上，返回识别结果。默认 95 分。取值范围：0 - 100。", "example": "95" }, { "name": "DefaultLibraryLabelSet", "type": "array", "required": false, "description": "默认人物过滤标签，指定需要返回的默认人物的标签。如果未填或者为空，则全部默认人物结果都返回。标签可选值： entertainment：娱乐明星； sport：体育明星； politician：敏感人物。", "example": "[\"entertainment\"]", "item_type": "string" }, { "name": "UserDefineLibraryLabelSet", "type": "array", "required": false, "description": "用户自定义人物过滤标签，指定需要返回的用户自定义人物的标签。如果未填或者为空，则全部自定义人物结果都返回。 标签个数最多 100 个，每个标签长度最多 16 个字符。", "example": "[\"artist\"]", "item_type": "string" }, { "name": "FaceLibrary", "type": "string", "required": false, "description": "人物库选择，可选值： Default：使用默认人物库； UserDefine：使用用户自定义人物库。 All：同时使用默认人物库和用户自定义人物库。 默认值：All，使用系统默认人物库及用户自定义人物库。", "example": "Default" } ] }, { "name": "OcrFullTextConfigure", "type": "object", "required": false, "description": "文本全文识别控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "文本全文识别任务开关，可选值： ON：开启智能文本全文识别任务； OFF：关闭智能文本全文识别任务。", "example": "ON" } ] }, { "name": "OcrWordsConfigure", "type": "object", "required": false, "description": "文本关键词识别控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "文本关键词识别任务开关，可选值： ON：开启文本关键词识别任务； OFF：关闭文本关键词识别任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "关键词过滤标签，指定需要返回的关键词的标签。如果未填或者为空，则全部结果都返回。 标签个数最多 10 个，每个标签长度最多 16 个字符。", "example": "[\"腾讯云\"]", "item_type": "string" } ] }, { "name": "AsrFullTextConfigure", "type": "object", "required": false, "description": "语音全文识别控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "语音全文识别任务开关，可选值： ON：开启智能语音全文识别任务； OFF：关闭智能语音全文识别任务。", "example": "ON" }, { "name": "SubtitleFormat", "type": "string", "required": false, "description": "生成的字幕文件格式，不填或者填空字符串表示不生成字幕文件，可选值： vtt：生成 WebVTT 字幕文件。", "example": "vtt" }, { "name": "SourceLanguage", "type": "string", "required": false, "description": "视频源语言。", "example": "zh" } ] }, { "name": "AsrWordsConfigure", "type": "object", "required": false, "description": "语音关键词识别控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "语音关键词识别任务开关，可选值： ON：开启语音关键词识别任务； OFF：关闭语音关键词识别任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "关键词过滤标签，指定需要返回的关键词的标签。如果未填或者为空，则全部结果都返回。 标签个数最多 10 个，每个标签长度最多 16 个字符。", "example": "[\"明星\",\"艺人\"]", "item_type": "string" } ] }, { "name": "TranslateConfigure", "type": "object", "required": false, "description": "语音翻译控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "语音翻译任务开关，可选值： ON：开启智能语音翻译任务； OFF：关闭智能语音翻译任务。", "example": "ON" }, { "name": "SourceLanguage", "type": "string", "required": false, "description": "视频源语言。", "example": "zh" }, { "name": "DestinationLanguage", "type": "string", "required": false, "description": "翻译目标语言。", "example": "en" }, { "name": "SubtitleFormat", "type": "string", "required": false, "description": "生成的字幕文件格式，填空字符串表示不生成字幕文件，可选值： vtt：生成 WebVTT 字幕文件。 注意：此字段可能返回 null，表示取不到有效值。", "example": "vtt" } ] } ], "required": [] }, { "name": "CreateAdaptiveDynamicStreamingTemplate", "description": "创建转自适应码流模板，数量上限：100。", "status": "online", "parameters": [ { "name": "Format", "type": "string", "required": true, "description": "自适应转码格式，取值范围： HLS， MPEG-DASH。", "example": "HLS" }, { "name": "StreamInfos", "type": "array", "required": true, "description": "转自适应码流输出子流参数信息，最多输出10路子流。 注意：各个子流的帧率必须保持一致；如果不一致，采用第一个子流的帧率作为输出帧率。", "example": "无", "item_type": "object", "children": [ { "name": "Audio", "type": "object", "required": true, "description": "音频参数信息。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": true, "description": "音频流的编码格式。 当不需要对音频进行转码时，可选值为： copy。 当外层参数 Container 为 mp3 时，可选值为： mp3。 当外层参数 Container 为 ogg 或 flac 时，可选值为： flac。 当外层参数 Container 为 m4a 时，可选值为： aac； ac3。 当外层参数 Container 为 mp4 或 flv 时，可选值为： aac：更适合 mp4； mp3：更适合 flv； mp2。 当外层参数 Container 为 hls 时，可选值为： aac； mp3; eac3：自适应\ufffd\ufffd...", "example": "aac" }, { "name": "Bitrate", "type": "integer", "required": true, "description": "音频流的码率，取值范围：0 和 [26, 256]，单位：kbps。 当取值为 0，表示音频码率和原始音频保持一致。 注意：如果使用自适应转码音轨合并TrackChannelInfo参数，取值范围： 1）、不能填0； 2）、Codec为：aac时，取值范围：[26, 256]; 3）、Codec为：ac3时，取值范围：[26, 640]; 4)、Codec为：eac3时，取值范围：[26, 6144]，备注：当SampleRate为44100HZ，最大值为：5644，当SampleRate为48000HZ，最大值\ufffd...", "example": "0" }, { "name": "SampleRate", "type": "integer", "required": true, "description": "音频流的采样率，不同编码标准支持的采样率选项不同。填0代表使用源音频的采样率数值。 详细参考[音频采样率支持范围文档](https://cloud.tencent.com/document/product/862/77166#f3b039f1-d817-4a96-b4e4-90132d31cd53) 单位：Hz 注意：请确保源音频流的采样率在上述选项范围内，否则可能导致转码失败！", "example": "44100" }, { "name": "AudioChannel", "type": "integer", "required": false, "description": "音频通道方式，可选值： 1：单通道 2：双通道 6：5.1声道 当媒体的封装格式是音频格式时（flac，ogg，mp3，m4a）时，声道数不允许设为5.1声道。 默认值：2。", "example": "2" }, { "name": "TrackChannelInfo", "type": "object", "required": false, "description": "合并音轨信息。 注意：此字段只是自适应转码生效， 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ChannelsRemix", "type": "integer", "required": false, "description": "是否开启混音，可选值： 0：表示不开启混音 1：表示开启混音 默认值：0 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SelectType", "type": "string", "required": false, "description": "合并音轨输入类型，可选值： track：表示使用音轨id； track_channel： 表示使用音轨id和声道id； 默认：track。 注意：如果原视频是多声道，建议使用track_channel。 注意：此字段可能返回 null，表示取不到有效值。", "example": "track" }, { "name": "InputTrackInfo", "type": "array", "required": false, "description": "音轨信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] } ] }, { "name": "Video", "type": "object", "required": false, "description": "视频参数信息。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": true, "description": "视频流的编码格式，可选值： h264：H.264 编码 h265：H.265 编码 h266：H.266 编码 av1：AOMedia Video 1 编码 vp8：VP8 编码 vp9：VP9 编码 mpeg2：MPEG2 编码 dnxhd：DNxHD 编码 mv-hevc：MV-HEVC 编码 注意：av1 编码容器目前只支持 mp4 ，webm，mkv。 注意：H.266 编码容器目前只支持 mp4 ，hls，ts，mov。 注意：VP8、VP9编码容器目前只支持webm，mkv。 注意：MPEG2、dnxhd 编码容器目前只支持mxf。 注意：MV-HEVC编码\ufffd\ufffd...", "example": "h264" }, { "name": "Fps", "type": "integer", "required": true, "description": "视频帧率，取值范围： 当FpsDenominator的值为空时，范围：[0, 120]，单位：Hz； 当FpsDenominator的值不为空时，Fps/FpsDenominator的范围：[0,120] 当取值为 0，表示帧率和原始视频保持一致。", "example": "0" }, { "name": "Bitrate", "type": "integer", "required": true, "description": "视频流的码率，取值范围：0 和 [128, 100000]，单位：kbps。 当取值为 0，表示视频码率和原始视频保持一致。", "example": "0" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。 默认值：open。 注意：自适应模式时，Width不能小于Height。", "example": "open" }, { "name": "Width", "type": "integer", "required": false, "description": "视频流宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。 注意：Codec为MV-HEVC时可以支持到7680", "example": "0" }, { "name": "Height", "type": "integer", "required": false, "description": "视频流高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。 注意：Codec为MV-HEVC时可以支持到7680", "example": "0" }, { "name": "Gop", "type": "integer", "required": false, "description": "关键帧 I 帧之间的间隔，允许按帧或秒自定义GOP长度，取值范围：0 和 [1, 100000]， 当填 0 或不填时，系统将自动设置 gop 长度。", "example": "0" }, { "name": "GopUnit", "type": "string", "required": false, "description": "Gop数值单位，可选值： frame：表示帧 second：表示秒 默认值：frame 注意：此字段可能返回 null，表示取不到有效值。", "example": "frame" }, { "name": "FillType", "type": "string", "required": false, "description": "填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“； black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。 white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。 gauss：高斯模糊，保持视频...", "example": "black" }, { "name": "Vcrf", "type": "integer", "required": false, "description": "视频的恒定码率控制因子，取值范围为[0, 51]，不填表示“自动”。如果没有特殊需求，建议不指定该参数。 当Mode参数设置为VBR时，如果同时配置了Vcrf值，MPS将在VBR模式下处理视频，同时考虑Vcrf和Bitrate参数的设置，以平衡视频质量、码率、转码效率和文件大小。 当Mode参数设置为CRF，Bitrate设置将失效，编码将根据Vcrf值进行。 当Mode参数选择ABR或CBR时，无需配置Vcrf值。 注意：...", "example": "1" }, { "name": "HlsTime", "type": "integer", "required": false, "description": "分片平均时长，范围：（0-10]，单位：秒 不填表示自动，将根据视频的GOP等特征自动选择合适的分片时长。 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "SegmentType", "type": "integer", "required": false, "description": "hls 分片类型，可选值 ： 0：HLS+TS 切片 2：HLS+TS byte range 7：HLS+MP4 切片 5：HLS+MP4 byte range 默认值：0 注意：该字段用于普通/极速高清转码设置，对自适应码流不生效，如需给自适应码流配置分片类型，可以使用外层字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "FpsDenominator", "type": "integer", "required": false, "description": "帧率分母部分 注意：值必须大于0 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Stereo3dType", "type": "string", "required": false, "description": "3D视频拼接方式，仅mv-hevc，3D视频生效，可选值： side_by_side：原视频内容左右排列布局 top_bottom：原视频内容上下排列布局 计费将按照切分后的分辨率尺寸上报用量及计费； 默认值:side_by_side 注意：此字段可能返回 null，表示取不到有效值。", "example": "side_by_side" }, { "name": "VideoProfile", "type": "string", "required": false, "description": "Profile，适用于不同场景。 baseline: 只支持I/P帧，并只支持无交错的场景，适用于视频通话、手机视频等场景。 main: 主流Profile，提供I帧、P帧、B帧，并支持无交错模式和交错模式。主要用在主流的音视频消费产品如视频播放器、流媒体传输设备上。 high: 最高编码等级，在Main Profile上添加了8X8的预测，并支持自定义量化。广泛应用在蓝光存储、高清电视等场景。 default：随原视频...", "example": "default" }, { "name": "VideoLevel", "type": "string", "required": false, "description": "编码器级别，默认为自动（\"\"） 若编码标准选择H264: 支持以下选项：\"\"，1 , 1.1 , 1.2 , 1.3 , 2 , 2.1 , 2.2 , 3 , 3.1 , 3.2 , 4 , 4.1 , 4.2 , 5 , 5.1 若编码标准选择H265: 支持以下选项：\"\"，1 , 2 , 2.1 , 3 , 3.1 , 4 , 4.1 , 5 , 5.1 , 5.2 , 6 , 6.1 , 6.2 , 8.5 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Bframes", "type": "integer", "required": false, "description": "参考帧之间的B帧数，默认选自动，支持 0 - 16 注意：不填表示使用自动 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Mode", "type": "string", "required": false, "description": "码率控制模式：可选值： VBR（Variable Bit Rate）：动态比特率，根据视频画面的复杂度动态调整输出的码率，使得画面质量更高，适用于存储场景和对画面质量要求较高的应用。 ABR（Average Bit Rate）：平均比特率，尽量保持输出视频的平均码率稳定，但允许短期内的码率波动，适用于需要在保持一定画质的情况下尽量减少整体码率的场景。 CBR（Constant Bit Rate）：恒定比特率，指视...", "example": "VBR" }, { "name": "Sar", "type": "string", "required": false, "description": "显示高宽比，可选值：[1:1，2:1，default] 默认值：default 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" }, { "name": "NoScenecut", "type": "integer", "required": false, "description": "自适应I帧决策，开启后，媒体处理将自动识别视频中不同场景之间的过渡点（通常是视觉上显著不同的帧，比如从一个镜头切换到另一个镜头），在这些点自适应插入关键帧（I帧），从而提高视频的随机访问性和编码效率。可选值： 0：关闭自适应I帧决策 1：使用自适应I帧决策 默认值：0 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "BitDepth", "type": "integer", "required": false, "description": "比特位：支持8/10，默认为8 注意：此字段可能返回 null，表示取不到有效值。", "example": "8" }, { "name": "RawPts", "type": "integer", "required": false, "description": "保持原始时间戳：可选值： 0：表示关闭 1：表示打开 默认是关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Compress", "type": "integer", "required": false, "description": "按比例压缩码率，开启后，将根据比例来调整输出视频的码率。填写压缩率后，系统会根据视频源码率自动计算目标输出码率。压缩率范围0-100 不填此值表示不开启，默认不开启 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SegmentSpecificInfo", "type": "object", "required": false, "description": "启动时分片时长 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "启动分片时长开关，可选值： on：打开 off：关闭 默认off 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "FragmentTime", "type": "integer", "required": false, "description": "启动时分片时长，单位：秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FragmentEndNum", "type": "integer", "required": false, "description": "生效分片数，表示前FragmentEndNum个分片以FragmentTime时长切片，取值\u003e=1 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "ScenarioBased", "type": "integer", "required": false, "description": "模板是否开启场景化 0：不开启 1：开启 默认值：0 注意：只有此字段值为1时，SceneType和CompressType字段的值才会生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SceneType", "type": "string", "required": false, "description": "视频场景化，可选值： normal：通用转码场景：通用转码压缩场景。 pgc：PGC高清影视：压缩时会注重影视剧的观看体验，根据影视剧特性进行ROI编码，同时保留高质量的视频内容和音频。 materials_video：高清素材：素材资源类场景，对画质要求极高，较多透明画面内容，在压缩的同时接近视觉无损。 ugc：UGC内容：适用于广泛的UGC/短视频场景，针对短视频的特性优化编码码率， \ufffd\ufffd...", "example": "normal" }, { "name": "CompressType", "type": "string", "required": false, "description": "转码策略，可选值： ultra_compress：极致压缩：相比标准压缩，该策略能在保证一定画质的基础上最大限度压缩码率，极大节约带宽和存储成本。 standard_compress：综合最优：平衡压缩率与画质，在保证主观画质没有明显降低的情况下尽可能压缩文件。该策略仅收取音视频极速高清转码费用。 high_compress：码率优先：优先保证降低文件体积大小，可能有一定画质损失。该策略仅收取...", "example": "standard_compress" } ] }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否移除音频流，取值范围： 0：否， 1：是。", "example": "0" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否移除视频流，取值范围： 0：否， 1：是。", "example": "0" }, { "name": "AudioList", "type": "array", "required": false, "description": "音频参数信息列表。 注意：参数只在自适应转码使用音轨合并多音轨时使用, 参数数组长度最大为64。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Codec", "type": "string", "required": true, "description": "音频流的编码格式。 当不需要对音频进行转码时，可选值为： copy。 当外层参数 Container 为 mp3 时，可选值为： mp3。 当外层参数 Container 为 ogg 或 flac 时，可选值为： flac。 当外层参数 Container 为 m4a 时，可选值为： aac； ac3。 当外层参数 Container 为 mp4 或 flv 时，可选值为： aac：更适合 mp4； mp3：更适合 flv； mp2。 当外层参数 Container 为 hls 时，可选值为： aac； mp3; eac3：自适应\ufffd\ufffd...", "example": "aac" }, { "name": "Bitrate", "type": "integer", "required": true, "description": "音频流的码率，取值范围：0 和 [26, 256]，单位：kbps。 当取值为 0，表示音频码率和原始音频保持一致。 注意：如果使用自适应转码音轨合并TrackChannelInfo参数，取值范围： 1）、不能填0； 2）、Codec为：aac时，取值范围：[26, 256]; 3）、Codec为：ac3时，取值范围：[26, 640]; 4)、Codec为：eac3时，取值范围：[26, 6144]，备注：当SampleRate为44100HZ，最大值为：5644，当SampleRate为48000HZ，最大值\ufffd...", "example": "0" }, { "name": "SampleRate", "type": "integer", "required": true, "description": "音频流的采样率，不同编码标准支持的采样率选项不同。填0代表使用源音频的采样率数值。 详细参考[音频采样率支持范围文档](https://cloud.tencent.com/document/product/862/77166#f3b039f1-d817-4a96-b4e4-90132d31cd53) 单位：Hz 注意：请确保源音频流的采样率在上述选项范围内，否则可能导致转码失败！", "example": "44100" }, { "name": "AudioChannel", "type": "integer", "required": false, "description": "音频通道方式，可选值： 1：单通道 2：双通道 6：5.1声道 当媒体的封装格式是音频格式时（flac，ogg，mp3，m4a）时，声道数不允许设为5.1声道。 默认值：2。", "example": "2" }, { "name": "TrackChannelInfo", "type": "object", "required": false, "description": "合并音轨信息。 注意：此字段只是自适应转码生效， 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ChannelsRemix", "type": "integer", "required": false, "description": "是否开启混音，可选值： 0：表示不开启混音 1：表示开启混音 默认值：0 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SelectType", "type": "string", "required": false, "description": "合并音轨输入类型，可选值： track：表示使用音轨id； track_channel： 表示使用音轨id和声道id； 默认：track。 注意：如果原视频是多声道，建议使用track_channel。 注意：此字段可能返回 null，表示取不到有效值。", "example": "track" }, { "name": "InputTrackInfo", "type": "array", "required": false, "description": "音轨信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] } ] } ] }, { "name": "Name", "type": "string", "required": false, "description": "模板名称，长度限制：64 个字符。", "example": "转自适应码流模板1" }, { "name": "DisableHigherVideoBitrate", "type": "integer", "required": false, "description": "是否禁止视频低码率转高码率，取值范围： 0：否， 1：是。 默认为否。", "example": "0" }, { "name": "DisableHigherVideoResolution", "type": "integer", "required": false, "description": "是否禁止视频分辨率转高分辨率，取值范围： 0：否， 1：是。 默认为否。", "example": "0" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "转自适应码流模板" }, { "name": "PureAudio", "type": "integer", "required": false, "description": "是否为纯音频，0表示视频模板，1表示纯音频模板 当值为1： 1. StreamInfos.N.RemoveVideo=1 2. StreamInfos.N.RemoveAudio=0 3. StreamInfos.N.Video.Codec=copy 当值为0： 1. StreamInfos.N.Video.Codec不能为copy 2. StreamInfos.N.Video.Fps不能为null 注意： 此值只是区分模板类型，任务使用RemoveAudio和RemoveVideo的值", "example": "0" }, { "name": "SegmentType", "type": "string", "required": false, "description": "分片类型，可选值： ts-segment：HLS+TS 切片 ts-byterange：HLS+TS byte range mp4-segment：HLS+MP4 切片 mp4-byterange：HLS/DASH+MP4 byte range ts-packed-audio：HLS+TS+Packed Audio 切片 mp4-packed-audio：HLS+MP4+Packed Audio 切片 ts-ts-segment：HLS+TS+TS 切片 ts-ts-byterange：HLS+TS+TS byte range mp4-mp4-segment：HLS+MP4+MP4 切片 mp4-mp4-byterange：HLS/DASH+MP4+MP4 byte range ts-packed-audio-byterange：HLS+TS+Packed Audio byte range mp4-packed-audio-byterange：HLS+MP...", "example": "ts-segment" } ], "required": [ "Format", "StreamInfos" ] }, { "name": "CreateAigcImageTask", "description": "调用该接口用于创建AIGC生图片任务。", "status": "online", "parameters": [ { "name": "ModelName", "type": "string", "required": false, "description": "模型名称。当前支持的模型列表：Hunyuan,GEM，Qwen。", "example": "GEM" }, { "name": "ModelVersion", "type": "string", "required": false, "description": "指定模型特定版本号。默认使用系统当前所支持的模型稳定版本。GEM， 可选[2.5,3.0]。", "example": "2.0" }, { "name": "Prompt", "type": "string", "required": false, "description": "生成图片的描述。(注：最大支持1000字符)。当未传入参考图片时，此参数必填。", "example": "draw a cat" }, { "name": "NegativePrompt", "type": "string", "required": false, "description": "用于描述您想要阻止模型生成的内容。 注意：部分模型支持。 例如： 顶部照明、明亮的色彩 人物、动物 多辆汽车、风。", "example": "adult face" }, { "name": "EnhancePrompt", "type": "boolean", "required": false, "description": "默认取值为False，模型会严格地遵循指令。如果需要更精细的prompt获得最佳效果，可将此参数设置为True，将自动优化传入的prompt，以提升生成质量。", "example": "false" }, { "name": "ImageInfos", "type": "array", "required": false, "description": "用于传入参考的资源图片信息，默认支持传入一张图片。支持多图输入的模型：GEM，可支持最多3张图片输入作为资源图。注意：推荐图片小于7M，各模型限制不同。图片格式支持：jpeg, png, webp。", "example": "无", "item_type": "object", "children": [ { "name": "ImageUrl", "type": "string", "required": false, "description": "用于指导视频生成的图片 URL。该URL需外网可访问。同时允许爬虫拉取。", "example": "https://****.vod-qcloud.com/6cd2c44bvodcq1500039689/179cafb25145403699605999621/Clc***E6jcA.png" }, { "name": "ReferenceType", "type": "string", "required": false, "description": "参考类型。 注意： 1. 当模型使用Vidu的q2多参考生图时，也可用于指定主体id。 2. 当使用GV模型时，可作为参考方式,可选asset(素材)、style(风格)。", "example": "asset" } ] }, { "name": "ExtraParameters", "type": "object", "required": false, "description": "用于传入模型要求的额外参数。", "example": "无", "children": [ { "name": "AspectRatio", "type": "string", "required": false, "description": "指定所生成视频的宽高比。 不同模型支持的宽高比: 1. GEM支持：1:1、3:2、2:3、3:4、4:3、4:5、5:4、9:16、16:9 和 21:9。 注：具体模型的宽高比参数，可查看相应模型官网获取更完整描述。", "example": "16:9" }, { "name": "Resolution", "type": "string", "required": false, "description": "指定图片输出分辨率。 支持该参数的模型： 支持选择: 720P, 1080P, 2K, 4K。", "example": "1080P" } ] }, { "name": "AdditionalParameters", "type": "string", "required": false, "description": "用于传入一些模型需要的特殊场景参数，Json格式序列化成字符串。 示例： {\"size\":\"2048x2048\"}", "example": "{\\\"size\\\":\\\"2048x2048\\\"}" }, { "name": "StoreCosParam", "type": "object", "required": false, "description": "文件结果指定存储Cos桶信息。 注意：需开通Cos，创建并授权MPS_QcsRole角色。", "example": "无", "children": [ { "name": "CosBucketName", "type": "string", "required": false, "description": "存储至 cos 的 bucket 桶名称。需要cos存储时，该值必填。 示例值：bucket。", "example": "aigc-test-video-1303333058" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "存储至 cos 的 bucket 区域。与bucket所属区域相同，上传cos时必填。 示例值：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "CosBucketPath", "type": "string", "required": false, "description": "存储至 cos 的 bucket 路径。 可选。 示例值：my_file", "example": "my_cos_file" } ] }, { "name": "Operator", "type": "string", "required": false, "description": "接口操作者名称。", "example": "admin" } ], "required": [] }, { "name": "CreateAigcVideoTask", "description": "调用该接口，用于创建AI生视频任务。", "status": "online", "parameters": [ { "name": "ModelName", "type": "string", "required": false, "description": "模型名称。当前支持的模型列表:Hunyuan,Hailuo，Kling，Vidu，OS，GV。", "example": "Hailuo" }, { "name": "ModelVersion", "type": "string", "required": false, "description": "指定模型特定版本号。默认使用系统当前所支持的模型稳定版本。Hailuo， 可选[02、2.3]。Kling，可选[2.0、2.1、2.5、O1、2.6、3.0、3.0-Omni]。Vidu,可选[q2、q2-pro、q2-turbo、q3-pro、q3-turbo]。GV, 可选[3.1]。OS，可选[2.0]。", "example": "2.3" }, { "name": "SceneType", "type": "string", "required": false, "description": "指定场景生视频。注意：仅部分模型支持指定场景。Kling支持动作控制，motion_control。Mingmou支持横转竖，land2port。Vidu支持特效模板，template_effect。", "example": "motion_control" }, { "name": "Prompt", "type": "string", "required": false, "description": "生成视频的描述。(注：最大支持2000字符)。当未传入图片时，此参数必填。", "example": "move the picture" }, { "name": "NegativePrompt", "type": "string", "required": false, "description": "用于描述您想要阻止模型生成的内容。注意：部分模型支持。例如：顶部照明、明亮的色彩人物、动物多辆汽车、风。", "example": "Top lighting, bright colors" }, { "name": "EnhancePrompt", "type": "boolean", "required": false, "description": "默认取值为False，模型会严格地遵循指令。如果需要更精细的prompt获得最佳效果，可将此参数设置为True，将自动优化传入的prompt，以提升生成质量。", "example": "false" }, { "name": "ImageUrl", "type": "string", "required": false, "description": "用于指导视频生成的图片 URL。该URL需外网可访问。注意：推荐图片大小不超过10M，不同模型大小限制不相同。支持的图片格式：jpeg、png。使用OS模型时，需输入图片尺寸为: 1280x720、720x1280。", "example": "https://1500039689.vod-xxx.com/6cd2c44bvodcq1500039689/179cafb25145403699605999621/xxdjoxE6jcA.png" }, { "name": "LastImageUrl", "type": "string", "required": false, "description": "模型将以此参数传入的图片作为尾帧画面来生成视频。支持此参数的模型：GV，传入尾帧图片时，必须同时传入ImageUrl作为首帧。Kling， 在Resolution:1080P的情况下 2.1版本支持首尾帧。Vidu, q2-pro, q2-turbo 支持首尾帧。注意：推荐图片大小不超过10M，各模型限制不同。支持的图片格式：jpeg、png。", "example": "https://aigc-xxx-image-1303333058.cos.ap-guangzhou.myqcloud.com/xxx_8655.png" }, { "name": "ImageInfos", "type": "array", "required": false, "description": "最多包含三张素材资源图片的列表，用于描述模型在生成视频时要使用的资源图片。支持多图输入的模型：GV，使用多图输入时，不可使用ImageUrl和LastImageUrl。Vidu，支持多图参考生视频。q2模型1-7张图片，可通过ImageInfos里面的ReferenceType作为主体id来传入。注意：图片大小不超过10M。支持的图片格式：jpeg、png。", "example": "无", "item_type": "object", "children": [ { "name": "ImageUrl", "type": "string", "required": false, "description": "用于指导视频生成的图片 URL。该URL需外网可访问。同时允许爬虫拉取。", "example": "http://myimage.com/mps/image.png" }, { "name": "ReferenceType", "type": "string", "required": false, "description": "参考类型。 注意： 1. 当使用GV模型时，可作为参考方式,可选asset(素材)、style(风格)。", "example": "asset" } ] }, { "name": "VideoInfos", "type": "array", "required": false, "description": "目前仅Kling O1版本支持参考视频信息传入。可作为特征参考视频，也可作为待编辑视频，默认为待编辑视频；可选择性保留视频原声。", "example": "无", "item_type": "object", "children": [ { "name": "VideoUrl", "type": "string", "required": false, "description": "参考视频url。需要外网可访问。 可作为特征参考视频，也可作为待编辑视频，默认为待编辑视频；可选择性保留视频原声 通过ReferType参数区分参考视频类型：feature为特征参考视频，base为待编辑视频 参考视频为待编辑视频时，不能定义视频首尾帧。" }, { "name": "ReferType", "type": "string", "required": false, "description": "通过ReferType参数区分参考视频类型：feature为特征参考视频，base为待编辑视频。" }, { "name": "KeepOriginalSound", "type": "string", "required": false, "description": "通过KeepOriginalSound参数选择是否保留视频原声，yes为保留，no为不保留；当前参数对特征参考视频（feature）也生效。" } ] }, { "name": "Duration", "type": "integer", "required": false, "description": "生成视频的时长。注意：Kling支持 5、10秒。默认: 5秒。Hailuo的std模式可支持6、10秒，其他仅6秒。默认：6秒。Vidu支持1-10秒。GV支持 8秒。 默认：8秒。OS支持4、8、12秒。 默认：8秒。", "example": "8" }, { "name": "ExtraParameters", "type": "object", "required": false, "description": "用于传入要求的额外参数。", "example": "无", "children": [ { "name": "Resolution", "type": "string", "required": false, "description": "生成视频的分辨率，分辨率与选择模型及设置的视频时长相关。 不同模型支持的分辨率选项:Kling 720P(默认), 1080P。Hailuo 768P(默认), 1080P。Vidu 720P(默认)，1080P。GV 720P(默认),1080P。OS 720P, 图片仅支持1280x720、720x1280，暂不支持指定。注意：除模型可支持的分辨率外，还可以生成 2K、4K分辨率。", "example": "720P" }, { "name": "AspectRatio", "type": "string", "required": false, "description": "指定所生成视频的宽高比。 不同模型对于此参数的支持：Kling 仅文生视频支持, 16:9(默认值)、9:16、 1:1。Hailuo 暂不支持。Vidu 仅文生和参考图生视频 支持[16:9、9:16、4:3、3:4、1:1]，其中仅q2支持4:3、3:4。GV 16:9(默认值)、9:16。OS 仅文生视频支持, 16:9(默认), 9:16。注：关于具体模型支持的宽高比例，可查看具体模型官网介绍获取更完整描述。", "example": "16:9" }, { "name": "LogoAdd", "type": "integer", "required": false, "description": "是否添加图标水印。Hailuo 支持此参数。Kling 支持此参数。Vidu 支持此参数。", "example": "0" }, { "name": "EnableAudio", "type": "boolean", "required": false, "description": "为视频生成音频。接受的值包括 true 或 false。 支持此参数的模型：GV，默认true。OS，默认true。", "example": "false" }, { "name": "OffPeak", "type": "boolean", "required": false, "description": "错峰模型，目前仅支持Vidu模型。错峰模式下提交的任务，会在48小时内生成，未能完成的任务会被自动取消。", "example": "false" }, { "name": "EnableBgm", "type": "boolean", "required": false, "description": "是否为生成的视频添加背景音乐。默认：false，可选值 true 、false。注意：部分模型的版本支持。", "example": "false" } ] }, { "name": "StoreCosParam", "type": "object", "required": false, "description": "文件结果指定存储Cos桶信息。 注意：需开通Cos，创建并授权MPS_QcsRole角色。", "example": "无", "children": [ { "name": "CosBucketName", "type": "string", "required": false, "description": "存储至 cos 的 bucket 桶名称。需要cos存储时，该值必填。 示例值：bucket。", "example": "aigc-test-video-1303333058" }, { "name": "CosBucketRegion", "type": "string", "required": false, "description": "存储至 cos 的 bucket 区域。与bucket所属区域相同，上传cos时必填。 示例值：ap-guangzhou", "example": "ap-guangzhou" }, { "name": "CosBucketPath", "type": "string", "required": false, "description": "存储至 cos 的 bucket 路径。 可选。 示例值：my_file", "example": "my_cos_file" } ] }, { "name": "AdditionalParameters", "type": "string", "required": false, "description": "用于传入一些模型需要的特殊场景参数，Json格式序列化成字符串。示例：{\"camera_control\":{\"type\":\"simple\"}}", "example": "{\\\"test\\\":1}" }, { "name": "Operator", "type": "string", "required": false, "description": "接口操作者名称。", "example": "admin" } ], "required": [] }, { "name": "CreateAnimatedGraphicsTemplate", "description": "创建用户自定义转动图模板，数量上限：16。", "status": "online", "parameters": [ { "name": "Fps", "type": "integer", "required": true, "description": "帧率，取值范围：[1, 30]，单位：Hz。", "example": "30" }, { "name": "Width", "type": "integer", "required": false, "description": "动图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "540" }, { "name": "Height", "type": "integer", "required": false, "description": "动图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "960" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。 默认值：open。", "example": "close" }, { "name": "Format", "type": "string", "required": false, "description": "动图格式，取值为 gif 和 webp。默认为 gif。", "example": "gif" }, { "name": "Quality", "type": "float", "required": false, "description": "图片质量，取值范围：[1, 100]，默认值为 75。", "example": "75" }, { "name": "Name", "type": "string", "required": false, "description": "转动图模板名称，长度限制：64 个字符。", "example": "转动图模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "转动图模板1" } ], "required": [ "Fps" ] }, { "name": "CreateAsrHotwords", "description": "智能字幕新建热词库接口", "status": "online", "parameters": [ { "name": "Type", "type": "integer", "required": true, "description": "0 临时热词 1 文件热词", "example": "0" }, { "name": "Name", "type": "string", "required": true, "description": "热词库名称", "example": "HotwordsName" }, { "name": "Content", "type": "string", "required": false, "description": "热词库文本，Type为 0 必选", "example": "腾讯云|10,语音识别|5,ASR|10" }, { "name": "FileContent", "type": "string", "required": false, "description": "热词库文件的 base64 的内容，Type 为 1 必选", "example": "data:text/plain;base64,5a123test4566=" }, { "name": "FileName", "type": "string", "required": false, "description": "上传的文件名", "example": "example.txt" } ], "required": [ "Type", "Name" ] }, { "name": "CreateBlindWatermarkTemplate", "description": "创建用户自定义数字水印模板。", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": true, "description": "数字水印类型，可选值：blind-basic：基础版权数字水印；blind-nagra：NAGRA水印；", "example": "blind-basic" }, { "name": "TextContent", "type": "string", "required": true, "description": "数字水印文字内容，长度不超过64个字符，NAGRA水印类型的模板创建后不支持修改文字内容。", "example": "数字水印文本" }, { "name": "Name", "type": "string", "required": false, "description": "数字水印模板名称，支持中文、英文、数字、_、-和. 六种格式，长度限制：64 个字符。", "example": "数字水印模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "数字水印模板描述信息，长度限制：256 个字符。", "example": "数字水印模板" }, { "name": "Strength", "type": "string", "required": false, "description": "数字水印强度。 default: 默认，高清画质和抗性平衡 stronger:画质清晰，抗性较强 strongest:画质一般，抗性最强", "example": "default" } ], "required": [ "Type", "TextContent" ] }, { "name": "CreateContentReviewTemplate", "description": "创建用户自定义内容审核模板，数量上限：50。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "内容审核模板名称，长度限制：64 个字符。", "example": "内容审核模板" }, { "name": "Comment", "type": "string", "required": false, "description": "内容审核模板描述信息，长度限制：256 个字符。", "example": "模板1" }, { "name": "PornConfigure", "type": "object", "required": false, "description": "鉴黄任务控制参数。", "example": "无", "children": [ { "name": "ImgReviewInfo", "type": "object", "required": false, "description": "画面鉴黄控制参数。", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "画面鉴黄任务开关，可选值： ON：开启画面鉴黄任务； OFF：关闭画面鉴黄任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "画面鉴黄过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回，可选值为： porn：色情； vulgar：低俗； intimacy：亲密行为； sexy：性感。", "example": "[\"porn\",\"sexy\"]", "item_type": "string" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 90 分。取值范围：0~100。", "example": "60" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 0 分。取值范围：0~100。", "example": "80" } ] }, { "name": "AsrReviewInfo", "type": "object", "required": false, "description": "语音鉴黄控制参数。", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "语音鉴黄任务开关，可选值： ON：开启语音鉴黄任务； OFF：关闭语音鉴黄任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。", "example": "60" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。", "example": "80" } ] }, { "name": "OcrReviewInfo", "type": "object", "required": false, "description": "文本鉴黄控制参数。", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "文本鉴黄任务开关，可选值： ON：开启文本鉴黄任务； OFF：关闭文本鉴黄任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。", "example": "60" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。", "example": "80" } ] } ] }, { "name": "TerrorismConfigure", "type": "object", "required": false, "description": "涉暴任务控制参数。", "example": "无", "children": [ { "name": "ImgReviewInfo", "type": "object", "required": false, "description": "画面涉敏任务控制参数。", "example": "NULL", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "画面涉敏任务开关，可选值： ON：开启画面涉敏任务； OFF：关闭画面涉敏任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "画面涉敏过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回，可选值为： guns：武器枪支； crowd：人群聚集； bloody：血腥画面； police：警察部队； banners：涉敏旗帜； militant：武装分子； explosion：爆炸火灾； terrorists：涉敏人物；", "example": "bloody", "item_type": "string" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 90 分。取值范围：0~100。", "example": "95" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 80 分。取值范围：0~100。", "example": "80" } ] }, { "name": "OcrReviewInfo", "type": "object", "required": false, "description": "文本涉敏任务控制参数。", "example": "NULL", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "文本涉敏任务开关，可选值： ON：开启文本涉敏任务； OFF：关闭文本涉敏任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。", "example": "0" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。", "example": "0" } ] } ] }, { "name": "PoliticalConfigure", "type": "object", "required": false, "description": "涉敏任务控制参数。", "example": "无", "children": [ { "name": "ImgReviewInfo", "type": "object", "required": false, "description": "画面涉敏控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "画面涉敏任务开关，可选值： ON：开启画面涉敏任务； OFF：关闭画面涉敏任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "画面涉敏过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回，可选值为： violation_photo：违规图标； politician：涉敏人物； entertainment：娱乐人物； sport：体育人物； entrepreneur：商业人物； scholar：教育学者； celebrity：知名人物； military：军事人物。", "example": "violation_photo", "item_type": "string" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 97 分。取值范围：0~100。", "example": "97" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 95 分。取值范围：0~100。", "example": "95" } ] }, { "name": "AsrReviewInfo", "type": "object", "required": false, "description": "语音涉敏控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "语音涉敏任务开关，可选值： ON：开启语音涉敏任务； OFF：关闭语音涉敏任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。", "example": "100" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。", "example": "75" } ] }, { "name": "OcrReviewInfo", "type": "object", "required": false, "description": "文本涉敏控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "文本涉敏任务开关，可选值： ON：开启文本涉敏任务； OFF：关闭文本涉敏任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。", "example": "0" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。", "example": "0" } ] } ] }, { "name": "ProhibitedConfigure", "type": "object", "required": false, "description": "违禁控制参数。违禁内容包括： 谩骂； 涉毒违法。 注意：此参数尚未支持。", "example": "无", "children": [ { "name": "AsrReviewInfo", "type": "object", "required": false, "description": "语音违禁控制参数。 注意：此字段可能返回 null，表示取不到有效值。", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "语音违禁任务开关，可选值： ON：开启语音违禁任务； OFF：关闭语音违禁任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。", "example": "60" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。", "example": "80" } ] }, { "name": "OcrReviewInfo", "type": "object", "required": false, "description": "文本违禁控制参数。 注意：此字段可能返回 null，表示取不到有效值。", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "文本违禁任务开关，可选值： ON：开启文本违禁任务； OFF：关闭文本违禁任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。", "example": "60" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。", "example": "80" } ] } ] }, { "name": "UserDefineConfigure", "type": "object", "required": false, "description": "用户自定义内容审核控制参数。", "example": "无", "children": [ { "name": "FaceReviewInfo", "type": "object", "required": false, "description": "用户自定义人物审核控制参数。", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "用户自定义人物审核任务开关，可选值： ON：开启自定义人物审核任务； OFF：关闭自定义人物审核任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "用户自定义人物过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回。如果要使用标签过滤功能，添加自定义人物库的时，需要添加对应人物标签。 标签个数最多 10 个，每个标签长度最多 16 个字符。", "example": "[\"自定义人物过滤标签1\"]", "item_type": "string" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 97 分。取值范围：0~100。", "example": "100" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 95 分。取值范围：0~100。", "example": "85" } ] }, { "name": "AsrReviewInfo", "type": "object", "required": false, "description": "用户自定义语音审核控制参数。", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "用户自定语音审核任务开关，可选值： ON：开启自定义语音审核任务； OFF：关闭自定义语音审核任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "用户自定义语音过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回。如果要使用标签过滤功能，添加自定义语音关键词素材时需要添加对应标签。 标签个数最多 10 个，每个标签长度最多 16 个字符。", "example": "[\"自定义语音过滤标签1\"]", "item_type": "string" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。", "example": "100" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。", "example": "85" } ] }, { "name": "OcrReviewInfo", "type": "object", "required": false, "description": "用户自定义文本审核控制参数。", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "用户自定文本审核任务开关，可选值： ON：开启自定义文本审核任务； OFF：关闭自定义文本审核任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "用户自定义文本过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回。如果要使用标签过滤功能，添加自定义文本关键词素材时需要添加对应标签。 标签个数最多 10 个，每个标签长度最多 16 个字符。", "example": "[\"自定义文本过滤标签1\"]", "item_type": "string" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。", "example": "100" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。", "example": "85" } ] } ] } ], "required": [] }, { "name": "CreateImageSpriteTemplate", "description": "创建用户自定义雪碧图模板，数量上限：16。", "status": "online", "parameters": [ { "name": "SampleType", "type": "string", "required": true, "description": "采样类型，取值： Percent：按百分比。 Time：按时间间隔。", "example": "Percent" }, { "name": "SampleInterval", "type": "integer", "required": true, "description": "采样间隔。 当 SampleType 为 Percent 时，指定采样间隔的百分比。 当 SampleType 为 Time 时，指定采样间隔的时间，单位为秒。", "example": "10" }, { "name": "RowCount", "type": "integer", "required": true, "description": "雪碧图中小图的行数。", "example": "5" }, { "name": "ColumnCount", "type": "integer", "required": true, "description": "雪碧图中小图的列数。", "example": "10" }, { "name": "Name", "type": "string", "required": false, "description": "雪碧图模板名称，长度限制：64 个字符。", "example": "雪碧图模板1" }, { "name": "Width", "type": "integer", "required": false, "description": "雪碧图中小图的宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "54" }, { "name": "Height", "type": "integer", "required": false, "description": "雪碧图中小图的高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "96" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。 默认值：open。", "example": "open" }, { "name": "FillType", "type": "string", "required": false, "description": "填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“； black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。 默认值：black 。", "example": "black " }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "雪碧图模板" }, { "name": "Format", "type": "string", "required": false, "description": "图片格式，取值为 jpg、png、webp。默认为 jpg。", "example": "jpg" } ], "required": [ "SampleType", "SampleInterval", "RowCount", "ColumnCount" ] }, { "name": "CreateLiveRecordTemplate", "description": "创建直播录制模板", "status": "online", "parameters": [ { "name": "HLSConfigure", "type": "object", "required": false, "description": "HLS配置参数，和MP4Configure需要二选一必填。", "example": "无", "children": [ { "name": "ItemDuration", "type": "integer", "required": false, "description": "单个 TS 文件时长，单位：秒，取值范围 5-30 秒。 不填默认为 30 秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "Interval", "type": "integer", "required": false, "description": "录制周期，单位：秒，取值范围 10 分钟到 12 小时。 不填默认为 10分钟（3600 秒）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3600" }, { "name": "ContinueTimeout", "type": "integer", "required": false, "description": "续录等待时间，单位：秒。取值范围为60秒-1800秒。 不填默认为0（不启用续录）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "60" } ] }, { "name": "MP4Configure", "type": "object", "required": false, "description": "MP4配置参数，和HLSConfigure需要二选一必填。", "example": "无", "children": [ { "name": "Interval", "type": "integer", "required": false, "description": "录制周期，单位：秒，取值范围 10 分钟到720分钟。默认值：60分钟（3600秒）。", "example": "3600" } ] }, { "name": "Name", "type": "string", "required": false, "description": "录制模板名称，长度限制：64 个字符。", "example": "录制模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "录制模板" }, { "name": "RecordType", "type": "string", "required": false, "description": "录制类型，取值为video（音视频录制）、audio（纯音频录制）、auto（自动探测）。不填时默认值为video。", "example": "video" } ], "required": [] }, { "name": "CreateMediaEvaluation", "description": "发起视频评测任务，功能包括： 1. 对一个原视频和多个转码后的视频进行评分。 2. 计算不同转码方式的 BD-Rate。", "status": "online", "parameters": [ { "name": "InputInfo", "type": "object", "required": true, "description": "评测的原文件输入信息。目前输入对象的类型有 COS 和 URL。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输入来源对象的类型，支持： COS：COS源 URL：URL源 AWS-S3：AWS 源，目前只支持转码任务 VOD：点播专业版", "example": "NULL" }, { "name": "CosInputInfo", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 对象信息。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": true, "description": "媒体处理对象文件的输入路径，如`/movie/201907/WildAnimal.mov`。", "example": "/movie/201907/WildAnimal.mov" } ] }, { "name": "UrlInputInfo", "type": "object", "required": false, "description": "当 Type 为 URL 时有效，则该项为必填，表示媒体处理 URL 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频的 URL。", "example": "NULL" } ] }, { "name": "S3InputInfo", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-us-125678" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域，目前支持： us-east-1 eu-west-3 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1 " }, { "name": "S3Object", "type": "string", "required": true, "description": "S3 bucket 中的媒体资源路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/test.mp4" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bb5******eff" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bbc5******eff" } ] }, { "name": "VODInputInfo", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理对象文件所在的 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理对象文件所在的 Bucket 所属园区", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": false, "description": "媒体处理对象文件的输入路径", "example": "/movie/201907/WildAnimal.mov" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "EvaluationTask", "type": "object", "required": true, "description": "评测任务参数。", "example": "无", "children": [ { "name": "TaskType", "type": "string", "required": true, "description": "评测任务类型，可选 NORMAL、BD_RATE", "example": "NORMAL" }, { "name": "EvaluationTypeSet", "type": "array", "required": true, "description": "评测类型，可选 PSNR、SSIM、VMAF、VMAF_NEG", "example": "[\"PSNR\"]", "item_type": "string" }, { "name": "EvaluationRangeType", "type": "string", "required": false, "description": "评测范围类型，可选 ALL（全部时长）、TIME（指定时长范围）、FRAME（指定帧数范围）", "example": "ALL" }, { "name": "ContrastMediaSet", "type": "array", "required": false, "description": "对比视频信息。", "example": "无", "item_type": "object", "children": [ { "name": "SourceId", "type": "string", "required": false, "description": "对比视频的来源 ID，当评测任务的类型为 BD_RATE 且对比视频来自用户输入时有效；当对比视频来自转码模板时为空 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "InputInfo", "type": "object", "required": false, "description": "对比视频的输入信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输入来源对象的类型，支持： COS：COS源 URL：URL源 AWS-S3：AWS 源，目前只支持转码任务 VOD：点播专业版", "example": "NULL" }, { "name": "CosInputInfo", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 对象信息。", "example": "无" }, { "name": "UrlInputInfo", "type": "object", "required": false, "description": "当 Type 为 URL 时有效，则该项为必填，表示媒体处理 URL 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3InputInfo", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODInputInfo", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] } ] }, { "name": "ContrastTemplateSet", "type": "array", "required": false, "description": "对比转码模板信息。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "转码模板的 ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "100010" } ] }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始评测时间，单位秒，当 EvaluationRangeType 为 TIME 时有效。", "example": "0" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束评测时间，单位秒，当 EvaluationRangeType 为 TIME 时有效。", "example": "10" }, { "name": "StartFrameIndex", "type": "integer", "required": false, "description": "评测开始帧，默认从0开始，当 EvaluationRangeType 为FRAME 时有效。", "example": "0" }, { "name": "EndFrameIndex", "type": "integer", "required": false, "description": "评测结束帧，默认为视频中可以参与评测的最后一帧，当 EvaluationRangeType 为 FRAME 时有效。", "example": "9" }, { "name": "ResolutionAlignmentMode", "type": "string", "required": false, "description": "分辨率对齐模式，默认对齐到低分辨率的视频，可选 ALIGN_HIGH_RESOLUTION、ALIGN_LOW_RESOLUTION", "example": "ALIGN_HIGH_RESOLUTION" }, { "name": "BitrateSet", "type": "array", "required": false, "description": "指定码率评测，当评测任务类型为 BD_RATE 有效。", "example": "[1500,2000,2500,3000]", "item_type": "integer" }, { "name": "VCRFSet", "type": "array", "required": false, "description": "指定 vcrf 评测，当评测任务类型为 BD_RATE 有效。", "example": "[20,24,30,34]", "item_type": "integer" } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "评测的输出文件的目标存储。不填则继承 InputInfo 中的存储位置。目前输出对象存储位置的类型有COS。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputDir", "type": "string", "required": false, "description": "评测生成文件的输出目录，必选以 / 开头和结尾，如/movie/201907/。 如果不填，表示与 InputInfo 中文件所在的目录一致。", "example": "无" }, { "name": "TaskNotifyConfig", "type": "object", "required": false, "description": "任务的事件通知信息，不填代表不获取事件通知。", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型，可选值： CMQ：已下线，建议切换到TDMQ-CMQ TDMQ-CMQ：消息队列 URL：指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同解析事件通知接口的输出参数 SCF：不推荐使用，需要在控制台额外配置SCF AWS-SQS：AWS 队列，只适用于 AWS 任务，且要求同区域 注：不填或为空时默认 TDMQ-CMQ，如需采用其他类型需填写对应类型值；如果使用TDMQ-CMQ消息队列，任务\ufffd...", "example": "URL" }, { "name": "NotifyMode", "type": "string", "required": false, "description": "工作流通知的模式，可取值有 Finish 和 Change，不填代表 Finish。", "example": "Finish " }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的模型，有 Queue 和 Topic 两种。", "example": "Queue " }, { "name": "CmqRegion", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。", "example": "mps_notify" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。", "example": "mps_que" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "AWS SQS 回调，NotifyType为 AWS-SQS 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NULL", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的key。", "example": "0se***9idaY" } ] }, { "name": "TasksPriority", "type": "integer", "required": false, "description": "任务优先级，数值越大优先级越高，取值范围是-10到 10，不填代表0。", "example": "无" }, { "name": "SessionId", "type": "string", "required": false, "description": "用于去重的识别码，如果三天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。", "example": "无" }, { "name": "SessionContext", "type": "string", "required": false, "description": "来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。", "example": "无" } ], "required": [ "InputInfo", "EvaluationTask" ] }, { "name": "CreatePersonSample", "description": "该接口用于创建素材样本，用于通过五官定位等技术，进行内容识别、内容不适宜等视频处理。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "素材名称，长度限制：20 个字符。" }, { "name": "Usages", "type": "array", "required": true, "description": "素材应用场景，可选值： 1. Recognition：用于内容识别，等价于 Recognition.Face。 2. Review：用于不适宜内容识别，等价于 Review.Face。 3. All：包含以上全部，等价于 1+2。", "item_type": "string" }, { "name": "Description", "type": "string", "required": false, "description": "素材描述，长度限制：1024 个字符。" }, { "name": "FaceContents", "type": "array", "required": false, "description": "素材图片 [Base64](https://tools.ietf.org/html/rfc4648) 编码后的字符串，仅支持 jpeg、png 图片格式。数组长度限制：5 张图片。 注意：图片必须是单人像五官较清晰的照片，像素不低于 200*200。", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "素材标签 数组长度限制：20 个标签； 单个标签长度限制：128 个字符。", "item_type": "string" } ], "required": [ "Name", "Usages" ] }, { "name": "CreateProcessImageTemplate", "description": "创建图片处理模板", "status": "online", "parameters": [ { "name": "ProcessImageTemplate", "type": "object", "required": true, "description": "图片处理模板。", "example": "无", "children": [ { "name": "EncodeConfig", "type": "object", "required": false, "description": "图片编码配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Format", "type": "string", "required": false, "description": "图片格式，取值范围：JPEG、PNG、BMP、WebP，缺省为原图格式。不支持动画。 注意：此字段可能返回 null，表示取不到有效值。", "example": "JPEG" }, { "name": "Quality", "type": "integer", "required": false, "description": "图片的相对质量，取值范围：1 - 100，数值以原图质量为标准，缺省为原图质量。 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" } ] }, { "name": "EnhanceConfig", "type": "object", "required": false, "description": "图片增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SuperResolution", "type": "object", "required": false, "description": "超分配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： lq：针对低清晰度有较多噪声视频的超分； hq：针对高清晰度视频超分。 默认值：lq。 注意：此字段可能返回 null，表示取不到有效值。", "example": "lq" }, { "name": "Size", "type": "integer", "required": false, "description": "超分倍数，可选值： 2：目前只支持 2 倍超分。 默认值：2。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2" } ] }, { "name": "AdvancedSuperResolutionConfig", "type": "object", "required": false, "description": "高级超分配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： standard：通用超分 super：高级超分super版。 ultra：高级超分ultra版。 默认值：standard。 注意：此字段可能返回 null，表示取不到有效值。", "example": "standard" }, { "name": "Mode", "type": "string", "required": false, "description": "输出图片模式，默认percent。 aspect: 超分至指定宽高的较大矩形。 fixed: 超分至固定宽高，强制缩放。 percent: 超分倍率，可以为小数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "percent" }, { "name": "Percent", "type": "float", "required": false, "description": "超分倍率，可以为小数。 注意：当Mode等于percent时使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2.0" }, { "name": "Width", "type": "integer", "required": false, "description": "目标图片宽度，不能超过4096。 注意：当Mode等于aspect或fixed时，优先使用此配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1280" }, { "name": "Height", "type": "integer", "required": false, "description": "目标图片高度，不能超过4096。 注意：当Mode等于aspect或fixed时，优先使用此配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "720" }, { "name": "LongSide", "type": "integer", "required": false, "description": "目标图片长边长度，不能超过4096。 注意：当Mode等于aspect或fixed，且未配置Width和Height字段时使用此配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1280" }, { "name": "ShortSide", "type": "integer", "required": false, "description": "目标图片短边长度，不能超过4096。 注意：当Mode等于aspect或fixed，且未配置Width和Height字段时使用此配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1280" } ] }, { "name": "Denoise", "type": "object", "required": false, "description": "降噪配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "ImageQualityEnhance", "type": "object", "required": false, "description": "综合增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak normal strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "ColorEnhance", "type": "object", "required": false, "description": "色彩增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak normal strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "SharpEnhance", "type": "object", "required": false, "description": "细节增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Intensity", "type": "float", "required": false, "description": "强度，取值范围：0.0~1.0。 默认：0.0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "FaceEnhance", "type": "object", "required": false, "description": "人脸增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Intensity", "type": "float", "required": false, "description": "强度，取值范围：0.0~1.0。 默认：0.0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "LowLightEnhance", "type": "object", "required": false, "description": "低光照增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： normal 默认值：normal。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" } ] } ] }, { "name": "EraseConfig", "type": "object", "required": false, "description": "图片擦除配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ImageEraseLogo", "type": "object", "required": false, "description": "图标擦除配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" }, { "name": "ImageAreaBoxes", "type": "array", "required": false, "description": "需要擦除的多个框选区域，最多开启16个区域。 注意：此字段可能返回 null，表示取不到有效值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "DetectTypes", "type": "array", "required": false, "description": "图片框选区域类型，可选值： logo：图标； text：文字； watermark：水印； 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"logo\", \"text\"]", "item_type": "string" } ] } ] }, { "name": "BlindWatermarkConfig", "type": "object", "required": false, "description": "盲水印配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "AddBlindWatermark", "type": "object", "required": false, "description": "增加盲水印 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" }, { "name": "EmbedInfo", "type": "object", "required": false, "description": "盲水印嵌入数据 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ExtractBlindWatermark", "type": "object", "required": false, "description": "提取盲水印 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" } ] }, { "name": "RemoveBlindWatermark", "type": "object", "required": false, "description": "移除盲水印 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" } ] } ] }, { "name": "BeautyConfig", "type": "object", "required": false, "description": "美颜配置。", "example": "无", "children": [ { "name": "BeautyEffectItems", "type": "array", "required": false, "description": "美颜效果", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型名称。取值如下： Whiten：美白 BlackAlpha1：美黑 BlackAlpha2：较强美黑 FoundationAlpha2：美白-粉白 Clear：清晰度 Sharpen：锐化 Smooth：磨皮 BeautyThinFace：瘦脸 NatureFace：自然脸型 VFace：V脸 EnlargeEye：大眼 EyeLighten：亮眼 RemoveEyeBags：祛眼袋 ThinNose：瘦鼻 RemoveLawLine：祛法令纹 CheekboneThin：瘦颧骨 FaceFeatureLipsLut：口红 ToothWhiten：牙齿美白 FaceFeatureSoftlight：柔光 Makeup：美妆", "example": "Whiten" }, { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Value", "type": "integer", "required": false, "description": "效果强度，值范围：[0, 100]。", "example": "40" }, { "name": "ResourcePath", "type": "string", "required": false, "description": "附加资源路径。", "example": "/makeupRes/video_makeup_mitao" }, { "name": "ExtInfo", "type": "string", "required": false, "description": "自定义参数。", "example": "{\\\"Color\\\":\\\"#ff0000\\\"}" } ] }, { "name": "BeautyFilterItems", "type": "array", "required": false, "description": "美颜滤镜", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型名称。取值如下： Dongjing：东京 Qingjiaopian：轻胶片 Meiwei：美味", "example": "Qingjiaopian" }, { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Value", "type": "integer", "required": false, "description": "效果强度，值范围：[-100, 100]。", "example": "70" } ] } ] }, { "name": "TransformConfig", "type": "object", "required": false, "description": "图片基础转换能力。", "example": "无", "children": [ { "name": "ImageResize", "type": "object", "required": false, "description": "图片缩放配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启 OFF：关闭 默认值：ON。", "example": "ON" }, { "name": "Mode", "type": "string", "required": false, "description": "输出图片模式，可选模式： percent: 指定缩放倍率，可以为小数 mfit: 缩放至指定宽高的较大矩形 lfit: 缩放至指定宽高的较小矩形 fill: 缩放至指定宽高的较大矩形，并居中裁剪指定宽高 pad: 缩放至指定宽高的较小矩形，并填充到指定宽高 fixed: 缩放至固定宽高，强制缩放 默认值：percent。 注意：此字段可能返回 null，表示取不到有效值。", "example": "percent" }, { "name": "Percent", "type": "float", "required": false, "description": "缩放倍率，可以为小数，当Mode为percent时使用。 默认值：1.0。 取值范围：[0.1，10.0] 注意：此字段可能返回 null，表示取不到有效值。", "example": "1.0" }, { "name": "Width", "type": "integer", "required": false, "description": "目标图片宽度。 取值范围：[1，16384]。 注意：此字段在Mode非percent时优先使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3840" }, { "name": "Height", "type": "integer", "required": false, "description": "目标图片高度。 取值范围：[1，16384]。 注意：此字段在Mode非percent时优先使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2160" }, { "name": "LongSide", "type": "integer", "required": false, "description": "目标图片长边。 取值范围：[1，16384]。 注意：此字段在Mode非percent且未配置Width和Height时使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3840" }, { "name": "ShortSide", "type": "integer", "required": false, "description": "目标图片短边。 取值范围：[1，16384]。 注意：此字段在Mode非percent且未配置Width和Height时使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2160" } ] } ] } ] }, { "name": "Name", "type": "string", "required": false, "description": "图片处理模板名称，长度限制：64个字符。", "example": "图片处理模板" }, { "name": "Comment", "type": "string", "required": false, "description": "图片处理模板描述信息，长度限制：256个字符。", "example": "图片处理模板1" }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "图片处理模板拓展参数。", "example": "{\"FilterConfig\":{\"Switch\":\"ON\", \"FilterParam\":\"TransformConfig:params=model=scale\u0026l=2560\u0026s=1440\"}}" } ], "required": [ "ProcessImageTemplate" ] }, { "name": "CreateQualityControlTemplate", "description": "创建媒体质检模板，数量上限：50。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "媒体质检模板名称，长度限制：64 个字符。", "example": "质检模板" }, { "name": "QualityControlItemSet", "type": "array", "required": true, "description": "媒体质检控制参数。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "质检项名称。质检项取值如下： LowEvaluation：视频无参考评分（MOS） AudioEvaluation：音频无参考评分（MOS） Mosaic：马赛克检测 CrashScreen：花屏检测 Blur：模糊检测 Jitter：抖动检测 Noise：噪点检测 QRCode：二维码检测 BarCode：条形码检测 AppletCode：小程序码检测 BlackWhiteEdge：黑白边检测 SolidColorScreen：纯色屏检测 LowLighting：低光照 HighLighting：过曝 NoVoice：静音检测 LowVoice：低音检测 Hi...", "example": "Mosaic" }, { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" }, { "name": "Sampling", "type": "string", "required": false, "description": "采样方式，取值范围： - Time：根据时间间隔采样。 注意：此字段可能返回 null，表示取不到有效值。", "example": "Time" }, { "name": "IntervalTime", "type": "integer", "required": false, "description": "采样间隔时间，单位：ms。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1000" }, { "name": "Duration", "type": "integer", "required": false, "description": "异常持续时间，单位：ms。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1000" }, { "name": "Threshold", "type": "string", "required": false, "description": "检测项对应的阈值，不同检测项对应阈值不同。 注意：此字段可能返回 null，表示取不到有效值。", "example": "80" } ] }, { "name": "Comment", "type": "string", "required": false, "description": "媒体质检模板描述信息，长度限制：256 个字符。", "example": "模板1" }, { "name": "RecordFormat", "type": "string", "required": false, "description": "录制文件格式。可选值： PNG: PNG图片", "example": "PNG" }, { "name": "Strategy", "type": "object", "required": false, "description": "媒体质检抽检策略。", "example": "{ \"StrategyType\": \"TimeSpotCheck\", \"TimeSpotCheck\": { \"CheckDuration\": 50, \"CheckInterval\": 10, \"SkipDuration\": 10, \"CirclesNumber\": 10 } }", "children": [ { "name": "StrategyType", "type": "string", "required": false, "description": "策略类型。取值： - TimeSpotCheck", "example": "TimeSpotCheck" }, { "name": "TimeSpotCheck", "type": "object", "required": false, "description": "根据时间的抽检策略。", "example": "无", "children": [ { "name": "CheckDuration", "type": "integer", "required": false, "description": "每次循环检测的时长。取值范围（单位s）： - 最小值：10 - 最大值：86400", "example": "30" }, { "name": "CheckInterval", "type": "integer", "required": false, "description": "抽检间隔，表示在一次检测结束后，等待多长时间后，再次检测。取值范围（单位 s）： - 最小值：10 - 最大值：3600", "example": "30" }, { "name": "SkipDuration", "type": "integer", "required": false, "description": "片头跳过时长。取值范围（单位 s）： - 最小值：1 - 最大值：1800", "example": "60" }, { "name": "CirclesNumber", "type": "integer", "required": false, "description": "循环次数。取值范围: - 最小值：0 - 最大值：1000 取值为 0 或为空时，表示循环至视频结束。", "example": "10" } ] } ] } ], "required": [ "Name", "QualityControlItemSet" ] }, { "name": "CreateSampleSnapshotTemplate", "description": "创建用户自定义采样截图模板，数量上限：16。", "status": "online", "parameters": [ { "name": "SampleType", "type": "string", "required": true, "description": "采样截图类型，取值： Percent：按百分比。 Time：按时间间隔。", "example": "Percent" }, { "name": "SampleInterval", "type": "integer", "required": true, "description": "采样间隔。 当 SampleType 为 Percent 时，指定采样间隔的百分比。 当 SampleType 为 Time 时，指定采样间隔的时间，单位为秒。", "example": "10" }, { "name": "Name", "type": "string", "required": false, "description": "采样截图模板名称，长度限制：64 个字符。", "example": "采样截图模板1" }, { "name": "Width", "type": "integer", "required": false, "description": "截图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "540" }, { "name": "Height", "type": "integer", "required": false, "description": "截图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "960" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。 默认值：open。", "example": "open" }, { "name": "Format", "type": "string", "required": false, "description": "图片格式，取值为 jpg、png、webp。默认为 jpg。", "example": "jpg" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "采样截图模板" }, { "name": "FillType", "type": "string", "required": false, "description": "填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“； black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。 white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。 gauss：高斯模糊，保持视频...", "example": "black " } ], "required": [ "SampleType", "SampleInterval" ] }, { "name": "CreateSchedule", "description": "对 COS 中指定 Bucket 的目录下上传的媒体文件，设置处理规则，包括： 1. 视频转码（带水印）； 2. 视频转动图； 3. 对视频按指定时间点截图； 4. 对视频采样截图； 5. 对视频截图雪碧图； 6. 对视频转自适应码流； 7. 智能内容审核（鉴黄、敏感信息检测）； 8. 智能内容分析（标签、分类、封面、按帧标签）； 9. 智能内容识别（人脸、文本全文、文本关键词、语音全文、语音关\ufffd...", "status": "online", "parameters": [ { "name": "ScheduleName", "type": "string", "required": true, "description": "编排名称，最多128字符。同一个用户该名称唯一。", "example": "trans-100020-100030-100040" }, { "name": "Trigger", "type": "object", "required": true, "description": "编排绑定的触发规则，当上传视频命中该规则到该对象时即触发编排。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "触发器的类型，可选值： CosFileUpload：COS触发 AwsS3FileUpload：AWS触发，目前只支持转码任务。只有编排支持，工作流不支持。", "example": "CosFileUpload" }, { "name": "CosFileUploadTrigger", "type": "object", "required": false, "description": "当 Type 为 CosFileUpload 时必填且有效，为 COS 触发规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "工作流绑定的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "CosVideoFile-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "工作流绑定的 COS Bucket 所属园区，如 ap-chongiqng。", "example": "ap-nanjing" }, { "name": "Dir", "type": "string", "required": false, "description": "工作流绑定的输入路径目录，必须为绝对路径，即以 `/` 开头和结尾。如`/movie/201907/`，不填代表根目录`/`。", "example": "/trigger-dir/" }, { "name": "Formats", "type": "array", "required": false, "description": "支持的所有格式如下： - 视频文件扩展名，支持以下选择，共15种： `.mp4`、`.avi`、`.mov`、`.wmv`、`.flv`、`.mkv`、`.mpg`、`.mpeg`、`.rm`、`.rmvb`、`.asf`、`.3gp`、`.webm`、`.ts`、`.m4v` - 音频文件扩展名，支持以下选择，共7种： `.mp3`、`.wav`、`.aac`、`.flac`、`.ogg`、`.m4a`、`.amr` - 字幕文件扩展名，支持以下选择，共2种： `.vtt`、`.srt` - `*`：支持任意文件格式 - 不传或者传空列表：支持系统预设\ufffd\ufffd...", "example": "[\"mp4\",\"flv\",\"mov\"]", "item_type": "string" } ] }, { "name": "AwsS3FileUploadTrigger", "type": "object", "required": false, "description": "当 Type 为 AwsS3FileUpload 时必填且有效，为 AWS S3 触发规则。 注意：目前AWS的S3、对应触发队列SQS、回调队列SQS的秘钥需要一致。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "绑定的 AWS S3 存储桶。", "example": "mps-test-s3" }, { "name": "S3Region", "type": "string", "required": true, "description": "绑定的桶所在 AWS 区域，目前支持： us-east-1 eu-west-3", "example": "us-east-1 " }, { "name": "Dir", "type": "string", "required": false, "description": "绑定的输入路径目录，必须为绝对路径，即以 `/` 开头和结尾。如`/movie/201907/`，不填代表根目录`/`。", "example": "/Dir/" }, { "name": "Formats", "type": "array", "required": false, "description": "允许触发的文件格式列表，如 [\"mp4\", \"flv\", \"mov\"]。不填代表所有格式的文件都可以触发工作流。", "example": "[\"mp4\", \"flv\", \"mov\"]", "item_type": "string" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "绑定的 AWS S3 存储桶的秘钥ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "绑定的 AWS S3 存储桶的秘钥Key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "绑定的 AWS S3 存储桶对应的 SQS事件队列。 注意：队列和桶需要在同一区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] } ] } ] }, { "name": "Activities", "type": "array", "required": true, "description": "编排任务列表。", "example": "无", "item_type": "object", "children": [ { "name": "ActivityType", "type": "string", "required": true, "description": "原子任务类型： input: 起始节点 output：终止节点 action-trans：转码 action-samplesnapshot：采样截图 action-AIAnalysis: 分析 action-AIRecognition：识别 action-aiReview：审核 action-animated-graphics：转动图 action-image-sprite：雪碧图 action-snapshotByTimeOffset: 时间点截图 action-adaptive-substream：自适应码流 action-AIQualityControl：媒体质检 action-SmartSubtitles：智能字幕 action-exec-rules：判断规则 action-SmartErase：智能擦...", "example": "input" }, { "name": "ReardriveIndex", "type": "array", "required": false, "description": "后驱节点索引数组", "example": "[3]", "item_type": "integer" }, { "name": "ActivityPara", "type": "object", "required": false, "description": "原子任务参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "TranscodeTask", "type": "object", "required": false, "description": "视频转码任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频转码模板 ID。", "example": "20" }, { "name": "RawParameter", "type": "object", "required": false, "description": "视频转码自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定转码参数。", "example": "无" }, { "name": "OverrideParameter", "type": "object", "required": false, "description": "视频转码自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分转码参数时，将使用填写的参数覆盖转码模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "string" }, { "name": "BlindWatermark", "type": "object", "required": false, "description": "数字水印参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "MosaicSet", "type": "array", "required": false, "description": "马赛克列表，最大可支持 10 张。", "example": "无", "item_type": "string" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "转码后的视频的起始时间偏移，单位：秒。 不填或填0，表示转码后的视频从原始视频的起始位置开始； 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始； 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。", "example": "1.0" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "转码后视频的终止时间偏移，单位：秒。 不填或填0，表示转码后的视频持续到原始视频的末尾终止； 当数值大于0时（假设为 n），表示转码后的视频持续到原始视频第 n 秒时终止； 当数值小于0时（假设为 -n），表示转码后的视频持续到原始视频结束 n 秒前终止。", "example": "15.0" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转码后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转码后主文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_transcode_{definition}.{format}`。", "example": "{inputName}_transcode_{definition}.{format}" }, { "name": "SegmentObjectName", "type": "string", "required": false, "description": "转码后分片文件的输出路径（转码 HLS 时 ts 的路径），只能为相对路径。如果不填，则默认为：`{inputName}_transcode_{definition}_{number}.{format}`。", "example": "{inputName}_transcode_{definition}_{number}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "转码后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HeadTailParameter", "type": "object", "required": false, "description": "片头片尾参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "AnimatedGraphicTask", "type": "object", "required": false, "description": "视频转动图任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频转动图模板 ID。", "example": "20000" }, { "name": "StartTimeOffset", "type": "float", "required": true, "description": "动图在视频中的开始时间，单位为秒。", "example": "1.5" }, { "name": "EndTimeOffset", "type": "float", "required": true, "description": "动图在视频中的结束时间，单位为秒。", "example": "11.2" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转动图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转动图后文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_animatedGraphic_{definition}.{format}`。", "example": "文件名_{变量名}.{format}" } ] }, { "name": "SnapshotByTimeOffsetTask", "type": "object", "required": false, "description": "视频按时间点截图任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "指定时间点截图模板 ID。", "example": "11028" }, { "name": "ExtTimeOffsetSet", "type": "array", "required": false, "description": "截图时间点列表，时间点支持 s、% 两种格式： 当字符串以 s 结尾，表示时间点单位为秒，如 3.5s 表示时间点为第3.5秒； 当字符串以 % 结尾，表示时间点为视频时长的百分比大小，如10%表示时间点为视频前第10%的时间。", "example": "[\"3.5s\", \"50%\"]", "item_type": "string" }, { "name": "TimeOffsetSet", "type": "array", "required": false, "description": "截图时间点列表，单位为秒。此参数已不再建议使用，建议您使用 ExtTimeOffsetSet 参数。", "example": "[7.5, 10]", "item_type": "float" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "string" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "时间点截图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "时间点截图后图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_snapshotByTimeOffset_{definition}_{number}.{format}`\ufffd...", "example": "/mps/output/{inputName}_test_{definition}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "时间点截图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "SampleSnapshotTask", "type": "object", "required": false, "description": "视频采样截图任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "采样截图模板 ID。", "example": "10" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "string" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "采样截图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "采样截图后图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_sampleSnapshot_{definition}_{number}.{format}`。", "example": "/{inputName}_snapshotByTimeOffsetTest_{definition}_{number}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "采样截图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ImageSpriteTask", "type": "object", "required": false, "description": "视频截雪碧图任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "雪碧图模板 ID。", "example": "10001" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "截取雪碧图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "截取雪碧图后，雪碧图图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_imageSprite_{definition}_{number}.{format...", "example": "xxx_imageSprite_10001_0.png" }, { "name": "WebVttObjectName", "type": "string", "required": false, "description": "截取雪碧图后，Web VTT 文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_imageSprite_{definition}.{format}`。", "example": "xxx_imageSprite_10001_0.vtt" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "截取雪碧图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "AdaptiveDynamicStreamingTask", "type": "object", "required": false, "description": "转自适应码流任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "转自适应码流模板 ID。", "example": "10" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "string" }, { "name": "BlindWatermark", "type": "object", "required": false, "description": "数字水印参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转自适应码流后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转自适应码流后，manifest 文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：{inputName}_adaptiveDynamicStreaming_{definition}.{format...", "example": "{inputName}_adaptiveDynamicStreaming_{definition}.{format}" }, { "name": "SubStreamObjectName", "type": "string", "required": false, "description": "转自适应码流后，子流文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}`。", "example": "{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}" }, { "name": "SegmentObjectName", "type": "string", "required": false, "description": "转自适应码流（仅 HLS）后，分片文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}`。", "example": "{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}" }, { "name": "AddOnSubtitles", "type": "array", "required": false, "description": "外挂字幕功能，指定要插入的字幕文件。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "DrmInfo", "type": "object", "required": false, "description": "Drm信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "DefinitionType", "type": "string", "required": false, "description": "自适应转码模板类型： Common：音视频类型 PureAudio：纯音频类型", "example": "Common" }, { "name": "SubtitleTemplate", "type": "object", "required": false, "description": "硬字幕（压制字幕）功能，指定字幕来源、字体大小、位置等字幕参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "转码参数扩展字段", "example": "{\"audio_info\": {\"codec\": \"vivid\"}}" }, { "name": "KeyPTSList", "type": "array", "required": false, "description": "指定pts时间的帧设为关键帧，并切片。单位毫秒（允许相对偏差\u003c=1ms）。当同时指定gop和切片时长时，会共同作用。注意需开启RawPts，保持帧率随源，并确保传入的pts时间在源中是有对应帧的。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[1000, 2000]", "item_type": "integer" } ] }, { "name": "AiContentReviewTask", "type": "object", "required": false, "description": "视频内容审核类型任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容审核模板 ID。", "example": "10" } ] }, { "name": "AiAnalysisTask", "type": "object", "required": false, "description": "视频内容分析类型任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容分析模板 ID。", "example": "28" }, { "name": "ExtendedParameter", "type": "string", "required": false, "description": "扩展参数，其值为序列化的 json字符串。 注意：此参数为定制需求参数，参考如下： [智能檫除](https://cloud.tencent.com/document/product/862/101530) [智能拆条](https://cloud.tencent.com/document/product/862/112098) [高光集锦](https://cloud.tencent.com/document/product/862/107280) [智能横转竖](https://cloud.tencent.com/document/product/862/112112) 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"{\\\"htv\\\": {} }\"" } ] }, { "name": "AiRecognitionTask", "type": "object", "required": false, "description": "视频内容识别类型任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频智能识别模板 ID 。", "example": "10" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "用户扩展字段，一般场景不用填。", "example": "{\"ParaTest\":\"test\"}" } ] }, { "name": "QualityControlTask", "type": "object", "required": false, "description": "媒体质检任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": false, "description": "媒体质检模板 ID 。 可以直接使用预设模板，也可以在控制台自定义模板。预设模板如下： - 10：开启所有质检项； - 20：仅开启格式诊断对应质检项； - 30：仅开启无参考打分对应质检项； - 40：仅开启画面质量对应质检项。 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "ChannelExtPara", "type": "string", "required": false, "description": "渠道扩展参数json序列化字符串。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\\\"OutputDir\\\":\\\"/test/output/1abc***12345/\\\"}" } ] }, { "name": "ExecRulesTask", "type": "object", "required": false, "description": "任务条件判断 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "条件判断信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "SmartSubtitlesTask", "type": "object", "required": false, "description": "智能字幕任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": false, "description": "智能字幕模板 ID 。", "example": "110167" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "用户扩展字段，一般场景不用填。", "example": "用户扩展字段" }, { "name": "RawParameter", "type": "object", "required": false, "description": "智能字幕自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定智能字幕参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "媒体处理输出文件的目标存储。不填则继承 InputInfo 中的存储位置。 **注意**：当InputInfo.Type为URL时，该参数是必填项。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{ \"Type\": \"COS\", \"CosOutputStorage\": { \"Bucket\": \"xxxx-yyy\", \"Region\": \"region\" } }" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "生成字幕文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例: - 文件名_{变量名}.{format} - 文件名.{format} 绝对路径示例： - /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径: `{inputName}_smartsubtitle_{definition}.{format}`。", "example": "/storage/{inputName}_smartsubtitle_{definition}.{format}" } ] }, { "name": "SmartEraseTask", "type": "object", "required": false, "description": "智能擦除任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": false, "description": "智能擦除模板id。", "example": "101" }, { "name": "RawParameter", "type": "object", "required": false, "description": "智能擦除自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定智能擦除参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OverrideParameter", "type": "object", "required": false, "description": "智能擦除自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分擦除参数时，将使用填写的参数覆盖智能擦除模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定智能擦除参数。", "example": "无" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} **注意**：目前不支持`BatchProcessMedia`接口。", "example": "{inputName}_smarterase.{format}" } ] } ] } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "媒体处理的文件输出存储位置。不填则继承 Trigger 中的存储位置。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputDir", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标目录，必选以 / 开头和结尾，如`/movie/201907/`。 如果不填，表示与触发文件所在的目录一致。", "example": "/tmp/" }, { "name": "TaskNotifyConfig", "type": "object", "required": false, "description": "任务的事件通知配置，不填代表不获取事件通知。", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型，可选值： CMQ：已下线，建议切换到TDMQ-CMQ TDMQ-CMQ：消息队列 URL：指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同解析事件通知接口的输出参数 SCF：不推荐使用，需要在控制台额外配置SCF AWS-SQS：AWS 队列，只适用于 AWS 任务，且要求同区域 注：不填或为空时默认 TDMQ-CMQ，如需采用其他类型需填写对应类型值；如果使用TDMQ-CMQ消息队列，任务\ufffd...", "example": "URL" }, { "name": "NotifyMode", "type": "string", "required": false, "description": "工作流通知的模式，可取值有 Finish 和 Change，不填代表 Finish。", "example": "Finish " }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的模型，有 Queue 和 Topic 两种。", "example": "Queue " }, { "name": "CmqRegion", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。", "example": "mps_notify" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。", "example": "mps_que" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "AWS SQS 回调，NotifyType为 AWS-SQS 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NULL", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的key。", "example": "0se***9idaY" } ] }, { "name": "ResourceId", "type": "string", "required": false, "description": "资源ID，需要保证对应资源是开启状态。默认为账号主资源ID。", "example": "vts-213xxxx02-0" } ], "required": [ "ScheduleName", "Trigger", "Activities" ] }, { "name": "CreateSmartEraseTemplate", "description": "创建自定义智能擦除模板", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "智能擦除模板名称长度限制：64 个字符。", "example": "智能擦除模板" }, { "name": "EraseType", "type": "string", "required": true, "description": "擦除类型 - subtitle 去字幕 - watermark 去水印 - privacy 隐私保护", "example": "subtitle" }, { "name": "Comment", "type": "string", "required": false, "description": "智能擦除模板描述信息长度限制：256 个字符。", "example": "模板2" }, { "name": "EraseSubtitleConfig", "type": "object", "required": false, "description": "字幕擦除配置，EraseType取subtitle时必填且仅此时生效。", "example": "无", "children": [ { "name": "SubtitleEraseMethod", "type": "string", "required": true, "description": "字幕擦除方式。 **自动擦除：**通过AI模型自动识别视频中的字幕文本内容，进行无痕化擦除，生成新的视频。但画面干扰、特殊字幕样式可能会带来一定漏擦误擦问题，可以通过指定区域擦除处理。 当使用自动擦除时，若您不指定AutoAreas，将对默认区域（画面中下部）进行自动擦除；若指定AutoAreas，将改为对您指定的区域进行自动擦除。 **指定区域擦除：**若您的字幕位置较\ufffd...", "example": "auto" }, { "name": "SubtitleModel", "type": "string", "required": true, "description": "字幕擦除模型。 **标准版（推荐）：**若您的字幕样式标准，通常建议选择该版本，细节无痕化效果更好。 **区域版：**若您的字幕存在花体、阴影、动效等特殊样式，建议选择区域版，擦除面积更大，但细节效果不如标准版。 - standard 标准模型 - area 区域模型", "example": "standard" }, { "name": "OcrSwitch", "type": "string", "required": false, "description": "是否开启OCR字幕提取，默认取OFF。 当且仅当SubtitleEraseMethod取auto时支持开启OCR字幕提取，开启后将识别自动擦除区域内出现时间最长且最稳定的文字区域为字幕区域，对字幕区域中的文字进行提取和擦除。 - ON 开启 - OFF 关闭", "example": "ON" }, { "name": "SubtitleLang", "type": "string", "required": false, "description": "字幕语言，用于指导OCR识别，默认取zh_en；仅当OcrSwitch取\"ON\"时生效。 - zh_en 中英文 - multi 其他 其他具体支持识别如下语言： 中文、英文、日文、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语、印地语、阿拉伯语、印度-孟加拉语、印度-古吉拉特语、印度-卡纳达语 、印度-马拉亚拉姆\ufffd...", "example": "zh_en" }, { "name": "SubtitleFormat", "type": "string", "required": false, "description": "字幕文件格式，默认取vtt；仅当OcrSwitch取\"ON\"时生效。 - srt srt格式 - vtt WebVTT格式", "example": "vtt" }, { "name": "TransSwitch", "type": "string", "required": false, "description": "是否开启字幕翻译，默认取OFF；仅当OcrSwitch取\"ON\"时生效。 - ON 开启 - OFF 关闭", "example": "ON" }, { "name": "TransDstLang", "type": "string", "required": false, "description": "字幕翻译目标语言，默认取en；仅当TransSwitch取\"ON\"时生效。 当前支持以下语言： zh：简体中文 en：英语 ja：日语 ko：韩语 fr：法语 es：西班牙语 it：意大利语 de：德语 tr：土耳其语 ru：俄语 pt：葡萄牙语 vi：越南语 id：印度尼西亚语 ms：马来语 th：泰语 ar：阿拉伯语 hi：印地语", "example": "en" }, { "name": "AutoAreas", "type": "array", "required": false, "description": "自动擦除自定义区域。 对选定区域，利用AI模型自动检测其中存在的擦除目标并擦除。 注意：当擦除方式选择custom时，此参数将不会生效；修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "object", "children": [ { "name": "LeftTopX", "type": "float", "required": true, "description": "区域左上角X坐标。 如当Unit取1即使用百分比单位时，0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。", "example": "0.0500" }, { "name": "LeftTopY", "type": "float", "required": true, "description": "区域左上角Y坐标。 如当Unit取1即使用百分比单位时，0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。", "example": "0.1000" }, { "name": "RightBottomX", "type": "float", "required": true, "description": "区域右下角X坐标。 如当Unit取1即使用百分比单位时，0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。", "example": "0.7500" }, { "name": "RightBottomY", "type": "float", "required": true, "description": "区域右下角Y坐标。 如当Unit取1即使用百分比单位时，0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。", "example": "0.9000" }, { "name": "Unit", "type": "integer", "required": true, "description": "坐标单位 - 1 百分比 - 2 像素值", "example": "1" } ] }, { "name": "CustomAreas", "type": "array", "required": false, "description": "指定擦除自定义区域。 对选定区域，在选定时间段内不进行检测识别直接进行擦除。 注意：修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "object", "children": [ { "name": "BeginMs", "type": "integer", "required": true, "description": "开始时间，单位:毫秒", "example": "200" }, { "name": "EndMs", "type": "integer", "required": true, "description": "结束时间，单位:毫秒", "example": "3000" }, { "name": "Areas", "type": "array", "required": true, "description": "时间段内擦除区域列表", "example": "无", "item_type": "object", "children": [ { "name": "LeftTopX", "type": "float", "required": true, "description": "区域左上角X坐标。 如当Unit取1即使用百分比单位时，0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。", "example": "0.0500" }, { "name": "LeftTopY", "type": "float", "required": true, "description": "区域左上角Y坐标。 如当Unit取1即使用百分比单位时，0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。", "example": "0.1000" }, { "name": "RightBottomX", "type": "float", "required": true, "description": "区域右下角X坐标。 如当Unit取1即使用百分比单位时，0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。", "example": "0.7500" }, { "name": "RightBottomY", "type": "float", "required": true, "description": "区域右下角Y坐标。 如当Unit取1即使用百分比单位时，0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。", "example": "0.9000" }, { "name": "Unit", "type": "integer", "required": true, "description": "坐标单位 - 1 百分比 - 2 像素值", "example": "1" } ] } ] } ] }, { "name": "EraseWatermarkConfig", "type": "object", "required": false, "description": "水印擦除配置，EraseType取watermark时必填且仅此时生效。", "example": "无", "children": [ { "name": "WatermarkEraseMethod", "type": "string", "required": true, "description": "水印擦除方式。 **自动擦除：**通过A模型自动识别视频中的水印，擦除后生成新的视频。适用于动态水印。 当使用自动擦除时，若您不指定AutoAreas，将对视频全屏进行自动擦除；若指定AutoAreas，将改为对您指定的区域进行自动擦除。 **指定区域擦除：**针对位置较固定的静态水印，建议您直接指定擦除区域。 当您选择指定区域擦除时，请至少传入一个指定区域。 - auto 自动擦\ufffd\ufffd...", "example": "auto" }, { "name": "WatermarkModel", "type": "string", "required": true, "description": "水印擦除模型。 基础版：效果一般，性价比高，适合动画或背景较干净的视频。 高级版：效果更好，适合短剧等现实风格视频。 - basic 基础版 - advanced 高级版", "example": "advanced" }, { "name": "AutoAreas", "type": "array", "required": false, "description": "自动擦除自定义区域。 对选定区域，利用AI模型自动检测其中存在的擦除目标并擦除。 注意，当擦除方式为custom时，此参数将不会生效。修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "object", "children": [ { "name": "LeftTopX", "type": "float", "required": true, "description": "区域左上角X坐标。 如当Unit取1即使用百分比单位时，0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。", "example": "0.0500" }, { "name": "LeftTopY", "type": "float", "required": true, "description": "区域左上角Y坐标。 如当Unit取1即使用百分比单位时，0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。", "example": "0.1000" }, { "name": "RightBottomX", "type": "float", "required": true, "description": "区域右下角X坐标。 如当Unit取1即使用百分比单位时，0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。", "example": "0.7500" }, { "name": "RightBottomY", "type": "float", "required": true, "description": "区域右下角Y坐标。 如当Unit取1即使用百分比单位时，0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。", "example": "0.9000" }, { "name": "Unit", "type": "integer", "required": true, "description": "坐标单位 - 1 百分比 - 2 像素值", "example": "1" } ] }, { "name": "CustomAreas", "type": "array", "required": false, "description": "指定擦除自定义区域。 对选定区域，在选定时间段内不进行检测识别直接进行擦除。 注意：修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "object", "children": [ { "name": "BeginMs", "type": "integer", "required": true, "description": "开始时间，单位:毫秒", "example": "200" }, { "name": "EndMs", "type": "integer", "required": true, "description": "结束时间，单位:毫秒", "example": "3000" }, { "name": "Areas", "type": "array", "required": true, "description": "时间段内擦除区域列表", "example": "无", "item_type": "object", "children": [ { "name": "LeftTopX", "type": "float", "required": true, "description": "区域左上角X坐标。 如当Unit取1即使用百分比单位时，0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。", "example": "0.0500" }, { "name": "LeftTopY", "type": "float", "required": true, "description": "区域左上角Y坐标。 如当Unit取1即使用百分比单位时，0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。", "example": "0.1000" }, { "name": "RightBottomX", "type": "float", "required": true, "description": "区域右下角X坐标。 如当Unit取1即使用百分比单位时，0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。", "example": "0.7500" }, { "name": "RightBottomY", "type": "float", "required": true, "description": "区域右下角Y坐标。 如当Unit取1即使用百分比单位时，0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。", "example": "0.9000" }, { "name": "Unit", "type": "integer", "required": true, "description": "坐标单位 - 1 百分比 - 2 像素值", "example": "1" } ] } ] } ] }, { "name": "ErasePrivacyConfig", "type": "object", "required": false, "description": "隐私保护配置，EraseType取privacy时必填且仅此时生效。", "example": "无", "children": [ { "name": "PrivacyModel", "type": "string", "required": true, "description": "隐私保护擦除方式。 - blur 模糊 - mosaic 马赛克", "example": "blur" }, { "name": "PrivacyTargets", "type": "array", "required": true, "description": "隐私保护目标，（在API Explorer上使用时无需传入数组，添加相应项并填入对应值即可）。 - face 人脸 - plate 车牌", "example": "[\"face\",\"plate\"]", "item_type": "string" } ] } ], "required": [ "Name", "EraseType" ] }, { "name": "CreateSmartSubtitleTemplate", "description": "创建自定义智能字幕模板", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "智能字幕模板名称 长度限制：64 个字符。", "example": "智能字幕模板" }, { "name": "VideoSrcLanguage", "type": "string", "required": true, "description": "智能字幕视频源语言 OCR识别仅支持以下语言： `zh_en`：中英 `multi`：其他 ASR识别和纯字幕翻译当前支持以下语言： `auto`：自动识别（仅在纯字幕翻译中支持） `zh`：简体中文 `en`：英语 `ja`：日语 `ko`：韩语 `zh-PY`：中英粤 `zh_medical`：中文医疗 `vi`：越南语 `ms`：马来语 `id`：印度尼西亚语 `fil`：菲律宾语 `th`：泰语 `pt`：葡萄牙语 `tr`：土耳其语 `ar`：阿拉伯语 `es`：西班牙语 `hi`\ufffd\ufffd...", "example": "zh" }, { "name": "SubtitleType", "type": "integer", "required": true, "description": "智能字幕字幕语言类型 0: 源语言 1: 翻译语言 2: 源语言+翻译语言 当TranslateSwitch为OFF时仅支持取0 当TranslateSwitch为ON时仅支持取1或2", "example": "0" }, { "name": "Comment", "type": "string", "required": false, "description": "智能字幕模板描述信息 长度限制：256 个字符。", "example": "模板2" }, { "name": "SubtitleFormat", "type": "string", "required": false, "description": "智能字幕文件格式: - ASR识别翻译处理类型下： - vtt: WebVTT 格式字幕 - srt: SRT 格式字幕 - 不填或填空：不生成字幕文件 - 纯字幕翻译处理类型下： - original：与源文件一致 - vtt: WebVTT 格式字幕 - srt: SRT 格式字幕 - OCR识别翻译处理类型下： - vtt: WebVTT 格式字幕 - srt: SRT 格式字幕 **注意**： - ASR识别方式下，翻译大于等于2种语言时不允许传空或不传； - 纯字幕翻译和OCR识别翻译方式\ufffd\ufffd...", "example": "vtt" }, { "name": "AsrHotWordsConfigure", "type": "object", "required": false, "description": "ASR热词库参数", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "热词开关 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" }, { "name": "LibraryId", "type": "string", "required": false, "description": "热词库ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "hwd-2670a776bb5eccccc324" } ] }, { "name": "TranslateSwitch", "type": "string", "required": false, "description": "字幕翻译开关 `ON`: 开启翻译 `OFF`: 关闭翻译 **注意**：纯字幕翻译方式下，不传默认是打开的，不允许传空或`OFF`；", "example": "ON" }, { "name": "TranslateDstLanguage", "type": "string", "required": false, "description": "字幕翻译目标语言 当TranslateSwitch为ON的时候生效，翻译语言列表： `ab`：阿布哈兹语 `ace`：亚齐语 `ach`：阿乔利语 `af`：南非荷兰语 `ak`：契维语（阿坎语） `am`：Amharic `ar`：阿拉伯语 `as`：阿萨姆语 `ay`：艾马拉语 `az`：阿塞拜疆语 `ba`：巴什基尔语 `ban`：巴厘语 `bbc`：巴塔克托巴语 `bem`：Bemba `bew`：Betawi `bg`：保加利亚语 `bho`：博杰普尔语 `bik`：Bikol `bm`：班巴拉语 `bn`：孟加拉语...", "example": "en" }, { "name": "ProcessType", "type": "integer", "required": false, "description": "字幕处理类型： - 0：ASR识别字幕 - 1：纯字幕翻译 - 2：OCR识别字幕 **注意**：不传的情况下默认类型为 ASR识别字幕", "example": "0" }, { "name": "SelectingSubtitleAreasConfig", "type": "object", "required": false, "description": "字幕OCR提取框选区域配置", "example": "无", "children": [ { "name": "AutoAreas", "type": "array", "required": false, "description": "自动选择自定义区域。 对选定区域，利用AI模型自动检测其中存在的选择目标并提取。", "example": "无", "item_type": "object", "children": [ { "name": "LeftTopX", "type": "float", "required": true, "description": "区域左上角X坐标。 如当Unit取1即使用百分比单位时，0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。", "example": "0.0500" }, { "name": "LeftTopY", "type": "float", "required": true, "description": "区域左上角Y坐标。 如当Unit取1即使用百分比单位时，0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。", "example": "0.1000" }, { "name": "RightBottomX", "type": "float", "required": true, "description": "区域右下角X坐标。 如当Unit取1即使用百分比单位时，0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。", "example": "0.7500" }, { "name": "RightBottomY", "type": "float", "required": true, "description": "区域右下角Y坐标。 如当Unit取1即使用百分比单位时，0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。", "example": "0.9000" }, { "name": "Unit", "type": "integer", "required": true, "description": "坐标单位 - 1 百分比 - 2 像素值", "example": "1" } ] }, { "name": "SampleWidth", "type": "integer", "required": false, "description": "示例视频或图片的宽，单位像素值", "example": "200" }, { "name": "SampleHeight", "type": "integer", "required": false, "description": "示例视频或图片的高，单位像素值", "example": "1000" } ] } ], "required": [ "Name", "VideoSrcLanguage", "SubtitleType" ] }, { "name": "CreateSnapshotByTimeOffsetTemplate", "description": "创建用户自定义指定时间点截图模板，数量上限：16。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "指定时间点截图模板名称，长度限制：64 个字符。", "example": "指定时间点截图模板1" }, { "name": "Width", "type": "integer", "required": false, "description": "截图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "540" }, { "name": "Height", "type": "integer", "required": false, "description": "截图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "960" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。 默认值：open。", "example": "close" }, { "name": "Format", "type": "string", "required": false, "description": "图片格式，取值可以为 jpg、png、webp。默认为 jpg。", "example": "jpg" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "指定时间点截图模板" }, { "name": "FillType", "type": "string", "required": false, "description": "填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“； black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。 white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。 gauss：高斯模糊，保持视频...", "example": "black" } ], "required": [] }, { "name": "CreateStreamLinkEvent", "description": "创建媒体传输的事件Event。", "status": "online", "parameters": [ { "name": "EventName", "type": "string", "required": true, "description": "事件名称。", "example": "event_test" }, { "name": "Description", "type": "string", "required": false, "description": "事件描述。", "example": "event for test live" } ], "required": [ "EventName" ] }, { "name": "CreateStreamLinkFlow", "description": "创建媒体传输的传输流配置。", "status": "online", "parameters": [ { "name": "FlowName", "type": "string", "required": true, "description": "流名称。", "example": "pgm_flow" }, { "name": "MaxBandwidth", "type": "integer", "required": true, "description": "最大带宽，单位bps，可选[10000000, 20000000, 50000000]。", "example": "20000000" }, { "name": "InputGroup", "type": "array", "required": false, "description": "流的输入组。", "example": "无", "item_type": "object", "children": [ { "name": "InputName", "type": "string", "required": true, "description": "输入名称，可填大小写、数字和下划线，长度为[1, 32]。", "example": "input" }, { "name": "Protocol", "type": "string", "required": true, "description": "输入的协议，可选[SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST]。", "example": "SRT" }, { "name": "Description", "type": "string", "required": false, "description": "输入描述，长度为[0, 255]。", "example": "input description" }, { "name": "AllowIpList", "type": "array", "required": false, "description": "输入的IP白名单，格式为CIDR。", "example": "[\"0.0.0.0/0\"]", "item_type": "string" }, { "name": "SRTSettings", "type": "object", "required": false, "description": "输入的SRT配置信息。", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "SRT模式，可选[LISTENER|CALLER]，默认为LISTENER。", "example": "LISTENER" }, { "name": "StreamId", "type": "string", "required": false, "description": "流Id，可选大小写字母、数字和特殊字符（.#!:\u0026,=_-），长度为0~512。具体格式可以参考：https://github.com/Haivision/srt/blob/master/docs/features/access-control.md#standard-keys。", "example": "streamId" }, { "name": "Latency", "type": "integer", "required": false, "description": "延迟，默认120，单位ms，范围为[0, 3000]。", "example": "120" }, { "name": "RecvLatency", "type": "integer", "required": false, "description": "接收延迟，默认120，单位ms，范围为[0, 3000]。", "example": "0" }, { "name": "PeerLatency", "type": "integer", "required": false, "description": "对端延迟，默认120，单位ms，范围为[0, 3000]。", "example": "0" }, { "name": "PeerIdleTimeout", "type": "integer", "required": false, "description": "对端超时时间，默认5000，单位ms，范围为[1000, 10000]。", "example": "5000" }, { "name": "Passphrase", "type": "string", "required": false, "description": "解密密钥，默认为空，表示不加密。只可填ascii码值，长度为[10, 79]。", "example": "passphrase" }, { "name": "PbKeyLen", "type": "integer", "required": false, "description": "密钥长度，默认为0，可选[0|16|24|32]。", "example": "0" }, { "name": "SourceAddresses", "type": "array", "required": false, "description": "SRT对端地址，当Mode为CALLER时必填，且只能填1组。", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "对端IP或域名。", "example": "1.1.1.1" }, { "name": "Port", "type": "integer", "required": true, "description": "对端端口。", "example": "65535" } ] }, { "name": "FEC", "type": "object", "required": false, "description": "SRT FEC 设置", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": false, "description": "是否开启 FEC", "example": "false" } ] } ] }, { "name": "RTPSettings", "type": "object", "required": false, "description": "输入的RTP配置信息。", "example": "无", "children": [ { "name": "FEC", "type": "string", "required": false, "description": "默认为“none”，可选值['none']。", "example": "none" }, { "name": "IdleTimeout", "type": "integer", "required": false, "description": "空闲超时时间，默认5000，单位ms，范围为[1000, 10000]。", "example": "1000" } ] }, { "name": "FailOver", "type": "string", "required": false, "description": "输入的主备开关，可选[OPEN|CLOSE]，默认为CLOSE。", "example": "CLOSE" }, { "name": "RTMPPullSettings", "type": "object", "required": false, "description": "输入的RTMP_PULL配置信息。", "example": "无", "children": [ { "name": "SourceAddresses", "type": "array", "required": true, "description": "RTMP源站的源站地址，有且只能有一个。", "example": "无", "item_type": "object", "children": [ { "name": "TcUrl", "type": "string", "required": true, "description": "RTMP源站的TcUrl地址。", "example": "rtmp://domain/live" }, { "name": "StreamKey", "type": "string", "required": true, "description": "RTMP源站的StreamKey信息。", "example": "streamKey" } ] } ] }, { "name": "RTSPPullSettings", "type": "object", "required": false, "description": "输入的RTSP_PULL配置信息。", "example": "无", "children": [ { "name": "SourceAddresses", "type": "array", "required": true, "description": "RTSP源站的源站地址，有且只能有一个。", "example": "无", "item_type": "object", "children": [ { "name": "Url", "type": "string", "required": true, "description": "RTSP源站的Url地址。", "example": "rtsp://9.223.70.41:8806/live/streamname" } ] } ] }, { "name": "HLSPullSettings", "type": "object", "required": false, "description": "输入的HLS_PULL配置信息。", "example": "无", "children": [ { "name": "SourceAddresses", "type": "array", "required": true, "description": "HLS源站的源站地址，有且只能有一个。", "example": "无", "item_type": "object", "children": [ { "name": "Url", "type": "string", "required": true, "description": "HLS源站的Url地址。", "example": "http://testdomain.com:8806/live/streamname" } ] } ] }, { "name": "ResilientStream", "type": "object", "required": false, "description": "延播平滑吐流配置信息。", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": false, "description": "是否开启延播平滑吐流，true开启，false不开启，默认不开启。 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "BufferTime", "type": "integer", "required": false, "description": "延播时间，单位秒，目前支持的范围为10~300秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "133" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "绑定的输入安全组 ID。", "example": "[\"01937702ecc509dc0f3269ca3420\"]", "item_type": "string" }, { "name": "Zones", "type": "array", "required": false, "description": "可用区，非必填，如果开启容灾必须输入两个不同的可用区，否则最多只允许输入一个可用区。", "example": "[\"ap-shanghai-1\"]", "item_type": "string" }, { "name": "RISTSettings", "type": "object", "required": false, "description": "输入的RIST配置信息。", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "RIST模式，可选[LISTENER]，默认为LISTENER。", "example": "LISTENER" }, { "name": "Profile", "type": "string", "required": false, "description": "RIST配置方案，可选[MAIN|SIMPLE]，默认为MAIN。", "example": "MAIN" }, { "name": "Buffer", "type": "integer", "required": false, "description": "RIST缓冲区大小，单位为毫秒。最小值为50毫秒，最大值为5000毫秒。默认值：120", "example": "120" } ] }, { "name": "InputRegion", "type": "string", "required": false, "description": "输入节点的地区", "example": "ap-mumbai" }, { "name": "FailOverOption", "type": "object", "required": false, "description": "冷热备相关", "example": "无", "children": [ { "name": "FailOverType", "type": "string", "required": false, "description": "热备", "example": "HOTSTANDBY" } ] } ] }, { "name": "EventId", "type": "string", "required": false, "description": "该Flow关联的媒体传输事件ID，每个flow只能关联一个Event。", "example": "01937702c54509dc0f3269ca341f" }, { "name": "OutputGroup", "type": "array", "required": false, "description": "流的输出组。", "example": "无", "item_type": "object", "children": [ { "name": "OutputName", "type": "string", "required": true, "description": "输出的名称。", "example": "OutputName" }, { "name": "Description", "type": "string", "required": true, "description": "输出描述。", "example": "OutputName" }, { "name": "Protocol", "type": "string", "required": true, "description": "输出的转推协议，支持SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST。", "example": "SRT" }, { "name": "OutputRegion", "type": "string", "required": true, "description": "输出地区。", "example": "ap-hongkong" }, { "name": "OutputType", "type": "string", "required": false, "description": "输出类型：Internet/TencentCSS", "example": "TencentCSS" }, { "name": "OutputKind", "type": "string", "required": false, "description": "输出模块类型，包括Pinpoint（单点输出，最多支持四路并发输出）；MultiMesh（多路输出，支持大于四路的并发输出，目前可以达到200路）。默认类型为 Pinpoint 输出。对于单个 Flow 一个区域最多只能有一个 MultiMesh 输出", "example": "Pinpoint" }, { "name": "SRTSettings", "type": "object", "required": false, "description": "输出的SRT的配置。", "example": "无", "children": [ { "name": "Destinations", "type": "array", "required": true, "description": "转推的目标地址，当Mode为CALLER时必填，且只能填1组。", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "输出的IP或域名。", "example": "0.0.0.0" }, { "name": "Port", "type": "integer", "required": true, "description": "输出的端口。", "example": "10" } ] }, { "name": "StreamId", "type": "string", "required": false, "description": "转推SRT的流Id，可选大小写字母、数字和特殊字符（.#!:\u0026,=_-），长度为0~512。", "example": "StreamId" }, { "name": "Latency", "type": "integer", "required": false, "description": "转推SRT的延迟，默认120，单位ms，范围为[0, 3000]。此参数同时设置了发送方和接收方的延迟（recvlatency和peerlatency）为相同的值。建议配置为至少3倍RTT，以确保在网络拥塞时能够有效处理数据包的重传和确认", "example": "120" }, { "name": "RecvLatency", "type": "integer", "required": false, "description": "转推SRT的接收延迟，默认120，单位ms，范围为[0, 3000]。 此参数表示接收方用于缓存数据包的时间长度", "example": "0" }, { "name": "PeerLatency", "type": "integer", "required": false, "description": "转推SRT的对端延迟，默认120，单位ms，范围为[0, 3000]。 此参数由发送方设置，用于告知接收方其期望的延迟缓冲时间", "example": "0" }, { "name": "PeerIdleTimeout", "type": "integer", "required": false, "description": "转推SRT的对端空闲超时时间，默认5000，单位ms，范围为[1000, 10000]。 如果连接在设定的超时时间内没有活动，将会被关闭", "example": "5000" }, { "name": "Passphrase", "type": "string", "required": false, "description": "转推SRT的加密密钥，默认为空，表示不加密。只可填ascii码值，长度为[10, 79]。", "example": "passphrase" }, { "name": "PbKeyLen", "type": "integer", "required": false, "description": "转推SRT的密钥长度，默认为0，可选[0|16|24|32]。", "example": "0" }, { "name": "Mode", "type": "string", "required": false, "description": "SRT模式，可选[LISTENER|CALLER]，默认为CALLER。", "example": "CALLER" }, { "name": "FEC", "type": "object", "required": false, "description": "SRT FEC 设置", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": false, "description": "是否开启 FEC", "example": "true" }, { "name": "Cols", "type": "integer", "required": false, "description": "FEC 数据包 Layout 列数量. 取值范围\u003e0", "example": "3" }, { "name": "Rows", "type": "integer", "required": false, "description": "FEC 数据包 Layout 行数量. 取值范围 \u003e=2 或者 \u003c=-2", "example": "1" }, { "name": "ARQ", "type": "string", "required": false, "description": "FEC 开启的情况下，ARQ的策略。取值 \"always\", \"onreq\", \"never\"", "example": "always" }, { "name": "Layout", "type": "string", "required": false, "description": "FEC 数据包 Layout 组织形式，取值 \"even\", \"staircase\"", "example": "staircase" } ] } ] }, { "name": "RTMPSettings", "type": "object", "required": false, "description": "输出的RTMP的配置。", "example": "无", "children": [ { "name": "Destinations", "type": "array", "required": true, "description": "转推的目标地址，可填1~2个。", "example": "your address", "item_type": "object", "children": [ { "name": "Url", "type": "string", "required": true, "description": "转推的URL，格式如：rtmp://domain/live。", "example": "rtmp://example.com/live" }, { "name": "StreamKey", "type": "string", "required": true, "description": "转推的StreamKey，格式如：stream?key=value。", "example": "stream_key" } ] }, { "name": "ChunkSize", "type": "integer", "required": false, "description": "RTMP的Chunk大小，范围为[4096, 40960]。", "example": "4096" } ] }, { "name": "RTPSettings", "type": "object", "required": false, "description": "输出的RTP的配置。", "example": "无", "children": [ { "name": "Destinations", "type": "array", "required": true, "description": "转推的目标地址，可填1~2个。", "example": "0", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "转推的目标IP。", "example": "ip" }, { "name": "Port", "type": "integer", "required": true, "description": "转推的目标端口。", "example": "port" } ] }, { "name": "FEC", "type": "string", "required": true, "description": "只能填none。", "example": "none" }, { "name": "IdleTimeout", "type": "integer", "required": true, "description": "空闲超时时间，单位ms。", "example": "1000" } ] }, { "name": "AllowIpList", "type": "array", "required": false, "description": "IP白名单列表，格式为CIDR，如0.0.0.0/0。 当Protocol为RTMP_PULL有效，为空代表不限制客户端IP。", "example": "[\"0.0.0.0\"]", "item_type": "string" }, { "name": "MaxConcurrent", "type": "integer", "required": false, "description": "最大拉流并发数，最大4，默认4。", "example": "1" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "绑定的输入安全组 ID。", "example": "[\"01937702c54509dc0f3269ca341f\"]", "item_type": "string" }, { "name": "Zones", "type": "array", "required": false, "description": "可用区，output最多只支持输入一个可用区。", "example": "[\"ap-shanghai-1\"]", "item_type": "string" }, { "name": "RISTSettings", "type": "object", "required": false, "description": "输出的RIST的配置。", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "RIST模式，可选[LISTENER|CALLER]，默认为LISTENER。", "example": "LISTENER" }, { "name": "Profile", "type": "string", "required": false, "description": "RIST配置方案，可选[MAIN|SIMPLE]，默认为MAIN。", "example": "MAIN" }, { "name": "Buffer", "type": "integer", "required": false, "description": "RIST缓冲区大小，单位为毫秒。最小值为50毫秒，最大值为5000毫秒。默认值：120", "example": "120" } ] }, { "name": "StreamSelector", "type": "object", "required": false, "description": "对于含有多个音/视频轨的流，可以指定需要使用的轨道。PidSelector 与 TrackSelector 只能存在一个", "example": "无", "children": [ { "name": "SelectorType", "type": "string", "required": false, "description": "选择类型: PID | TRACK", "example": "PID" }, { "name": "PidSelector", "type": "object", "required": false, "description": "根据 PID 配置选择器", "example": "无", "children": [ { "name": "AudioPID", "type": "array", "required": false, "description": "对于含有多音轨的流, 可以通过输入PID来指定需要使用的音轨，PID可以输入1到8191之间的正整数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[123,124]", "item_type": "integer" }, { "name": "VideoPID", "type": "array", "required": false, "description": "对于含有多个视频轨的流，可以通过输入PID来指定需要使用的视频轨，PID可以输入1到8191之间的正整数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[123,124]", "item_type": "integer" } ] }, { "name": "TrackSelector", "type": "object", "required": false, "description": "根据 Track 配置选择器", "example": "无", "children": [ { "name": "VideoIndex", "type": "array", "required": false, "description": "视频轨道序号，从1开始.", "example": "[1,2]", "item_type": "integer" }, { "name": "AudioIndex", "type": "array", "required": false, "description": "音频轨道序号，从1开始.", "example": "[1,2]", "item_type": "integer" } ] } ] } ] } ], "required": [ "FlowName", "MaxBandwidth" ] }, { "name": "CreateStreamLinkInput", "description": "创建媒体传输的输入配置。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "媒体传输流ID。", "example": "018f09cc50671eb401a6024fcabc" }, { "name": "InputGroup", "type": "array", "required": false, "description": "流的输入组。", "example": "无", "item_type": "object", "children": [ { "name": "InputName", "type": "string", "required": true, "description": "输入名称，可填大小写、数字和下划线，长度为[1, 32]。", "example": "input" }, { "name": "Protocol", "type": "string", "required": true, "description": "输入的协议，可选[SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST]。", "example": "SRT" }, { "name": "Description", "type": "string", "required": false, "description": "输入描述，长度为[0, 255]。", "example": "input description" }, { "name": "AllowIpList", "type": "array", "required": false, "description": "输入的IP白名单，格式为CIDR。", "example": "[\"0.0.0.0/0\"]", "item_type": "string" }, { "name": "SRTSettings", "type": "object", "required": false, "description": "输入的SRT配置信息。", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "SRT模式，可选[LISTENER|CALLER]，默认为LISTENER。", "example": "LISTENER" }, { "name": "StreamId", "type": "string", "required": false, "description": "流Id，可选大小写字母、数字和特殊字符（.#!:\u0026,=_-），长度为0~512。具体格式可以参考：https://github.com/Haivision/srt/blob/master/docs/features/access-control.md#standard-keys。", "example": "streamId" }, { "name": "Latency", "type": "integer", "required": false, "description": "延迟，默认120，单位ms，范围为[0, 3000]。", "example": "120" }, { "name": "RecvLatency", "type": "integer", "required": false, "description": "接收延迟，默认120，单位ms，范围为[0, 3000]。", "example": "0" }, { "name": "PeerLatency", "type": "integer", "required": false, "description": "对端延迟，默认120，单位ms，范围为[0, 3000]。", "example": "0" }, { "name": "PeerIdleTimeout", "type": "integer", "required": false, "description": "对端超时时间，默认5000，单位ms，范围为[1000, 10000]。", "example": "5000" }, { "name": "Passphrase", "type": "string", "required": false, "description": "解密密钥，默认为空，表示不加密。只可填ascii码值，长度为[10, 79]。", "example": "passphrase" }, { "name": "PbKeyLen", "type": "integer", "required": false, "description": "密钥长度，默认为0，可选[0|16|24|32]。", "example": "0" }, { "name": "SourceAddresses", "type": "array", "required": false, "description": "SRT对端地址，当Mode为CALLER时必填，且只能填1组。", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "对端IP或域名。", "example": "1.1.1.1" }, { "name": "Port", "type": "integer", "required": true, "description": "对端端口。", "example": "65535" } ] }, { "name": "FEC", "type": "object", "required": false, "description": "SRT FEC 设置", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": false, "description": "是否开启 FEC", "example": "false" } ] } ] }, { "name": "RTPSettings", "type": "object", "required": false, "description": "输入的RTP配置信息。", "example": "无", "children": [ { "name": "FEC", "type": "string", "required": false, "description": "默认为“none”，可选值['none']。", "example": "none" }, { "name": "IdleTimeout", "type": "integer", "required": false, "description": "空闲超时时间，默认5000，单位ms，范围为[1000, 10000]。", "example": "1000" } ] }, { "name": "FailOver", "type": "string", "required": false, "description": "输入的主备开关，可选[OPEN|CLOSE]，默认为CLOSE。", "example": "CLOSE" }, { "name": "RTMPPullSettings", "type": "object", "required": false, "description": "输入的RTMP_PULL配置信息。", "example": "无", "children": [ { "name": "SourceAddresses", "type": "array", "required": true, "description": "RTMP源站的源站地址，有且只能有一个。", "example": "无", "item_type": "object", "children": [ { "name": "TcUrl", "type": "string", "required": true, "description": "RTMP源站的TcUrl地址。", "example": "rtmp://domain/live" }, { "name": "StreamKey", "type": "string", "required": true, "description": "RTMP源站的StreamKey信息。", "example": "streamKey" } ] } ] }, { "name": "RTSPPullSettings", "type": "object", "required": false, "description": "输入的RTSP_PULL配置信息。", "example": "无", "children": [ { "name": "SourceAddresses", "type": "array", "required": true, "description": "RTSP源站的源站地址，有且只能有一个。", "example": "无", "item_type": "object", "children": [ { "name": "Url", "type": "string", "required": true, "description": "RTSP源站的Url地址。", "example": "rtsp://9.223.70.41:8806/live/streamname" } ] } ] }, { "name": "HLSPullSettings", "type": "object", "required": false, "description": "输入的HLS_PULL配置信息。", "example": "无", "children": [ { "name": "SourceAddresses", "type": "array", "required": true, "description": "HLS源站的源站地址，有且只能有一个。", "example": "无", "item_type": "object", "children": [ { "name": "Url", "type": "string", "required": true, "description": "HLS源站的Url地址。", "example": "http://testdomain.com:8806/live/streamname" } ] } ] }, { "name": "ResilientStream", "type": "object", "required": false, "description": "延播平滑吐流配置信息。", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": false, "description": "是否开启延播平滑吐流，true开启，false不开启，默认不开启。 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "BufferTime", "type": "integer", "required": false, "description": "延播时间，单位秒，目前支持的范围为10~300秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "133" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "绑定的输入安全组 ID。", "example": "[\"01937702ecc509dc0f3269ca3420\"]", "item_type": "string" }, { "name": "Zones", "type": "array", "required": false, "description": "可用区，非必填，如果开启容灾必须输入两个不同的可用区，否则最多只允许输入一个可用区。", "example": "[\"ap-shanghai-1\"]", "item_type": "string" }, { "name": "RISTSettings", "type": "object", "required": false, "description": "输入的RIST配置信息。", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "RIST模式，可选[LISTENER]，默认为LISTENER。", "example": "LISTENER" }, { "name": "Profile", "type": "string", "required": false, "description": "RIST配置方案，可选[MAIN|SIMPLE]，默认为MAIN。", "example": "MAIN" }, { "name": "Buffer", "type": "integer", "required": false, "description": "RIST缓冲区大小，单位为毫秒。最小值为50毫秒，最大值为5000毫秒。默认值：120", "example": "120" } ] }, { "name": "InputRegion", "type": "string", "required": false, "description": "输入节点的地区", "example": "ap-mumbai" }, { "name": "FailOverOption", "type": "object", "required": false, "description": "冷热备相关", "example": "无", "children": [ { "name": "FailOverType", "type": "string", "required": false, "description": "热备", "example": "HOTSTANDBY" } ] } ] } ], "required": [ "FlowId" ] }, { "name": "CreateStreamLinkOutputInfo", "description": "创建媒体传输流的输出信息。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "传输流Id。", "example": "01746cfeda560956b92d34d30445" }, { "name": "Output", "type": "object", "required": true, "description": "传输流的Output配置。", "example": "无", "children": [ { "name": "OutputName", "type": "string", "required": true, "description": "输出的名称。", "example": "OutputName" }, { "name": "Description", "type": "string", "required": true, "description": "输出描述。", "example": "OutputName" }, { "name": "Protocol", "type": "string", "required": true, "description": "输出的转推协议，支持SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST。", "example": "SRT" }, { "name": "OutputRegion", "type": "string", "required": true, "description": "输出地区。", "example": "ap-hongkong" }, { "name": "OutputType", "type": "string", "required": false, "description": "输出类型：Internet/TencentCSS", "example": "TencentCSS" }, { "name": "OutputKind", "type": "string", "required": false, "description": "输出模块类型，包括Pinpoint（单点输出，最多支持四路并发输出）；MultiMesh（多路输出，支持大于四路的并发输出，目前可以达到200路）。默认类型为 Pinpoint 输出。对于单个 Flow 一个区域最多只能有一个 MultiMesh 输出", "example": "Pinpoint" }, { "name": "SRTSettings", "type": "object", "required": false, "description": "输出的SRT的配置。", "example": "无", "children": [ { "name": "Destinations", "type": "array", "required": true, "description": "转推的目标地址，当Mode为CALLER时必填，且只能填1组。", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "输出的IP或域名。", "example": "0.0.0.0" }, { "name": "Port", "type": "integer", "required": true, "description": "输出的端口。", "example": "10" } ] }, { "name": "StreamId", "type": "string", "required": false, "description": "转推SRT的流Id，可选大小写字母、数字和特殊字符（.#!:\u0026,=_-），长度为0~512。", "example": "StreamId" }, { "name": "Latency", "type": "integer", "required": false, "description": "转推SRT的延迟，默认120，单位ms，范围为[0, 3000]。此参数同时设置了发送方和接收方的延迟（recvlatency和peerlatency）为相同的值。建议配置为至少3倍RTT，以确保在网络拥塞时能够有效处理数据包的重传和确认", "example": "120" }, { "name": "RecvLatency", "type": "integer", "required": false, "description": "转推SRT的接收延迟，默认120，单位ms，范围为[0, 3000]。 此参数表示接收方用于缓存数据包的时间长度", "example": "0" }, { "name": "PeerLatency", "type": "integer", "required": false, "description": "转推SRT的对端延迟，默认120，单位ms，范围为[0, 3000]。 此参数由发送方设置，用于告知接收方其期望的延迟缓冲时间", "example": "0" }, { "name": "PeerIdleTimeout", "type": "integer", "required": false, "description": "转推SRT的对端空闲超时时间，默认5000，单位ms，范围为[1000, 10000]。 如果连接在设定的超时时间内没有活动，将会被关闭", "example": "5000" }, { "name": "Passphrase", "type": "string", "required": false, "description": "转推SRT的加密密钥，默认为空，表示不加密。只可填ascii码值，长度为[10, 79]。", "example": "passphrase" }, { "name": "PbKeyLen", "type": "integer", "required": false, "description": "转推SRT的密钥长度，默认为0，可选[0|16|24|32]。", "example": "0" }, { "name": "Mode", "type": "string", "required": false, "description": "SRT模式，可选[LISTENER|CALLER]，默认为CALLER。", "example": "CALLER" }, { "name": "FEC", "type": "object", "required": false, "description": "SRT FEC 设置", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": false, "description": "是否开启 FEC", "example": "true" }, { "name": "Cols", "type": "integer", "required": false, "description": "FEC 数据包 Layout 列数量. 取值范围\u003e0", "example": "3" }, { "name": "Rows", "type": "integer", "required": false, "description": "FEC 数据包 Layout 行数量. 取值范围 \u003e=2 或者 \u003c=-2", "example": "1" }, { "name": "ARQ", "type": "string", "required": false, "description": "FEC 开启的情况下，ARQ的策略。取值 \"always\", \"onreq\", \"never\"", "example": "always" }, { "name": "Layout", "type": "string", "required": false, "description": "FEC 数据包 Layout 组织形式，取值 \"even\", \"staircase\"", "example": "staircase" } ] } ] }, { "name": "RTMPSettings", "type": "object", "required": false, "description": "输出的RTMP的配置。", "example": "无", "children": [ { "name": "Destinations", "type": "array", "required": true, "description": "转推的目标地址，可填1~2个。", "example": "your address", "item_type": "object", "children": [ { "name": "Url", "type": "string", "required": true, "description": "转推的URL，格式如：rtmp://domain/live。", "example": "rtmp://example.com/live" }, { "name": "StreamKey", "type": "string", "required": true, "description": "转推的StreamKey，格式如：stream?key=value。", "example": "stream_key" } ] }, { "name": "ChunkSize", "type": "integer", "required": false, "description": "RTMP的Chunk大小，范围为[4096, 40960]。", "example": "4096" } ] }, { "name": "RTPSettings", "type": "object", "required": false, "description": "输出的RTP的配置。", "example": "无", "children": [ { "name": "Destinations", "type": "array", "required": true, "description": "转推的目标地址，可填1~2个。", "example": "0", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "转推的目标IP。", "example": "ip" }, { "name": "Port", "type": "integer", "required": true, "description": "转推的目标端口。", "example": "port" } ] }, { "name": "FEC", "type": "string", "required": true, "description": "只能填none。", "example": "none" }, { "name": "IdleTimeout", "type": "integer", "required": true, "description": "空闲超时时间，单位ms。", "example": "1000" } ] }, { "name": "AllowIpList", "type": "array", "required": false, "description": "IP白名单列表，格式为CIDR，如0.0.0.0/0。 当Protocol为RTMP_PULL有效，为空代表不限制客户端IP。", "example": "[\"0.0.0.0\"]", "item_type": "string" }, { "name": "MaxConcurrent", "type": "integer", "required": false, "description": "最大拉流并发数，最大4，默认4。", "example": "1" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "绑定的输入安全组 ID。", "example": "[\"01937702c54509dc0f3269ca341f\"]", "item_type": "string" }, { "name": "Zones", "type": "array", "required": false, "description": "可用区，output最多只支持输入一个可用区。", "example": "[\"ap-shanghai-1\"]", "item_type": "string" }, { "name": "RISTSettings", "type": "object", "required": false, "description": "输出的RIST的配置。", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "RIST模式，可选[LISTENER|CALLER]，默认为LISTENER。", "example": "LISTENER" }, { "name": "Profile", "type": "string", "required": false, "description": "RIST配置方案，可选[MAIN|SIMPLE]，默认为MAIN。", "example": "MAIN" }, { "name": "Buffer", "type": "integer", "required": false, "description": "RIST缓冲区大小，单位为毫秒。最小值为50毫秒，最大值为5000毫秒。默认值：120", "example": "120" } ] }, { "name": "StreamSelector", "type": "object", "required": false, "description": "对于含有多个音/视频轨的流，可以指定需要使用的轨道。PidSelector 与 TrackSelector 只能存在一个", "example": "无", "children": [ { "name": "SelectorType", "type": "string", "required": false, "description": "选择类型: PID | TRACK", "example": "PID" }, { "name": "PidSelector", "type": "object", "required": false, "description": "根据 PID 配置选择器", "example": "无", "children": [ { "name": "AudioPID", "type": "array", "required": false, "description": "对于含有多音轨的流, 可以通过输入PID来指定需要使用的音轨，PID可以输入1到8191之间的正整数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[123,124]", "item_type": "integer" }, { "name": "VideoPID", "type": "array", "required": false, "description": "对于含有多个视频轨的流，可以通过输入PID来指定需要使用的视频轨，PID可以输入1到8191之间的正整数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[123,124]", "item_type": "integer" } ] }, { "name": "TrackSelector", "type": "object", "required": false, "description": "根据 Track 配置选择器", "example": "无", "children": [ { "name": "VideoIndex", "type": "array", "required": false, "description": "视频轨道序号，从1开始.", "example": "[1,2]", "item_type": "integer" }, { "name": "AudioIndex", "type": "array", "required": false, "description": "音频轨道序号，从1开始.", "example": "[1,2]", "item_type": "integer" } ] } ] } ] } ], "required": [ "FlowId", "Output" ] }, { "name": "CreateStreamLinkSecurityGroup", "description": "创建安全组，数量限制5个。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "安全组名称，限制大小写、数字和下划线，Region下唯一。", "example": "live_test" }, { "name": "Whitelist", "type": "array", "required": true, "description": "白名单列表，数量限制[1, 10]。", "example": "[\"101.102.101.22/32\"]", "item_type": "string" } ], "required": [ "Name", "Whitelist" ] }, { "name": "CreateTranscodeTemplate", "description": "创建用户自定义转码模板，数量上限：1000", "status": "online", "parameters": [ { "name": "Container", "type": "string", "required": true, "description": "封装格式，可选值：mp4、flv、hls、ts、webm、mkv、mxf、mov、mp3、flac、ogg、m4a。其中，mp3、flac、ogg、m4a 为纯音频文件。", "example": "mp4" }, { "name": "Name", "type": "string", "required": false, "description": "转码模板名称，长度限制：64 个字符。", "example": "转码模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "转码模板" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，可选值： 0：保留 1：去除 默认值：0。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，可选值： 0：保留 1：去除 默认值：0。", "example": "0" }, { "name": "VideoTemplate", "type": "object", "required": false, "description": "视频流配置参数，当 RemoveVideo 为 0，该字段必填。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": true, "description": "视频流的编码格式，可选值： h264：H.264 编码 h265：H.265 编码 h266：H.266 编码 av1：AOMedia Video 1 编码 vp8：VP8 编码 vp9：VP9 编码 mpeg2：MPEG2 编码 dnxhd：DNxHD 编码 mv-hevc：MV-HEVC 编码 注意：av1 编码容器目前只支持 mp4 ，webm，mkv。 注意：H.266 编码容器目前只支持 mp4 ，hls，ts，mov。 注意：VP8、VP9编码容器目前只支持webm，mkv。 注意：MPEG2、dnxhd 编码容器目前只支持mxf。 注意：MV-HEVC编码\ufffd\ufffd...", "example": "h264" }, { "name": "Fps", "type": "integer", "required": true, "description": "视频帧率，取值范围： 当FpsDenominator的值为空时，范围：[0, 120]，单位：Hz； 当FpsDenominator的值不为空时，Fps/FpsDenominator的范围：[0,120] 当取值为 0，表示帧率和原始视频保持一致。", "example": "0" }, { "name": "Bitrate", "type": "integer", "required": true, "description": "视频流的码率，取值范围：0 和 [128, 100000]，单位：kbps。 当取值为 0，表示视频码率和原始视频保持一致。", "example": "0" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。 默认值：open。 注意：自适应模式时，Width不能小于Height。", "example": "open" }, { "name": "Width", "type": "integer", "required": false, "description": "视频流宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。 注意：Codec为MV-HEVC时可以支持到7680", "example": "0" }, { "name": "Height", "type": "integer", "required": false, "description": "视频流高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。 注意：Codec为MV-HEVC时可以支持到7680", "example": "0" }, { "name": "Gop", "type": "integer", "required": false, "description": "关键帧 I 帧之间的间隔，允许按帧或秒自定义GOP长度，取值范围：0 和 [1, 100000]， 当填 0 或不填时，系统将自动设置 gop 长度。", "example": "0" }, { "name": "GopUnit", "type": "string", "required": false, "description": "Gop数值单位，可选值： frame：表示帧 second：表示秒 默认值：frame 注意：此字段可能返回 null，表示取不到有效值。", "example": "frame" }, { "name": "FillType", "type": "string", "required": false, "description": "填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“； black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。 white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。 gauss：高斯模糊，保持视频...", "example": "black" }, { "name": "Vcrf", "type": "integer", "required": false, "description": "视频的恒定码率控制因子，取值范围为[0, 51]，不填表示“自动”。如果没有特殊需求，建议不指定该参数。 当Mode参数设置为VBR时，如果同时配置了Vcrf值，MPS将在VBR模式下处理视频，同时考虑Vcrf和Bitrate参数的设置，以平衡视频质量、码率、转码效率和文件大小。 当Mode参数设置为CRF，Bitrate设置将失效，编码将根据Vcrf值进行。 当Mode参数选择ABR或CBR时，无需配置Vcrf值。 注意：...", "example": "1" }, { "name": "HlsTime", "type": "integer", "required": false, "description": "分片平均时长，范围：（0-10]，单位：秒 不填表示自动，将根据视频的GOP等特征自动选择合适的分片时长。 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "SegmentType", "type": "integer", "required": false, "description": "hls 分片类型，可选值 ： 0：HLS+TS 切片 2：HLS+TS byte range 7：HLS+MP4 切片 5：HLS+MP4 byte range 默认值：0 注意：该字段用于普通/极速高清转码设置，对自适应码流不生效，如需给自适应码流配置分片类型，可以使用外层字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "FpsDenominator", "type": "integer", "required": false, "description": "帧率分母部分 注意：值必须大于0 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Stereo3dType", "type": "string", "required": false, "description": "3D视频拼接方式，仅mv-hevc，3D视频生效，可选值： side_by_side：原视频内容左右排列布局 top_bottom：原视频内容上下排列布局 计费将按照切分后的分辨率尺寸上报用量及计费； 默认值:side_by_side 注意：此字段可能返回 null，表示取不到有效值。", "example": "side_by_side" }, { "name": "VideoProfile", "type": "string", "required": false, "description": "Profile，适用于不同场景。 baseline: 只支持I/P帧，并只支持无交错的场景，适用于视频通话、手机视频等场景。 main: 主流Profile，提供I帧、P帧、B帧，并支持无交错模式和交错模式。主要用在主流的音视频消费产品如视频播放器、流媒体传输设备上。 high: 最高编码等级，在Main Profile上添加了8X8的预测，并支持自定义量化。广泛应用在蓝光存储、高清电视等场景。 default：随原视频...", "example": "default" }, { "name": "VideoLevel", "type": "string", "required": false, "description": "编码器级别，默认为自动（\"\"） 若编码标准选择H264: 支持以下选项：\"\"，1 , 1.1 , 1.2 , 1.3 , 2 , 2.1 , 2.2 , 3 , 3.1 , 3.2 , 4 , 4.1 , 4.2 , 5 , 5.1 若编码标准选择H265: 支持以下选项：\"\"，1 , 2 , 2.1 , 3 , 3.1 , 4 , 4.1 , 5 , 5.1 , 5.2 , 6 , 6.1 , 6.2 , 8.5 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Bframes", "type": "integer", "required": false, "description": "参考帧之间的B帧数，默认选自动，支持 0 - 16 注意：不填表示使用自动 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Mode", "type": "string", "required": false, "description": "码率控制模式：可选值： VBR（Variable Bit Rate）：动态比特率，根据视频画面的复杂度动态调整输出的码率，使得画面质量更高，适用于存储场景和对画面质量要求较高的应用。 ABR（Average Bit Rate）：平均比特率，尽量保持输出视频的平均码率稳定，但允许短期内的码率波动，适用于需要在保持一定画质的情况下尽量减少整体码率的场景。 CBR（Constant Bit Rate）：恒定比特率，指视...", "example": "VBR" }, { "name": "Sar", "type": "string", "required": false, "description": "显示高宽比，可选值：[1:1，2:1，default] 默认值：default 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" }, { "name": "NoScenecut", "type": "integer", "required": false, "description": "自适应I帧决策，开启后，媒体处理将自动识别视频中不同场景之间的过渡点（通常是视觉上显著不同的帧，比如从一个镜头切换到另一个镜头），在这些点自适应插入关键帧（I帧），从而提高视频的随机访问性和编码效率。可选值： 0：关闭自适应I帧决策 1：使用自适应I帧决策 默认值：0 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "BitDepth", "type": "integer", "required": false, "description": "比特位：支持8/10，默认为8 注意：此字段可能返回 null，表示取不到有效值。", "example": "8" }, { "name": "RawPts", "type": "integer", "required": false, "description": "保持原始时间戳：可选值： 0：表示关闭 1：表示打开 默认是关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Compress", "type": "integer", "required": false, "description": "按比例压缩码率，开启后，将根据比例来调整输出视频的码率。填写压缩率后，系统会根据视频源码率自动计算目标输出码率。压缩率范围0-100 不填此值表示不开启，默认不开启 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SegmentSpecificInfo", "type": "object", "required": false, "description": "启动时分片时长 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "启动分片时长开关，可选值： on：打开 off：关闭 默认off 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "FragmentTime", "type": "integer", "required": false, "description": "启动时分片时长，单位：秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FragmentEndNum", "type": "integer", "required": false, "description": "生效分片数，表示前FragmentEndNum个分片以FragmentTime时长切片，取值\u003e=1 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "ScenarioBased", "type": "integer", "required": false, "description": "模板是否开启场景化 0：不开启 1：开启 默认值：0 注意：只有此字段值为1时，SceneType和CompressType字段的值才会生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SceneType", "type": "string", "required": false, "description": "视频场景化，可选值： normal：通用转码场景：通用转码压缩场景。 pgc：PGC高清影视：压缩时会注重影视剧的观看体验，根据影视剧特性进行ROI编码，同时保留高质量的视频内容和音频。 materials_video：高清素材：素材资源类场景，对画质要求极高，较多透明画面内容，在压缩的同时接近视觉无损。 ugc：UGC内容：适用于广泛的UGC/短视频场景，针对短视频的特性优化编码码率， \ufffd\ufffd...", "example": "normal" }, { "name": "CompressType", "type": "string", "required": false, "description": "转码策略，可选值： ultra_compress：极致压缩：相比标准压缩，该策略能在保证一定画质的基础上最大限度压缩码率，极大节约带宽和存储成本。 standard_compress：综合最优：平衡压缩率与画质，在保证主观画质没有明显降低的情况下尽可能压缩文件。该策略仅收取音视频极速高清转码费用。 high_compress：码率优先：优先保证降低文件体积大小，可能有一定画质损失。该策略仅收取...", "example": "standard_compress" } ] }, { "name": "AudioTemplate", "type": "object", "required": false, "description": "音频流配置参数，当 RemoveAudio 为 0，该字段必填。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": true, "description": "音频流的编码格式。 当不需要对音频进行转码时，可选值为： copy。 当外层参数 Container 为 mp3 时，可选值为： mp3。 当外层参数 Container 为 ogg 或 flac 时，可选值为： flac。 当外层参数 Container 为 m4a 时，可选值为： aac； ac3。 当外层参数 Container 为 mp4 或 flv 时，可选值为： aac：更适合 mp4； mp3：更适合 flv； mp2。 当外层参数 Container 为 hls 时，可选值为： aac； mp3; eac3：自适应\ufffd\ufffd...", "example": "aac" }, { "name": "Bitrate", "type": "integer", "required": true, "description": "音频流的码率，取值范围：0 和 [26, 256]，单位：kbps。 当取值为 0，表示音频码率和原始音频保持一致。 注意：如果使用自适应转码音轨合并TrackChannelInfo参数，取值范围： 1）、不能填0； 2）、Codec为：aac时，取值范围：[26, 256]; 3）、Codec为：ac3时，取值范围：[26, 640]; 4)、Codec为：eac3时，取值范围：[26, 6144]，备注：当SampleRate为44100HZ，最大值为：5644，当SampleRate为48000HZ，最大值\ufffd...", "example": "0" }, { "name": "SampleRate", "type": "integer", "required": true, "description": "音频流的采样率，不同编码标准支持的采样率选项不同。填0代表使用源音频的采样率数值。 详细参考[音频采样率支持范围文档](https://cloud.tencent.com/document/product/862/77166#f3b039f1-d817-4a96-b4e4-90132d31cd53) 单位：Hz 注意：请确保源音频流的采样率在上述选项范围内，否则可能导致转码失败！", "example": "44100" }, { "name": "AudioChannel", "type": "integer", "required": false, "description": "音频通道方式，可选值： 1：单通道 2：双通道 6：5.1声道 当媒体的封装格式是音频格式时（flac，ogg，mp3，m4a）时，声道数不允许设为5.1声道。 默认值：2。", "example": "2" }, { "name": "TrackChannelInfo", "type": "object", "required": false, "description": "合并音轨信息。 注意：此字段只是自适应转码生效， 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ChannelsRemix", "type": "integer", "required": false, "description": "是否开启混音，可选值： 0：表示不开启混音 1：表示开启混音 默认值：0 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SelectType", "type": "string", "required": false, "description": "合并音轨输入类型，可选值： track：表示使用音轨id； track_channel： 表示使用音轨id和声道id； 默认：track。 注意：如果原视频是多声道，建议使用track_channel。 注意：此字段可能返回 null，表示取不到有效值。", "example": "track" }, { "name": "InputTrackInfo", "type": "array", "required": false, "description": "音轨信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "TrackNum", "type": "string", "required": false, "description": "音轨和声道数字，说明： 当：SelectType值为track，此值为整数类型，例如：1； 当：SelectType值为track_channel，此值为小数类型，例如：1.0； 默认值：1.0 注意：整数部分代表音轨序号，以小数部分代表声道。音轨序号即为音轨的stream index，支持输入0和正整数。小数部分最多支持2位小数，并且仅支持0-63，但是如果Codec为aac/eac3/ac3时，小数部分仅支持0-15。例如：对于stream index为1的音...", "example": "1.0" }, { "name": "ChannelVolume", "type": "array", "required": false, "description": "声道音量大小，说明： 当：AudioChannel的值为1时，此数组长度为1，例如：[6]； 当：AudioChannel的值为2时，此数组长度为2，例如：[0,6]； 当：AudioChannel的值为6时，此数组长度大于2小于16，例如：[-60,0,0,6]。 此值数组值取值范围：[-60, 6]，其中-60代表静音、0代表保持原音量，6表示原音量增加一倍，默认值为-60。 注意：支持3位小数。 注意：此字段可能返回 null，表示取不到有效值\ufffd...", "example": "[-60, 0, 6]", "item_type": "float" } ] } ] } ] }, { "name": "TEHDConfig", "type": "object", "required": false, "description": "极速高清转码参数。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "极速高清类型，可选值： TEHD-100：极速高清-100（视频极速高清）。 TEHD-200：极速高清-200（音频极速高清）。 不填代表不启用极速高清。", "example": "TEHD-100" }, { "name": "MaxVideoBitrate", "type": "integer", "required": false, "description": "视频码率上限，当 Type 指定了极速高清类型时有效。 不填或填0表示不设视频码率上限。", "example": "0" } ] }, { "name": "EnhanceConfig", "type": "object", "required": false, "description": "音视频增强配置。", "example": "无", "children": [ { "name": "VideoEnhance", "type": "object", "required": false, "description": "视频增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FrameRate", "type": "object", "required": false, "description": "插帧帧率配置（旧）。新用户建议使用FrameRateWithDen配置插帧帧率，支持分数，且效果更好。注意，FrameRate 与FrameRateWithDen 只能二选一，同时配置可能导致任务失败。源帧率大于等于目标帧率时能力不会生效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Fps", "type": "integer", "required": false, "description": "帧率，取值范围：[0, 100]，单位：Hz。 默认值 0。 注意：对于转码，该参数会覆盖 VideoTemplate 内部的 Fps。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "SuperResolution", "type": "object", "required": false, "description": "超分配置。源分辨率高于目标分辨率时不对视频做处理。注意与大模型增强不可同时开启。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： lq：针对低清晰度有较多噪声视频的超分； hq：针对高清晰度视频超分。 默认值：lq。 注意：此字段可能返回 null，表示取不到有效值。", "example": "lq" }, { "name": "Size", "type": "integer", "required": false, "description": "超分倍数，可选值： 2：目前只支持 2 倍超分。 默认值：2。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2" } ] }, { "name": "Hdr", "type": "object", "required": false, "description": "HDR配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： HDR10 HLG 默认值：HDR10。 注意：video的编码方式需要为h264或h265； 注意：视频编码位深为10。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HDR10" } ] }, { "name": "Denoise", "type": "object", "required": false, "description": "视频降噪配置。注意与大模型增强不可同时开启。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "ImageQualityEnhance", "type": "object", "required": false, "description": "综合增强配置。注意大模型、综合增强、去毛刺三项里最多配置一项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak normal strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "ColorEnhance", "type": "object", "required": false, "description": "色彩增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak normal strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "LowLightEnhance", "type": "object", "required": false, "description": "低光照增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： normal 默认值：normal。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" } ] }, { "name": "ScratchRepair", "type": "object", "required": false, "description": "去划痕配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Intensity", "type": "float", "required": false, "description": "强度，取值范围：0.0~1.0。 默认：0.0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0.5" } ] }, { "name": "ArtifactRepair", "type": "object", "required": false, "description": "去伪影（毛刺）配置。注意大模型、综合增强、去毛刺三项里最多配置一项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "EnhanceSceneType", "type": "string", "required": false, "description": "增强场景配置，可选值： common（通用），通用增强参数，适用于各种视频类型的基础优化参数，提升整体画质。 AIGC，整体分辨率提升，利用AI技术提升视频整体分辨率，增强画面清晰度。 short_play（短剧），增强面部与字幕细节，突出人物面部表情细节和字幕清晰度，提升观剧体验。 short_video（短视频），优化复杂多样的画质问题，针对短视频的复杂场景，优化画质，解决多\ufffd...", "example": "common" }, { "name": "DiffusionEnhance", "type": "object", "required": false, "description": "大模型增强配置。注意大模型、综合增强、去毛刺三项里最多配置一项。且不可与超分、降噪同时开启。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认，OFF。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "强度类型，可选值： weak normal strong 默认值：normal。 注意：此字段可能返回 null，表示取不到有效值。", "example": "strong" } ] }, { "name": "FrameRateWithDen", "type": "object", "required": false, "description": "新插帧帧率配置，支持分数。注意与FrameRate二选一。源帧率大于等于目标帧率时能力不会生效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "FpsNum", "type": "integer", "required": false, "description": "帧率分子，取值范围：非负数，除以分母后小于120，单位：Hz。 默认值 0。 注意：对于转码，该参数会覆盖 VideoTemplate 内部的 Fps。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "FpsDen", "type": "integer", "required": false, "description": "帧率分母，取值范围：大于等于1。 默认值 1。 注意：对于转码，该参数会覆盖 VideoTemplate 内部的 FpsDenominator。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ] }, { "name": "AudioEnhance", "type": "object", "required": false, "description": "音频增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Denoise", "type": "object", "required": false, "description": "音频降噪配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" } ] }, { "name": "Separate", "type": "object", "required": false, "description": "音频分离配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "场景类型，可选值： normal：人声背景声场景 music：演唱伴奏场景 默认值：normal。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" }, { "name": "Track", "type": "string", "required": false, "description": "输出音轨，可选值： vocal：输出人声 background：应用场景为normal时输出背景声，应用场景为music时输出伴奏 默认值：vocal。 注意：此字段可能返回 null，表示取不到有效值。", "example": "vocal" } ] }, { "name": "VolumeBalance", "type": "object", "required": false, "description": "音量均衡配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： loudNorm：响度标准化 gainControl：减小突变 默认值：loudNorm。 注意：此字段可能返回 null，表示取不到有效值。", "example": "loudNorm" } ] }, { "name": "Beautify", "type": "object", "required": false, "description": "音频美化配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Types", "type": "array", "required": false, "description": "类型，可多选，可选值： declick：杂音去除 deesser：齿音压制 默认值：declick。 注意：此字段可能返回 null，表示取不到有效值。", "example": "declick", "item_type": "string" } ] } ] } ] }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "扩展参数，序列化的 json 字符串。", "example": "{\\\"video_info\\\":{\\\"keep_gop\\\":0}}" } ], "required": [ "Container" ] }, { "name": "CreateVideoDatabaseEntryTask", "description": "对URL链接或COS中的视频发起入库任务。 可选在任务完成后向回调方发送任务完成状态信息。", "status": "online", "parameters": [ { "name": "InputInfo", "type": "object", "required": true, "description": "待入库视频信息", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输入来源对象的类型，支持： COS：COS源 URL：URL源 AWS-S3：AWS 源，目前只支持转码任务 VOD：点播专业版", "example": "NULL" }, { "name": "CosInputInfo", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 对象信息。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": true, "description": "媒体处理对象文件的输入路径，如`/movie/201907/WildAnimal.mov`。", "example": "/movie/201907/WildAnimal.mov" } ] }, { "name": "UrlInputInfo", "type": "object", "required": false, "description": "当 Type 为 URL 时有效，则该项为必填，表示媒体处理 URL 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频的 URL。", "example": "NULL" } ] }, { "name": "S3InputInfo", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-us-125678" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域，目前支持： us-east-1 eu-west-3 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1 " }, { "name": "S3Object", "type": "string", "required": true, "description": "S3 bucket 中的媒体资源路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/test.mp4" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bb5******eff" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bbc5******eff" } ] }, { "name": "VODInputInfo", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理对象文件所在的 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理对象文件所在的 Bucket 所属园区", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": false, "description": "媒体处理对象文件的输入路径", "example": "/movie/201907/WildAnimal.mov" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "TaskNotifyConfig", "type": "object", "required": false, "description": "可选，入库任务完成后向指定的回调地址传递任务结果，目前仅支持URL", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型，可选值： CMQ：已下线，建议切换到TDMQ-CMQ TDMQ-CMQ：消息队列 URL：指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同解析事件通知接口的输出参数 SCF：不推荐使用，需要在控制台额外配置SCF AWS-SQS：AWS 队列，只适用于 AWS 任务，且要求同区域 注：不填或为空时默认 TDMQ-CMQ，如需采用其他类型需填写对应类型值；如果使用TDMQ-CMQ消息队列，任务\ufffd...", "example": "URL" }, { "name": "NotifyMode", "type": "string", "required": false, "description": "工作流通知的模式，可取值有 Finish 和 Change，不填代表 Finish。", "example": "Finish " }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的模型，有 Queue 和 Topic 两种。", "example": "Queue " }, { "name": "CmqRegion", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。", "example": "mps_notify" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。", "example": "mps_que" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "AWS SQS 回调，NotifyType为 AWS-SQS 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NULL", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的key。", "example": "0se***9idaY" } ] } ], "required": [ "InputInfo" ] }, { "name": "CreateVideoSearchTask", "description": "使用检索值检索库中最接近检索值的若干视频。", "status": "online", "parameters": [ { "name": "SearchValueInput", "type": "object", "required": true, "description": "用于检索任务的输入", "example": "无", "children": [ { "name": "SearchValueType", "type": "string", "required": true, "description": "检索输入的类型，目前支持： Text：文本检索", "example": "Text" }, { "name": "TextInput", "type": "string", "required": false, "description": "当SearchValueType为Text时有效且必填，用于检索视频的文本 注意：此字段可能返回 null，表示取不到有效值。", "example": "测试文本" } ] }, { "name": "Limit", "type": "integer", "required": false, "description": "返回视频的最大数量，取值范围[1,20]，将返回最相近的前Limit条视频,默认为5", "example": "5" }, { "name": "TaskNotifyConfig", "type": "object", "required": false, "description": "可选，用于检索任务完成后向回调方发送检索结果，目前仅支持URL方式", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型，可选值： CMQ：已下线，建议切换到TDMQ-CMQ TDMQ-CMQ：消息队列 URL：指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同解析事件通知接口的输出参数 SCF：不推荐使用，需要在控制台额外配置SCF AWS-SQS：AWS 队列，只适用于 AWS 任务，且要求同区域 注：不填或为空时默认 TDMQ-CMQ，如需采用其他类型需填写对应类型值；如果使用TDMQ-CMQ消息队列，任务\ufffd...", "example": "URL" }, { "name": "NotifyMode", "type": "string", "required": false, "description": "工作流通知的模式，可取值有 Finish 和 Change，不填代表 Finish。", "example": "Finish " }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的模型，有 Queue 和 Topic 两种。", "example": "Queue " }, { "name": "CmqRegion", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。", "example": "mps_notify" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。", "example": "mps_que" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "AWS SQS 回调，NotifyType为 AWS-SQS 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NULL", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的key。", "example": "0se***9idaY" } ] } ], "required": [ "SearchValueInput" ] }, { "name": "CreateWatermarkTemplate", "description": "创建用户自定义水印模板，数量上限：1000。", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": true, "description": "水印类型，可选值： image：图片水印； text：文字水印； svg：SVG 水印。", "example": "text" }, { "name": "Name", "type": "string", "required": false, "description": "水印模板名称，长度限制：64 个字符。", "example": "水印模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "文字水印" }, { "name": "CoordinateOrigin", "type": "string", "required": false, "description": "原点位置，可选值： TopLeft：表示坐标原点位于视频图像左上角，水印原点为图片或文字的左上角； TopRight：表示坐标原点位于视频图像的右上角，水印原点为图片或文字的右上角； BottomLeft：表示坐标原点位于视频图像的左下角，水印原点为图片或文字的左下角； BottomRight：表示坐标原点位于视频图像的右下角，水印原点为图片或文字的右下角。 默认值：TopLeft。", "example": "TopLeft" }, { "name": "XPos", "type": "string", "required": false, "description": "水印原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式： 当字符串以 % 结尾，表示水印 XPos 为视频宽度指定百分比，如 10% 表示 XPos 为视频宽度的 10%； 当字符串以 px 结尾，表示水印 XPos 为指定像素，如 100px 表示 XPos 为 100 像素。 默认值：0px。", "example": "5%" }, { "name": "YPos", "type": "string", "required": false, "description": "水印原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式： 当字符串以 % 结尾，表示水印 YPos 为视频高度指定百分比，如 10% 表示 YPos 为视频高度的 10%； 当字符串以 px 结尾，表示水印 YPos 为指定像素，如 100px 表示 YPos 为 100 像素。 默认值：0px。", "example": "5%" }, { "name": "ImageTemplate", "type": "object", "required": false, "description": "图片水印模板，仅当 Type 为 image，该字段必填且有效。", "example": "无", "children": [ { "name": "ImageContent", "type": "string", "required": true, "description": "水印图片 [Base64](https://tools.ietf.org/html/rfc4648) 编码后的字符串。支持 jpeg、png 图片格式。", "example": "AKIAABC*******12345W" }, { "name": "Width", "type": "string", "required": false, "description": "水印的宽度。支持 %、px 两种格式： 当字符串以 % 结尾，表示水印 Width 为视频宽度的百分比大小，如 10% 表示 Width 为视频宽度的 10%； 当字符串以 px 结尾，表示水印 Width 单位为像素，如 100px 表示 Width 为 100 像素。取值范围为[8, 4096]。 当宽高都不填或者为0时，默认为 10%。", "example": "10%" }, { "name": "Height", "type": "string", "required": false, "description": "水印的高度。支持 %、px 两种格式： 当字符串以 % 结尾，表示水印 Height 为视频高度的百分比大小，如 10% 表示 Height 为视频高度的 10%； 当字符串以 px 结尾，表示水印 Height 单位为像素，如 100px 表示 Height 为 100 像素。取值范围为0或[8, 4096]。 默认值：0px，表示 Height 按照原始水印图片的宽高比缩放。", "example": "10%" }, { "name": "RepeatType", "type": "string", "required": false, "description": "水印重复类型。使用场景：水印为动态图像。取值范围： once：动态水印播放完后，不再出现； repeat_last_frame：水印播放完后，停留在最后一帧； repeat：水印循环播放，直到视频结束（默认值）。", "example": "once" } ] }, { "name": "TextTemplate", "type": "object", "required": false, "description": "文字水印模板，仅当 Type 为 text，该字段必填且有效。", "example": "无", "children": [ { "name": "FontType", "type": "string", "required": true, "description": "字体类型，目前可以支持两种： simkai.ttf：可以支持中文和英文； arial.ttf：仅支持英文。", "example": "arial.ttf" }, { "name": "FontSize", "type": "string", "required": true, "description": "字体大小，格式：Npx，N 为数值。N的取值范围：[0,1] 和 [8, 4096]", "example": "10px" }, { "name": "FontColor", "type": "string", "required": true, "description": "字体颜色，格式：0xRRGGBB，默认值：0xFFFFFF（白色）。", "example": "0xFFFFFF" }, { "name": "FontAlpha", "type": "float", "required": true, "description": "文字透明度，取值范围：(0, 1] 0：完全透明 1：完全不透明 默认值：1。", "example": "0.5" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps水印测试" } ] }, { "name": "SvgTemplate", "type": "object", "required": false, "description": "SVG 水印模板，仅当 Type 为 svg，该字段必填且有效。", "example": "无", "children": [ { "name": "Width", "type": "string", "required": false, "description": "水印的宽度，支持 px，%，W%，H%，S%，L% 六种格式： 当字符串以 px 结尾，表示水印 Width 单位为像素，如 100px 表示 Width 为 100 像素；当填 0px 且 Height 不为 0px 时，表示水印的宽度按原始 SVG 图像等比缩放；当 Width、Height 都填 0px 时，表示水印的宽度取原始 SVG 图像的宽度； 当字符串以 W% 结尾，表示水印 Width 为视频宽度的百分比大小，如 10W% 表示 Width 为视频宽度的 10%； 当字符\ufffd\ufffd...", "example": "10%" }, { "name": "Height", "type": "string", "required": false, "description": "水印的高度，支持 px，W%，H%，S%，L% 六种格式： 当字符串以 px 结尾，表示水印 Height 单位为像素，如 100px 表示 Height 为 100 像素；当填 0px 且 Width 不为 0px 时，表示水印的高度按原始 SVG 图像等比缩放；当 Width、Height 都填 0px 时，表示水印的高度取原始 SVG 图像的高度； 当字符串以 W% 结尾，表示水印 Height 为视频宽度的百分比大小，如 10W% 表示 Height 为视频宽度的 10%； 当字符串...", "example": "0px" } ] } ], "required": [ "Type" ] }, { "name": "CreateWordSamples", "description": "该接口用于批量创建关键词样本，样本用于通过OCR、ASR技术，进行不适宜内容识别、内容识别等视频处理。", "status": "online", "parameters": [ { "name": "Usages", "type": "array", "required": true, "description": "关键词应用场景，可选值： 1. Recognition.Ocr：通过光学字符识别技术，进行内容识别； 2. Recognition.Asr：通过音频识别技术，进行内容识别； 3. Review.Ocr：通过光学字符识别技术，进行不适宜内容识别； 4. Review.Asr：通过音频识别技术，进行不适宜内容识别； 可合并简写为： 5. Recognition：通过光学字符识别技术、音频识别技术，进行内容识别，等价于 1+2； 6. Review：通过光学字符\ufffd\ufffd...", "item_type": "string" }, { "name": "Words", "type": "array", "required": true, "description": "关键词，数组长度限制：100。", "item_type": "object", "children": [ { "name": "Keyword", "type": "string", "required": true, "description": "关键词，长度限制：20 个字符。", "example": "张三" }, { "name": "Tags", "type": "array", "required": false, "description": "关键词标签 数组长度限制：20 个标签； 单个标签长度限制：128 个字符。", "example": "[\"明星\",\"艺人\"]", "item_type": "string" } ] } ], "required": [ "Usages", "Words" ] }, { "name": "CreateWorkflow", "description": "对 COS 中指定 Bucket 的目录下上传的媒体文件，设置处理规则，包括： 1. 视频转码（带水印）； 2. 视频转动图； 3. 对视频按指定时间点截图； 4. 对视频采样截图； 5. 对视频截图雪碧图； 6. 对视频转自适应码流； 7. 智能内容审核（鉴黄、敏感信息检测）； 8. 智能内容分析（标签、分类、封面、按帧标签）； 9. 智能内容识别（人脸、文本全文、文本关键词、语音全文、语音关\ufffd...", "status": "online", "parameters": [ { "name": "WorkflowName", "type": "string", "required": true, "description": "工作流名称，最多128字符。同一个用户该名称唯一。", "example": "trans-100020-100030-100040" }, { "name": "Trigger", "type": "object", "required": true, "description": "工作流绑定的触发规则，当上传视频命中该规则到该对象时即触发工作流。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "触发器的类型，可选值： CosFileUpload：COS触发 AwsS3FileUpload：AWS触发，目前只支持转码任务。只有编排支持，工作流不支持。", "example": "CosFileUpload" }, { "name": "CosFileUploadTrigger", "type": "object", "required": false, "description": "当 Type 为 CosFileUpload 时必填且有效，为 COS 触发规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "工作流绑定的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "CosVideoFile-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "工作流绑定的 COS Bucket 所属园区，如 ap-chongiqng。", "example": "ap-nanjing" }, { "name": "Dir", "type": "string", "required": false, "description": "工作流绑定的输入路径目录，必须为绝对路径，即以 `/` 开头和结尾。如`/movie/201907/`，不填代表根目录`/`。", "example": "/trigger-dir/" }, { "name": "Formats", "type": "array", "required": false, "description": "支持的所有格式如下： - 视频文件扩展名，支持以下选择，共15种： `.mp4`、`.avi`、`.mov`、`.wmv`、`.flv`、`.mkv`、`.mpg`、`.mpeg`、`.rm`、`.rmvb`、`.asf`、`.3gp`、`.webm`、`.ts`、`.m4v` - 音频文件扩展名，支持以下选择，共7种： `.mp3`、`.wav`、`.aac`、`.flac`、`.ogg`、`.m4a`、`.amr` - 字幕文件扩展名，支持以下选择，共2种： `.vtt`、`.srt` - `*`：支持任意文件格式 - 不传或者传空列表：支持系统预设\ufffd\ufffd...", "example": "[\"mp4\",\"flv\",\"mov\"]", "item_type": "string" } ] }, { "name": "AwsS3FileUploadTrigger", "type": "object", "required": false, "description": "当 Type 为 AwsS3FileUpload 时必填且有效，为 AWS S3 触发规则。 注意：目前AWS的S3、对应触发队列SQS、回调队列SQS的秘钥需要一致。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "绑定的 AWS S3 存储桶。", "example": "mps-test-s3" }, { "name": "S3Region", "type": "string", "required": true, "description": "绑定的桶所在 AWS 区域，目前支持： us-east-1 eu-west-3", "example": "us-east-1 " }, { "name": "Dir", "type": "string", "required": false, "description": "绑定的输入路径目录，必须为绝对路径，即以 `/` 开头和结尾。如`/movie/201907/`，不填代表根目录`/`。", "example": "/Dir/" }, { "name": "Formats", "type": "array", "required": false, "description": "允许触发的文件格式列表，如 [\"mp4\", \"flv\", \"mov\"]。不填代表所有格式的文件都可以触发工作流。", "example": "[\"mp4\", \"flv\", \"mov\"]", "item_type": "string" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "绑定的 AWS S3 存储桶的秘钥ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "绑定的 AWS S3 存储桶的秘钥Key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "绑定的 AWS S3 存储桶对应的 SQS事件队列。 注意：队列和桶需要在同一区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] } ] } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "媒体处理的文件输出存储位置。不填则继承 Trigger 中的存储位置。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputDir", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标目录，必选以 / 开头和结尾，如`/movie/201907/`。 如果不填，表示与触发文件所在的目录一致。", "example": "\"\"" }, { "name": "MediaProcessTask", "type": "object", "required": false, "description": "媒体处理类型任务参数。", "example": "无", "children": [ { "name": "TranscodeTaskSet", "type": "array", "required": false, "description": "视频转码任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频转码模板 ID。", "example": "20" }, { "name": "RawParameter", "type": "object", "required": false, "description": "视频转码自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定转码参数。", "example": "无", "children": [ { "name": "Container", "type": "string", "required": true, "description": "封装格式，可选值：mp4、flv、hls、mp3、flac、ogg、m4a。其中，mp3、flac、ogg、m4a 为纯音频文件。", "example": "mp4" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，取值： 0：保留； 1：去除。 默认值：0。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，取值： 0：保留； 1：去除。 默认值：0。", "example": "0" }, { "name": "VideoTemplate", "type": "object", "required": false, "description": "视频流配置参数，当 RemoveVideo 为 0，该字段必填。", "example": "无" }, { "name": "AudioTemplate", "type": "object", "required": false, "description": "音频流配置参数，当 RemoveAudio 为 0，该字段必填。", "example": "无" }, { "name": "TEHDConfig", "type": "object", "required": false, "description": "极速高清转码参数。", "example": "无" }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "扩展参数，序列化的 json 字符串。", "example": "{\"video_info\":{\"color_prim\":\"bt709\"}}" }, { "name": "EnhanceConfig", "type": "object", "required": false, "description": "音视频增强配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SubtitleTemplate", "type": "object", "required": false, "description": "字幕参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OverrideParameter", "type": "object", "required": false, "description": "视频转码自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分转码参数时，将使用填写的参数覆盖转码模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Container", "type": "string", "required": false, "description": "封装格式，可选值：mp4、flv、hls、mp3、flac、ogg、m4a。其中，mp3、flac、ogg、m4a 为纯音频文件。", "example": "mp4" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，取值： 0：保留； 1：去除。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，取值： 0：保留； 1：去除。", "example": "0" }, { "name": "VideoTemplate", "type": "object", "required": false, "description": "视频流配置参数。", "example": "无" }, { "name": "AudioTemplate", "type": "object", "required": false, "description": "音频流配置参数。", "example": "无" }, { "name": "TEHDConfig", "type": "object", "required": false, "description": "极速高清转码参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SubtitleTemplate", "type": "object", "required": false, "description": "字幕流配置参数。", "example": "无" }, { "name": "AddonAudioStream", "type": "array", "required": false, "description": "外挂音轨参数。", "example": "无", "item_type": "string" }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "转码扩展字段。", "example": "{\"audio_info\": {\"codec\": \"vivid\"}}" }, { "name": "AddOnSubtitles", "type": "array", "required": false, "description": "要插入的字幕文件。", "example": "无", "item_type": "string" } ] }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板 ID。", "example": "NULL" }, { "name": "RawParameter", "type": "object", "required": false, "description": "水印自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。", "example": "NULL" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。", "example": "NULL" }, { "name": "SvgContent", "type": "string", "required": false, "description": "SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。 不填或填0，表示水印从画面开始就出现； 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。 注：只用于视频场景，截图不支持。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "水印的结束时间偏移，单位：秒。 不填或填0，表示水印持续到画面结束； 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。 注：只用于视频场景，截图不支持。", "example": "NULL" } ] }, { "name": "BlindWatermark", "type": "object", "required": false, "description": "数字水印参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "数字水印模板ID", "example": "10" } ] }, { "name": "MosaicSet", "type": "array", "required": false, "description": "马赛克列表，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "CoordinateOrigin", "type": "string", "required": false, "description": "原点位置，目前仅支持： TopLeft：表示坐标原点位于视频图像左上角，马赛克原点为图片或文字的左上角。 默认值：TopLeft。", "example": "NULL" }, { "name": "XPos", "type": "string", "required": false, "description": "马赛克原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式： 当字符串以 % 结尾，表示马赛克 XPos 为视频宽度指定百分比，如 10% 表示 XPos 为视频宽度的 10%； 当字符串以 px 结尾，表示马赛克 XPos 为指定像素，如 100px 表示 XPos 为 100 像素。 默认值：0px。", "example": "NULL" }, { "name": "YPos", "type": "string", "required": false, "description": "马赛克原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式： 当字符串以 % 结尾，表示马赛克 YPos 为视频高度指定百分比，如 10% 表示 YPos 为视频高度的 10%； 当字符串以 px 结尾，表示马赛克 YPos 为指定像素，如 100px 表示 YPos 为 100 像素。 默认值：0px。", "example": "NULL" }, { "name": "Width", "type": "string", "required": false, "description": "马赛克的宽度。支持 %、px 两种格式： 当字符串以 % 结尾，表示马赛克 Width 为视频宽度的百分比大小，如 10% 表示 Width 为视频宽度的 10%； 当字符串以 px 结尾，表示马赛克 Width 单位为像素，如 100px 表示 Width 为 100 像素。 默认值：10%。", "example": "NULL" }, { "name": "Height", "type": "string", "required": false, "description": "马赛克的高度。支持 %、px 两种格式： 当字符串以 % 结尾，表示马赛克 Height 为视频高度的百分比大小，如 10% 表示 Height 为视频高度的 10%； 当字符串以 px 结尾，表示马赛克 Height 单位为像素，如 100px 表示 Height 为 100 像素。 默认值：10%。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "马赛克的起始时间偏移，单位：秒。不填或填0，表示马赛克从画面出现时开始显现。 不填或填0，表示马赛克从画面开始就出现； 当数值大于0时（假设为 n），表示马赛克从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示马赛克从离画面结束 n 秒前开始出现。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "马赛克的结束时间偏移，单位：秒。 不填或填0，表示马赛克持续到画面结束； 当数值大于0时（假设为 n），表示马赛克持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示马赛克持续到离画面结束 n 秒前消失。", "example": "NULL" } ] }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "转码后的视频的起始时间偏移，单位：秒。 不填或填0，表示转码后的视频从原始视频的起始位置开始； 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始； 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。", "example": "1.0" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "转码后视频的终止时间偏移，单位：秒。 不填或填0，表示转码后的视频持续到原始视频的末尾终止； 当数值大于0时（假设为 n），表示转码后的视频持续到原始视频第 n 秒时终止； 当数值小于0时（假设为 -n），表示转码后的视频持续到原始视频结束 n 秒前终止。", "example": "15.0" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转码后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转码后主文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_transcode_{definition}.{format}`。", "example": "{inputName}_transcode_{definition}.{format}" }, { "name": "SegmentObjectName", "type": "string", "required": false, "description": "转码后分片文件的输出路径（转码 HLS 时 ts 的路径），只能为相对路径。如果不填，则默认为：`{inputName}_transcode_{definition}_{number}.{format}`。", "example": "{inputName}_transcode_{definition}_{number}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "转码后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InitialValue", "type": "integer", "required": false, "description": "`{number}`变量的起始值，默认为0。", "example": "0" }, { "name": "Increment", "type": "integer", "required": false, "description": "`{number}`变量的增长步长，默认为1。", "example": "1" }, { "name": "MinLength", "type": "integer", "required": false, "description": "`{number}`变量的最小长度，不足时补占位符。默认为1。", "example": "1" }, { "name": "PlaceHolder", "type": "string", "required": false, "description": "`{number}`变量的长度不足时，补充的占位符。默认为\"0\"。", "example": "0" } ] }, { "name": "HeadTailParameter", "type": "object", "required": false, "description": "片头片尾参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "HeadSet", "type": "array", "required": false, "description": "片头列表。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[ { \"Type\": \"URL\", \"UrlInputInfo\": { \"Url\": \"htt", "item_type": "string" }, { "name": "TailSet", "type": "array", "required": false, "description": "片尾列表。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[ { \"Type\": \"URL\", \"UrlInputInfo\": { \"Url\": \"htt", "item_type": "string" } ] } ] }, { "name": "AnimatedGraphicTaskSet", "type": "array", "required": false, "description": "视频转动图任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频转动图模板 ID。", "example": "20000" }, { "name": "StartTimeOffset", "type": "float", "required": true, "description": "动图在视频中的开始时间，单位为秒。", "example": "1.5" }, { "name": "EndTimeOffset", "type": "float", "required": true, "description": "动图在视频中的结束时间，单位为秒。", "example": "11.2" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转动图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转动图后文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_animatedGraphic_{definition}.{format}`。", "example": "文件名_{变量名}.{format}" } ] }, { "name": "SnapshotByTimeOffsetTaskSet", "type": "array", "required": false, "description": "对视频按时间点截图任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "指定时间点截图模板 ID。", "example": "11028" }, { "name": "ExtTimeOffsetSet", "type": "array", "required": false, "description": "截图时间点列表，时间点支持 s、% 两种格式： 当字符串以 s 结尾，表示时间点单位为秒，如 3.5s 表示时间点为第3.5秒； 当字符串以 % 结尾，表示时间点为视频时长的百分比大小，如10%表示时间点为视频前第10%的时间。", "example": "[\"3.5s\", \"50%\"]", "item_type": "string" }, { "name": "TimeOffsetSet", "type": "array", "required": false, "description": "截图时间点列表，单位为秒。此参数已不再建议使用，建议您使用 ExtTimeOffsetSet 参数。", "example": "[7.5, 10]", "item_type": "float" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板 ID。", "example": "NULL" }, { "name": "RawParameter", "type": "object", "required": false, "description": "水印自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。", "example": "NULL" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。", "example": "NULL" }, { "name": "SvgContent", "type": "string", "required": false, "description": "SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。 不填或填0，表示水印从画面开始就出现； 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。 注：只用于视频场景，截图不支持。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "水印的结束时间偏移，单位：秒。 不填或填0，表示水印持续到画面结束； 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。 注：只用于视频场景，截图不支持。", "example": "NULL" } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "时间点截图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "时间点截图后图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_snapshotByTimeOffset_{definition}_{number}.{format}`\ufffd...", "example": "/mps/output/{inputName}_test_{definition}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "时间点截图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InitialValue", "type": "integer", "required": false, "description": "`{number}`变量的起始值，默认为0。", "example": "0" }, { "name": "Increment", "type": "integer", "required": false, "description": "`{number}`变量的增长步长，默认为1。", "example": "1" }, { "name": "MinLength", "type": "integer", "required": false, "description": "`{number}`变量的最小长度，不足时补占位符。默认为1。", "example": "1" }, { "name": "PlaceHolder", "type": "string", "required": false, "description": "`{number}`变量的长度不足时，补充的占位符。默认为\"0\"。", "example": "0" } ] } ] }, { "name": "SampleSnapshotTaskSet", "type": "array", "required": false, "description": "对视频采样截图任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "采样截图模板 ID。", "example": "10" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板 ID。", "example": "NULL" }, { "name": "RawParameter", "type": "object", "required": false, "description": "水印自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。", "example": "NULL" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。", "example": "NULL" }, { "name": "SvgContent", "type": "string", "required": false, "description": "SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。 不填或填0，表示水印从画面开始就出现； 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。 注：只用于视频场景，截图不支持。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "水印的结束时间偏移，单位：秒。 不填或填0，表示水印持续到画面结束； 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。 注：只用于视频场景，截图不支持。", "example": "NULL" } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "采样截图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "采样截图后图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_sampleSnapshot_{definition}_{number}.{format}`。", "example": "/{inputName}_snapshotByTimeOffsetTest_{definition}_{number}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "采样截图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InitialValue", "type": "integer", "required": false, "description": "`{number}`变量的起始值，默认为0。", "example": "0" }, { "name": "Increment", "type": "integer", "required": false, "description": "`{number}`变量的增长步长，默认为1。", "example": "1" }, { "name": "MinLength", "type": "integer", "required": false, "description": "`{number}`变量的最小长度，不足时补占位符。默认为1。", "example": "1" }, { "name": "PlaceHolder", "type": "string", "required": false, "description": "`{number}`变量的长度不足时，补充的占位符。默认为\"0\"。", "example": "0" } ] } ] }, { "name": "ImageSpriteTaskSet", "type": "array", "required": false, "description": "对视频截雪碧图任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "雪碧图模板 ID。", "example": "10001" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "截取雪碧图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "截取雪碧图后，雪碧图图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_imageSprite_{definition}_{number}.{format...", "example": "xxx_imageSprite_10001_0.png" }, { "name": "WebVttObjectName", "type": "string", "required": false, "description": "截取雪碧图后，Web VTT 文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_imageSprite_{definition}.{format}`。", "example": "xxx_imageSprite_10001_0.vtt" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "截取雪碧图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InitialValue", "type": "integer", "required": false, "description": "`{number}`变量的起始值，默认为0。", "example": "0" }, { "name": "Increment", "type": "integer", "required": false, "description": "`{number}`变量的增长步长，默认为1。", "example": "1" }, { "name": "MinLength", "type": "integer", "required": false, "description": "`{number}`变量的最小长度，不足时补占位符。默认为1。", "example": "1" }, { "name": "PlaceHolder", "type": "string", "required": false, "description": "`{number}`变量的长度不足时，补充的占位符。默认为\"0\"。", "example": "0" } ] } ] }, { "name": "AdaptiveDynamicStreamingTaskSet", "type": "array", "required": false, "description": "转自适应码流任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "转自适应码流模板 ID。", "example": "10" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板 ID。", "example": "NULL" }, { "name": "RawParameter", "type": "object", "required": false, "description": "水印自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。", "example": "NULL" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。", "example": "NULL" }, { "name": "SvgContent", "type": "string", "required": false, "description": "SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。 不填或填0，表示水印从画面开始就出现； 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。 注：只用于视频场景，截图不支持。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "水印的结束时间偏移，单位：秒。 不填或填0，表示水印持续到画面结束； 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。 注：只用于视频场景，截图不支持。", "example": "NULL" } ] }, { "name": "BlindWatermark", "type": "object", "required": false, "description": "数字水印参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "数字水印模板ID", "example": "10" } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转自适应码流后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转自适应码流后，manifest 文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：{inputName}_adaptiveDynamicStreaming_{definition}.{format...", "example": "{inputName}_adaptiveDynamicStreaming_{definition}.{format}" }, { "name": "SubStreamObjectName", "type": "string", "required": false, "description": "转自适应码流后，子流文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}`。", "example": "{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}" }, { "name": "SegmentObjectName", "type": "string", "required": false, "description": "转自适应码流（仅 HLS）后，分片文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}`。", "example": "{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}" }, { "name": "AddOnSubtitles", "type": "array", "required": false, "description": "外挂字幕功能，指定要插入的字幕文件。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "插入形式，可选值： subtitle-stream：插入字幕轨道 close-caption-708：CEA-708字幕编码到SEI帧 close-caption-608：CEA-608字幕编码到SEI帧 注意：此字段可能返回 null，表示取不到有效值。", "example": "subtitle-stream" }, { "name": "Subtitle", "type": "object", "required": false, "description": "字幕文件。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SubtitleName", "type": "string", "required": false, "description": "字幕名称 。 注意：仅支持中文、英文、数字、空格、下划线(_)、短横线(-)、句点(.)和中英文括号，长度不能超过64个字符。 注意：此字段可能返回 null，表示取不到有效值。", "example": "字幕1" }, { "name": "OutputFormat", "type": "string", "required": false, "description": "字幕输出格式。取值{\"WebVTT\",\"TTML\"}。 默认值：\"WebVTT\"", "example": "WebVTT" }, { "name": "DefaultTrack", "type": "boolean", "required": false, "description": "默认字幕轨道。为true时指定当前字幕为默认字幕轨道，最多可指定1条默认字幕轨道。 默认值：false", "example": "false" } ] }, { "name": "DrmInfo", "type": "object", "required": false, "description": "Drm信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "加密类型： - simpleaes 只能用于HLS，切片格式支持ts和mp4 只能使用切片模式，不能使用singlefile模式 - fairplay： 只能用于HLS，切片格式只能是mp4 可以使用切片模式或singlefile模式 - widevine： 可以用于HLS和DASH，切片格式只能是mp4 输出HLS：可以使用切片模式或singlefile模式 输出DASH：只能singlefile模式 - playready： 可以用于HLS和DASH，切片格式只能是mp4 输出HLS：可以使用切片模式或singlefile...", "example": "widevine" }, { "name": "SimpleAesDrm", "type": "object", "required": false, "description": "SimpleAes 加密信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SpekeDrm", "type": "object", "required": false, "description": "FairPlay，WideVine，PlayReady 加密信息。", "example": "无" } ] }, { "name": "DefinitionType", "type": "string", "required": false, "description": "自适应转码模板类型： Common：音视频类型 PureAudio：纯音频类型", "example": "Common" }, { "name": "SubtitleTemplate", "type": "object", "required": false, "description": "硬字幕（压制字幕）功能，指定字幕来源、字体大小、位置等字幕参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Path", "type": "string", "required": false, "description": "要压制到视频中的字幕文件地址。 注意：此字段可能返回 null，表示取不到有效值。", "example": "https://test-13xxxx46.cos.ap-nanjing.myqcloud.com/xxxxx/subtitle/1.srt" }, { "name": "StreamIndex", "type": "integer", "required": false, "description": "指定要压制到视频中的字幕轨道，Streamindex的取值从0开始，0表示使用源视频中的第一条字幕轨。如果指定了Path，则优先使用Path。Path 和 StreamIndex 至少指定一个。 - 注意：StreamIndex必须与源文件中的字幕轨索引一致。例如，源文件中的字幕轨为stream#0:3，则StreamIndex应为3，否则可能导致任务处理失败。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SubtitleFileInput", "type": "object", "required": false, "description": "要压制到视频中的字幕文件的输入信息，目前仅支持存储在COS的字幕文件 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "FontFileInput", "type": "object", "required": false, "description": "压制字幕字体文件的输入信息，目前仅支持url和cos。都填时url优先于cos。填了FontFileInput时FontFileInput优先于FontType", "example": "无" }, { "name": "FontType", "type": "string", "required": false, "description": "字体类型，支持： hei.ttf：黑体 song.ttf：宋体 kai.ttf（推荐）或 simkai.ttf：楷体 msyh.ttf：微软雅黑 msyhbd.ttf：微软雅黑加粗 hkjgt.ttf：华康金刚体 dhttx.ttf：典黑体特细 xqgdzt.ttf：喜鹊古字典体 qpcyt.ttf：巧拼超圆体 arial.ttf：仅支持英文 dinalternate.ttf：DIN Alternate Bold helveticalt.ttf：Helvetica helveticains.ttf：Helvetica Inserat trajanpro.ttf：TrajanPro-Bold korean.ttf：韩语 japanese.ttf：日语 thai.ttf：泰语 默...", "example": "kai.ttf" }, { "name": "FontSize", "type": "string", "required": false, "description": "字体大小，不指定则以字幕文件中为准。支持像素和百分比格式： - 像素：Npx，N范围：(0,4096]。 - 百分百：N%，N范围：(0,100]；例如10%表示字幕字体大小=10%*源视频高度。 不填且字幕文件无设置时，默认源视频高度的5%。 注意：此字段可能返回 null，表示取不到有效值。", "example": "50px" }, { "name": "FontColor", "type": "string", "required": false, "description": "字体颜色，格式：0xRRGGBB，默认值：0xFFFFFF（白色）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0xFFFFFF" }, { "name": "FontAlpha", "type": "float", "required": false, "description": "文字透明度，取值范围：(0, 1] 0：完全透明 1：完全不透明 默认值：1。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1.0" }, { "name": "YPos", "type": "string", "required": false, "description": "字幕y轴坐标位置，指定此参数会忽略字幕文件自带坐标；支持像素和百分比格式： - 像素：Npx，N范围：[0,4096]。 - 百分百：N%，N范围：[0,100]；例如10%表示字幕y坐标=10%*源视频高度。 默认值：源视频高度*4%。 注意：坐标轴原点在源视频中轴线底部，字幕基准点在字幕中轴线底部，参考下图： ![image](https://ie-mps-1258344699.cos.ap-nanjing.tencentcos.cn/common/cloud/mps-demo/102_ai_subtitle/subtitle_sty...", "example": "4%" }, { "name": "BoardY", "type": "string", "required": false, "description": "字幕背景底板的y轴坐标位置；支持像素和百分比格式： - 像素：Npx，N范围：[0,4096]。 - 百分百：N%，N范围：[0,100]；例如10%表示字幕背景底板y坐标=10%*源视频高度。 不传表示不开启字幕背景底板。 注意：坐标轴原点位于源视频的中轴线底部，字幕背景底板的基准点在其中轴线底部，参考下图： ![image](https://ie-mps-1258344699.cos.ap-nanjing.tencentcos.cn/common/cloud/mps-demo/102_ai_subtitle/subtitle_...", "example": "1%" }, { "name": "BoardWidth", "type": "integer", "required": false, "description": "底板的宽度，正整数。 - 代表像素时，取值范围：[0,4096]。 - 代表百分数时，[0, 100]。 开启底板且不填此值时，默认源视频宽像素的90%。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1920" }, { "name": "BoardHeight", "type": "integer", "required": false, "description": "底板的高度，正整数。 - 代表像素时，取值范围：[0,4096]。 - 代表百分数时，[0, 100]。 开启底板且不填此值时，默认为源视频高像素的15%。 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "BoardColor", "type": "string", "required": false, "description": "底板颜色。格式：0xRRGGBB， 默认值：0x000000（黑色）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0x000000" }, { "name": "BoardAlpha", "type": "float", "required": false, "description": "字幕背景板透明度，取值范围：[0, 1] 0：完全透明 1：完全不透明 默认值：0.8。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0.8" }, { "name": "OutlineWidth", "type": "float", "required": false, "description": "描边宽度。浮点数。 - 代表像素值时， [0, 1000]。 - 代表百分数时，[0, 100]。 不填默认源视频高度的0.3%。", "example": "1.0" }, { "name": "OutlineColor", "type": "string", "required": false, "description": "描边颜色。6位16进制RGB。不填默认黑色。", "example": "0x000000" }, { "name": "OutlineAlpha", "type": "float", "required": false, "description": "描边透明度。(0，1] 正浮点数。不填默认1，完全不透明", "example": "0.8" }, { "name": "ShadowWidth", "type": "float", "required": false, "description": "阴影宽度。浮点数。 - 代表像素值时， [0, 1000]。 - 代表百分数时，[0, 100]。 不填默认无阴影。", "example": "1.0" }, { "name": "ShadowColor", "type": "string", "required": false, "description": "阴影颜色。6位16进制RGB。不填默认黑色（有设置阴影的情况下）", "example": "0x000000" }, { "name": "ShadowAlpha", "type": "float", "required": false, "description": "阴影透明度。(0，1] 正浮点数。不填默认1，完全不透明（有设置阴影的情况下）", "example": "0.9" }, { "name": "LineSpacing", "type": "integer", "required": false, "description": "行间距。正整数。 - 代表像素值时， [0, 1000]。 - 代表百分数时，[0, 100]。不填默认0。", "example": "5" }, { "name": "Alignment", "type": "string", "required": false, "description": "对齐方式，取值：top: 顶部对齐，字幕顶部按位置固定，底部随行数变化。bottom: 底部对齐，字幕底部按位置固定，顶部随行数变化。不填默认底部对齐。", "example": "bottom" }, { "name": "BoardWidthUnit", "type": "integer", "required": false, "description": "默认0。为1时BoardWidth代表百分之几，以视频宽为基准", "example": "1" }, { "name": "BoardHeightUnit", "type": "integer", "required": false, "description": "默认0。为1时BoardHeight代表百分之几，以视频高为基准", "example": "1" }, { "name": "OutlineWidthUnit", "type": "integer", "required": false, "description": "默认0。为1时OutlineWidth代表百分之几，以视频高为基准", "example": "1" }, { "name": "ShadowWidthUnit", "type": "integer", "required": false, "description": "默认0。为1时ShadowWidth代表百分之几，以视频高为基准", "example": "1" }, { "name": "LineSpacingUnit", "type": "integer", "required": false, "description": "默认0。为1时LineSpacing代表百分之几，以视频高为基准", "example": "1" } ] }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "转码参数扩展字段", "example": "{\"audio_info\": {\"codec\": \"vivid\"}}" }, { "name": "KeyPTSList", "type": "array", "required": false, "description": "指定pts时间的帧设为关键帧，并切片。单位毫秒（允许相对偏差\u003c=1ms）。当同时指定gop和切片时长时，会共同作用。注意需开启RawPts，保持帧率随源，并确保传入的pts时间在源中是有对应帧的。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[1000, 2000]", "item_type": "integer" } ] } ] }, { "name": "AiContentReviewTask", "type": "object", "required": false, "description": "视频内容审核类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容审核模板 ID。", "example": "10" } ] }, { "name": "AiAnalysisTask", "type": "object", "required": false, "description": "视频内容分析类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容分析模板 ID。", "example": "28" }, { "name": "ExtendedParameter", "type": "string", "required": false, "description": "扩展参数，其值为序列化的 json字符串。 注意：此参数为定制需求参数，参考如下： [智能檫除](https://cloud.tencent.com/document/product/862/101530) [智能拆条](https://cloud.tencent.com/document/product/862/112098) [高光集锦](https://cloud.tencent.com/document/product/862/107280) [智能横转竖](https://cloud.tencent.com/document/product/862/112112) 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"{\\\"htv\\\": {} }\"" } ] }, { "name": "AiRecognitionTask", "type": "object", "required": false, "description": "视频内容识别类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频智能识别模板 ID 。", "example": "10" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "用户扩展字段，一般场景不用填。", "example": "{\"ParaTest\":\"test\"}" } ] }, { "name": "TaskNotifyConfig", "type": "object", "required": false, "description": "任务的事件通知配置，不填代表不获取事件通知。", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型，可选值： CMQ：已下线，建议切换到TDMQ-CMQ TDMQ-CMQ：消息队列 URL：指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同解析事件通知接口的输出参数 SCF：不推荐使用，需要在控制台额外配置SCF AWS-SQS：AWS 队列，只适用于 AWS 任务，且要求同区域 注：不填或为空时默认 TDMQ-CMQ，如需采用其他类型需填写对应类型值；如果使用TDMQ-CMQ消息队列，任务\ufffd...", "example": "URL" }, { "name": "NotifyMode", "type": "string", "required": false, "description": "工作流通知的模式，可取值有 Finish 和 Change，不填代表 Finish。", "example": "Finish " }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的模型，有 Queue 和 Topic 两种。", "example": "Queue " }, { "name": "CmqRegion", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。", "example": "mps_notify" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。", "example": "mps_que" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "AWS SQS 回调，NotifyType为 AWS-SQS 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NULL", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的key。", "example": "0se***9idaY" } ] }, { "name": "TaskPriority", "type": "integer", "required": false, "description": "工作流的优先级，数值越大优先级越高，取值范围是 -10 到 10，不填代表 0。", "example": "0" } ], "required": [ "WorkflowName", "Trigger" ] }, { "name": "DeleteAIAnalysisTemplate", "description": "删除用户自定义内容分析模板。 注意：模板 ID 为 10000 以下的为系统预置模板，不允许删除。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容分析模板唯一标识。", "example": "30" } ], "required": [ "Definition" ] }, { "name": "DeleteAIRecognitionTemplate", "description": "删除用户自定义内容识别模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容识别模板唯一标识。", "example": "30" } ], "required": [ "Definition" ] }, { "name": "DeleteAdaptiveDynamicStreamingTemplate", "description": "删除转自适应码流模板", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "自适应转码模板唯一标识。", "example": "10001" } ], "required": [ "Definition" ] }, { "name": "DeleteAnimatedGraphicsTemplate", "description": "删除用户自定义转动图模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "转动图模板唯一标识。", "example": "10001" } ], "required": [ "Definition" ] }, { "name": "DeleteAsrHotwords", "description": "删除智能字幕热词库", "status": "online", "parameters": [ { "name": "HotwordsId", "type": "string", "required": true, "description": "删除的热词库 id", "example": "hwd-aexxxxxxxxxxxxxx1481" } ], "required": [ "HotwordsId" ] }, { "name": "DeleteBlindWatermarkTemplate", "description": "删除用户自定义数字水印模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "数字水印模板唯一标识。", "example": "10" } ], "required": [ "Definition" ] }, { "name": "DeleteContentReviewTemplate", "description": "删除用户自定义内容审核模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "内容审核模板唯一标识。", "example": "30" } ], "required": [ "Definition" ] }, { "name": "DeleteImageSpriteTemplate", "description": "删除雪碧图模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "雪碧图模板唯一标识。", "example": "10001" } ], "required": [ "Definition" ] }, { "name": "DeleteLiveRecordTemplate", "description": "删除直播录制模板", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "录制模板唯一标识。", "example": "20001" } ], "required": [ "Definition" ] }, { "name": "DeletePersonSample", "description": "该接口用于根据素材 ID，删除素材样本。", "status": "online", "parameters": [ { "name": "PersonId", "type": "string", "required": true, "description": "素材 ID。" } ], "required": [ "PersonId" ] }, { "name": "DeleteProcessImageTemplate", "description": "删除图片处理模板", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": false, "description": "图片处理模板唯一标识。", "example": "200043" } ], "required": [] }, { "name": "DeleteQualityControlTemplate", "description": "删除媒体质检模板", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "媒体质检模板唯一标识。", "example": "10001" } ], "required": [ "Definition" ] }, { "name": "DeleteSampleSnapshotTemplate", "description": "删除用户自定义采样截图模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "采样截图模板唯一标识。", "example": "10001" } ], "required": [ "Definition" ] }, { "name": "DeleteSchedule", "description": "删除编排", "status": "online", "parameters": [ { "name": "ScheduleId", "type": "integer", "required": true, "description": "编排唯一标识。", "example": "0" } ], "required": [ "ScheduleId" ] }, { "name": "DeleteSmartEraseTemplate", "description": "删除用户自定义智能擦除模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "智能擦除模板唯一标识。", "example": "30" } ], "required": [ "Definition" ] }, { "name": "DeleteSmartSubtitleTemplate", "description": "删除用户自定义智能字幕模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "智能字幕模板唯一标识。", "example": "30" } ], "required": [ "Definition" ] }, { "name": "DeleteSnapshotByTimeOffsetTemplate", "description": "删除用户自定义指定时间点截图模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "指定时间点截图模板唯一标识。", "example": "10001" } ], "required": [ "Definition" ] }, { "name": "DeleteStreamLinkEvent", "description": "删除媒体传输的事件配置。", "status": "online", "parameters": [ { "name": "EventId", "type": "string", "required": true, "description": "媒体传输事件Id，删除前需要保证该Event关联的所有Flow都已经删除。", "example": "01937702ecc509dc0f3269ca3420" } ], "required": [ "EventId" ] }, { "name": "DeleteStreamLinkFlow", "description": "删除媒体传输的传输流配置。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "传输流Id。", "example": "01937702c54509dc0f3269ca341f" } ], "required": [ "FlowId" ] }, { "name": "DeleteStreamLinkOutput", "description": "删除媒体传输流的输出配置。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "流Id。", "example": "01937702c54509dc0f3269ca341f" }, { "name": "OutputId", "type": "string", "required": true, "description": "输出Id。", "example": "019202e96d9f09dc0f325e7f7a2a" } ], "required": [ "FlowId", "OutputId" ] }, { "name": "DeleteStreamLinkSecurityGroup", "description": "删除安全组。", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "安全组 ID。", "example": "019202e96d9f09dc0f325e7f7a2a" } ], "required": [ "Id" ] }, { "name": "DeleteTranscodeTemplate", "description": "删除用户自定义转码模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "转码模板唯一标识。", "example": "1008" } ], "required": [ "Definition" ] }, { "name": "DeleteWatermarkTemplate", "description": "删除用户自定义水印模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板唯一标识。", "example": "1001" } ], "required": [ "Definition" ] }, { "name": "DeleteWordSamples", "description": "该接口用于批量删除关键词样本。", "status": "online", "parameters": [ { "name": "Keywords", "type": "array", "required": true, "description": "关键词，数组长度限制：100 个词。", "example": "“”", "item_type": "string" } ], "required": [ "Keywords" ] }, { "name": "DeleteWorkflow", "description": "删除工作流。对于已启用的工作流，需要禁用后才能删除。", "status": "online", "parameters": [ { "name": "WorkflowId", "type": "integer", "required": true, "description": "工作流 ID。", "example": "100010" } ], "required": [ "WorkflowId" ] }, { "name": "DescribeAIAnalysisTemplates", "description": "根据内容分析模板唯一标识，获取内容分析模板详情列表。返回结果包含符合条件的所有用户自定义内容分析模板及系统预置视频内容分析模板", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "视频内容分析模板唯一标识过滤条件，数组长度限制：100。", "example": "[30]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "10" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，不填则返回所有，可选值： * Preset：系统预置模板； * Custom：用户自定义模板。", "example": "Preset" }, { "name": "Name", "type": "string", "required": false, "description": "视频内容分析模板标识过滤条件，长度限制：64 个字符。", "example": "内容分析模板" } ], "required": [] }, { "name": "DescribeAIRecognitionTemplates", "description": "根据内容识别模板唯一标识，获取内容识别模板详情列表。返回结果包含符合条件的所有用户自定义内容识别模板及系统预置视频内容识别模板", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "视频内容识别模板唯一标识过滤条件，数组长度限制：100。", "example": "[30]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：50。", "example": "10" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，不填则返回所有，可选值： * Preset：系统预置模板； * Custom：用户自定义模板。", "example": "Preset" }, { "name": "Name", "type": "string", "required": false, "description": "视频内容识别模板标识过滤条件，长度限制：64 个字符。", "example": "Presetting Template" } ], "required": [] }, { "name": "DescribeAdaptiveDynamicStreamingTemplates", "description": "查询转自适应码流模板，支持根据条件，分页查询。", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "转自适应码流模板唯一标识过滤条件，数组长度限制：100。", "example": "[10001]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "0" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，可选值： Preset：系统预置模板； Custom：用户自定义模板。", "example": "Preset" }, { "name": "PureAudio", "type": "integer", "required": false, "description": "是否为纯音频，0表示视频，1表示纯音频 默认值：0", "example": "0" }, { "name": "Name", "type": "string", "required": false, "description": "自适应转码模板标识过滤条件，长度限制：64 个字符", "example": "Presetting HLS" } ], "required": [] }, { "name": "DescribeAigcImageTask", "description": "调用该接口，查询AIGC生图片任务进度以及获取生成结果。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "创建的AIGC生图片任务ID。", "example": "4-AigcImage-c3b145ec76****94ac55b9e63be17d" } ], "required": [ "TaskId" ] }, { "name": "DescribeAigcVideoTask", "description": "调用该接口，用于查询AIGC生视频任务的进度以及获取生成结果。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "创建AIGC生视频任务时，返回的任务ID。", "example": "4-AigcVideo-c3b145******4ac55b699e63be17d" } ], "required": [ "TaskId" ] }, { "name": "DescribeAnimatedGraphicsTemplates", "description": "查询转动图模板列表，支持根据条件，分页查询。", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "转动图模板唯一标识过滤条件，数组长度限制：100。", "example": "[\"10001\\r\\n\"]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "0" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，可选值： Preset：系统预置模板； Custom：用户自定义模板。", "example": "“”" }, { "name": "Name", "type": "string", "required": false, "description": "转动图模板标识过滤条件，长度限制：64 个字符。", "example": "“”" } ], "required": [] }, { "name": "DescribeAsrHotwords", "description": "查询智能字幕热词库", "status": "online", "parameters": [ { "name": "HotwordsId", "type": "string", "required": false, "description": "需要查询的热词库 id **注意：HotwordsId 与 Name 必须选择填写一个，如果同时填写，HotwordsId 优先级高于 Name**", "example": "hwd-aexxxxxxxxxx1481" }, { "name": "Name", "type": "string", "required": false, "description": "热词库名称， **注意：HotwordsId 与 Name 必须选择填写一个，如果同时填写，HotwordsId 优先级高于 Name**", "example": "热词1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "10" }, { "name": "OrderBy", "type": "string", "required": false, "description": "热词排序字段，目前可选值为 - Default：默认文件中的顺序 - Weight：权重排序 - Lexical：热词文本排序", "example": "Default" }, { "name": "OrderType", "type": "integer", "required": false, "description": "热词排序顺序 0：升序（默认） 1：降序", "example": "0" } ], "required": [] }, { "name": "DescribeAsrHotwordsList", "description": "获取热词库列表", "status": "online", "parameters": [ { "name": "HotwordsId", "type": "string", "required": false, "description": "检索参数，根据热词库 id 查询", "example": "hwd-aexxxxxxxxxxx1481" }, { "name": "Name", "type": "string", "required": false, "description": "检索参数，根据热词库名称查询", "example": "Hotwords" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认返回所有热词库", "example": "10" }, { "name": "OrderType", "type": "integer", "required": false, "description": "热词排序顺序 0：升序（默认） 1：降序", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "根据某个字段排序，默认使用创建时间，使用非法字段视为默认情况 - CreateTime：创建时间排序 - UpdateTime：更新时间排序 - Name：热词库名称排序 - WordCount：热词数量排序 - HotwordsId：热词库 id 排序", "example": "CreateTime" }, { "name": "Types", "type": "array", "required": false, "description": "0 临时热词 1 文件热词", "example": "[0,1]", "item_type": "integer" } ], "required": [] }, { "name": "DescribeBatchTaskDetail", "description": "通过任务 ID 查询任务的执行状态和结果的详细信息（最多可以查询7天之内提交的任务）。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "视频处理任务的任务 ID。", "example": "235303****-BatchTask-80108cc3380155d98b2e3573a48a******" } ], "required": [ "TaskId" ] }, { "name": "DescribeBlindWatermarkTemplates", "description": "查询用户自定义数字水印模板，支持根据条件，分页查询。", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "数字水印模板唯一标识过滤条件，数组长度限制：100。", "example": "[10,20,30]", "item_type": "integer" }, { "name": "Name", "type": "string", "required": false, "description": "数字水印模板标识过滤条件，长度限制：64 个字符。", "example": "数字水印模板1" }, { "name": "Type", "type": "string", "required": false, "description": "数字水印类型，可选值：blind-basic：基础版权数字水印；blind-nagra：Nagra取证水印；", "example": "blind-basic" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数 默认值：10； 最大值：100。", "example": "10" } ], "required": [] }, { "name": "DescribeContentReviewTemplates", "description": "根据智能审核模板唯一标识，获取智能审核模板详情列表。返回结果包含符合条件的所有用户自定义模板及系统预置智能审核模板。", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "智能审核模板唯一标识过滤条件，数组长度限制：50。", "example": "无", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "无" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：50。", "example": "无" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，不填则返回所有，可选值： * Preset：系统预置模板； * Custom：用户自定义模板。", "example": "“”" }, { "name": "Name", "type": "string", "required": false, "description": "智能审核模板标识过滤条件，长度限制：64 个字符。", "example": "“”" } ], "required": [] }, { "name": "DescribeGroupAttachFlowsById", "description": "根据安全组反差关联的Flow信息。", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": false, "description": "媒体传输安全组ID。", "example": "019202e96d9f09dc0f325e7f7a2a" } ], "required": [] }, { "name": "DescribeImageSpriteTemplates", "description": "查询雪碧图模板，支持根据条件，分页查询。", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "雪碧图模板唯一标识过滤条件，数组长度限制：100。", "example": "[\"10001\\r\\n\"]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "0" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，可选值： Preset：系统预置模板； Custom：用户自定义模板。", "example": "“”" }, { "name": "Name", "type": "string", "required": false, "description": "雪碧图模板标识过滤条件，长度限制：64 个字符。", "example": "“”" } ], "required": [] }, { "name": "DescribeImageTaskDetail", "description": "通过任务 ID 查询任务的执行状态和结果的详细信息（最多可以查询7天之内提交的任务）。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "图片处理任务的任务 ID。", "example": "235303****-WorkflowTask-80108cc3380155d98b2e3573a48a******" } ], "required": [ "TaskId" ] }, { "name": "DescribeLiveRecordTemplates", "description": "获取直播录制模板", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "录制模板唯一标识过滤条件，数组长度限制：100。", "example": "[20001]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "10" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，不填则返回所有，可选值： * Preset：系统预置模板； * Custom：用户自定义模板。", "example": "Preset" }, { "name": "Name", "type": "string", "required": false, "description": "录制模板标识过滤条件，长度限制：64 个字符。", "example": "直播录制通用模板" } ], "required": [] }, { "name": "DescribeMediaMetaData", "description": "获取媒体的元信息，包括视频画面宽、高、编码格式、时长、帧率等。", "status": "online", "parameters": [ { "name": "InputInfo", "type": "object", "required": true, "description": "需要获取元信息的文件输入信息。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输入来源对象的类型，支持： COS：COS源 URL：URL源 AWS-S3：AWS 源，目前只支持转码任务 VOD：点播专业版", "example": "NULL" }, { "name": "CosInputInfo", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 对象信息。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": true, "description": "媒体处理对象文件的输入路径，如`/movie/201907/WildAnimal.mov`。", "example": "/movie/201907/WildAnimal.mov" } ] }, { "name": "UrlInputInfo", "type": "object", "required": false, "description": "当 Type 为 URL 时有效，则该项为必填，表示媒体处理 URL 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频的 URL。", "example": "NULL" } ] }, { "name": "S3InputInfo", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-us-125678" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域，目前支持： us-east-1 eu-west-3 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1 " }, { "name": "S3Object", "type": "string", "required": true, "description": "S3 bucket 中的媒体资源路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/test.mp4" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bb5******eff" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bbc5******eff" } ] }, { "name": "VODInputInfo", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理对象文件所在的 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理对象文件所在的 Bucket 所属园区", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": false, "description": "媒体处理对象文件的输入路径", "example": "/movie/201907/WildAnimal.mov" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] } ], "required": [ "InputInfo" ] }, { "name": "DescribePersonSamples", "description": "该接口用于查询素材样本信息，支持根据素材 ID、名称、标签，分页查询。", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": false, "description": "拉取的素材类型，可选值： UserDefine：用户自定义素材库； Default：系统默认素材库。 默认值：UserDefine，拉取用户自定义素材库素材。 说明：如果是拉取系统默认素材库，只能使用素材名字或者素材 ID + 素材名字的方式进行拉取，且人脸图片只返回一张。" }, { "name": "PersonIds", "type": "array", "required": false, "description": "素材 ID，数组长度限制：100。", "item_type": "string" }, { "name": "Names", "type": "array", "required": false, "description": "素材名称，数组长度限制：20。", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "素材标签，数组长度限制：20。", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：100，最大值：100。" } ], "required": [] }, { "name": "DescribeProcessImageTemplates", "description": "查询图片处理模板列表。", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "图片处理模板唯一标识过滤条件，数组长度限制：100。", "example": "[1001]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数 默认值：10；最大值：100。", "example": "10" }, { "name": "Name", "type": "string", "required": false, "description": "图片处理模板标识过滤条件。", "example": "图片处理模板1" }, { "name": "OrderType", "type": "integer", "required": false, "description": "排序方式，OrderBy设置后才有效，可选值： 0：升序 1：降序 默认 0。", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，可选值： Definition：模板唯一标识； 默认值：创建时间。", "example": "Definition" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，可选值： Preset：系统预置模板； Custom：用户自定义模板。", "example": "Preset" } ], "required": [] }, { "name": "DescribeQualityControlTemplates", "description": "查询用户自定义媒体质检模板，支持根据条件，分页查询。", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "媒体质检模板唯一标识过滤条件，数组长度限制：100。", "example": "[1001]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数 默认值：10； 最大值：100。", "example": "10" }, { "name": "Type", "type": "string", "required": false, "description": "\"Preset\"：预设，Custom\":自定义模板", "example": "Preset" }, { "name": "Name", "type": "string", "required": false, "description": "媒体质检模板标识过滤条件，长度限制：64 个字符。", "example": "质检模板1" } ], "required": [] }, { "name": "DescribeSampleSnapshotTemplates", "description": "查询采样截图模板，支持根据条件，分页查询。", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "采样截图模板唯一标识过滤条件，数组长度限制：100。", "example": "[\"10001\\r\\n\"]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "10" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，可选值： Preset：系统预置模板； Custom：用户自定义模板。", "example": "“”" }, { "name": "Name", "type": "string", "required": false, "description": "采样截图模板标识过滤条件，长度限制：64 个字符。", "example": "“”" } ], "required": [] }, { "name": "DescribeSchedules", "description": "查询编排。", "status": "online", "parameters": [ { "name": "ScheduleIds", "type": "array", "required": false, "description": "编排 ID 过滤条件，数组长度限制：100。", "example": "[100]", "item_type": "integer" }, { "name": "TriggerType", "type": "string", "required": false, "description": "编排触发类型，可选值： CosFileUpload： 腾讯云 COS 文件上传触发 AwsS3FileUpload：Aws S3 文件上传触发。 不填或者为空表示全部。", "example": "CosFileUpload" }, { "name": "Status", "type": "string", "required": false, "description": "状态，取值范围： Enabled：已启用， Disabled：已禁用。 不填此参数，则不区编排状态。", "example": "Disabled" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "0" } ], "required": [] }, { "name": "DescribeSmartEraseTemplates", "description": "根据智能擦除模板唯一标识，获取智能擦除模板详情列表。返回结果包含符合条件的所有用户自定义智能擦除模板及系统预置智能擦除模板", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "智能擦除模板唯一标识过滤条件，数组长度限制：100。", "example": "[30]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "10" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，不填则返回所有，可选值： * Preset：系统预置模板； * Custom：用户自定义模板。", "example": "Preset" }, { "name": "EraseType", "type": "string", "required": false, "description": "智能擦除模板擦除类型过滤条件。 - subtitle 去字幕 - watermark 去水印 - privacy 隐私保护", "example": "擦除模板类型" }, { "name": "Name", "type": "string", "required": false, "description": "智能擦除模板名过滤条件，长度限制：64 个字符。", "example": "擦除模板1" } ], "required": [] }, { "name": "DescribeSmartSubtitleTemplates", "description": "根据智能字幕 模板唯一标识，获取智能字幕模板详情列表。返回结果包含符合条件的所有用户自定义智能字幕模板及系统预置智能字幕模板", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "智能字幕模板唯一标识过滤条件，数组长度限制：100。", "example": "[30]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "10" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，不填则返回所有，可选值： * Preset：系统预置模板； * Custom：用户自定义模板。", "example": "Preset" }, { "name": "Name", "type": "string", "required": false, "description": "智能字幕模板标识过滤条件，长度限制：64 个字符。", "example": "智能字幕模板" }, { "name": "ProcessType", "type": "integer", "required": false, "description": "字幕处理类型： - 0：ASR识别字幕 - 1：纯字幕翻译", "example": "0" } ], "required": [] }, { "name": "DescribeSnapshotByTimeOffsetTemplates", "description": "查询指定时间点截图模板，支持根据条件，分页查询。", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "指定时间点截图模板唯一标识过滤条件，数组长度限制：100。", "example": "10001", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "10" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，可选值： Preset：系统预置模板； Custom：用户自定义模板。", "example": "Preset" }, { "name": "Name", "type": "string", "required": false, "description": "指定时间点截图模板标识过滤条件，长度限制：64 个字符。", "example": "截图模板" } ], "required": [] }, { "name": "DescribeStreamLinkActivateState", "description": "查询媒体传输开通状态。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeStreamLinkEvent", "description": "查询媒体传输事件的配置信息。", "status": "online", "parameters": [ { "name": "EventId", "type": "string", "required": true, "description": "媒体传输事件ID。", "example": "eventid" } ], "required": [ "EventId" ] }, { "name": "DescribeStreamLinkEventAttachedFlows", "description": "查询媒体传输事件关联的所有媒体输入流的配置信息。", "status": "online", "parameters": [ { "name": "EventId", "type": "string", "required": true, "description": "EventId。", "example": "无" }, { "name": "PageNum", "type": "integer", "required": false, "description": "当前页数，默认1。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页大小，默认1000。", "example": "10" } ], "required": [ "EventId" ] }, { "name": "DescribeStreamLinkEvents", "description": "批量查询媒体传输事件的配置信息。", "status": "online", "parameters": [ { "name": "PageNum", "type": "integer", "required": false, "description": "当前页数，默认1。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页大小，默认10。", "example": "10" } ], "required": [] }, { "name": "DescribeStreamLinkFlow", "description": "查询媒体输入流的配置信息。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "流Id。", "example": "0193d38d0a4f09dc0f326fd4342c" } ], "required": [ "FlowId" ] }, { "name": "DescribeStreamLinkFlowLogs", "description": "查询媒体传输流的日志信息。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "传输流Id。", "example": "0175723949ba0956b92d0bf40cfe" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计的开始时间，默认为前一小时，最多支持查询近7天。 UTC时间，如'2020-01-01T12:00:00Z'。", "example": "2020-12-10T13:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计的结束时间，默认为StartTime后一小时，最多支持查询24小时的数据。 UTC时间，如'2020-01-01T12:00:00Z'。", "example": "2020-12-10T13:27:00Z" }, { "name": "Type", "type": "array", "required": true, "description": "输入或输出类型，可选[input|output]。", "example": "[\"Input\",\"Output\"]", "item_type": "string" }, { "name": "Pipeline", "type": "array", "required": true, "description": "主通道或备通道，可选[0|1]。", "example": "[\"0\",\"1\"]", "item_type": "string" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页大小，默认100，范围为[1, 1000]。", "example": "100" }, { "name": "SortType", "type": "string", "required": false, "description": "按Timestamp升序或降序排序，默认降序，可选[desc|asc]。", "example": "desc" }, { "name": "PageNum", "type": "integer", "required": false, "description": "页码，默认1，范围为[1, 1000]。", "example": "1" } ], "required": [ "FlowId", "StartTime", "EndTime", "Type", "Pipeline", "PageSize" ] }, { "name": "DescribeStreamLinkFlowMediaStatistics", "description": "查询媒体传输流的媒体质量数据。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "传输流ID。", "example": "0175723949ba0956b92d0bf40cfe" }, { "name": "Type", "type": "string", "required": true, "description": "输入或输出类型，可选[input|output]。", "example": "input" }, { "name": "InputOutputId", "type": "string", "required": true, "description": "输入或输出Id。", "example": "0175723949bb0956b92d0bf40cff" }, { "name": "Pipeline", "type": "string", "required": true, "description": "主通道或备通道，可选[0|1]。", "example": "0" }, { "name": "Period", "type": "string", "required": true, "description": "查询间隔，可选[5s|1min|5min|15min]。", "example": "1min" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计的开始时间，默认为前一小时，最多支持查询近7天。 UTC时间，如'2020-01-01T12:00:00Z'。", "example": "2020-12-10T11:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计的结束时间，默认为StartTime后一小时，最多支持查询24小时的数据。 UTC时间，如'2020-01-01T12:00:00Z'。", "example": "2020-12-10T12:00:00Z" }, { "name": "RemoteIp", "type": "string", "required": false, "description": "对端客户端或者服务端的IP地址", "example": "101.101.101.101" } ], "required": [ "FlowId", "Type", "InputOutputId", "Pipeline", "Period", "StartTime", "EndTime" ] }, { "name": "DescribeStreamLinkFlowRealtimeStatus", "description": "实时查询流的当前状态", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "流ID。", "example": "0176ac7f1af20956b92d2aad1e6d" }, { "name": "InputIds", "type": "array", "required": false, "description": "输入id数组，如果输入输出数组都为空，则代表全量查询。", "example": "[\"0176ac7f1af3\",\"0956b92d2aad1e6e\"]", "item_type": "string" }, { "name": "OutputIds", "type": "array", "required": false, "description": "输出id数组，如果输入输出数组都为空，则代表全量查询。", "example": "[\"0178c3f4bceb09\",\"56b92d149e1b5d\"]", "item_type": "string" } ], "required": [ "FlowId" ] }, { "name": "DescribeStreamLinkFlowSRTStatistics", "description": "查询媒体传输流的SRT质量数据。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "传输流ID。", "example": "0175723949ba0956b92d0bf40cfe" }, { "name": "Type", "type": "string", "required": true, "description": "输入或输出类型，可选[input|output]。", "example": "input" }, { "name": "InputOutputId", "type": "string", "required": true, "description": "输入或输出Id。", "example": "0175723949bb0956b92d0bf40cff" }, { "name": "Pipeline", "type": "string", "required": true, "description": "主通道或备通道，可选[0|1]。", "example": "0" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计的开始时间，默认为前一小时，最多支持查询近7天。 UTC时间，如'2020-01-01T12:00:00Z'。", "example": "2020-12-10T11:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计的结束时间，默认为StartTime后一小时，最多支持查询24小时的数据。 UTC时间，如'2020-01-01T12:00:00Z'。", "example": "2020-12-10T12:00:00Z" }, { "name": "Period", "type": "string", "required": true, "description": "查询间隔，可选[5s|1min|5min|15min]。", "example": "1min" }, { "name": "RemoteIp", "type": "string", "required": false, "description": "对端客户端或者服务端的IP地址", "example": "101.101.101.101" } ], "required": [ "FlowId", "Type", "InputOutputId", "Pipeline", "StartTime", "EndTime", "Period" ] }, { "name": "DescribeStreamLinkFlowStatistics", "description": "查询媒体传输流的媒体质量数据。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "传输流ID。", "example": "019202e96d9f09dc0f325e7f7a2a" }, { "name": "Type", "type": "string", "required": true, "description": "输入或输出类型，可选[input|output]。", "example": "input" }, { "name": "InputOutputId", "type": "string", "required": true, "description": "输入或输出Id。", "example": "01937702ecc509dc0f3269ca3420" }, { "name": "Pipeline", "type": "string", "required": true, "description": "主通道或备通道，可选[0|1]。", "example": "0" }, { "name": "Period", "type": "string", "required": true, "description": "查询间隔，可选[5s|1min|5min|15min]。", "example": "1min" }, { "name": "StartTime", "type": "string", "required": true, "description": "统计的开始时间，默认为前一小时，最多支持查询近7天。 UTC时间，如'2020-01-01T12:00:00Z'。", "example": "2020-01-01T12:00:00Z" }, { "name": "EndTime", "type": "string", "required": true, "description": "统计的结束时间，默认为StartTime后一小时，最多支持查询24小时的数据。 UTC时间，如'2020-01-01T12:00:00Z'。", "example": "2020-01-01T12:00:00Z" }, { "name": "RemoteIp", "type": "string", "required": false, "description": "对端客户端或者服务端的IP地址", "example": "101.101.101.101" } ], "required": [ "FlowId", "Type", "InputOutputId", "Pipeline", "Period", "StartTime", "EndTime" ] }, { "name": "DescribeStreamLinkFlows", "description": "批量查询媒体输入流的配置信息。", "status": "online", "parameters": [ { "name": "PageNum", "type": "integer", "required": false, "description": "当前页数，默认1。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页大小，默认10。", "example": "10" } ], "required": [] }, { "name": "DescribeStreamLinkRegions", "description": "查询媒体传输所有地区。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeStreamLinkSecurityGroups", "description": "批量查询安全组信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeTaskDetail", "description": "通过任务 ID 查询任务的执行状态和结果的详细信息（最多可以查询7天之内提交的任务）。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "视频处理任务的任务 ID。", "example": "235303****-WorkflowTask-80108cc3380155d98b2e3573a48a******" } ], "required": [ "TaskId" ] }, { "name": "DescribeTasks", "description": "* 该接口用于查询任务列表； * 当列表数据比较多时，单次接口调用无法拉取整个列表，可通过 ScrollToken 参数，分批拉取； * 只能查询到最近七天（168小时）内的任务。", "status": "online", "parameters": [ { "name": "Status", "type": "string", "required": true, "description": "任务状态过滤条件，可选值： - WAITING（等待中） - PROCESSING（处理中） - FINISH（已完成）。", "example": "FINISH" }, { "name": "SubTaskHasFailed", "type": "boolean", "required": false, "description": "任务结束时子任务是否有失败。如果不传则忽略。 false: 过滤子任务没有失败的任务； true: 过滤子任务有失败的任务。", "example": "false" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "10" }, { "name": "ScrollToken", "type": "string", "required": false, "description": "翻页标识，分批拉取时使用：当单次请求无法拉取所有数据，接口将会返回 ScrollToken，下一次请求携带该 Token，将会从下一条记录开始获取。", "example": "531d5385xxxx" }, { "name": "StartTime", "type": "string", "required": false, "description": "查询任务开始时间", "example": "2021-02-03T04:05:06Z" }, { "name": "EndTime", "type": "string", "required": false, "description": "查询任务结束时间。", "example": "2021-02-03T04:05:06Z" } ], "required": [ "Status" ] }, { "name": "DescribeTranscodeTemplates", "description": "根据转码模板唯一标识，获取转码模板详情列表。返回结果包含符合条件的所有用户自定义模板及[系统预置转码模板](https://cloud.tencent.com/document/product/266/33476#.E9.A2.84.E7.BD.AE.E8.BD.AC.E7.A0.81.E6.A8.A1.E6.9D.BF)。", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "转码模板唯一标识过滤条件，数组长度限制：100。", "example": "[10]", "item_type": "integer" }, { "name": "Type", "type": "string", "required": false, "description": "模板类型过滤条件，可选值： Preset：系统预置模板； Custom：用户自定义模板。", "example": "Preset" }, { "name": "ContainerType", "type": "string", "required": false, "description": "封装格式过滤条件，可选值： Video：视频格式，可以同时包含视频流和音频流的封装格式板； PureAudio：纯音频格式，只能包含音频流的封装格式。", "example": "Video" }, { "name": "TEHDType", "type": "string", "required": false, "description": "（建议使用TranscodeType代替）极速高清过滤条件，用于过滤普通转码或极速高清转码模板，可选值： Common：普通转码模板； TEHD：极速高清模板。", "example": "Common" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "10" }, { "name": "TranscodeType", "type": "string", "required": false, "description": "模板类型（替换旧版本 TEHDType），可选值： Common：普通转码模板； TEHD：视频极速高清，老的类型（建议使用 TEHD-100） 。 TEHD-100：视频极速高清 TEHD-200：音频极速高清 Enhance：音视频增强模板。 默认空，不限制类型。", "example": "Common" }, { "name": "Name", "type": "string", "required": false, "description": "转码模板标识过滤条件，长度限制：64 个字符。", "example": "MP4" }, { "name": "SceneType", "type": "string", "required": false, "description": "视频场景化，可选值： normal：通用转码场景：通用转码压缩场景。 pgc：PGC高清影视：压缩时会注重影视剧的观看体验，根据影视剧特性进行ROI编码，同时保留高质量的视频内容和音频。 materials_video：高清素材：素材资源类场景，对画质要求极高，较多透明画面内容，在压缩的同时接近视觉无损。 ugc：UGC内容：适用于广泛的UGC/短视频场景，针对短视频的特性优化编码码率， \ufffd\ufffd...", "example": "normal" }, { "name": "CompressType", "type": "string", "required": false, "description": "转码策略，可选值： ultra_compress：极致压缩：相比标准压缩，该策略能在保证一定画质的基础上最大限度压缩码率，极大节约带宽和存储成本。 standard_compress：综合最优：平衡压缩率与画质，在保证主观画质没有明显降低的情况下尽可能压缩文件。该策略仅收取音视频极速高清转码费用。 high_compress：码率优先：优先保证降低文件体积大小，可能有一定画质损失。该策略仅收取...", "example": "standard_compress" }, { "name": "EnhanceSceneType", "type": "string", "required": false, "description": "增强场景配置，可选值： common（通用），通用增强参数，适用于各种视频类型的基础优化参数，提升整体画质。 AIGC，整体分辨率提升，利用AI技术提升视频整体分辨率，增强画面清晰度。 short_play（短剧），增强面部与字幕细节，突出人物面部表情细节和字幕清晰度，提升观剧体验。 short_video（短视频），优化复杂多样的画质问题，针对短视频的复杂场景，优化画质，解决多\ufffd...", "example": "common" }, { "name": "EnhanceTranscodeType", "type": "string", "required": false, "description": "增强转码类型，可选值： Common（普通转码） TEHD-100（极速高清视频转码） TEHD-200（极速高清音频转码）", "example": "TEHD-100" }, { "name": "EnhanceType", "type": "string", "required": false, "description": "增强类型，可选值： VideoEnhance（仅视频增强） AudioEnhance（仅音频增强） VideoAudioEnhance（视频音频增强都含）", "example": "VideoEnhance" } ], "required": [] }, { "name": "DescribeUsageData", "description": "该接口返回查询时间范围内每天使用的媒体处理用量信息。 1. 可以查询最近365天内的媒体处理统计数据。 2. 查询时间跨度不超过90天。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "起始日期。使用 ISO 日期格式。", "example": "2019-07-02T00:00:00+08:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束日期，需大于等于起始日期。使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#iso-.E6.97.A5.E6.9C.9F.E6.A0.BC.E5.BC.8F)。", "example": "2019-07-03T00:00:00+08:00" }, { "name": "Types", "type": "array", "required": false, "description": "查询媒体处理任务类型，默认查询转码。 Transcode：转码 Enhance：增强 AIAnalysis：智能分析 AIRecognition：智能识别 AIReview：内容审核 Snapshot：截图 AnimatedGraphics：转动图 AiQualityControl：质检 Evaluation：视频评测 ImageProcess: 图片处理 AddBlindWatermark: 添加基础版权数字水印 AddNagraWatermark: 添加NAGRA数字水印 ExtractBlindWatermark: 提取基础版权数字水印 AIGC: AIGC", "example": "[\"Transcode\"]", "item_type": "string" }, { "name": "ProcessRegions", "type": "array", "required": false, "description": "媒体处理园区，默认返回 ap-guangzhou 园区。 ap-guangzhou：广州 ap-hongkong：中国香港 ap-taipei：中国台北 ap-singapore：新加坡 ap-mumbai：印度 ap-jakarta：雅加达 ap-seoul：首尔 ap-bangkok：泰国 ap-tokyo：日本 na-siliconvalley：美国硅谷 na-ashburn：弗吉尼亚 na-toronto：多伦多 sa-saopaulo：圣保罗 eu-frankfurt：法兰克福 eu-moscow：俄罗斯 aws：AWS", "example": "[\"ap-guangzhou\"]", "item_type": "string" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeVideoDatabaseEntryTaskDetail", "description": "根据任务ID查询视频入库任务的状态。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "待查询的任务Id", "example": "251xxx279-VideoDBEntryTask-60e4ae3b23ff4fd3xxxxxxx7e8af25ec" } ], "required": [ "TaskId" ] }, { "name": "DescribeVideoSearchTaskDetail", "description": "根据任务ID查询视频检索任务的状态。", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "待查询的任务Id", "example": "251xxx279-VideoSearchTask-60e4ae3b23ff4fd3xxxxxxx7e8af25ec" } ], "required": [ "TaskId" ] }, { "name": "DescribeWatermarkTemplates", "description": "查询用户自定义水印模板，支持根据条件，分页查询。", "status": "online", "parameters": [ { "name": "Definitions", "type": "array", "required": false, "description": "水印模板唯一标识过滤条件，数组长度限制：100。", "example": "[1001]", "item_type": "integer" }, { "name": "Type", "type": "string", "required": false, "description": "水印类型过滤条件，可选值： image：图片水印； text：文字水印。", "example": "image" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数 默认值：10； 最大值：100。", "example": "20" }, { "name": "Name", "type": "string", "required": false, "description": "水印模板标识过滤条件，长度限制：64 个字符。", "example": "水印模板" } ], "required": [] }, { "name": "DescribeWordSamples", "description": "该接口用于根据应用场景、关键词、标签，分页查询关键词样本信息。", "status": "online", "parameters": [ { "name": "Keywords", "type": "array", "required": false, "description": "关键词过滤条件，数组长度限制：100 个词。", "example": "[\"samples\"]", "item_type": "string" }, { "name": "Usages", "type": "array", "required": false, "description": "关键词应用场景过滤条件，可选值： 1. Recognition.Ocr：通过光学字符识别技术，进行内容识别； 2. Recognition.Asr：通过音频识别技术，进行内容识别； 3. Review.Ocr：通过光学字符识别技术，进行不适宜内容的识别； 4. Review.Asr：通过音频识别技术，进行不适宜内容的识别； 可合并简写为： 5. Recognition：通过光学字符识别技术、音频识别技术，进行内容识别，等价于 1+2； 6. Review：\ufffd\ufffd...", "example": "[\"Recognition\"]", "item_type": "string" }, { "name": "Tags", "type": "array", "required": false, "description": "标签过滤条件，数组长度限制：20 个词。", "example": "[\"tag1\"]", "item_type": "string" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：100，最大值：100。", "example": "100" } ], "required": [] }, { "name": "DescribeWorkflows", "description": "根据工作流 ID，获取工作流详情列表。", "status": "online", "parameters": [ { "name": "WorkflowIds", "type": "array", "required": false, "description": "工作流 ID 过滤条件，数组长度限制：100。", "example": "[\"78459\\n\"]", "item_type": "integer" }, { "name": "Status", "type": "string", "required": false, "description": "工作流状态，取值范围： Enabled：已启用， Disabled：已禁用。 不填此参数，则不区分工作流状态。", "example": "“”" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量，默认值：0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回记录条数，默认值：10，最大值：100。", "example": "0" } ], "required": [] }, { "name": "DisableSchedule", "description": "禁用自动化触发编排任务。", "status": "online", "parameters": [ { "name": "ScheduleId", "type": "integer", "required": true, "description": "编排唯一表示。", "example": "0" } ], "required": [ "ScheduleId" ] }, { "name": "DisableWorkflow", "description": "禁用工作流。", "status": "online", "parameters": [ { "name": "WorkflowId", "type": "integer", "required": true, "description": "工作流 ID。", "example": "19000" } ], "required": [ "WorkflowId" ] }, { "name": "DisassociateSecurityGroup", "description": "批量解绑安全组下面关联的输入输出。", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": false, "description": "媒体传输安全组ID。", "example": "无" }, { "name": "UnattachInOutInfos", "type": "array", "required": false, "description": "要解绑的输入输出信息列表。", "example": "无", "item_type": "object", "children": [ { "name": "FlowId", "type": "string", "required": true, "description": "该安全组关联的FlowId。", "example": "01963d5435de1eaa814800077080" }, { "name": "InOutId", "type": "string", "required": true, "description": "要解绑的输入/输出ID。", "example": "019527caa7b209dc0f3253a63420" }, { "name": "InOutType", "type": "string", "required": true, "description": "输入/输出类型，可选值： Input：输入 Output：输出。", "example": "input" }, { "name": "FlowRegion", "type": "string", "required": true, "description": "Flow所在的Region，和input共用。", "example": "ap-shanghai" } ] } ], "required": [] }, { "name": "EditMedia", "description": "对视频进行编辑，生成一个新的视频。编辑的功能包括： 一、**剪辑任务**：简单的视频剪辑，如剪辑、拼接等 1. 对一个文件进行剪辑，生成一个新的视频； 2. 对多个文件进行拼接，生成一个新的视频； 3. 对多个文件进行剪辑，然后再拼接，生成一个新的视频。 二、**合成任务**：通过接口描述信息，合成一个新的视频。 1. 多轨道（视频、音频、字幕）、多类型元素（视频、...", "status": "online", "parameters": [ { "name": "FileInfos", "type": "array", "required": true, "description": "输入的视频文件信息。", "example": "无", "item_type": "object", "children": [ { "name": "InputInfo", "type": "object", "required": true, "description": "视频的输入信息。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输入来源对象的类型，支持： COS：COS源 URL：URL源 AWS-S3：AWS 源，目前只支持转码任务 VOD：点播专业版", "example": "NULL" }, { "name": "CosInputInfo", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 对象信息。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": true, "description": "媒体处理对象文件的输入路径，如`/movie/201907/WildAnimal.mov`。", "example": "/movie/201907/WildAnimal.mov" } ] }, { "name": "UrlInputInfo", "type": "object", "required": false, "description": "当 Type 为 URL 时有效，则该项为必填，表示媒体处理 URL 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频的 URL。", "example": "NULL" } ] }, { "name": "S3InputInfo", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-us-125678" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域，目前支持： us-east-1 eu-west-3 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1 " }, { "name": "S3Object", "type": "string", "required": true, "description": "S3 bucket 中的媒体资源路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/test.mp4" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bb5******eff" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bbc5******eff" } ] }, { "name": "VODInputInfo", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理对象文件所在的 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理对象文件所在的 Bucket 所属园区", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": false, "description": "媒体处理对象文件的输入路径", "example": "/movie/201907/WildAnimal.mov" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "【剪辑】任务生效，视频剪辑的起始时间偏移，单位：秒。", "example": "1" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "【剪辑】任务生效，视频剪辑的结束时间偏移，单位：秒。", "example": "10" }, { "name": "Id", "type": "string", "required": false, "description": "【合成】任务必选，用于轨道元素中媒体关联源素材 ID。 注意：允许字母、数字、-、_ ，最长 32 字符 注意：此字段可能返回 null，表示取不到有效值。", "example": "id1" } ] }, { "name": "OutputStorage", "type": "object", "required": true, "description": "媒体处理输出文件的目标存储。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputObjectPath", "type": "string", "required": true, "description": "媒体处理输出文件的目标路径。注意：对于复杂合成任务，路径中的文件名只可为数字、字母、-、_ 的组合，最长 64 个字符。", "example": "/clip_result/clip_WildAnimal.{format}" }, { "name": "OutputConfig", "type": "object", "required": false, "description": "【剪辑】任务生成的文件配置。", "example": "无", "children": [ { "name": "Container", "type": "string", "required": false, "description": "封装格式，可选值：mp4、hls、mov、flv、avi。默认是 mp4。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mp4" }, { "name": "Type", "type": "string", "required": false, "description": "剪辑模式，可选值： normal（默认）：精准编辑 fast：快速编辑，处理速度更快但精准度一定程度降低 注意：fast只支持单文件，normal默认输出转码格式是h264 注意：此字段可能返回 null，表示取不到有效值。", "example": "fast" } ] }, { "name": "ComposeConfig", "type": "object", "required": false, "description": "【合成】任务配置。注意：当其不为空时，认为是合成任务，否则按剪辑任务处理。", "example": "无", "children": [ { "name": "TargetInfo", "type": "object", "required": false, "description": "合成目标视频信息。", "example": "无", "children": [ { "name": "Container", "type": "string", "required": false, "description": "封装容器格式，可选值： mp4：视频文件（默认）。 mp3：纯音频文件。", "example": "mp4" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，可选值： 0：保留（默认）。 1：去除。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，可选值： 0：保留（默认）。 1：去除。", "example": "0" }, { "name": "VideoStream", "type": "object", "required": false, "description": "输出视频流信息。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": false, "description": "视频流的编码方式，可选值： H.264：H.264 编码（默认）。", "example": "H.264" }, { "name": "Fps", "type": "integer", "required": false, "description": "视频帧率，取值范围：[0, 60]，单位：Hz。 默认值：0，表示和第一个视频帧率一致。", "example": "0" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "参考码率，单位 kbps，范围：50~35000。 如果设置，编码时会尽量按该码率进行编码。 如果不设置，服务将通过画面复杂度自动采用合适的码率。", "example": "128" } ] }, { "name": "AudioStream", "type": "object", "required": false, "description": "输出音频流信息。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": false, "description": "音频流的编码方式，可选值： AAC：AAC 编码（默认），用于容器为 mp4。 MP3：mp3 编码，用于容器为 mp3。", "example": "AAC" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "音频流的采样率，单位：Hz，可选值： 16000（默认） 32000 44100 48000", "example": "16000" }, { "name": "AudioChannel", "type": "integer", "required": false, "description": "声道数，可选值： 1：单声道 。 2：双声道（默认）。", "example": "2" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "参考码率，单位 kbps，范围：26~10000。 如果设置，编码时会尽量按该码率进行编码。 如果不设置，服务将根据音频参数自动采用合适的码率。", "example": "128" } ] } ] }, { "name": "Canvas", "type": "object", "required": false, "description": "合成目标视频的画布信息。", "example": "无", "children": [ { "name": "Color", "type": "string", "required": false, "description": "背景颜色对应的 RGB 参考值，取值格式： #RRGGBB，如 #F0F0F0 。 默认值：#000000（黑色）。", "example": "#000000" }, { "name": "Width", "type": "integer", "required": false, "description": "画布宽度，即输出视频的宽度，取值范围：0~ 3840，单位：px。 默认值：0，表示和第一个视频宽度一致。", "example": "0" }, { "name": "Height", "type": "integer", "required": false, "description": "画布高度，即输出视频的高度，取值范围：0~ 3840，单位：px。 默认值：0，表示和第一个视频高度一致。", "example": "0" } ] }, { "name": "Styles", "type": "array", "required": false, "description": "全局样式，和轨道 Tracks 配合使用，用于定于样式，如字幕样式。", "example": "无", "item_type": "object", "children": [ { "name": "Id", "type": "string", "required": true, "description": "样式 Id，用于和轨道元素中的样式关联。 注意：允许字母、数字、-、_ 组合，最长 32 字符。", "example": "s1" }, { "name": "Type", "type": "string", "required": true, "description": "样式类型，取值有： Subtitle：字幕样式。", "example": "Subtitle" }, { "name": "Subtitle", "type": "object", "required": false, "description": "字幕样式信息，当 Type = Subtitle 时有效。", "example": "无", "children": [ { "name": "Height", "type": "string", "required": false, "description": "字幕高度。支持 %、px 两种格式： 当字符串以 % 结尾，表示为画布高度的百分比大小，如 10% 表示为画布高度的 10%。 当字符串以 px 结尾，表示单位为像素，如 100px 表示为100像素。 默认为 FontSize 大小。", "example": "10%" }, { "name": "MarginBottom", "type": "string", "required": false, "description": "字幕距离下边框距离，支持 %、px 两种格式： 当字符串以 % 结尾，表示为画布高度的百分比大小，如 10% 表示为画布高度的 10%。 当字符串以 px 结尾，表示单位为像素，如 100px 表示为100像素。 默认：0px", "example": "10px" }, { "name": "FontType", "type": "string", "required": false, "description": "字体类型，支持： SimHei：黑体（默认）。 SimSun：宋体。", "example": "SimHei" }, { "name": "FontSize", "type": "string", "required": false, "description": "字体大小，支持 %、px 两种格式： 当字符串以 % 结尾，表示为画布高度的百分比大小，如 10% 表示为画布高度的 10%。 当字符串以 px 结尾，表示单位为像素，如 100px 表示为100像素。 默认：2%", "example": "2%" }, { "name": "FontBold", "type": "integer", "required": false, "description": "是否使用粗体，和字体相关，可选值： 0：否（默认）。 1：是。", "example": "0" }, { "name": "FontItalic", "type": "integer", "required": false, "description": "是否使用斜体，和字体相关，可选值： 0：否（默认）。 1：是。", "example": "0" }, { "name": "FontColor", "type": "string", "required": false, "description": "字体颜色，格式：#RRGGBBAA。 默认值：0x000000FF（黑色）。 注意：其中 AA 部分指的是透明度，为可选。", "example": "0x000000FF" }, { "name": "FontAlign", "type": "string", "required": false, "description": "文字对齐方式： Center：居中（默认）。 Left：左对齐。 Right：右对齐。", "example": "Center" }, { "name": "FontAlignMargin", "type": "string", "required": false, "description": "用于字幕对齐留白： FontAlign=Left 时，表示距离左边距离。 FontAlign=Right时，表示距离右边距离。 支持 %、px 两种格式： 当字符串以 % 结尾，表示为画布宽度的百分比大小，如 10% 表示为画布宽度的 10%。 当字符串以 px 结尾，表示单位为像素，如 100px 表示为100像素。", "example": "10%" }, { "name": "BorderWidth", "type": "string", "required": false, "description": "字体边框宽度，支持 %、px 两种格式： 当字符串以 % 结尾，表示为画布高度的百分比大小，如 10% 表示为画布高度的 10%。 当字符串以 px 结尾，表示单位为像素，如 100px 表示为100像素。 默认： 0，表示不需要边框。", "example": "10px" }, { "name": "BorderColor", "type": "string", "required": false, "description": "边框颜色，当 BorderWidth 不为 0 时生效，其值格式和 FontColor 一致。", "example": "0x000000FF" }, { "name": "BottomColor", "type": "string", "required": false, "description": "文字底色，其值格式和 FontColor 一致。 默认为空， 表示不使用底色。", "example": "0x000000FF" } ] } ] }, { "name": "Tracks", "type": "array", "required": false, "description": "用于描述合成视频的轨道列表，包括：视频、音频、图片、文字等元素组成的多个轨道信息。关于轨道和时间： 轨道时间轴即为目标视频时间轴。时间轴上相同时间点的不同轨道上的元素会重叠：视频、图片、文字：按轨道顺序进行图像的叠加，轨道顺序靠前的在上面。音频 ：进行混音。注意：同一轨道中各个元素（除字幕元素外）的轨道时间不能重叠。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "轨道类型，取值有：Video ：视频轨道。视频轨道可由以下元素组成：Video 元素Image 元素Transition 元素Empty 元素Audio ：音频轨道。音频轨道可由以下元素组成：Audio 元素Transition 元素Empty 元素Title：文字轨道。文字轨道可由以下元素组成：Subtitle 元素", "example": "Video" }, { "name": "Items", "type": "array", "required": true, "description": "轨道上的元素列表。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "元素类型。取值有： Video：视频元素。 Audio：音频元素。 Image：图片元素。 Transition：转场元素。 Subtitle：字幕元素。 Empty：空白元素。", "example": "Video" }, { "name": "Video", "type": "object", "required": false, "description": "视频元素，当 Type = Video 时有效。", "example": "无" }, { "name": "Audio", "type": "object", "required": false, "description": "音频元素，当 Type = Audio 时有效。", "example": "无" }, { "name": "Image", "type": "object", "required": false, "description": "图片元素，当 Type = Image 时有效。", "example": "无" }, { "name": "Transition", "type": "object", "required": false, "description": "转场元素，当 Type = Transition 时有效。", "example": "无" }, { "name": "Subtitle", "type": "object", "required": false, "description": "字幕元素，当 Type = Subtitle 是有效。", "example": "无" }, { "name": "Empty", "type": "object", "required": false, "description": "空白元素，当 Type = Empty 时有效。用于时间轴的占位。", "example": "无" } ] } ] } ] }, { "name": "TaskNotifyConfig", "type": "object", "required": false, "description": "任务的事件通知信息，不填代表不获取事件通知。", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型，可选值： CMQ：已下线，建议切换到TDMQ-CMQ TDMQ-CMQ：消息队列 URL：指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同解析事件通知接口的输出参数 SCF：不推荐使用，需要在控制台额外配置SCF AWS-SQS：AWS 队列，只适用于 AWS 任务，且要求同区域 注：不填或为空时默认 TDMQ-CMQ，如需采用其他类型需填写对应类型值；如果使用TDMQ-CMQ消息队列，任务\ufffd...", "example": "URL" }, { "name": "NotifyMode", "type": "string", "required": false, "description": "工作流通知的模式，可取值有 Finish 和 Change，不填代表 Finish。", "example": "Finish " }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的模型，有 Queue 和 Topic 两种。", "example": "Queue " }, { "name": "CmqRegion", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。", "example": "mps_notify" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。", "example": "mps_que" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "AWS SQS 回调，NotifyType为 AWS-SQS 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NULL", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的key。", "example": "0se***9idaY" } ] }, { "name": "TasksPriority", "type": "integer", "required": false, "description": "任务优先级，数值越大优先级越高，取值范围是-10到 10，不填代表0。", "example": "0" }, { "name": "SessionId", "type": "string", "required": false, "description": "用于去重的识别码，如果三天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。", "example": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d" }, { "name": "SessionContext", "type": "string", "required": false, "description": "来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。", "example": "MD123******QNA==" }, { "name": "ResourceId", "type": "string", "required": false, "description": "资源ID，需要保证对应资源是开启状态。默认为帐号主资源ID。", "example": "vts-24000-0" } ], "required": [ "FileInfos", "OutputStorage", "OutputObjectPath" ] }, { "name": "EnableSchedule", "description": "启用自动化触发编排任务。", "status": "online", "parameters": [ { "name": "ScheduleId", "type": "integer", "required": true, "description": "编排唯一标识。", "example": "0" } ], "required": [ "ScheduleId" ] }, { "name": "EnableWorkflow", "description": "启用工作流。", "status": "online", "parameters": [ { "name": "WorkflowId", "type": "integer", "required": true, "description": "工作流 ID。", "example": "100010" } ], "required": [ "WorkflowId" ] }, { "name": "ExecuteFunction", "description": "本接口仅用于定制开发的特殊场景，除非云媒体处理客服人员主动告知您需要使用本接口，其它情况请勿调用。", "status": "online", "parameters": [ { "name": "FunctionName", "type": "string", "required": true, "description": "调用后端接口名称。", "example": "ExampleFunc" }, { "name": "FunctionArg", "type": "string", "required": true, "description": "接口参数，具体参数格式调用时与后端协调。", "example": "XXX" } ], "required": [ "FunctionName", "FunctionArg" ] }, { "name": "ExtractBlindWatermark", "description": "用于发起提取视频数字水印任务，提取结果可以通过DescribeTaskDetail查询。", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": true, "description": "数字水印类型，可选值：blind-basic：基础版权数字水印；blind-abseq：ab序列版权数字水印；", "example": "blind-basic" }, { "name": "InputInfo", "type": "object", "required": true, "description": "媒体处理的文件输入信息。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输入来源对象的类型，支持： COS：COS源 URL：URL源 AWS-S3：AWS 源，目前只支持转码任务 VOD：点播专业版", "example": "NULL" }, { "name": "CosInputInfo", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 对象信息。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": true, "description": "媒体处理对象文件的输入路径，如`/movie/201907/WildAnimal.mov`。", "example": "/movie/201907/WildAnimal.mov" } ] }, { "name": "UrlInputInfo", "type": "object", "required": false, "description": "当 Type 为 URL 时有效，则该项为必填，表示媒体处理 URL 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频的 URL。", "example": "NULL" } ] }, { "name": "S3InputInfo", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-us-125678" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域，目前支持： us-east-1 eu-west-3 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1 " }, { "name": "S3Object", "type": "string", "required": true, "description": "S3 bucket 中的媒体资源路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/test.mp4" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bb5******eff" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bbc5******eff" } ] }, { "name": "VODInputInfo", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理对象文件所在的 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理对象文件所在的 Bucket 所属园区", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": false, "description": "媒体处理对象文件的输入路径", "example": "/movie/201907/WildAnimal.mov" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "TaskNotifyConfig", "type": "object", "required": false, "description": "任务的事件通知信息，不填代表不获取事件通知。", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型，可选值： CMQ：已下线，建议切换到TDMQ-CMQ TDMQ-CMQ：消息队列 URL：指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同解析事件通知接口的输出参数 SCF：不推荐使用，需要在控制台额外配置SCF AWS-SQS：AWS 队列，只适用于 AWS 任务，且要求同区域 注：不填或为空时默认 TDMQ-CMQ，如需采用其他类型需填写对应类型值；如果使用TDMQ-CMQ消息队列，任务\ufffd...", "example": "URL" }, { "name": "NotifyMode", "type": "string", "required": false, "description": "工作流通知的模式，可取值有 Finish 和 Change，不填代表 Finish。", "example": "Finish " }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的模型，有 Queue 和 Topic 两种。", "example": "Queue " }, { "name": "CmqRegion", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。", "example": "mps_notify" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。", "example": "mps_que" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "AWS SQS 回调，NotifyType为 AWS-SQS 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NULL", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的key。", "example": "0se***9idaY" } ] }, { "name": "ExtractBlindWatermarkConfig", "type": "object", "required": false, "description": "提取数字水印任务配置", "example": "无", "children": [ { "name": "SegmentDuration", "type": "integer", "required": true, "description": "当提取数字水印类型为blind-abseq时有效，用于指定输入视频的切片时长，单位：毫秒。 如果不填默认切片时长为5秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "5000" } ] }, { "name": "ResourceId", "type": "string", "required": false, "description": "资源ID，需要保证对应资源是开启状态。默认为账号主资源ID。", "example": "vts-240000xx-0" } ], "required": [ "Type", "InputInfo" ] }, { "name": "ManageTask", "description": "对已发起的任务进行管理。", "status": "online", "parameters": [ { "name": "OperationType", "type": "string", "required": true, "description": "操作类型，取值范围： Abort：终止任务。使用说明： 若 [任务类型](/document/product/862/37614#3.-.E8.BE.93.E5.87.BA.E5.8F.82.E6.95.B0) 为直播流处理任务（LiveStreamProcessTask），支持终止 [任务状态](/document/product/862/37614#3.-.E8.BE.93.E5.87.BA.E5.8F.82.E6.95.B0) 为等待中（WAITING）或处理中（PROCESSING）的任务； 否则，对于其他 [任务类型](/document/product/862/37614#3.-.E8.BE.93.E5.87.BA.E5.8F.82.E6.95.B0)，只支持终止 [...", "example": "Abort" }, { "name": "TaskId", "type": "string", "required": true, "description": "视频处理的任务 ID。", "example": "2000000081-WorkflowTask-2ea2172665eea4aa4f4d6dbcd61b16a9tt7" } ], "required": [ "OperationType", "TaskId" ] }, { "name": "ModifyAIAnalysisTemplate", "description": "修改用户自定义内容分析模板。 注意：模板 ID 10000 以下的为系统预置模板，不允许修改。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容分析模板唯一标识。", "example": "30" }, { "name": "Name", "type": "string", "required": false, "description": "视频内容分析模板名称，长度限制：64 个字符。", "example": "内容分析模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "视频内容分析模板描述信息，长度限制：256 个字符。", "example": "内容分析模板" }, { "name": "ClassificationConfigure", "type": "object", "required": false, "description": "智能分类任务控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "智能分类任务开关，可选值： ON：开启智能分类任务； OFF：关闭智能分类任务。", "example": "ON" } ] }, { "name": "TagConfigure", "type": "object", "required": false, "description": "智能标签任务控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "智能标签任务开关，可选值： ON：开启智能标签任务； OFF：关闭智能标签任务。", "example": "ON" } ] }, { "name": "CoverConfigure", "type": "object", "required": false, "description": "智能封面任务控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "智能封面任务开关，可选值： ON：开启智能封面任务； OFF：关闭智能封面任务。", "example": "ON" } ] }, { "name": "FrameTagConfigure", "type": "object", "required": false, "description": "智能按帧标签任务控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "智能按帧标签任务开关，可选值： ON：开启智能按帧标签任务； OFF：关闭智能按帧标签任务。", "example": "ON" } ] } ], "required": [ "Definition" ] }, { "name": "ModifyAIRecognitionTemplate", "description": "修改用户自定义内容识别模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容识别模板唯一标识。", "example": "30" }, { "name": "Name", "type": "string", "required": false, "description": "视频内容识别模板名称，长度限制：64 个字符。", "example": "内容识别模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "视频内容识别模板描述信息，长度限制：256 个字符。", "example": "内容识别模板" }, { "name": "FaceConfigure", "type": "object", "required": false, "description": "人脸识别控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "人脸识别任务开关，可选值： ON：开启智能人脸识别任务； OFF：关闭智能人脸识别任务。", "example": "ON" }, { "name": "Score", "type": "float", "required": false, "description": "人脸识别过滤分数，当识别结果达到该分数以上，返回识别结果。取值范围：0-100。", "example": "80" }, { "name": "DefaultLibraryLabelSet", "type": "array", "required": false, "description": "默认人物过滤标签，指定需要返回的默认人物的标签。如果未填或者为空，则全部默认人物结果都返回。标签可选值： entertainment：娱乐明星； sport：体育明星； politician：敏感人物。", "example": "[\"entertainment\"]", "item_type": "string" }, { "name": "UserDefineLibraryLabelSet", "type": "array", "required": false, "description": "用户自定义人物过滤标签，指定需要返回的用户自定义人物的标签。如果未填或者为空，则全部自定义人物结果都返回。 标签个数最多 100 个，每个标签长度最多 16 个字符。", "example": "[\"artist\"]", "item_type": "string" }, { "name": "FaceLibrary", "type": "string", "required": false, "description": "人物库选择，可选值： Default：使用默认人物库； UserDefine：使用用户自定义人物库。 All：同时使用默认人物库和用户自定义人物库。", "example": "Default" } ] }, { "name": "OcrFullTextConfigure", "type": "object", "required": false, "description": "文本全文识别控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "文本全文识别任务开关，可选值： ON：开启智能文本全文识别任务； OFF：关闭智能文本全文识别任务。", "example": "ON" } ] }, { "name": "OcrWordsConfigure", "type": "object", "required": false, "description": "文本关键词识别控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "文本关键词识别任务开关，可选值： ON：开启文本关键词识别任务； OFF：关闭文本关键词识别任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "关键词过滤标签，指定需要返回的关键词的标签。如果未填或者为空，则全部结果都返回。 标签个数最多 10 个，每个标签长度最多 16 个字符。", "example": "[\"腾讯云\"]", "item_type": "string" } ] }, { "name": "AsrFullTextConfigure", "type": "object", "required": false, "description": "语音全文识别控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "语音全文识别任务开关，可选值： ON：开启智能语音全文识别任务； OFF：关闭智能语音全文识别任务。", "example": "ON" }, { "name": "SubtitleFormat", "type": "string", "required": false, "description": "生成的字幕文件格式，填空字符串表示不生成字幕文件，可选值： vtt：生成 WebVTT 字幕文件。", "example": "vtt" }, { "name": "SourceLanguage", "type": "string", "required": false, "description": "视频源语言。", "example": "zh" } ] }, { "name": "AsrWordsConfigure", "type": "object", "required": false, "description": "语音关键词识别控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "语音关键词识别任务开关，可选值： ON：开启语音关键词识别任务； OFF：关闭语音关键词识别任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "关键词过滤标签，指定需要返回的关键词的标签。如果未填或者为空，则全部结果都返回。 标签个数最多 10 个，每个标签长度最多 16 个字符。", "example": "[\"明星\",\"艺人\"]", "item_type": "string" } ] }, { "name": "TranslateConfigure", "type": "object", "required": false, "description": "语音翻译控制参数。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "语音翻译任务开关，可选值： ON：开启智能语音翻译任务； OFF：关闭智能语音翻译任务。", "example": "ON" }, { "name": "SourceLanguage", "type": "string", "required": false, "description": "视频源语言。", "example": "zh" }, { "name": "DestinationLanguage", "type": "string", "required": false, "description": "翻译目标语言。", "example": "en" }, { "name": "SubtitleFormat", "type": "string", "required": false, "description": "生成的字幕文件格式，填空字符串表示不生成字幕文件，可选值： vtt：生成 WebVTT 字幕文件。", "example": "vtt" } ] } ], "required": [ "Definition" ] }, { "name": "ModifyAdaptiveDynamicStreamingTemplate", "description": "修改转自适应码流模板", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "转自适应码流模板唯一标识。", "example": "10038" }, { "name": "Name", "type": "string", "required": false, "description": "模板名称，长度限制：64 个字符。", "example": "转自适应码流模板2" }, { "name": "Format", "type": "string", "required": false, "description": "转自适应码流格式，取值范围： HLS， MPEG-DASH。", "example": "HLS" }, { "name": "DisableHigherVideoBitrate", "type": "integer", "required": false, "description": "是否禁止视频低码率转高码率，取值范围： 0：否， 1：是。", "example": "0" }, { "name": "DisableHigherVideoResolution", "type": "integer", "required": false, "description": "是否禁止视频分辨率转高分辨率，取值范围： 0：否， 1：是。", "example": "0" }, { "name": "StreamInfos", "type": "array", "required": false, "description": "转自适应码流输入流参数信息，最多输入10路流。 注意： 1、各个流的帧率必须保持一致；如果不一致，采用第一个流的帧率作为输出帧率。 2、修改子流信息时需要全量修改添加所有字段值，否则没填字段会使用默认值。", "example": "无", "item_type": "object", "children": [ { "name": "Audio", "type": "object", "required": true, "description": "音频参数信息。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": true, "description": "音频流的编码格式。 当不需要对音频进行转码时，可选值为： copy。 当外层参数 Container 为 mp3 时，可选值为： mp3。 当外层参数 Container 为 ogg 或 flac 时，可选值为： flac。 当外层参数 Container 为 m4a 时，可选值为： aac； ac3。 当外层参数 Container 为 mp4 或 flv 时，可选值为： aac：更适合 mp4； mp3：更适合 flv； mp2。 当外层参数 Container 为 hls 时，可选值为： aac； mp3; eac3：自适应\ufffd\ufffd...", "example": "aac" }, { "name": "Bitrate", "type": "integer", "required": true, "description": "音频流的码率，取值范围：0 和 [26, 256]，单位：kbps。 当取值为 0，表示音频码率和原始音频保持一致。 注意：如果使用自适应转码音轨合并TrackChannelInfo参数，取值范围： 1）、不能填0； 2）、Codec为：aac时，取值范围：[26, 256]; 3）、Codec为：ac3时，取值范围：[26, 640]; 4)、Codec为：eac3时，取值范围：[26, 6144]，备注：当SampleRate为44100HZ，最大值为：5644，当SampleRate为48000HZ，最大值\ufffd...", "example": "0" }, { "name": "SampleRate", "type": "integer", "required": true, "description": "音频流的采样率，不同编码标准支持的采样率选项不同。填0代表使用源音频的采样率数值。 详细参考[音频采样率支持范围文档](https://cloud.tencent.com/document/product/862/77166#f3b039f1-d817-4a96-b4e4-90132d31cd53) 单位：Hz 注意：请确保源音频流的采样率在上述选项范围内，否则可能导致转码失败！", "example": "44100" }, { "name": "AudioChannel", "type": "integer", "required": false, "description": "音频通道方式，可选值： 1：单通道 2：双通道 6：5.1声道 当媒体的封装格式是音频格式时（flac，ogg，mp3，m4a）时，声道数不允许设为5.1声道。 默认值：2。", "example": "2" }, { "name": "TrackChannelInfo", "type": "object", "required": false, "description": "合并音轨信息。 注意：此字段只是自适应转码生效， 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ChannelsRemix", "type": "integer", "required": false, "description": "是否开启混音，可选值： 0：表示不开启混音 1：表示开启混音 默认值：0 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SelectType", "type": "string", "required": false, "description": "合并音轨输入类型，可选值： track：表示使用音轨id； track_channel： 表示使用音轨id和声道id； 默认：track。 注意：如果原视频是多声道，建议使用track_channel。 注意：此字段可能返回 null，表示取不到有效值。", "example": "track" }, { "name": "InputTrackInfo", "type": "array", "required": false, "description": "音轨信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] } ] }, { "name": "Video", "type": "object", "required": false, "description": "视频参数信息。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": true, "description": "视频流的编码格式，可选值： h264：H.264 编码 h265：H.265 编码 h266：H.266 编码 av1：AOMedia Video 1 编码 vp8：VP8 编码 vp9：VP9 编码 mpeg2：MPEG2 编码 dnxhd：DNxHD 编码 mv-hevc：MV-HEVC 编码 注意：av1 编码容器目前只支持 mp4 ，webm，mkv。 注意：H.266 编码容器目前只支持 mp4 ，hls，ts，mov。 注意：VP8、VP9编码容器目前只支持webm，mkv。 注意：MPEG2、dnxhd 编码容器目前只支持mxf。 注意：MV-HEVC编码\ufffd\ufffd...", "example": "h264" }, { "name": "Fps", "type": "integer", "required": true, "description": "视频帧率，取值范围： 当FpsDenominator的值为空时，范围：[0, 120]，单位：Hz； 当FpsDenominator的值不为空时，Fps/FpsDenominator的范围：[0,120] 当取值为 0，表示帧率和原始视频保持一致。", "example": "0" }, { "name": "Bitrate", "type": "integer", "required": true, "description": "视频流的码率，取值范围：0 和 [128, 100000]，单位：kbps。 当取值为 0，表示视频码率和原始视频保持一致。", "example": "0" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。 默认值：open。 注意：自适应模式时，Width不能小于Height。", "example": "open" }, { "name": "Width", "type": "integer", "required": false, "description": "视频流宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。 注意：Codec为MV-HEVC时可以支持到7680", "example": "0" }, { "name": "Height", "type": "integer", "required": false, "description": "视频流高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。 注意：Codec为MV-HEVC时可以支持到7680", "example": "0" }, { "name": "Gop", "type": "integer", "required": false, "description": "关键帧 I 帧之间的间隔，允许按帧或秒自定义GOP长度，取值范围：0 和 [1, 100000]， 当填 0 或不填时，系统将自动设置 gop 长度。", "example": "0" }, { "name": "GopUnit", "type": "string", "required": false, "description": "Gop数值单位，可选值： frame：表示帧 second：表示秒 默认值：frame 注意：此字段可能返回 null，表示取不到有效值。", "example": "frame" }, { "name": "FillType", "type": "string", "required": false, "description": "填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“； black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。 white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。 gauss：高斯模糊，保持视频...", "example": "black" }, { "name": "Vcrf", "type": "integer", "required": false, "description": "视频的恒定码率控制因子，取值范围为[0, 51]，不填表示“自动”。如果没有特殊需求，建议不指定该参数。 当Mode参数设置为VBR时，如果同时配置了Vcrf值，MPS将在VBR模式下处理视频，同时考虑Vcrf和Bitrate参数的设置，以平衡视频质量、码率、转码效率和文件大小。 当Mode参数设置为CRF，Bitrate设置将失效，编码将根据Vcrf值进行。 当Mode参数选择ABR或CBR时，无需配置Vcrf值。 注意：...", "example": "1" }, { "name": "HlsTime", "type": "integer", "required": false, "description": "分片平均时长，范围：（0-10]，单位：秒 不填表示自动，将根据视频的GOP等特征自动选择合适的分片时长。 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "SegmentType", "type": "integer", "required": false, "description": "hls 分片类型，可选值 ： 0：HLS+TS 切片 2：HLS+TS byte range 7：HLS+MP4 切片 5：HLS+MP4 byte range 默认值：0 注意：该字段用于普通/极速高清转码设置，对自适应码流不生效，如需给自适应码流配置分片类型，可以使用外层字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "FpsDenominator", "type": "integer", "required": false, "description": "帧率分母部分 注意：值必须大于0 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Stereo3dType", "type": "string", "required": false, "description": "3D视频拼接方式，仅mv-hevc，3D视频生效，可选值： side_by_side：原视频内容左右排列布局 top_bottom：原视频内容上下排列布局 计费将按照切分后的分辨率尺寸上报用量及计费； 默认值:side_by_side 注意：此字段可能返回 null，表示取不到有效值。", "example": "side_by_side" }, { "name": "VideoProfile", "type": "string", "required": false, "description": "Profile，适用于不同场景。 baseline: 只支持I/P帧，并只支持无交错的场景，适用于视频通话、手机视频等场景。 main: 主流Profile，提供I帧、P帧、B帧，并支持无交错模式和交错模式。主要用在主流的音视频消费产品如视频播放器、流媒体传输设备上。 high: 最高编码等级，在Main Profile上添加了8X8的预测，并支持自定义量化。广泛应用在蓝光存储、高清电视等场景。 default：随原视频...", "example": "default" }, { "name": "VideoLevel", "type": "string", "required": false, "description": "编码器级别，默认为自动（\"\"） 若编码标准选择H264: 支持以下选项：\"\"，1 , 1.1 , 1.2 , 1.3 , 2 , 2.1 , 2.2 , 3 , 3.1 , 3.2 , 4 , 4.1 , 4.2 , 5 , 5.1 若编码标准选择H265: 支持以下选项：\"\"，1 , 2 , 2.1 , 3 , 3.1 , 4 , 4.1 , 5 , 5.1 , 5.2 , 6 , 6.1 , 6.2 , 8.5 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Bframes", "type": "integer", "required": false, "description": "参考帧之间的B帧数，默认选自动，支持 0 - 16 注意：不填表示使用自动 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Mode", "type": "string", "required": false, "description": "码率控制模式：可选值： VBR（Variable Bit Rate）：动态比特率，根据视频画面的复杂度动态调整输出的码率，使得画面质量更高，适用于存储场景和对画面质量要求较高的应用。 ABR（Average Bit Rate）：平均比特率，尽量保持输出视频的平均码率稳定，但允许短期内的码率波动，适用于需要在保持一定画质的情况下尽量减少整体码率的场景。 CBR（Constant Bit Rate）：恒定比特率，指视...", "example": "VBR" }, { "name": "Sar", "type": "string", "required": false, "description": "显示高宽比，可选值：[1:1，2:1，default] 默认值：default 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" }, { "name": "NoScenecut", "type": "integer", "required": false, "description": "自适应I帧决策，开启后，媒体处理将自动识别视频中不同场景之间的过渡点（通常是视觉上显著不同的帧，比如从一个镜头切换到另一个镜头），在这些点自适应插入关键帧（I帧），从而提高视频的随机访问性和编码效率。可选值： 0：关闭自适应I帧决策 1：使用自适应I帧决策 默认值：0 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "BitDepth", "type": "integer", "required": false, "description": "比特位：支持8/10，默认为8 注意：此字段可能返回 null，表示取不到有效值。", "example": "8" }, { "name": "RawPts", "type": "integer", "required": false, "description": "保持原始时间戳：可选值： 0：表示关闭 1：表示打开 默认是关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Compress", "type": "integer", "required": false, "description": "按比例压缩码率，开启后，将根据比例来调整输出视频的码率。填写压缩率后，系统会根据视频源码率自动计算目标输出码率。压缩率范围0-100 不填此值表示不开启，默认不开启 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SegmentSpecificInfo", "type": "object", "required": false, "description": "启动时分片时长 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "启动分片时长开关，可选值： on：打开 off：关闭 默认off 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "FragmentTime", "type": "integer", "required": false, "description": "启动时分片时长，单位：秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FragmentEndNum", "type": "integer", "required": false, "description": "生效分片数，表示前FragmentEndNum个分片以FragmentTime时长切片，取值\u003e=1 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "ScenarioBased", "type": "integer", "required": false, "description": "模板是否开启场景化 0：不开启 1：开启 默认值：0 注意：只有此字段值为1时，SceneType和CompressType字段的值才会生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SceneType", "type": "string", "required": false, "description": "视频场景化，可选值： normal：通用转码场景：通用转码压缩场景。 pgc：PGC高清影视：压缩时会注重影视剧的观看体验，根据影视剧特性进行ROI编码，同时保留高质量的视频内容和音频。 materials_video：高清素材：素材资源类场景，对画质要求极高，较多透明画面内容，在压缩的同时接近视觉无损。 ugc：UGC内容：适用于广泛的UGC/短视频场景，针对短视频的特性优化编码码率， \ufffd\ufffd...", "example": "normal" }, { "name": "CompressType", "type": "string", "required": false, "description": "转码策略，可选值： ultra_compress：极致压缩：相比标准压缩，该策略能在保证一定画质的基础上最大限度压缩码率，极大节约带宽和存储成本。 standard_compress：综合最优：平衡压缩率与画质，在保证主观画质没有明显降低的情况下尽可能压缩文件。该策略仅收取音视频极速高清转码费用。 high_compress：码率优先：优先保证降低文件体积大小，可能有一定画质损失。该策略仅收取...", "example": "standard_compress" } ] }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否移除音频流，取值范围： 0：否， 1：是。", "example": "0" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否移除视频流，取值范围： 0：否， 1：是。", "example": "0" }, { "name": "AudioList", "type": "array", "required": false, "description": "音频参数信息列表。 注意：参数只在自适应转码使用音轨合并多音轨时使用, 参数数组长度最大为64。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Codec", "type": "string", "required": true, "description": "音频流的编码格式。 当不需要对音频进行转码时，可选值为： copy。 当外层参数 Container 为 mp3 时，可选值为： mp3。 当外层参数 Container 为 ogg 或 flac 时，可选值为： flac。 当外层参数 Container 为 m4a 时，可选值为： aac； ac3。 当外层参数 Container 为 mp4 或 flv 时，可选值为： aac：更适合 mp4； mp3：更适合 flv； mp2。 当外层参数 Container 为 hls 时，可选值为： aac； mp3; eac3：自适应\ufffd\ufffd...", "example": "aac" }, { "name": "Bitrate", "type": "integer", "required": true, "description": "音频流的码率，取值范围：0 和 [26, 256]，单位：kbps。 当取值为 0，表示音频码率和原始音频保持一致。 注意：如果使用自适应转码音轨合并TrackChannelInfo参数，取值范围： 1）、不能填0； 2）、Codec为：aac时，取值范围：[26, 256]; 3）、Codec为：ac3时，取值范围：[26, 640]; 4)、Codec为：eac3时，取值范围：[26, 6144]，备注：当SampleRate为44100HZ，最大值为：5644，当SampleRate为48000HZ，最大值\ufffd...", "example": "0" }, { "name": "SampleRate", "type": "integer", "required": true, "description": "音频流的采样率，不同编码标准支持的采样率选项不同。填0代表使用源音频的采样率数值。 详细参考[音频采样率支持范围文档](https://cloud.tencent.com/document/product/862/77166#f3b039f1-d817-4a96-b4e4-90132d31cd53) 单位：Hz 注意：请确保源音频流的采样率在上述选项范围内，否则可能导致转码失败！", "example": "44100" }, { "name": "AudioChannel", "type": "integer", "required": false, "description": "音频通道方式，可选值： 1：单通道 2：双通道 6：5.1声道 当媒体的封装格式是音频格式时（flac，ogg，mp3，m4a）时，声道数不允许设为5.1声道。 默认值：2。", "example": "2" }, { "name": "TrackChannelInfo", "type": "object", "required": false, "description": "合并音轨信息。 注意：此字段只是自适应转码生效， 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ChannelsRemix", "type": "integer", "required": false, "description": "是否开启混音，可选值： 0：表示不开启混音 1：表示开启混音 默认值：0 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SelectType", "type": "string", "required": false, "description": "合并音轨输入类型，可选值： track：表示使用音轨id； track_channel： 表示使用音轨id和声道id； 默认：track。 注意：如果原视频是多声道，建议使用track_channel。 注意：此字段可能返回 null，表示取不到有效值。", "example": "track" }, { "name": "InputTrackInfo", "type": "array", "required": false, "description": "音轨信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] } ] } ] }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "\"描述\"" }, { "name": "PureAudio", "type": "integer", "required": false, "description": "是否为纯音频，0表示视频模板，1表示纯音频模板 当值为1： 1. StreamInfos.N.RemoveVideo=1 2. StreamInfos.N.RemoveAudio=0 3. StreamInfos.N.Video.Codec=copy 当值为0： 1. StreamInfos.N.Video.Codec不能为copy 2. StreamInfos.N.Video.Fps不能为null 注意： 此值只是区分模板类型，任务使用RemoveAudio和RemoveVideo的值", "example": "0" }, { "name": "SegmentType", "type": "string", "required": false, "description": "分片类型，可选值： ts-segment：HLS+TS 切片 ts-byterange：HLS+TS byte range mp4-segment：HLS+MP4 切片 mp4-byterange：HLS/DASH+MP4 byte range ts-packed-audio：HLS+TS+Packed Audio 切片 mp4-packed-audio：HLS+MP4+Packed Audio 切片 ts-ts-segment：HLS+TS+TS 切片 ts-ts-byterange：HLS+TS+TS byte range mp4-mp4-segment：HLS+MP4+MP4 切片 mp4-mp4-byterange：HLS/DASH+MP4+MP4 byte range ts-packed-audio-byterange：HLS+TS+Packed Audio byte range mp4-packed-audio-byterange：HLS+MP...", "example": "ts-segment" } ], "required": [ "Definition" ] }, { "name": "ModifyAnimatedGraphicsTemplate", "description": "修改用户自定义转动图模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "转动图模板唯一标识。", "example": "10001" }, { "name": "Name", "type": "string", "required": false, "description": "转动图模板名称，长度限制：64 个字符。", "example": "转动图模板1" }, { "name": "Width", "type": "integer", "required": false, "description": "动图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "540" }, { "name": "Height", "type": "integer", "required": false, "description": "动图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "960" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。 默认值：open。", "example": "open" }, { "name": "Format", "type": "string", "required": false, "description": "动图格式，取值为 gif 和 webp。", "example": "gif" }, { "name": "Fps", "type": "integer", "required": false, "description": "帧率，取值范围：[1, 30]，单位：Hz。", "example": "30" }, { "name": "Quality", "type": "float", "required": false, "description": "图片质量，取值范围：[1, 100]，默认值为 75。", "example": "75" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "转动图模板" } ], "required": [ "Definition" ] }, { "name": "ModifyAsrHotwords", "description": "智能字幕更新热词库接口", "status": "online", "parameters": [ { "name": "HotwordsId", "type": "string", "required": true, "description": "热词库 id 如果热词库是临时热词：Name 和 Content 至少填一个 如果热词库是文件热词：Name、FileContent 和 FileName 至少填一个", "example": "hwd-aexxxxxxxxxxxxxx1481" }, { "name": "Name", "type": "string", "required": false, "description": "热词库名称", "example": "Hotwords_Template" }, { "name": "Content", "type": "string", "required": false, "description": "热词库文本", "example": "腾讯云|10,语音识别|5,ASR|10" }, { "name": "FileContent", "type": "string", "required": false, "description": "热词库文件的 base64 的内容，Type 为 1 必选", "example": "5aqS5L*****6IW+6K6v5aSn5Y6mfDU=" }, { "name": "FileName", "type": "string", "required": false, "description": "热词文件上传时的文件名", "example": "example.txt" } ], "required": [ "HotwordsId" ] }, { "name": "ModifyBlindWatermarkTemplate", "description": "修改用户自定义数字水印模板，数字水印类型不允许修改。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "数字水印模板唯一标识。", "example": "10" }, { "name": "Name", "type": "string", "required": false, "description": "数字水印模板名称，支持 中文、英文、数字、_、-和. 六种格式，长度限制：64 个字符。", "example": "数字水印模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "数字水印模板描述信息，长度限制：256 个字符。", "example": "数字水印模板" }, { "name": "TextContent", "type": "string", "required": false, "description": "数字水印文字内容，长度不超过64个字符，NAGRA水印类型的模板不支持修改文字内容。", "example": "数字水印文本" }, { "name": "Strength", "type": "string", "required": false, "description": "数字水印强度。 default: 默认，高清画质和抗性平衡 stronger:画质清晰，抗性较强 strongest:画质一般，抗性最强", "example": "default" } ], "required": [ "Definition" ] }, { "name": "ModifyContentReviewTemplate", "description": "修改用户自定义内容审核模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "内容审核模板唯一标识。", "example": "30" }, { "name": "Name", "type": "string", "required": false, "description": "内容审核模板名称，长度限制：64 个字符。", "example": "内容审核模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "内容审核模板描述信息，长度限制：256 个字符。", "example": "内容审核模板" }, { "name": "PornConfigure", "type": "object", "required": false, "description": "令人反感的信息的控制参数。", "example": "无", "children": [ { "name": "ImgReviewInfo", "type": "object", "required": false, "description": "画面鉴黄控制参数。", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "画面鉴黄任务开关，可选值： ON：开启画面鉴黄任务； OFF：关闭画面鉴黄任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "画面鉴黄过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回，可选值为： porn：色情； vulgar：低俗； intimacy：亲密行为； sexy：性感。", "example": "[\"porn\",\"sexy\"]", "item_type": "string" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规。取值范围：0~100。", "example": "60" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核。取值范围：0~100。", "example": "80" } ] }, { "name": "AsrReviewInfo", "type": "object", "required": false, "description": "语音鉴黄控制参数。", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "语音鉴黄任务开关，可选值： ON：开启语音鉴黄任务； OFF：关闭语音鉴黄任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规。取值范围：0~100。", "example": "60" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核。取值范围：0~100。", "example": "80" } ] }, { "name": "OcrReviewInfo", "type": "object", "required": false, "description": "文本鉴黄控制参数。", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "文本鉴黄任务开关，可选值： ON：开启文本鉴黄任务； OFF：关闭文本鉴黄任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规。取值范围：0~100。", "example": "60" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核。取值范围：0~100。", "example": "80" } ] } ] }, { "name": "TerrorismConfigure", "type": "object", "required": false, "description": "令人不安全的信息的控制参数。", "example": "无", "children": [ { "name": "ImgReviewInfo", "type": "object", "required": false, "description": "画面涉敏任务控制参数。", "example": "NULL", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "画面涉敏任务开关，可选值： ON：开启画面涉敏任务； OFF：关闭画面涉敏任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "画面涉敏过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回，可选值为： guns：武器枪支； crowd：人群聚集； bloody：血腥画面； police：警察部队； banners：涉敏旗帜； militant：武装分子； explosion：爆炸火灾； terrorists：涉敏人物；", "example": "guns", "item_type": "string" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规。取值范围：0~100。", "example": "95" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核。取值范围：0~100。", "example": "80" } ] }, { "name": "OcrReviewInfo", "type": "object", "required": false, "description": "文本涉敏任务控制参数。", "example": "NULL", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "文本涉敏任务开关，可选值： ON：开启文本涉敏任务； OFF：关闭文本涉敏任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。", "example": "0" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。", "example": "0" } ] } ] }, { "name": "PoliticalConfigure", "type": "object", "required": false, "description": "令人不适宜的控制参数。", "example": "无", "children": [ { "name": "ImgReviewInfo", "type": "object", "required": false, "description": "画面涉敏控制参数。", "example": "NULL", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "画面涉敏任务开关，可选值： ON：开启画面涉敏任务； OFF：关闭画面涉敏任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "画面涉敏过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回，可选值为： violation_photo：违规图标； politician：涉敏人物； entertainment：娱乐人物； sport：体育人物； entrepreneur：商业人物； scholar：教育学者； celebrity：知名人物； military：军事人物。", "example": "violation_photo", "item_type": "string" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规。取值范围：0~100。", "example": "0" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核。取值范围：0~100。", "example": "0" } ] }, { "name": "AsrReviewInfo", "type": "object", "required": false, "description": "语音涉敏控制参数。", "example": "NULL", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "语音涉敏任务开关，可选值： ON：开启语音涉敏任务； OFF：关闭语音涉敏任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规。取值范围：0~100。", "example": "85" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核。取值范围：0~100。", "example": "75" } ] }, { "name": "OcrReviewInfo", "type": "object", "required": false, "description": "文本涉敏控制参数。", "example": "NULL", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "文本涉敏任务开关，可选值： ON：开启文本涉敏任务； OFF：关闭文本涉敏任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规。取值范围：0~100。", "example": "0" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核。取值范围：0~100。", "example": "0" } ] } ] }, { "name": "ProhibitedConfigure", "type": "object", "required": false, "description": "违禁控制参数。违禁内容包括： 谩骂； 涉毒违法。 注意：此参数尚未支持。", "example": "无", "children": [ { "name": "AsrReviewInfo", "type": "object", "required": false, "description": "语音违禁控制参数。", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "语音违禁任务开关，可选值： ON：开启语音违禁任务； OFF：关闭语音违禁任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。", "example": "60" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。", "example": "80" } ] }, { "name": "OcrReviewInfo", "type": "object", "required": false, "description": "文本违禁控制参数。", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "文本违禁任务开关，可选值： ON：开启文本违禁任务； OFF：关闭文本违禁任务。", "example": "ON" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规，不填默认为 100 分。取值范围：0~100。", "example": "60" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核，不填默认为 75 分。取值范围：0~100。", "example": "80" } ] } ] }, { "name": "UserDefineConfigure", "type": "object", "required": false, "description": "用户自定义内容审核控制参数。", "example": "无", "children": [ { "name": "FaceReviewInfo", "type": "object", "required": true, "description": "用户自定义人物审核控制参数。", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "用户自定义人物审核任务开关，可选值： ON：开启自定义人物审核任务； OFF：关闭自定义人物审核任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "用户自定义人物过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回。如果要使用标签过滤功能，添加自定义人物库的时，需要添加对应人物标签。 标签个数最多 10 个，每个标签长度最多 16 个字符。", "example": "[\"自定义人物过滤标签1\"]", "item_type": "string" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规。取值范围：0~100。", "example": "100" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核。取值范围：0~100。", "example": "85" } ] }, { "name": "AsrReviewInfo", "type": "object", "required": true, "description": "用户自定义语音审核控制参数。", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "用户自定语音审核任务开关，可选值： ON：开启自定义语音审核任务； OFF：关闭自定义语音审核任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "用户自定义语音过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回。如果要使用标签过滤功能，添加自定义语音关键词素材时需要添加对应标签。 标签个数最多 10 个，每个标签长度最多 16 个字符。", "example": "[\"自定义语音过滤标签1\"]", "item_type": "string" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规。取值范围：0~100。", "example": "100" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核。取值范围：0~100。", "example": "85" } ] }, { "name": "OcrReviewInfo", "type": "object", "required": true, "description": "用户自定义文本审核控制参数。", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "用户自定文本审核任务开关，可选值： ON：开启自定义文本审核任务； OFF：关闭自定义文本审核任务。", "example": "ON" }, { "name": "LabelSet", "type": "array", "required": false, "description": "用户自定义文本过滤标签，审核结果包含选择的标签则返回结果，如果过滤标签为空，则审核结果全部返回。如果要使用标签过滤功能，添加自定义文本关键词素材时需要添加对应标签。 标签个数最多 10 个，每个标签长度最多 16 个字符。", "example": "[\"entertainment\", \"sport\"]", "item_type": "string" }, { "name": "BlockConfidence", "type": "integer", "required": false, "description": "判定涉嫌违规的分数阈值，当智能审核达到该分数以上，认为涉嫌违规。取值范围：0~100。", "example": "90" }, { "name": "ReviewConfidence", "type": "integer", "required": false, "description": "判定需人工复核是否违规的分数阈值，当智能审核达到该分数以上，认为需人工复核。取值范围：0~100。", "example": "80" } ] } ] } ], "required": [ "Definition" ] }, { "name": "ModifyImageSpriteTemplate", "description": "修改用户自定义雪碧图模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "雪碧图模板唯一标识。", "example": "10001" }, { "name": "Name", "type": "string", "required": false, "description": "雪碧图模板名称，长度限制：64 个字符。", "example": "雪碧图模板1" }, { "name": "Width", "type": "integer", "required": false, "description": "雪碧图中小图的宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "54" }, { "name": "Height", "type": "integer", "required": false, "description": "雪碧图中小图的高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "96" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。 默认值：open。", "example": "open" }, { "name": "SampleType", "type": "string", "required": false, "description": "采样类型，取值： Percent：按百分比。 Time：按时间间隔。", "example": "Percent" }, { "name": "SampleInterval", "type": "integer", "required": false, "description": "采样间隔。 当 SampleType 为 Percent 时，指定采样间隔的百分比。 当 SampleType 为 Time 时，指定采样间隔的时间，单位为秒。", "example": "10" }, { "name": "RowCount", "type": "integer", "required": false, "description": "雪碧图中小图的行数。", "example": "5" }, { "name": "ColumnCount", "type": "integer", "required": false, "description": "雪碧图中小图的列数。", "example": "10" }, { "name": "FillType", "type": "string", "required": false, "description": "填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“； black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。 默认值：black 。", "example": "black " }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "雪碧图模板" }, { "name": "Format", "type": "string", "required": false, "description": "图片格式，取值可以为 jpg、png、webp。", "example": "jpg" } ], "required": [ "Definition" ] }, { "name": "ModifyLiveRecordTemplate", "description": "修改直播录制模板", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "录制模板唯一标识。", "example": "20001" }, { "name": "HLSConfigure", "type": "object", "required": false, "description": "HLS配置参数，和MP4Configure需要二选一必填。", "example": "无", "children": [ { "name": "ItemDuration", "type": "integer", "required": false, "description": "单个 TS 文件时长，单位：秒，取值范围 5-30 秒。 不填默认为 30 秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "Interval", "type": "integer", "required": false, "description": "录制周期，单位：秒，取值范围 10 分钟到 12 小时。 不填默认为 10分钟（3600 秒）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3600" }, { "name": "ContinueTimeout", "type": "integer", "required": false, "description": "续录等待时间，单位：秒。取值范围为60秒-1800秒。 不填默认为0（不启用续录）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "60" } ] }, { "name": "MP4Configure", "type": "object", "required": false, "description": "MP4配置参数，和HLSConfigure需要二选一必填。", "example": "无", "children": [ { "name": "Interval", "type": "integer", "required": false, "description": "录制周期，单位：秒，取值范围 10 分钟到720分钟。默认值：60分钟（3600秒）。", "example": "3600" } ] }, { "name": "Name", "type": "string", "required": false, "description": "录制模板名称，长度限制：64 个字符。", "example": "直播录制模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "直播录制模板" }, { "name": "RecordType", "type": "string", "required": false, "description": "录制类型，取值为video（音视频录制）、audio（纯音频录制）、auto（自动探测）。", "example": "video" } ], "required": [ "Definition" ] }, { "name": "ModifyPersonSample", "description": "该接口用于根据素材 ID，修改素材样本信息，包括名称、描述的修改，以及五官、标签的添加、删除、重置操作。五官删除操作需保证至少剩余 1 张图片，否则，请使用重置操作。", "status": "online", "parameters": [ { "name": "PersonId", "type": "string", "required": true, "description": "素材 ID。", "example": "acdxx-xxx" }, { "name": "Name", "type": "string", "required": false, "description": "名称，长度限制：128 个字符。", "example": "张三" }, { "name": "Description", "type": "string", "required": false, "description": "描述，长度限制：1024 个字符。", "example": "三组" }, { "name": "Usages", "type": "array", "required": false, "description": "素材应用场景，可选值： 1. Recognition：用于内容识别，等价于 Recognition.Face。 2. Review：用于不适宜的内容识别，等价于 Review.Face。 3. All：用于内容识别、不适宜的内容识别，等价于 1+2。", "example": "[\"All\"]", "item_type": "string" }, { "name": "FaceOperationInfo", "type": "object", "required": false, "description": "五官操作信息。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "操作类型，可选值：add（添加）、delete（删除）、reset（重置）。重置操作将清空该人物已有人脸数据，并添加 FaceContents 指定人脸数据。", "example": "add" }, { "name": "FaceIds", "type": "array", "required": false, "description": "人脸 ID 集合，当 Type为delete 时，该字段必填。", "example": "[\"151***\"]", "item_type": "string" }, { "name": "FaceContents", "type": "array", "required": false, "description": "人脸图片 [Base64](https://tools.ietf.org/html/rfc4648) 编码后的字符串集合。 当 Type为add 或 reset 时，该字段必填； 数组长度限制：5 张图片。 注意：图片必须是单人像正面人脸较清晰的照片，像素不低于 200*200。", "example": "[\"/9j/4****SkZJRg****SABIAAD\"]", "item_type": "string" } ] }, { "name": "TagOperationInfo", "type": "object", "required": false, "description": "标签操作信息。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "操作类型，可选值：add（添加）、delete（删除）、reset（重置）。", "example": "add" }, { "name": "Tags", "type": "array", "required": true, "description": "标签，长度限制：128 个字符。", "example": "明星", "item_type": "string" } ] } ], "required": [ "PersonId" ] }, { "name": "ModifyProcessImageTemplate", "description": "修改图片处理模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "图片处理模板唯一标识。", "example": "200043" }, { "name": "Name", "type": "string", "required": false, "description": "图片处理模板名称，长度限制：64个字符。", "example": "图片处理模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制256个字符。", "example": "图片处理模板超分" }, { "name": "ProcessImageTemplate", "type": "object", "required": false, "description": "图片处理模板参数。", "example": "无", "children": [ { "name": "EncodeConfig", "type": "object", "required": false, "description": "图片编码配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Format", "type": "string", "required": false, "description": "图片格式，取值范围：JPEG、PNG、BMP、WebP，缺省为原图格式。不支持动画。 注意：此字段可能返回 null，表示取不到有效值。", "example": "JPEG" }, { "name": "Quality", "type": "integer", "required": false, "description": "图片的相对质量，取值范围：1 - 100，数值以原图质量为标准，缺省为原图质量。 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" } ] }, { "name": "EnhanceConfig", "type": "object", "required": false, "description": "图片增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SuperResolution", "type": "object", "required": false, "description": "超分配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： lq：针对低清晰度有较多噪声视频的超分； hq：针对高清晰度视频超分。 默认值：lq。 注意：此字段可能返回 null，表示取不到有效值。", "example": "lq" }, { "name": "Size", "type": "integer", "required": false, "description": "超分倍数，可选值： 2：目前只支持 2 倍超分。 默认值：2。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2" } ] }, { "name": "AdvancedSuperResolutionConfig", "type": "object", "required": false, "description": "高级超分配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： standard：通用超分 super：高级超分super版。 ultra：高级超分ultra版。 默认值：standard。 注意：此字段可能返回 null，表示取不到有效值。", "example": "standard" }, { "name": "Mode", "type": "string", "required": false, "description": "输出图片模式，默认percent。 aspect: 超分至指定宽高的较大矩形。 fixed: 超分至固定宽高，强制缩放。 percent: 超分倍率，可以为小数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "percent" }, { "name": "Percent", "type": "float", "required": false, "description": "超分倍率，可以为小数。 注意：当Mode等于percent时使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2.0" }, { "name": "Width", "type": "integer", "required": false, "description": "目标图片宽度，不能超过4096。 注意：当Mode等于aspect或fixed时，优先使用此配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1280" }, { "name": "Height", "type": "integer", "required": false, "description": "目标图片高度，不能超过4096。 注意：当Mode等于aspect或fixed时，优先使用此配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "720" }, { "name": "LongSide", "type": "integer", "required": false, "description": "目标图片长边长度，不能超过4096。 注意：当Mode等于aspect或fixed，且未配置Width和Height字段时使用此配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1280" }, { "name": "ShortSide", "type": "integer", "required": false, "description": "目标图片短边长度，不能超过4096。 注意：当Mode等于aspect或fixed，且未配置Width和Height字段时使用此配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1280" } ] }, { "name": "Denoise", "type": "object", "required": false, "description": "降噪配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "ImageQualityEnhance", "type": "object", "required": false, "description": "综合增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak normal strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "ColorEnhance", "type": "object", "required": false, "description": "色彩增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak normal strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "SharpEnhance", "type": "object", "required": false, "description": "细节增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Intensity", "type": "float", "required": false, "description": "强度，取值范围：0.0~1.0。 默认：0.0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "FaceEnhance", "type": "object", "required": false, "description": "人脸增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Intensity", "type": "float", "required": false, "description": "强度，取值范围：0.0~1.0。 默认：0.0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "LowLightEnhance", "type": "object", "required": false, "description": "低光照增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： normal 默认值：normal。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" } ] } ] }, { "name": "EraseConfig", "type": "object", "required": false, "description": "图片擦除配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ImageEraseLogo", "type": "object", "required": false, "description": "图标擦除配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" }, { "name": "ImageAreaBoxes", "type": "array", "required": false, "description": "需要擦除的多个框选区域，最多开启16个区域。 注意：此字段可能返回 null，表示取不到有效值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "DetectTypes", "type": "array", "required": false, "description": "图片框选区域类型，可选值： logo：图标； text：文字； watermark：水印； 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"logo\", \"text\"]", "item_type": "string" } ] } ] }, { "name": "BlindWatermarkConfig", "type": "object", "required": false, "description": "盲水印配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "AddBlindWatermark", "type": "object", "required": false, "description": "增加盲水印 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" }, { "name": "EmbedInfo", "type": "object", "required": false, "description": "盲水印嵌入数据 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ExtractBlindWatermark", "type": "object", "required": false, "description": "提取盲水印 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" } ] }, { "name": "RemoveBlindWatermark", "type": "object", "required": false, "description": "移除盲水印 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" } ] } ] }, { "name": "BeautyConfig", "type": "object", "required": false, "description": "美颜配置。", "example": "无", "children": [ { "name": "BeautyEffectItems", "type": "array", "required": false, "description": "美颜效果", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型名称。取值如下： Whiten：美白 BlackAlpha1：美黑 BlackAlpha2：较强美黑 FoundationAlpha2：美白-粉白 Clear：清晰度 Sharpen：锐化 Smooth：磨皮 BeautyThinFace：瘦脸 NatureFace：自然脸型 VFace：V脸 EnlargeEye：大眼 EyeLighten：亮眼 RemoveEyeBags：祛眼袋 ThinNose：瘦鼻 RemoveLawLine：祛法令纹 CheekboneThin：瘦颧骨 FaceFeatureLipsLut：口红 ToothWhiten：牙齿美白 FaceFeatureSoftlight：柔光 Makeup：美妆", "example": "Whiten" }, { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Value", "type": "integer", "required": false, "description": "效果强度，值范围：[0, 100]。", "example": "40" }, { "name": "ResourcePath", "type": "string", "required": false, "description": "附加资源路径。", "example": "/makeupRes/video_makeup_mitao" }, { "name": "ExtInfo", "type": "string", "required": false, "description": "自定义参数。", "example": "{\\\"Color\\\":\\\"#ff0000\\\"}" } ] }, { "name": "BeautyFilterItems", "type": "array", "required": false, "description": "美颜滤镜", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型名称。取值如下： Dongjing：东京 Qingjiaopian：轻胶片 Meiwei：美味", "example": "Qingjiaopian" }, { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Value", "type": "integer", "required": false, "description": "效果强度，值范围：[-100, 100]。", "example": "70" } ] } ] }, { "name": "TransformConfig", "type": "object", "required": false, "description": "图片基础转换能力。", "example": "无", "children": [ { "name": "ImageResize", "type": "object", "required": false, "description": "图片缩放配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启 OFF：关闭 默认值：ON。", "example": "ON" }, { "name": "Mode", "type": "string", "required": false, "description": "输出图片模式，可选模式： percent: 指定缩放倍率，可以为小数 mfit: 缩放至指定宽高的较大矩形 lfit: 缩放至指定宽高的较小矩形 fill: 缩放至指定宽高的较大矩形，并居中裁剪指定宽高 pad: 缩放至指定宽高的较小矩形，并填充到指定宽高 fixed: 缩放至固定宽高，强制缩放 默认值：percent。 注意：此字段可能返回 null，表示取不到有效值。", "example": "percent" }, { "name": "Percent", "type": "float", "required": false, "description": "缩放倍率，可以为小数，当Mode为percent时使用。 默认值：1.0。 取值范围：[0.1，10.0] 注意：此字段可能返回 null，表示取不到有效值。", "example": "1.0" }, { "name": "Width", "type": "integer", "required": false, "description": "目标图片宽度。 取值范围：[1，16384]。 注意：此字段在Mode非percent时优先使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3840" }, { "name": "Height", "type": "integer", "required": false, "description": "目标图片高度。 取值范围：[1，16384]。 注意：此字段在Mode非percent时优先使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2160" }, { "name": "LongSide", "type": "integer", "required": false, "description": "目标图片长边。 取值范围：[1，16384]。 注意：此字段在Mode非percent且未配置Width和Height时使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3840" }, { "name": "ShortSide", "type": "integer", "required": false, "description": "目标图片短边。 取值范围：[1，16384]。 注意：此字段在Mode非percent且未配置Width和Height时使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2160" } ] } ] } ] } ], "required": [ "Definition" ] }, { "name": "ModifyQualityControlTemplate", "description": "修改媒体质检模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "媒体质检模板唯一标识。", "example": "1002" }, { "name": "Name", "type": "string", "required": false, "description": "媒体质检模板名称，长度限制：64 个字符。", "example": "媒体质检模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "媒体质检模板" }, { "name": "QualityControlItemSet", "type": "array", "required": false, "description": "媒体质检配置参数。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "质检项名称。质检项取值如下： LowEvaluation：视频无参考评分（MOS） AudioEvaluation：音频无参考评分（MOS） Mosaic：马赛克检测 CrashScreen：花屏检测 Blur：模糊检测 Jitter：抖动检测 Noise：噪点检测 QRCode：二维码检测 BarCode：条形码检测 AppletCode：小程序码检测 BlackWhiteEdge：黑白边检测 SolidColorScreen：纯色屏检测 LowLighting：低光照 HighLighting：过曝 NoVoice：静音检测 LowVoice：低音检测 Hi...", "example": "Mosaic" }, { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" }, { "name": "Sampling", "type": "string", "required": false, "description": "采样方式，取值范围： - Time：根据时间间隔采样。 注意：此字段可能返回 null，表示取不到有效值。", "example": "Time" }, { "name": "IntervalTime", "type": "integer", "required": false, "description": "采样间隔时间，单位：ms。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1000" }, { "name": "Duration", "type": "integer", "required": false, "description": "异常持续时间，单位：ms。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1000" }, { "name": "Threshold", "type": "string", "required": false, "description": "检测项对应的阈值，不同检测项对应阈值不同。 注意：此字段可能返回 null，表示取不到有效值。", "example": "80" } ] }, { "name": "RecordFormat", "type": "string", "required": false, "description": "录制文件格式。可选值： PNG: PNG图片", "example": "PNG" }, { "name": "Strategy", "type": "object", "required": false, "description": "媒体质检抽检策略。", "example": "无", "children": [ { "name": "StrategyType", "type": "string", "required": false, "description": "策略类型。取值： - TimeSpotCheck", "example": "TimeSpotCheck" }, { "name": "TimeSpotCheck", "type": "object", "required": false, "description": "根据时间的抽检策略。", "example": "无", "children": [ { "name": "CheckDuration", "type": "integer", "required": false, "description": "每次循环检测的时长。取值范围（单位s）： - 最小值：10 - 最大值：86400", "example": "30" }, { "name": "CheckInterval", "type": "integer", "required": false, "description": "抽检间隔，表示在一次检测结束后，等待多长时间后，再次检测。取值范围（单位 s）： - 最小值：10 - 最大值：3600", "example": "30" }, { "name": "SkipDuration", "type": "integer", "required": false, "description": "片头跳过时长。取值范围（单位 s）： - 最小值：1 - 最大值：1800", "example": "60" }, { "name": "CirclesNumber", "type": "integer", "required": false, "description": "循环次数。取值范围: - 最小值：0 - 最大值：1000 取值为 0 或为空时，表示循环至视频结束。", "example": "10" } ] } ] } ], "required": [ "Definition" ] }, { "name": "ModifySampleSnapshotTemplate", "description": "修改用户自定义采样截图模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "采样截图模板唯一标识。", "example": "10001" }, { "name": "Name", "type": "string", "required": false, "description": "采样截图模板名称，长度限制：64 个字符。", "example": "采样截图模板1" }, { "name": "Width", "type": "integer", "required": false, "description": "截图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "540" }, { "name": "Height", "type": "integer", "required": false, "description": "截图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "960" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。 默认值：open。", "example": "open" }, { "name": "SampleType", "type": "string", "required": false, "description": "采样截图类型，取值： Percent：按百分比。 Time：按时间间隔。", "example": "Percent" }, { "name": "SampleInterval", "type": "integer", "required": false, "description": "采样间隔。 当 SampleType 为 Percent 时，指定采样间隔的百分比。 当 SampleType 为 Time 时，指定采样间隔的时间，单位为秒。", "example": "10" }, { "name": "Format", "type": "string", "required": false, "description": "图片格式，取值为 jpg、png、webp。", "example": "jpg" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "采样截图模板" }, { "name": "FillType", "type": "string", "required": false, "description": "填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“； black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。 white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。 gauss：高斯模糊，保持视频...", "example": "black " } ], "required": [ "Definition" ] }, { "name": "ModifySchedule", "description": "修改编排", "status": "online", "parameters": [ { "name": "ScheduleId", "type": "integer", "required": true, "description": "编排唯一标识。", "example": "20010" }, { "name": "ScheduleName", "type": "string", "required": false, "description": "编排名称。", "example": "编排1" }, { "name": "Trigger", "type": "object", "required": false, "description": "编排绑定的触发规则。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "触发器的类型，可选值： CosFileUpload：COS触发 AwsS3FileUpload：AWS触发，目前只支持转码任务。只有编排支持，工作流不支持。", "example": "CosFileUpload" }, { "name": "CosFileUploadTrigger", "type": "object", "required": false, "description": "当 Type 为 CosFileUpload 时必填且有效，为 COS 触发规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "工作流绑定的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "CosVideoFile-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "工作流绑定的 COS Bucket 所属园区，如 ap-chongiqng。", "example": "ap-nanjing" }, { "name": "Dir", "type": "string", "required": false, "description": "工作流绑定的输入路径目录，必须为绝对路径，即以 `/` 开头和结尾。如`/movie/201907/`，不填代表根目录`/`。", "example": "/trigger-dir/" }, { "name": "Formats", "type": "array", "required": false, "description": "支持的所有格式如下： - 视频文件扩展名，支持以下选择，共15种： `.mp4`、`.avi`、`.mov`、`.wmv`、`.flv`、`.mkv`、`.mpg`、`.mpeg`、`.rm`、`.rmvb`、`.asf`、`.3gp`、`.webm`、`.ts`、`.m4v` - 音频文件扩展名，支持以下选择，共7种： `.mp3`、`.wav`、`.aac`、`.flac`、`.ogg`、`.m4a`、`.amr` - 字幕文件扩展名，支持以下选择，共2种： `.vtt`、`.srt` - `*`：支持任意文件格式 - 不传或者传空列表：支持系统预设\ufffd\ufffd...", "example": "[\"mp4\",\"flv\",\"mov\"]", "item_type": "string" } ] }, { "name": "AwsS3FileUploadTrigger", "type": "object", "required": false, "description": "当 Type 为 AwsS3FileUpload 时必填且有效，为 AWS S3 触发规则。 注意：目前AWS的S3、对应触发队列SQS、回调队列SQS的秘钥需要一致。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "绑定的 AWS S3 存储桶。", "example": "mps-test-s3" }, { "name": "S3Region", "type": "string", "required": true, "description": "绑定的桶所在 AWS 区域，目前支持： us-east-1 eu-west-3", "example": "us-east-1 " }, { "name": "Dir", "type": "string", "required": false, "description": "绑定的输入路径目录，必须为绝对路径，即以 `/` 开头和结尾。如`/movie/201907/`，不填代表根目录`/`。", "example": "/Dir/" }, { "name": "Formats", "type": "array", "required": false, "description": "允许触发的文件格式列表，如 [\"mp4\", \"flv\", \"mov\"]。不填代表所有格式的文件都可以触发工作流。", "example": "[\"mp4\", \"flv\", \"mov\"]", "item_type": "string" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "绑定的 AWS S3 存储桶的秘钥ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "绑定的 AWS S3 存储桶的秘钥Key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "绑定的 AWS S3 存储桶对应的 SQS事件队列。 注意：队列和桶需要在同一区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] } ] } ] }, { "name": "Activities", "type": "array", "required": false, "description": "编排任务列表。 注意：内部不允许部分更新，如果需要更新需全量提交编排任务列表。", "example": "无", "item_type": "object", "children": [ { "name": "ActivityType", "type": "string", "required": true, "description": "原子任务类型： input: 起始节点 output：终止节点 action-trans：转码 action-samplesnapshot：采样截图 action-AIAnalysis: 分析 action-AIRecognition：识别 action-aiReview：审核 action-animated-graphics：转动图 action-image-sprite：雪碧图 action-snapshotByTimeOffset: 时间点截图 action-adaptive-substream：自适应码流 action-AIQualityControl：媒体质检 action-SmartSubtitles：智能字幕 action-exec-rules：判断规则 action-SmartErase：智能擦...", "example": "input" }, { "name": "ReardriveIndex", "type": "array", "required": false, "description": "后驱节点索引数组", "example": "[3]", "item_type": "integer" }, { "name": "ActivityPara", "type": "object", "required": false, "description": "原子任务参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "TranscodeTask", "type": "object", "required": false, "description": "视频转码任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频转码模板 ID。", "example": "20" }, { "name": "RawParameter", "type": "object", "required": false, "description": "视频转码自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定转码参数。", "example": "无" }, { "name": "OverrideParameter", "type": "object", "required": false, "description": "视频转码自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分转码参数时，将使用填写的参数覆盖转码模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "string" }, { "name": "BlindWatermark", "type": "object", "required": false, "description": "数字水印参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "MosaicSet", "type": "array", "required": false, "description": "马赛克列表，最大可支持 10 张。", "example": "无", "item_type": "string" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "转码后的视频的起始时间偏移，单位：秒。 不填或填0，表示转码后的视频从原始视频的起始位置开始； 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始； 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。", "example": "1.0" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "转码后视频的终止时间偏移，单位：秒。 不填或填0，表示转码后的视频持续到原始视频的末尾终止； 当数值大于0时（假设为 n），表示转码后的视频持续到原始视频第 n 秒时终止； 当数值小于0时（假设为 -n），表示转码后的视频持续到原始视频结束 n 秒前终止。", "example": "15.0" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转码后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转码后主文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_transcode_{definition}.{format}`。", "example": "{inputName}_transcode_{definition}.{format}" }, { "name": "SegmentObjectName", "type": "string", "required": false, "description": "转码后分片文件的输出路径（转码 HLS 时 ts 的路径），只能为相对路径。如果不填，则默认为：`{inputName}_transcode_{definition}_{number}.{format}`。", "example": "{inputName}_transcode_{definition}_{number}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "转码后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "HeadTailParameter", "type": "object", "required": false, "description": "片头片尾参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "AnimatedGraphicTask", "type": "object", "required": false, "description": "视频转动图任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频转动图模板 ID。", "example": "20000" }, { "name": "StartTimeOffset", "type": "float", "required": true, "description": "动图在视频中的开始时间，单位为秒。", "example": "1.5" }, { "name": "EndTimeOffset", "type": "float", "required": true, "description": "动图在视频中的结束时间，单位为秒。", "example": "11.2" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转动图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转动图后文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_animatedGraphic_{definition}.{format}`。", "example": "文件名_{变量名}.{format}" } ] }, { "name": "SnapshotByTimeOffsetTask", "type": "object", "required": false, "description": "视频按时间点截图任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "指定时间点截图模板 ID。", "example": "11028" }, { "name": "ExtTimeOffsetSet", "type": "array", "required": false, "description": "截图时间点列表，时间点支持 s、% 两种格式： 当字符串以 s 结尾，表示时间点单位为秒，如 3.5s 表示时间点为第3.5秒； 当字符串以 % 结尾，表示时间点为视频时长的百分比大小，如10%表示时间点为视频前第10%的时间。", "example": "[\"3.5s\", \"50%\"]", "item_type": "string" }, { "name": "TimeOffsetSet", "type": "array", "required": false, "description": "截图时间点列表，单位为秒。此参数已不再建议使用，建议您使用 ExtTimeOffsetSet 参数。", "example": "[7.5, 10]", "item_type": "float" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "string" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "时间点截图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "时间点截图后图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_snapshotByTimeOffset_{definition}_{number}.{format}`\ufffd...", "example": "/mps/output/{inputName}_test_{definition}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "时间点截图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "SampleSnapshotTask", "type": "object", "required": false, "description": "视频采样截图任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "采样截图模板 ID。", "example": "10" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "string" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "采样截图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "采样截图后图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_sampleSnapshot_{definition}_{number}.{format}`。", "example": "/{inputName}_snapshotByTimeOffsetTest_{definition}_{number}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "采样截图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ImageSpriteTask", "type": "object", "required": false, "description": "视频截雪碧图任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "雪碧图模板 ID。", "example": "10001" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "截取雪碧图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "截取雪碧图后，雪碧图图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_imageSprite_{definition}_{number}.{format...", "example": "xxx_imageSprite_10001_0.png" }, { "name": "WebVttObjectName", "type": "string", "required": false, "description": "截取雪碧图后，Web VTT 文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_imageSprite_{definition}.{format}`。", "example": "xxx_imageSprite_10001_0.vtt" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "截取雪碧图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "AdaptiveDynamicStreamingTask", "type": "object", "required": false, "description": "转自适应码流任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "转自适应码流模板 ID。", "example": "10" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "string" }, { "name": "BlindWatermark", "type": "object", "required": false, "description": "数字水印参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转自适应码流后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转自适应码流后，manifest 文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：{inputName}_adaptiveDynamicStreaming_{definition}.{format...", "example": "{inputName}_adaptiveDynamicStreaming_{definition}.{format}" }, { "name": "SubStreamObjectName", "type": "string", "required": false, "description": "转自适应码流后，子流文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}`。", "example": "{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}" }, { "name": "SegmentObjectName", "type": "string", "required": false, "description": "转自适应码流（仅 HLS）后，分片文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}`。", "example": "{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}" }, { "name": "AddOnSubtitles", "type": "array", "required": false, "description": "外挂字幕功能，指定要插入的字幕文件。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "DrmInfo", "type": "object", "required": false, "description": "Drm信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "DefinitionType", "type": "string", "required": false, "description": "自适应转码模板类型： Common：音视频类型 PureAudio：纯音频类型", "example": "Common" }, { "name": "SubtitleTemplate", "type": "object", "required": false, "description": "硬字幕（压制字幕）功能，指定字幕来源、字体大小、位置等字幕参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "转码参数扩展字段", "example": "{\"audio_info\": {\"codec\": \"vivid\"}}" }, { "name": "KeyPTSList", "type": "array", "required": false, "description": "指定pts时间的帧设为关键帧，并切片。单位毫秒（允许相对偏差\u003c=1ms）。当同时指定gop和切片时长时，会共同作用。注意需开启RawPts，保持帧率随源，并确保传入的pts时间在源中是有对应帧的。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[1000, 2000]", "item_type": "integer" } ] }, { "name": "AiContentReviewTask", "type": "object", "required": false, "description": "视频内容审核类型任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容审核模板 ID。", "example": "10" } ] }, { "name": "AiAnalysisTask", "type": "object", "required": false, "description": "视频内容分析类型任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容分析模板 ID。", "example": "28" }, { "name": "ExtendedParameter", "type": "string", "required": false, "description": "扩展参数，其值为序列化的 json字符串。 注意：此参数为定制需求参数，参考如下： [智能檫除](https://cloud.tencent.com/document/product/862/101530) [智能拆条](https://cloud.tencent.com/document/product/862/112098) [高光集锦](https://cloud.tencent.com/document/product/862/107280) [智能横转竖](https://cloud.tencent.com/document/product/862/112112) 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"{\\\"htv\\\": {} }\"" } ] }, { "name": "AiRecognitionTask", "type": "object", "required": false, "description": "视频内容识别类型任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频智能识别模板 ID 。", "example": "10" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "用户扩展字段，一般场景不用填。", "example": "{\"ParaTest\":\"test\"}" } ] }, { "name": "QualityControlTask", "type": "object", "required": false, "description": "媒体质检任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": false, "description": "媒体质检模板 ID 。 可以直接使用预设模板，也可以在控制台自定义模板。预设模板如下： - 10：开启所有质检项； - 20：仅开启格式诊断对应质检项； - 30：仅开启无参考打分对应质检项； - 40：仅开启画面质量对应质检项。 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "ChannelExtPara", "type": "string", "required": false, "description": "渠道扩展参数json序列化字符串。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\\\"OutputDir\\\":\\\"/test/output/1abc***12345/\\\"}" } ] }, { "name": "ExecRulesTask", "type": "object", "required": false, "description": "任务条件判断 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Rules", "type": "array", "required": false, "description": "条件判断信息 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" } ] }, { "name": "SmartSubtitlesTask", "type": "object", "required": false, "description": "智能字幕任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": false, "description": "智能字幕模板 ID 。", "example": "110167" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "用户扩展字段，一般场景不用填。", "example": "用户扩展字段" }, { "name": "RawParameter", "type": "object", "required": false, "description": "智能字幕自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定智能字幕参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "媒体处理输出文件的目标存储。不填则继承 InputInfo 中的存储位置。 **注意**：当InputInfo.Type为URL时，该参数是必填项。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{ \"Type\": \"COS\", \"CosOutputStorage\": { \"Bucket\": \"xxxx-yyy\", \"Region\": \"region\" } }" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "生成字幕文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例: - 文件名_{变量名}.{format} - 文件名.{format} 绝对路径示例： - /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径: `{inputName}_smartsubtitle_{definition}.{format}`。", "example": "/storage/{inputName}_smartsubtitle_{definition}.{format}" } ] }, { "name": "SmartEraseTask", "type": "object", "required": false, "description": "智能擦除任务 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": false, "description": "智能擦除模板id。", "example": "101" }, { "name": "RawParameter", "type": "object", "required": false, "description": "智能擦除自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定智能擦除参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OverrideParameter", "type": "object", "required": false, "description": "智能擦除自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分擦除参数时，将使用填写的参数覆盖智能擦除模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定智能擦除参数。", "example": "无" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} **注意**：目前不支持`BatchProcessMedia`接口。", "example": "{inputName}_smarterase.{format}" } ] } ] } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "媒体处理的文件输出存储位置。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputDir", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标目录，必选以 / 开头和结尾。 注意：如果设置为空，则表示取消老配置的OutputDir值。", "example": "/tmp/" }, { "name": "TaskNotifyConfig", "type": "object", "required": false, "description": "任务的事件通知配置。", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型，可选值： CMQ：已下线，建议切换到TDMQ-CMQ TDMQ-CMQ：消息队列 URL：指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同解析事件通知接口的输出参数 SCF：不推荐使用，需要在控制台额外配置SCF AWS-SQS：AWS 队列，只适用于 AWS 任务，且要求同区域 注：不填或为空时默认 TDMQ-CMQ，如需采用其他类型需填写对应类型值；如果使用TDMQ-CMQ消息队列，任务\ufffd...", "example": "URL" }, { "name": "NotifyMode", "type": "string", "required": false, "description": "工作流通知的模式，可取值有 Finish 和 Change，不填代表 Finish。", "example": "Finish " }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的模型，有 Queue 和 Topic 两种。", "example": "Queue " }, { "name": "CmqRegion", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。", "example": "mps_notify" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。", "example": "mps_que" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "AWS SQS 回调，NotifyType为 AWS-SQS 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NULL", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的key。", "example": "0se***9idaY" } ] }, { "name": "ResourceId", "type": "string", "required": false, "description": "资源ID，需要保证对应资源是开启状态。", "example": "974e52bf-****-fdeca9b2d290" } ], "required": [ "ScheduleId" ] }, { "name": "ModifySmartEraseTemplate", "description": "修改用户自定义智能擦除模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "智能擦除模板唯一标识", "example": "30" }, { "name": "Name", "type": "string", "required": false, "description": "智能擦除模板名称长度限制：64 个字符。", "example": "模板1" }, { "name": "Comment", "type": "string", "required": false, "description": "智能擦除模板描述信息长度限制：256 个字符。", "example": "模板2" }, { "name": "EraseType", "type": "string", "required": false, "description": "擦除类型 - subtitle 去字幕 - watermark 去水印 - privacy 隐私保护", "example": "subtitle" }, { "name": "EraseSubtitleConfig", "type": "object", "required": false, "description": "字幕擦除配置，EraseType取subtitle或者EraseType不填，对应模板原EraseType为subtitle时生效。", "example": "无", "children": [ { "name": "SubtitleEraseMethod", "type": "string", "required": true, "description": "字幕擦除方式。 **自动擦除：**通过AI模型自动识别视频中的字幕文本内容，进行无痕化擦除，生成新的视频。但画面干扰、特殊字幕样式可能会带来一定漏擦误擦问题，可以通过指定区域擦除处理。 当使用自动擦除时，若您不指定AutoAreas，将对默认区域（画面中下部）进行自动擦除；若指定AutoAreas，将改为对您指定的区域进行自动擦除。 **指定区域擦除：**若您的字幕位置较\ufffd...", "example": "auto" }, { "name": "SubtitleModel", "type": "string", "required": true, "description": "字幕擦除模型。 **标准版（推荐）：**若您的字幕样式标准，通常建议选择该版本，细节无痕化效果更好。 **区域版：**若您的字幕存在花体、阴影、动效等特殊样式，建议选择区域版，擦除面积更大，但细节效果不如标准版。 - standard 标准模型 - area 区域模型", "example": "standard" }, { "name": "OcrSwitch", "type": "string", "required": false, "description": "是否开启OCR字幕提取，默认取OFF。 当且仅当SubtitleEraseMethod取auto时支持开启OCR字幕提取，开启后将识别自动擦除区域内出现时间最长且最稳定的文字区域为字幕区域，对字幕区域中的文字进行提取和擦除。 - ON 开启 - OFF 关闭", "example": "ON" }, { "name": "SubtitleLang", "type": "string", "required": false, "description": "字幕语言，用于指导OCR识别，默认取zh_en；仅当OcrSwitch取\"ON\"时生效。 - zh_en 中英文 - multi 其他 其他具体支持识别如下语言： 中文、英文、日文、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语、印地语、阿拉伯语、印度-孟加拉语、印度-古吉拉特语、印度-卡纳达语 、印度-马拉亚拉姆\ufffd...", "example": "zh_en" }, { "name": "SubtitleFormat", "type": "string", "required": false, "description": "字幕文件格式，默认取vtt；仅当OcrSwitch取\"ON\"时生效。 - srt srt格式 - vtt WebVTT格式", "example": "vtt" }, { "name": "TransSwitch", "type": "string", "required": false, "description": "是否开启字幕翻译，默认取OFF；仅当OcrSwitch取\"ON\"时生效。 - ON 开启 - OFF 关闭", "example": "ON" }, { "name": "TransDstLang", "type": "string", "required": false, "description": "字幕翻译目标语言，默认取en；仅当TransSwitch取\"ON\"时生效。 当前支持以下语言： zh：简体中文 en：英语 ja：日语 ko：韩语 fr：法语 es：西班牙语 it：意大利语 de：德语 tr：土耳其语 ru：俄语 pt：葡萄牙语 vi：越南语 id：印度尼西亚语 ms：马来语 th：泰语 ar：阿拉伯语 hi：印地语", "example": "en" }, { "name": "AutoAreas", "type": "array", "required": false, "description": "自动擦除自定义区域。 对选定区域，利用AI模型自动检测其中存在的擦除目标并擦除。 注意：当擦除方式选择custom时，此参数将不会生效；修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "object", "children": [ { "name": "LeftTopX", "type": "float", "required": true, "description": "区域左上角X坐标。 如当Unit取1即使用百分比单位时，0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。", "example": "0.0500" }, { "name": "LeftTopY", "type": "float", "required": true, "description": "区域左上角Y坐标。 如当Unit取1即使用百分比单位时，0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。", "example": "0.1000" }, { "name": "RightBottomX", "type": "float", "required": true, "description": "区域右下角X坐标。 如当Unit取1即使用百分比单位时，0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。", "example": "0.7500" }, { "name": "RightBottomY", "type": "float", "required": true, "description": "区域右下角Y坐标。 如当Unit取1即使用百分比单位时，0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。", "example": "0.9000" }, { "name": "Unit", "type": "integer", "required": true, "description": "坐标单位 - 1 百分比 - 2 像素值", "example": "1" } ] }, { "name": "CustomAreas", "type": "array", "required": false, "description": "指定擦除自定义区域。 对选定区域，在选定时间段内不进行检测识别直接进行擦除。 注意：修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "object", "children": [ { "name": "BeginMs", "type": "integer", "required": true, "description": "开始时间，单位:毫秒", "example": "200" }, { "name": "EndMs", "type": "integer", "required": true, "description": "结束时间，单位:毫秒", "example": "3000" }, { "name": "Areas", "type": "array", "required": true, "description": "时间段内擦除区域列表", "example": "无", "item_type": "object", "children": [ { "name": "LeftTopX", "type": "float", "required": true, "description": "区域左上角X坐标。 如当Unit取1即使用百分比单位时，0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。", "example": "0.0500" }, { "name": "LeftTopY", "type": "float", "required": true, "description": "区域左上角Y坐标。 如当Unit取1即使用百分比单位时，0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。", "example": "0.1000" }, { "name": "RightBottomX", "type": "float", "required": true, "description": "区域右下角X坐标。 如当Unit取1即使用百分比单位时，0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。", "example": "0.7500" }, { "name": "RightBottomY", "type": "float", "required": true, "description": "区域右下角Y坐标。 如当Unit取1即使用百分比单位时，0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。", "example": "0.9000" }, { "name": "Unit", "type": "integer", "required": true, "description": "坐标单位 - 1 百分比 - 2 像素值", "example": "1" } ] } ] } ] }, { "name": "EraseWatermarkConfig", "type": "object", "required": false, "description": "水印擦除配置，EraseType取watermark或者EraseType不填，对应模板原EraseType为watermark时生效。", "example": "无", "children": [ { "name": "WatermarkEraseMethod", "type": "string", "required": true, "description": "水印擦除方式。 **自动擦除：**通过A模型自动识别视频中的水印，擦除后生成新的视频。适用于动态水印。 当使用自动擦除时，若您不指定AutoAreas，将对视频全屏进行自动擦除；若指定AutoAreas，将改为对您指定的区域进行自动擦除。 **指定区域擦除：**针对位置较固定的静态水印，建议您直接指定擦除区域。 当您选择指定区域擦除时，请至少传入一个指定区域。 - auto 自动擦\ufffd\ufffd...", "example": "auto" }, { "name": "WatermarkModel", "type": "string", "required": true, "description": "水印擦除模型。 基础版：效果一般，性价比高，适合动画或背景较干净的视频。 高级版：效果更好，适合短剧等现实风格视频。 - basic 基础版 - advanced 高级版", "example": "advanced" }, { "name": "AutoAreas", "type": "array", "required": false, "description": "自动擦除自定义区域。 对选定区域，利用AI模型自动检测其中存在的擦除目标并擦除。 注意，当擦除方式为custom时，此参数将不会生效。修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "object", "children": [ { "name": "LeftTopX", "type": "float", "required": true, "description": "区域左上角X坐标。 如当Unit取1即使用百分比单位时，0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。", "example": "0.0500" }, { "name": "LeftTopY", "type": "float", "required": true, "description": "区域左上角Y坐标。 如当Unit取1即使用百分比单位时，0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。", "example": "0.1000" }, { "name": "RightBottomX", "type": "float", "required": true, "description": "区域右下角X坐标。 如当Unit取1即使用百分比单位时，0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。", "example": "0.7500" }, { "name": "RightBottomY", "type": "float", "required": true, "description": "区域右下角Y坐标。 如当Unit取1即使用百分比单位时，0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。", "example": "0.9000" }, { "name": "Unit", "type": "integer", "required": true, "description": "坐标单位 - 1 百分比 - 2 像素值", "example": "1" } ] }, { "name": "CustomAreas", "type": "array", "required": false, "description": "指定擦除自定义区域。 对选定区域，在选定时间段内不进行检测识别直接进行擦除。 注意：修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "object", "children": [ { "name": "BeginMs", "type": "integer", "required": true, "description": "开始时间，单位:毫秒", "example": "200" }, { "name": "EndMs", "type": "integer", "required": true, "description": "结束时间，单位:毫秒", "example": "3000" }, { "name": "Areas", "type": "array", "required": true, "description": "时间段内擦除区域列表", "example": "无", "item_type": "object", "children": [ { "name": "LeftTopX", "type": "float", "required": true, "description": "区域左上角X坐标。 如当Unit取1即使用百分比单位时，0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。", "example": "0.0500" }, { "name": "LeftTopY", "type": "float", "required": true, "description": "区域左上角Y坐标。 如当Unit取1即使用百分比单位时，0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。", "example": "0.1000" }, { "name": "RightBottomX", "type": "float", "required": true, "description": "区域右下角X坐标。 如当Unit取1即使用百分比单位时，0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。", "example": "0.7500" }, { "name": "RightBottomY", "type": "float", "required": true, "description": "区域右下角Y坐标。 如当Unit取1即使用百分比单位时，0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。", "example": "0.9000" }, { "name": "Unit", "type": "integer", "required": true, "description": "坐标单位 - 1 百分比 - 2 像素值", "example": "1" } ] } ] } ] }, { "name": "ErasePrivacyConfig", "type": "object", "required": false, "description": "隐私保护配置，EraseType取privacy或者EraseType不填，对应模板原EraseType为privacy时生效。", "example": "无", "children": [ { "name": "PrivacyModel", "type": "string", "required": true, "description": "隐私保护擦除方式。 - blur 模糊 - mosaic 马赛克", "example": "blur" }, { "name": "PrivacyTargets", "type": "array", "required": true, "description": "隐私保护目标，（在API Explorer上使用时无需传入数组，添加相应项并填入对应值即可）。 - face 人脸 - plate 车牌", "example": "[\"face\",\"plate\"]", "item_type": "string" } ] } ], "required": [ "Definition" ] }, { "name": "ModifySmartSubtitleTemplate", "description": "修改用户自定义智能字幕模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "智能字幕模板唯一标识", "example": "30" }, { "name": "TranslateSwitch", "type": "string", "required": false, "description": "字幕翻译开关 `ON`: 开启翻译 `OFF`: 关闭翻译 **注意**：纯字幕翻译方式下，不传默认是打开的，不允许传空或`OFF`；", "example": "ON" }, { "name": "Name", "type": "string", "required": false, "description": "智能字幕模板名称 长度限制：64 个字符。", "example": "智能字幕模板" }, { "name": "Comment", "type": "string", "required": false, "description": "智能字幕模板描述信息 长度限制：256 个字符。", "example": "模板2" }, { "name": "VideoSrcLanguage", "type": "string", "required": false, "description": "智能字幕视频源语言 OCR识别仅支持以下语言： `zh_en`：中英 `multi`：其他 ASR识别和纯字幕翻译当前支持以下语言： `auto`：自动识别（仅在纯字幕翻译中支持） `zh`：简体中文 `en`：英语 `ja`：日语 `ko`：韩语 `zh-PY`：中英粤 `zh_medical`：中文医疗 `vi`：越南语 `ms`：马来语 `id`：印度尼西亚语 `fil`：菲律宾语 `th`：泰语 `pt`：葡萄牙语 `tr`：土耳其语 `ar`：阿拉伯语 `es`：西班牙语 `hi`\ufffd\ufffd...", "example": "zh" }, { "name": "SubtitleFormat", "type": "string", "required": false, "description": "智能字幕文件格式: - ASR识别翻译处理类型下： - vtt: WebVTT 格式字幕 - srt: SRT 格式字幕 - 不填或填空：不生成字幕文件 - 纯字幕翻译处理类型下： - original：与源文件一致 - vtt: WebVTT 格式字幕 - srt: SRT 格式字幕 - OCR识别翻译处理类型下： - vtt: WebVTT 格式字幕 - srt: SRT 格式字幕 **注意**： - ASR识别方式下，翻译大于等于2种语言时不允许传空或不传； - 纯字幕翻译和OCR识别翻译方式\ufffd\ufffd...", "example": "vtt" }, { "name": "SubtitleType", "type": "integer", "required": false, "description": "智能字幕字幕语言类型 0: 源语言 1: 翻译语言 2: 源语言+翻译语言 当TranslateSwitch为OFF时仅支持取0 当TranslateSwitch为ON时仅支持取1或2", "example": "0" }, { "name": "AsrHotWordsConfigure", "type": "object", "required": false, "description": "ASR热词库参数", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "热词开关 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" }, { "name": "LibraryId", "type": "string", "required": false, "description": "热词库ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "hwd-2670a776bb5eccccc324" } ] }, { "name": "TranslateDstLanguage", "type": "string", "required": false, "description": "字幕翻译目标语言 当TranslateSwitch为ON的时候生效，翻译语言列表： `ab`：阿布哈兹语 `ace`：亚齐语 `ach`：阿乔利语 `af`：南非荷兰语 `ak`：契维语（阿坎语） `am`：Amharic `ar`：阿拉伯语 `as`：阿萨姆语 `ay`：艾马拉语 `az`：阿塞拜疆语 `ba`：巴什基尔语 `ban`：巴厘语 `bbc`：巴塔克托巴语 `bem`：Bemba `bew`：Betawi `bg`：保加利亚语 `bho`：博杰普尔语 `bik`：Bikol `bm`：班巴拉语 `bn`：孟加拉语...", "example": "en" }, { "name": "ProcessType", "type": "integer", "required": false, "description": "字幕处理类型： - 0：ASR识别字幕 - 1：纯字幕翻译 - 2：OCR识别字幕 **注意**：不传的情况下，默认是ASR方式", "example": "0" }, { "name": "SelectingSubtitleAreasConfig", "type": "object", "required": false, "description": "字幕OCR提取框选区域配置", "example": "无", "children": [ { "name": "AutoAreas", "type": "array", "required": false, "description": "自动选择自定义区域。 对选定区域，利用AI模型自动检测其中存在的选择目标并提取。", "example": "无", "item_type": "object", "children": [ { "name": "LeftTopX", "type": "float", "required": true, "description": "区域左上角X坐标。 如当Unit取1即使用百分比单位时，0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。", "example": "0.0500" }, { "name": "LeftTopY", "type": "float", "required": true, "description": "区域左上角Y坐标。 如当Unit取1即使用百分比单位时，0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。", "example": "0.1000" }, { "name": "RightBottomX", "type": "float", "required": true, "description": "区域右下角X坐标。 如当Unit取1即使用百分比单位时，0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。", "example": "0.7500" }, { "name": "RightBottomY", "type": "float", "required": true, "description": "区域右下角Y坐标。 如当Unit取1即使用百分比单位时，0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。", "example": "0.9000" }, { "name": "Unit", "type": "integer", "required": true, "description": "坐标单位 - 1 百分比 - 2 像素值", "example": "1" } ] }, { "name": "SampleWidth", "type": "integer", "required": false, "description": "示例视频或图片的宽，单位像素值", "example": "200" }, { "name": "SampleHeight", "type": "integer", "required": false, "description": "示例视频或图片的高，单位像素值", "example": "1000" } ] } ], "required": [ "Definition" ] }, { "name": "ModifySnapshotByTimeOffsetTemplate", "description": "修改用户自定义指定时间点截图模板。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "指定时间点截图模板唯一标识。", "example": "10001" }, { "name": "Name", "type": "string", "required": false, "description": "指定时间点截图模板名称，长度限制：64 个字符。", "example": "指定时间点截图模板1" }, { "name": "Width", "type": "integer", "required": false, "description": "截图宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "540" }, { "name": "Height", "type": "integer", "required": false, "description": "截图高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 默认值：0。", "example": "960" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。 默认值：open。", "example": "open" }, { "name": "Format", "type": "string", "required": false, "description": "图片格式，取值可以为 jpg、png、webp。", "example": "jpg" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "指定时间点截图模板" }, { "name": "FillType", "type": "string", "required": false, "description": "填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“； black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。 white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。 gauss：高斯模糊，保持视频...", "example": "black " } ], "required": [ "Definition" ] }, { "name": "ModifyStreamLinkEvent", "description": "修改媒体传输的事件配置信息。", "status": "online", "parameters": [ { "name": "EventId", "type": "string", "required": true, "description": "媒体传输事件Event Id。", "example": "0193d38d4e5d09dc0f326fd4342d" }, { "name": "EventName", "type": "string", "required": true, "description": "需要修改的事件名称。", "example": "event_name" }, { "name": "Description", "type": "string", "required": false, "description": "Event的描述信息。", "example": "description" } ], "required": [ "EventId", "EventName" ] }, { "name": "ModifyStreamLinkFlow", "description": "修改媒体传输的传输流配置信息。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "流Id。", "example": "0194407416cf09dc0f321631343d" }, { "name": "FlowName", "type": "string", "required": true, "description": "需要修改的流名称。", "example": "flow_name" } ], "required": [ "FlowId", "FlowName" ] }, { "name": "ModifyStreamLinkInput", "description": "修改媒体传输流的输入信息。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "流Id。", "example": "01746cfeda560956b92d34d30445" }, { "name": "Input", "type": "object", "required": true, "description": "需要修改的Input信息。", "example": "无", "children": [ { "name": "InputId", "type": "string", "required": true, "description": "输入Id。", "example": "InputId" }, { "name": "InputName", "type": "string", "required": true, "description": "输入名称。", "example": "InputName" }, { "name": "Description", "type": "string", "required": true, "description": "输入描述。", "example": "Description" }, { "name": "AllowIpList", "type": "array", "required": true, "description": "允许的推流的IP，CIDR格式。", "example": "[\"0.0.0.0/0\"]", "item_type": "string" }, { "name": "SRTSettings", "type": "object", "required": true, "description": "SRT的配置信息。", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "SRT模式，可选[LISTENER|CALLER]，默认为LISTENER。", "example": "LISTENER" }, { "name": "StreamId", "type": "string", "required": false, "description": "流Id，可选大小写字母、数字和特殊字符（.#!:\u0026,=_-），长度为0~512。具体格式可以参考：https://github.com/Haivision/srt/blob/master/docs/features/access-control.md#standard-keys。", "example": "streamId" }, { "name": "Latency", "type": "integer", "required": false, "description": "延迟，默认120，单位ms，范围为[0, 3000]。", "example": "120" }, { "name": "RecvLatency", "type": "integer", "required": false, "description": "接收延迟，默认120，单位ms，范围为[0, 3000]。", "example": "0" }, { "name": "PeerLatency", "type": "integer", "required": false, "description": "对端延迟，默认120，单位ms，范围为[0, 3000]。", "example": "0" }, { "name": "PeerIdleTimeout", "type": "integer", "required": false, "description": "对端超时时间，默认5000，单位ms，范围为[1000, 10000]。", "example": "5000" }, { "name": "Passphrase", "type": "string", "required": false, "description": "解密密钥，默认为空，表示不加密。只可填ascii码值，长度为[10, 79]。", "example": "passphrase" }, { "name": "PbKeyLen", "type": "integer", "required": false, "description": "密钥长度，默认为0，可选[0|16|24|32]。", "example": "0" }, { "name": "SourceAddresses", "type": "array", "required": false, "description": "SRT对端地址，当Mode为CALLER时必填，且只能填1组。", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "对端IP或域名。", "example": "1.1.1.1" }, { "name": "Port", "type": "integer", "required": true, "description": "对端端口。", "example": "65535" } ] }, { "name": "FEC", "type": "object", "required": false, "description": "SRT FEC 设置", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": false, "description": "是否开启 FEC", "example": "false" } ] } ] }, { "name": "RTPSettings", "type": "object", "required": true, "description": "RTP的配置信息。", "example": "无", "children": [ { "name": "FEC", "type": "string", "required": false, "description": "默认为“none”，可选值['none']。", "example": "none" }, { "name": "IdleTimeout", "type": "integer", "required": false, "description": "空闲超时时间，默认5000，单位ms，范围为[1000, 10000]。", "example": "1000" } ] }, { "name": "Protocol", "type": "string", "required": false, "description": "输入的协议，可选[SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST]。 -", "example": "SRT" }, { "name": "FailOver", "type": "string", "required": false, "description": "输入的主备开关，可选[OPEN|CLOSE]。", "example": "CLOSE" }, { "name": "RTMPPullSettings", "type": "object", "required": false, "description": "RTMP_PULL的配置信息。", "example": "无", "children": [ { "name": "SourceAddresses", "type": "array", "required": true, "description": "RTMP源站的源站地址，有且只能有一个。", "example": "无", "item_type": "object", "children": [ { "name": "TcUrl", "type": "string", "required": true, "description": "RTMP源站的TcUrl地址。", "example": "rtmp://domain/live" }, { "name": "StreamKey", "type": "string", "required": true, "description": "RTMP源站的StreamKey信息。", "example": "streamKey" } ] } ] }, { "name": "RTSPPullSettings", "type": "object", "required": false, "description": "RTSP_PULL的配置信息。", "example": "无", "children": [ { "name": "SourceAddresses", "type": "array", "required": true, "description": "RTSP源站的源站地址，有且只能有一个。", "example": "无", "item_type": "object", "children": [ { "name": "Url", "type": "string", "required": true, "description": "RTSP源站的Url地址。", "example": "rtsp://9.223.70.41:8806/live/streamname" } ] } ] }, { "name": "HLSPullSettings", "type": "object", "required": false, "description": "HLS_PULL的配置信息。", "example": "无", "children": [ { "name": "SourceAddresses", "type": "array", "required": true, "description": "HLS源站的源站地址，有且只能有一个。", "example": "无", "item_type": "object", "children": [ { "name": "Url", "type": "string", "required": true, "description": "HLS源站的Url地址。", "example": "http://testdomain.com:8806/live/streamname" } ] } ] }, { "name": "ResilientStream", "type": "object", "required": false, "description": "延播平滑吐流配置信息。", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": false, "description": "是否开启延播平滑吐流，true开启，false不开启，默认不开启。 注意：此字段可能返回 null，表示取不到有效值。", "example": "true" }, { "name": "BufferTime", "type": "integer", "required": false, "description": "延播时间，单位秒，目前支持的范围为10~300秒。 注意：此字段可能返回 null，表示取不到有效值。", "example": "133" } ] }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "绑定的输入安全组 ID。 仅支持关联一组安全组。", "example": "[\"019631fd7ab41ea506497cedffg\"]", "item_type": "string" }, { "name": "Zones", "type": "array", "required": false, "description": "可用区，非必填，最多支持输入两个可用区，对于需改接口，只要第二个可用区会参与到资源分配。如果input开启容灾或者涉及RTSP_PULL协议切换时有效(会重新分配地址)。", "example": "[\"ap-shanghai-1\"]", "item_type": "string" }, { "name": "RISTSettings", "type": "object", "required": false, "description": "RIST的配置信息。", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "RIST模式，可选[LISTENER]，默认为LISTENER。", "example": "LISTENER" }, { "name": "Profile", "type": "string", "required": false, "description": "RIST配置方案，可选[MAIN|SIMPLE]，默认为MAIN。", "example": "MAIN" }, { "name": "Buffer", "type": "integer", "required": false, "description": "RIST缓冲区大小，单位为毫秒。最小值为50毫秒，最大值为5000毫秒。默认值：120", "example": "120" } ] }, { "name": "InputRegion", "type": "string", "required": false, "description": "输入节点的地区", "example": "ap-shanghai" }, { "name": "FailOverOption", "type": "object", "required": false, "description": "冷热备相关", "example": "无", "children": [ { "name": "FailOverType", "type": "string", "required": false, "description": "热备", "example": "HOTSTANDBY" } ] } ] } ], "required": [ "FlowId", "Input" ] }, { "name": "ModifyStreamLinkOutputInfo", "description": "修改媒体传输流的输出配置。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "流Id。", "example": "01937702ecc509dc0f3269ca3420" }, { "name": "Output", "type": "object", "required": true, "description": "需要修改的Output配置。", "example": "无", "children": [ { "name": "OutputId", "type": "string", "required": true, "description": "需要修改的Output的Id。", "example": "019202e96d9f09dc0f325e7f7a2a" }, { "name": "OutputName", "type": "string", "required": true, "description": "输出的名称。", "example": "OutputName" }, { "name": "Description", "type": "string", "required": true, "description": "输出的描述。", "example": "Description" }, { "name": "Protocol", "type": "string", "required": true, "description": "输出的转推协议，支持SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST。", "example": "SRT" }, { "name": "OutputKind", "type": "string", "required": false, "description": "输出模块类型，包括Pinpoint（单点输出，最多支持四路并发输出）；MultiMesh（多路输出，支持大于四路的并发输出，目前可以达到200路）。默认类型为 Pinpoint 输出。对于单个 Flow 一个区域最多只能有一个 MultiMesh 输出。", "example": "Pinpoint" }, { "name": "SRTSettings", "type": "object", "required": false, "description": "转推SRT的配置。", "example": "无", "children": [ { "name": "Destinations", "type": "array", "required": true, "description": "转推的目标地址，当Mode为CALLER时必填，且只能填1组。", "example": "无", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "输出的IP或域名。", "example": "0.0.0.0" }, { "name": "Port", "type": "integer", "required": true, "description": "输出的端口。", "example": "10" } ] }, { "name": "StreamId", "type": "string", "required": false, "description": "转推SRT的流Id，可选大小写字母、数字和特殊字符（.#!:\u0026,=_-），长度为0~512。", "example": "StreamId" }, { "name": "Latency", "type": "integer", "required": false, "description": "转推SRT的延迟，默认120，单位ms，范围为[0, 3000]。此参数同时设置了发送方和接收方的延迟（recvlatency和peerlatency）为相同的值。建议配置为至少3倍RTT，以确保在网络拥塞时能够有效处理数据包的重传和确认", "example": "120" }, { "name": "RecvLatency", "type": "integer", "required": false, "description": "转推SRT的接收延迟，默认120，单位ms，范围为[0, 3000]。 此参数表示接收方用于缓存数据包的时间长度", "example": "0" }, { "name": "PeerLatency", "type": "integer", "required": false, "description": "转推SRT的对端延迟，默认120，单位ms，范围为[0, 3000]。 此参数由发送方设置，用于告知接收方其期望的延迟缓冲时间", "example": "0" }, { "name": "PeerIdleTimeout", "type": "integer", "required": false, "description": "转推SRT的对端空闲超时时间，默认5000，单位ms，范围为[1000, 10000]。 如果连接在设定的超时时间内没有活动，将会被关闭", "example": "5000" }, { "name": "Passphrase", "type": "string", "required": false, "description": "转推SRT的加密密钥，默认为空，表示不加密。只可填ascii码值，长度为[10, 79]。", "example": "passphrase" }, { "name": "PbKeyLen", "type": "integer", "required": false, "description": "转推SRT的密钥长度，默认为0，可选[0|16|24|32]。", "example": "0" }, { "name": "Mode", "type": "string", "required": false, "description": "SRT模式，可选[LISTENER|CALLER]，默认为CALLER。", "example": "CALLER" }, { "name": "FEC", "type": "object", "required": false, "description": "SRT FEC 设置", "example": "无", "children": [ { "name": "Enable", "type": "boolean", "required": false, "description": "是否开启 FEC", "example": "true" }, { "name": "Cols", "type": "integer", "required": false, "description": "FEC 数据包 Layout 列数量. 取值范围\u003e0", "example": "3" }, { "name": "Rows", "type": "integer", "required": false, "description": "FEC 数据包 Layout 行数量. 取值范围 \u003e=2 或者 \u003c=-2", "example": "1" }, { "name": "ARQ", "type": "string", "required": false, "description": "FEC 开启的情况下，ARQ的策略。取值 \"always\", \"onreq\", \"never\"", "example": "always" }, { "name": "Layout", "type": "string", "required": false, "description": "FEC 数据包 Layout 组织形式，取值 \"even\", \"staircase\"", "example": "staircase" } ] } ] }, { "name": "RTPSettings", "type": "object", "required": false, "description": "转推RTP的配置。", "example": "无", "children": [ { "name": "Destinations", "type": "array", "required": true, "description": "转推的目标地址，可填1~2个。", "example": "0", "item_type": "object", "children": [ { "name": "Ip", "type": "string", "required": true, "description": "转推的目标IP。", "example": "ip" }, { "name": "Port", "type": "integer", "required": true, "description": "转推的目标端口。", "example": "port" } ] }, { "name": "FEC", "type": "string", "required": true, "description": "只能填none。", "example": "none" }, { "name": "IdleTimeout", "type": "integer", "required": true, "description": "空闲超时时间，单位ms。", "example": "1000" } ] }, { "name": "RTMPSettings", "type": "object", "required": false, "description": "转推RTMP的配置。", "example": "无", "children": [ { "name": "Destinations", "type": "array", "required": true, "description": "转推的目标地址，可填1~2个。", "example": "your address", "item_type": "object", "children": [ { "name": "Url", "type": "string", "required": true, "description": "转推的URL，格式如：rtmp://domain/live。", "example": "rtmp://example.com/live" }, { "name": "StreamKey", "type": "string", "required": true, "description": "转推的StreamKey，格式如：stream?key=value。", "example": "stream_key" } ] }, { "name": "ChunkSize", "type": "integer", "required": false, "description": "RTMP的Chunk大小，范围为[4096, 40960]。", "example": "4096" } ] }, { "name": "AllowIpList", "type": "array", "required": false, "description": "IP白名单列表，格式为CIDR，如0.0.0.0/0。 当Protocol为RTMP_PULL有效，为空代表不限制客户端IP。", "example": "[\"0.0.0.0/0\"]", "item_type": "string" }, { "name": "MaxConcurrent", "type": "integer", "required": false, "description": "最大拉流并发数，最大4，默认4。", "example": "1" }, { "name": "SecurityGroupIds", "type": "array", "required": false, "description": "绑定的安全组 ID。 仅支持关联一组安全组。", "example": "[\"035hk1fd7ab41ea5064bb9\"]", "item_type": "string" }, { "name": "Zones", "type": "array", "required": false, "description": "可用区", "example": "[\"ap-shanghai-1\"]", "item_type": "string" }, { "name": "RISTSettings", "type": "object", "required": false, "description": "转推RIST的配置。", "example": "无", "children": [ { "name": "Mode", "type": "string", "required": false, "description": "RIST模式，可选[LISTENER|CALLER]，默认为LISTENER。", "example": "LISTENER" }, { "name": "Profile", "type": "string", "required": false, "description": "RIST配置方案，可选[MAIN|SIMPLE]，默认为MAIN。", "example": "MAIN" }, { "name": "Buffer", "type": "integer", "required": false, "description": "RIST缓冲区大小，单位为毫秒。最小值为50毫秒，最大值为5000毫秒。默认值：120", "example": "120" } ] }, { "name": "OutputType", "type": "string", "required": false, "description": "输出类型：Internet/TencentCSS/StreamLive", "example": "TencentCSS" }, { "name": "StreamSelector", "type": "object", "required": false, "description": "对于含有多个音/视频轨的流，可以指定需要使用的轨道", "example": "无", "children": [ { "name": "SelectorType", "type": "string", "required": false, "description": "选择类型: PID | TRACK", "example": "PID" }, { "name": "PidSelector", "type": "object", "required": false, "description": "根据 PID 配置选择器", "example": "无", "children": [ { "name": "AudioPID", "type": "array", "required": false, "description": "对于含有多音轨的流, 可以通过输入PID来指定需要使用的音轨，PID可以输入1到8191之间的正整数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[123,124]", "item_type": "integer" }, { "name": "VideoPID", "type": "array", "required": false, "description": "对于含有多个视频轨的流，可以通过输入PID来指定需要使用的视频轨，PID可以输入1到8191之间的正整数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[123,124]", "item_type": "integer" } ] }, { "name": "TrackSelector", "type": "object", "required": false, "description": "根据 Track 配置选择器", "example": "无", "children": [ { "name": "VideoIndex", "type": "array", "required": false, "description": "视频轨道序号，从1开始.", "example": "[1,2]", "item_type": "integer" }, { "name": "AudioIndex", "type": "array", "required": false, "description": "音频轨道序号，从1开始.", "example": "[1,2]", "item_type": "integer" } ] } ] } ] } ], "required": [ "FlowId", "Output" ] }, { "name": "ModifyStreamLinkSecurityGroup", "description": "更新安全组。", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "安全组Id。", "example": " 01937702c54509dc0f3269ca341f" }, { "name": "Name", "type": "string", "required": false, "description": "安全组名称，限制大小写、数字和下划线，长度[1, 32]，Region下唯一。", "example": "live_test" }, { "name": "Whitelist", "type": "array", "required": false, "description": "白名单列表，最多10个。", "example": "0.0.0.0/0", "item_type": "string" } ], "required": [ "Id" ] }, { "name": "ModifyTranscodeTemplate", "description": "修改用户自定义转码模板信息。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "转码模板唯一标识。", "example": "1008" }, { "name": "Container", "type": "string", "required": false, "description": "封装格式，可选值：mp4、flv、hls、mp3、flac、ogg、m4a。其中，mp3、flac、ogg、m4a 为纯音频文件。", "example": "mp4" }, { "name": "Name", "type": "string", "required": false, "description": "转码模板名称，长度限制：64 个字符。", "example": "转码模板12" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "转码模板12" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，可选值： 0：保留 1：去除", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，可选值： 0：保留 1：去除", "example": "0" }, { "name": "VideoTemplate", "type": "object", "required": false, "description": "视频流配置参数。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": false, "description": "视频流的编码格式，可选值： h264：H.264 编码 h265：H.265 编码 h266：H.266 编码 av1：AOMedia Video 1 编码 vp8：VP8 编码 vp9：VP9 编码 mpeg2：MPEG2 编码 dnxhd：DNxHD 编码 mv-hevc：MV-HEVC 编码 注意：av1 编码容器目前只支持 mp4 ，webm，mkv。 注意：H.266 编码容器目前只支持 mp4 ，hls，ts，mov。 注意：VP8、VP9编码容器目前只支持webm，mkv。 注意：MPEG2、dnxhd 编码容器目前只支持mxf。 注意：MV-HEVC编码\ufffd\ufffd...", "example": "h264" }, { "name": "Fps", "type": "integer", "required": false, "description": "视频帧率，取值范围： 当FpsDenominator的值为空时，范围：[0, 120]，单位：Hz； 当FpsDenominator的值不为空时，Fps/FpsDenominator的范围：[0,120] 当取值为 0，表示帧率和原始视频保持一致。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "视频流的码率，取值范围：0 和 [128, 100000]，单位：kbps。 当取值为 0，表示视频码率和原始视频保持一致。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "ResolutionAdaptive", "type": "string", "required": false, "description": "分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。 注意：自适应模式时，Width不能小于Height。 注意：此字段可能返回 null，表示取不到有效值。", "example": "open" }, { "name": "Width", "type": "integer", "required": false, "description": "视频流宽度（或长边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 当 Width、Height 均为 0，则分辨率同源； 当 Width 为 0，Height 非 0，则 Width 按比例缩放； 当 Width 非 0，Height 为 0，则 Height 按比例缩放； 当 Width、Height 均非 0，则分辨率按用户指定。 注意：Codec为MV-HEVC时可以支持到7680 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Height", "type": "integer", "required": false, "description": "视频流高度（或短边）的最大值，取值范围：0 和 [128, 4096]，单位：px。 注意：Codec为MV-HEVC时可以支持到7680 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Gop", "type": "integer", "required": false, "description": "关键帧 I 帧之间的间隔，允许按帧或秒自定义GOP长度，取值范围：0 和 [1, 100000]。 当填 0 时，系统将自动设置 gop 长度。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "GopUnit", "type": "string", "required": false, "description": "Gop数值单位，可选值： frame：表示帧 second：表示秒 默认值：frame 注意：此字段可能返回 null，表示取不到有效值。", "example": "frame" }, { "name": "FillType", "type": "string", "required": false, "description": "填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“； black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。 white：留白，保持视频宽高比不变，边缘剩余部分使用白色填充。 gauss：高斯模糊，保持视频...", "example": "black" }, { "name": "Vcrf", "type": "integer", "required": false, "description": "视频的恒定码率控制因子，取值范围为[0, 51]，不填表示“自动”。如果没有特殊需求，建议不指定该参数。 当Mode参数设置为VBR时，如果同时配置了Vcrf值，MPS将在VBR模式下处理视频，同时考虑Vcrf和Bitrate参数的设置，以平衡视频质量、码率、转码效率和文件大小。 当Mode参数设置为CRF，Bitrate设置将失效，编码将根据Vcrf值进行。 当Mode参数选择ABR或CBR时，无需配置Vcrf值。 注意：...", "example": "0" }, { "name": "ContentAdaptStream", "type": "integer", "required": false, "description": "内容自适应编码。可选值： 0：不开启 1：开启 默认值: 0. 当开启该参数时，将会自适应生成多个不同分辨率，不同码率的码流， 其中VideoTemplate的宽和高为多个码流中的最大分辨率，VideoTemplate中的码率为多个码流中的最高码率， VideoTemplate中的vcrf为多个码流中的最高质量。 当不设置分辨率、码率和vcrf时， ContentAdaptStream 参数生成的最高分辨率为视频源的分辨率，视频质量为接...", "example": "0" }, { "name": "HlsTime", "type": "integer", "required": false, "description": "分片平均时长，取值范围：（0-10]，单位：秒 默认值：10 注意：只在封装格式HLS时使用 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "SegmentType", "type": "integer", "required": false, "description": "hls 分片类型，可选值： 0：HLS+TS 切片 2：HLS+TS byte range 7：HLS+MP4 切片 5：HLS+MP4 byte range 默认值：0 注意：该字段用于普通/极速高清转码设置，对自适应码流不生效，如需给自适应码流配置分片类型，可以使用外层字段 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "FpsDenominator", "type": "integer", "required": false, "description": "帧率分母部分 注意：值必须大于0 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Stereo3dType", "type": "string", "required": false, "description": "3D视频拼接方式，仅mv-hevc，3D视频生效，可选值： side_by_side：原视频内容左右排列布局 top_bottom：原视频内容上下排列布局 计费将按照切分后的分辨率尺寸上报用量及计费； 默认值:side_by_side 注意：此字段可能返回 null，表示取不到有效值。", "example": "side_by_side" }, { "name": "VideoProfile", "type": "string", "required": false, "description": "Profile，适用于不同场景。 baseline: 只支持I/P帧，并只支持无交错的场景，适用于视频通话、手机视频等场景。 main: 主流Profile，提供I帧、P帧、B帧，并支持无交错模式和交错模式。主要用在主流的音视频消费产品如视频播放器、流媒体传输设备上。 high: 最高编码等级，在Main Profile上添加了8X8的预测，并支持自定义量化。广泛应用在蓝光存储、高清电视等场景。 default：随原视频...", "example": "default" }, { "name": "VideoLevel", "type": "string", "required": false, "description": "编码器级别，默认为自动（\"\"） 若编码标准选择H264: 支持以下选项：\"\"，1 , 1.1 , 1.2 , 1.3 , 2 , 2.1 , 2.2 , 3 , 3.1 , 3.2 , 4 , 4.1 , 4.2 , 5 , 5.1 若编码标准选择H265: 支持以下选项：\"\"，1 , 2 , 2.1 , 3 , 3.1 , 4 , 4.1 , 5 , 5.1 , 5.2 , 6 , 6.1 , 6.2 , 8.5 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "Bframes", "type": "integer", "required": false, "description": "最大连续B帧数，默认选自动，支持 0 - 16和-1 注意： -1表示修改为自动值 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Mode", "type": "string", "required": false, "description": "码率控制模式：可选值： VBR（Variable Bit Rate）：动态比特率，根据视频画面的复杂度动态调整输出的码率，使得画面质量更高，适用于存储场景和对画面质量要求较高的应用。 ABR（Average Bit Rate）：平均比特率，尽量保持输出视频的平均码率稳定，但允许短期内的码率波动，适用于需要在保持一定画质的情况下尽量减少整体码率的场景。 CBR（Constant Bit Rate）：恒定比特率，指视...", "example": "VBR" }, { "name": "Sar", "type": "string", "required": false, "description": "显示高宽比，可选值：[1:1，2:1，default] 默认值：default 注意：此字段可能返回 null，表示取不到有效值。", "example": "default" }, { "name": "NoScenecut", "type": "integer", "required": false, "description": "自适应I帧决策，开启后，媒体处理将自动识别视频中不同场景之间的过渡点（通常是视觉上显著不同的帧，比如从一个镜头切换到另一个镜头），在这些点自适应插入关键帧（I帧），从而提高视频的随机访问性和编码效率。可选值： 0：关闭自适应I帧决策 1：使用自适应I帧决策 默认值：0 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "BitDepth", "type": "integer", "required": false, "description": "比特位：支持8/10，默认为8 注意：此字段可能返回 null，表示取不到有效值。", "example": "8" }, { "name": "RawPts", "type": "integer", "required": false, "description": "保持原始时间戳：可选值： 0：表示关闭 1：表示打开 默认是关闭 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Compress", "type": "integer", "required": false, "description": "按比例压缩码率，开启后，将根据比例来调整输出视频的码率。填写压缩率后，系统会根据视频源码率自动计算目标输出码率。压缩率范围0-100，可选值：[0-100]和-1 注意：-1表示修改为自动 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SegmentSpecificInfo", "type": "object", "required": false, "description": "启动时分片时长 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "启动分片时长开关，可选值： on：打开 off：关闭 默认off 注意：此字段可能返回 null，表示取不到有效值。", "example": "off" }, { "name": "FragmentTime", "type": "integer", "required": false, "description": "启动时分片时长，单位：秒 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" }, { "name": "FragmentEndNum", "type": "integer", "required": false, "description": "生效分片数，表示前FragmentEndNum个分片以FragmentTime时长切片，取值\u003e=1 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] }, { "name": "ScenarioBased", "type": "integer", "required": false, "description": "模板是否开启场景化 0：不开启 1：开启 默认值：0 注意：只有此字段值为1时，SceneType和CompressType字段的值才会生效 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SceneType", "type": "string", "required": false, "description": "视频场景化，可选值： normal：通用转码场景：通用转码压缩场景 pgc：PGC高清影视：压缩时会注重影视剧的观看体验，根据影视剧特性进行ROI编码，同时保留高质量的视频内容和音频。 materials_video：高清素材：素材资源类场景，对画质要求极高，较多透明画面内容，在压缩的同时接近视觉无损。 ugc：UGC内容：适用于广泛的UGC/短视频场景，针对短视频的特性优化编码码率， 画\ufffd\ufffd...", "example": "normal" }, { "name": "CompressType", "type": "string", "required": false, "description": "转码策略，可选值： ultra_compress：极致压缩：相比标准压缩，该策略能在保证一定画质的基础上最大限度压缩码率，极大节约带宽和存储成本。 standard_compress：综合最优：平衡压缩率与画质，在保证主观画质没有明显降低的情况下尽可能压缩文件。该策略仅收取音视频极速高清转码费用。 high_compress：码率优先：优先保证降低文件体积大小，可能有一定画质损失。该策略仅收取...", "example": "standard_compress" } ] }, { "name": "AudioTemplate", "type": "object", "required": false, "description": "音频流配置参数。", "example": "无", "children": [ { "name": "Codec", "type": "string", "required": false, "description": "音频流的编码格式。 当不需要对音频进行转码时，可选值为： copy。 当外层参数 Container 为 mp3 时，可选值为： mp3。 当外层参数 Container 为 ogg 或 flac 时，可选值为： flac。 当外层参数 Container 为 m4a 时，可选值为： aac； ac3。 当外层参数 Container 为 mp4 或 flv 时，可选值为： aac：更适合 mp4； mp3：更适合 flv； mp2。 当外层参数 Container 为 hls 时，可选值为： aac； mp3。 注意：此字\ufffd...", "example": "aac" }, { "name": "Bitrate", "type": "integer", "required": false, "description": "音频流的码率，取值范围：0 和 [26, 256]，单位：kbps。 当取值为 0，表示音频码率和原始音频保持一致。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "音频流的采样率，不同编码标准支持的采样率选项不同。填0代表使用源音频的采样率数值。 详细参考[音频采样率支持范围文档](https://cloud.tencent.com/document/product/862/77166#f3b039f1-d817-4a96-b4e4-90132d31cd53) 单位：Hz 注意：请确保源音频流的采样率在上述选项范围内，否则可能导致转码失败！ 注意：此字段可能返回 null，表示取不到有效值。", "example": "44100" }, { "name": "AudioChannel", "type": "integer", "required": false, "description": "音频通道方式，可选值： 1：单通道 2：双通道 6：5.1声道 当媒体的封装格式是音频格式时（flac，ogg，mp3，m4a）时，声道数不允许设为5.1声道。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2" }, { "name": "StreamSelects", "type": "array", "required": false, "description": "指定输出要保留的音频轨道。默认是全部保留源的。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[0]", "item_type": "integer" } ] }, { "name": "TEHDConfig", "type": "object", "required": false, "description": "极速高清转码参数。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": false, "description": "极速高清类型，可选值： TEHD-100：极速高清-100（视频极速高清）。 TEHD-200：极速高清-200（音频极速高清）。 不填代表不修改。 注意：此字段可能返回 null，表示取不到有效值。", "example": "TEHD-100" }, { "name": "MaxVideoBitrate", "type": "integer", "required": false, "description": "视频码率上限，不填代表不修改。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "EnhanceConfig", "type": "object", "required": false, "description": "音视频增强参数。", "example": "无", "children": [ { "name": "VideoEnhance", "type": "object", "required": false, "description": "视频增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "FrameRate", "type": "object", "required": false, "description": "插帧帧率配置（旧）。新用户建议使用FrameRateWithDen配置插帧帧率，支持分数，且效果更好。注意，FrameRate 与FrameRateWithDen 只能二选一，同时配置可能导致任务失败。源帧率大于等于目标帧率时能力不会生效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Fps", "type": "integer", "required": false, "description": "帧率，取值范围：[0, 100]，单位：Hz。 默认值 0。 注意：对于转码，该参数会覆盖 VideoTemplate 内部的 Fps。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "SuperResolution", "type": "object", "required": false, "description": "超分配置。源分辨率高于目标分辨率时不对视频做处理。注意与大模型增强不可同时开启。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： lq：针对低清晰度有较多噪声视频的超分； hq：针对高清晰度视频超分。 默认值：lq。 注意：此字段可能返回 null，表示取不到有效值。", "example": "lq" }, { "name": "Size", "type": "integer", "required": false, "description": "超分倍数，可选值： 2：目前只支持 2 倍超分。 默认值：2。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2" } ] }, { "name": "Hdr", "type": "object", "required": false, "description": "HDR配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： HDR10 HLG 默认值：HDR10。 注意：video的编码方式需要为h264或h265； 注意：视频编码位深为10。 注意：此字段可能返回 null，表示取不到有效值。", "example": "HDR10" } ] }, { "name": "Denoise", "type": "object", "required": false, "description": "视频降噪配置。注意与大模型增强不可同时开启。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "ImageQualityEnhance", "type": "object", "required": false, "description": "综合增强配置。注意大模型、综合增强、去毛刺三项里最多配置一项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak normal strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "ColorEnhance", "type": "object", "required": false, "description": "色彩增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak normal strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "LowLightEnhance", "type": "object", "required": false, "description": "低光照增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： normal 默认值：normal。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" } ] }, { "name": "ScratchRepair", "type": "object", "required": false, "description": "去划痕配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Intensity", "type": "float", "required": false, "description": "强度，取值范围：0.0~1.0。 默认：0.0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0.5" } ] }, { "name": "ArtifactRepair", "type": "object", "required": false, "description": "去伪影（毛刺）配置。注意大模型、综合增强、去毛刺三项里最多配置一项 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "EnhanceSceneType", "type": "string", "required": false, "description": "增强场景配置，可选值： common（通用），通用增强参数，适用于各种视频类型的基础优化参数，提升整体画质。 AIGC，整体分辨率提升，利用AI技术提升视频整体分辨率，增强画面清晰度。 short_play（短剧），增强面部与字幕细节，突出人物面部表情细节和字幕清晰度，提升观剧体验。 short_video（短视频），优化复杂多样的画质问题，针对短视频的复杂场景，优化画质，解决多\ufffd...", "example": "common" }, { "name": "DiffusionEnhance", "type": "object", "required": false, "description": "大模型增强配置。注意大模型、综合增强、去毛刺三项里最多配置一项。且不可与超分、降噪同时开启。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认，OFF。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "强度类型，可选值： weak normal strong 默认值：normal。 注意：此字段可能返回 null，表示取不到有效值。", "example": "strong" } ] }, { "name": "FrameRateWithDen", "type": "object", "required": false, "description": "新插帧帧率配置，支持分数。注意与FrameRate二选一。源帧率大于等于目标帧率时能力不会生效。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "FpsNum", "type": "integer", "required": false, "description": "帧率分子，取值范围：非负数，除以分母后小于120，单位：Hz。 默认值 0。 注意：对于转码，该参数会覆盖 VideoTemplate 内部的 Fps。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "FpsDen", "type": "integer", "required": false, "description": "帧率分母，取值范围：大于等于1。 默认值 1。 注意：对于转码，该参数会覆盖 VideoTemplate 内部的 FpsDenominator。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1" } ] } ] }, { "name": "AudioEnhance", "type": "object", "required": false, "description": "音频增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Denoise", "type": "object", "required": false, "description": "音频降噪配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" } ] }, { "name": "Separate", "type": "object", "required": false, "description": "音频分离配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "场景类型，可选值： normal：人声背景声场景 music：演唱伴奏场景 默认值：normal。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" }, { "name": "Track", "type": "string", "required": false, "description": "输出音轨，可选值： vocal：输出人声 background：应用场景为normal时输出背景声，应用场景为music时输出伴奏 默认值：vocal。 注意：此字段可能返回 null，表示取不到有效值。", "example": "vocal" } ] }, { "name": "VolumeBalance", "type": "object", "required": false, "description": "音量均衡配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： loudNorm：响度标准化 gainControl：减小突变 默认值：loudNorm。 注意：此字段可能返回 null，表示取不到有效值。", "example": "loudNorm" } ] }, { "name": "Beautify", "type": "object", "required": false, "description": "音频美化配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Types", "type": "array", "required": false, "description": "类型，可多选，可选值： declick：杂音去除 deesser：齿音压制 默认值：declick。 注意：此字段可能返回 null，表示取不到有效值。", "example": "declick", "item_type": "string" } ] } ] } ] } ], "required": [ "Definition" ] }, { "name": "ModifyWatermarkTemplate", "description": "修改用户自定义水印模板，水印类型不允许修改。", "status": "online", "parameters": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板唯一标识。", "example": "1001" }, { "name": "Name", "type": "string", "required": false, "description": "水印模板名称，长度限制：64 个字符。", "example": "模板2" }, { "name": "Comment", "type": "string", "required": false, "description": "模板描述信息，长度限制：256 个字符。", "example": "水印模板" }, { "name": "CoordinateOrigin", "type": "string", "required": false, "description": "原点位置，可选值： TopLeft：表示坐标原点位于视频图像左上角，水印原点为图片或文字的左上角； TopRight：表示坐标原点位于视频图像的右上角，水印原点为图片或文字的右上角； BottomLeft：表示坐标原点位于视频图像的左下角，水印原点为图片或文字的左下角； BottomRight：表示坐标原点位于视频图像的右下角，水印原点为图片或文字的右下角。", "example": "TopLeft" }, { "name": "XPos", "type": "string", "required": false, "description": "水印原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式： 当字符串以 % 结尾，表示水印 XPos 为视频宽度指定百分比，如 10% 表示 XPos 为视频宽度的 10%； 当字符串以 px 结尾，表示水印 XPos 为指定像素，如 100px 表示 XPos 为 100 像素。", "example": "100px" }, { "name": "YPos", "type": "string", "required": false, "description": "水印原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式： 当字符串以 % 结尾，表示水印 YPos 为视频高度指定百分比，如 10% 表示 YPos 为视频高度的 10%； 当字符串以 px 结尾，表示水印 YPos 为指定像素，如 100px 表示 YPos 为 100 像素。", "example": "100px" }, { "name": "ImageTemplate", "type": "object", "required": false, "description": "图片水印模板，该字段仅对图片水印模板有效。", "example": "无", "children": [ { "name": "ImageContent", "type": "string", "required": false, "description": "水印图片 [Base64](https://tools.ietf.org/html/rfc4648) 编码后的字符串。支持 jpeg、png 图片格式。", "example": "AKIAABC*******12345W" }, { "name": "Width", "type": "string", "required": false, "description": "水印的宽度。支持 %、px 两种格式： 当字符串以 % 结尾，表示水印 Width 为视频宽度的百分比大小，如 10% 表示 Width 为视频宽度的 10%； 当字符串以 px 结尾，表示水印 Width 单位为像素，如 100px 表示 Width 为 100 像素。取值范围为[8, 4096]。", "example": "10%" }, { "name": "Height", "type": "string", "required": false, "description": "水印的高度。支持 %、px 两种格式： 当字符串以 % 结尾，表示水印 Height 为视频高度的百分比大小，如 10% 表示 Height 为视频高度的 10%； 当字符串以 px 结尾，表示水印 Height 单位为像素，如 100px 表示 Height 为 100 像素。取值范围为0或[8, 4096]。", "example": "10%" }, { "name": "RepeatType", "type": "string", "required": false, "description": "水印重复类型。使用场景：水印为动态图像。取值范围： once：动态水印播放完后，不再出现； repeat_last_frame：水印播放完后，停留在最后一帧； repeat：水印循环播放，直到视频结束。", "example": "once" } ] }, { "name": "TextTemplate", "type": "object", "required": false, "description": "文字水印模板，该字段仅对文字水印模板有效。", "example": "无", "children": [ { "name": "FontType", "type": "string", "required": false, "description": "字体类型，目前可以支持两种： simkai.ttf：可以支持中文和英文； arial.ttf：仅支持英文。", "example": "simkai.ttf" }, { "name": "FontSize", "type": "string", "required": false, "description": "字体大小，格式：Npx，N 为数值。N的取值范围：[0,1] 和 [8, 4096]", "example": "10px" }, { "name": "FontColor", "type": "string", "required": false, "description": "字体颜色，格式：0xRRGGBB，默认值：0xFFFFFF（白色）。", "example": "0xFFFFFF" }, { "name": "FontAlpha", "type": "float", "required": false, "description": "文字透明度，取值范围：(0, 1] 0：完全透明 1：完全不透明", "example": "1" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。", "example": "mps水印测试" } ] }, { "name": "SvgTemplate", "type": "object", "required": false, "description": "SVG水印模板，当 Type 为 svg，该字段必填。当 Type 为 image 或 text，该字段无效。", "example": "无", "children": [ { "name": "Width", "type": "string", "required": false, "description": "水印的宽度，支持 px，%，W%，H%，S%，L% 六种格式： 当字符串以 px 结尾，表示水印 Width 单位为像素，如 100px 表示 Width 为 100 像素；当填 0px 且 Height 不为 0px 时，表示水印的宽度按原始 SVG 图像等比缩放；当 Width、Height 都填 0px 时，表示水印的宽度取原始 SVG 图像的宽度； 当字符串以 W% 结尾，表示水印 Width 为视频宽度的百分比大小，如 10W% 表示 Width 为视频宽度的 10%； 当字符\ufffd\ufffd...", "example": "10%" }, { "name": "Height", "type": "string", "required": false, "description": "水印的高度，支持 px，%，W%，H%，S%，L% 六种格式： 当字符串以 px 结尾，表示水印 Height 单位为像素，如 100px 表示 Height 为 100 像素；当填 0px 且 Width 不为 0px 时，表示水印的高度按原始 SVG 图像等比缩放；当 Width、Height 都填 0px 时，表示水印的高度取原始 SVG 图像的高度； 当字符串以 W% 结尾，表示水印 Height 为视频宽度的百分比大小，如 10W% 表示 Height 为视频宽度的 10%； 当字\ufffd\ufffd...", "example": "0px" } ] } ], "required": [ "Definition" ] }, { "name": "ModifyWordSample", "description": "该接口用于修改关键词的应用场景、标签，关键词本身不可修改，如需修改，可删除重建。", "status": "online", "parameters": [ { "name": "Keyword", "type": "string", "required": true, "description": "关键词，长度限制：128 个字符。", "example": "格斗" }, { "name": "Usages", "type": "array", "required": false, "description": "关键词应用场景，可选值： 1. Recognition.Ocr：通过光学字符识别技术，进行内容识别； 2. Recognition.Asr：通过音频识别技术，进行内容识别； 3. Review.Ocr：通过光学字符识别技术，进行不适宜的内容识别； 4. Review.Asr：通过音频识别技术，进行不适宜的音频识别； 可合并简写为： 5. Recognition：通过光学字符识别技术、音频识别技术，进行内容识别，等价于 1+2； 6. Review：通过光学\ufffd\ufffd...", "example": "[\"Review\\n\"]", "item_type": "string" }, { "name": "TagOperationInfo", "type": "object", "required": false, "description": "标签操作信息。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "操作类型，可选值：add（添加）、delete（删除）、reset（重置）。", "example": "add" }, { "name": "Tags", "type": "array", "required": true, "description": "标签，长度限制：128 个字符。", "example": "明星", "item_type": "string" } ] } ], "required": [ "Keyword" ] }, { "name": "ParseLiveStreamProcessNotification", "description": "从 CMQ 获取到消息后，从消息的 msgBody 字段中解析出 MPS 直播流处理事件通知的内容。 该接口不用于发起网络调用，而是用来帮助生成各个语言平台的 SDK，您可以参考 SDK 中的解析实现事件通知的解析。", "status": "online", "parameters": [ { "name": "Content", "type": "string", "required": true, "description": "从 CMQ 获取到的直播流事件通知内容。", "example": "NotificationContent" } ], "required": [ "Content" ] }, { "name": "ParseNotification", "description": "从 CMQ 获取到消息后，从消息的 msgBody 字段中解析出 MPS 事件通知的内容。 该接口不用于发起网络调用，而是用来帮助生成各个语言平台的 SDK，您可以参考 SDK 中的解析函数，实现事件通知的解析。", "status": "online", "parameters": [ { "name": "Content", "type": "string", "required": true, "description": "从 CMQ 获取到的事件通知内容。", "example": "NotificationContent" } ], "required": [ "Content" ] }, { "name": "ProcessImage", "description": "发起图片处理，功能包括： 1. 格式转换； 2. 图像增强； 3. 图像擦除;", "status": "online", "parameters": [ { "name": "InputInfo", "type": "object", "required": true, "description": "图片处理的文件输入信息。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输入来源对象的类型，支持： COS：COS源 URL：URL源 AWS-S3：AWS 源，目前只支持转码任务 VOD：点播专业版", "example": "NULL" }, { "name": "CosInputInfo", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 对象信息。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": true, "description": "媒体处理对象文件的输入路径，如`/movie/201907/WildAnimal.mov`。", "example": "/movie/201907/WildAnimal.mov" } ] }, { "name": "UrlInputInfo", "type": "object", "required": false, "description": "当 Type 为 URL 时有效，则该项为必填，表示媒体处理 URL 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频的 URL。", "example": "NULL" } ] }, { "name": "S3InputInfo", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-us-125678" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域，目前支持： us-east-1 eu-west-3 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1 " }, { "name": "S3Object", "type": "string", "required": true, "description": "S3 bucket 中的媒体资源路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/test.mp4" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bb5******eff" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bbc5******eff" } ] }, { "name": "VODInputInfo", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理对象文件所在的 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理对象文件所在的 Bucket 所属园区", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": false, "description": "媒体处理对象文件的输入路径", "example": "/movie/201907/WildAnimal.mov" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "图片处理输出文件的目标存储。不填则继承 InputInfo 中的存储位置。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputDir", "type": "string", "required": false, "description": "图片处理生成的文件输出的路径。如果不填表示与 InputInfo 中文件所在的目录一致。如果是目录，如`/image/201907/`，表示继承原文件名输出到该目录。", "example": "/image/" }, { "name": "OutputPath", "type": "string", "required": false, "description": "输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：{inputName}.{format}。", "example": "{inputName}.{format}" }, { "name": "Definition", "type": "integer", "required": false, "description": "图片处理模板唯一标识。 图片模板功能内测中，如需使用请提交工单申请。", "example": "20001" }, { "name": "ResourceId", "type": "string", "required": false, "description": "资源ID，需要保证对应资源是开启状态。默认为账号主资源ID。", "example": "vts-24000-0" }, { "name": "ImageTask", "type": "object", "required": false, "description": "图片处理参数。", "example": "无", "children": [ { "name": "EncodeConfig", "type": "object", "required": false, "description": "图片编码配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Format", "type": "string", "required": false, "description": "图片格式，取值范围：JPEG、PNG、BMP、WebP，缺省为原图格式。不支持动画。 注意：此字段可能返回 null，表示取不到有效值。", "example": "JPEG" }, { "name": "Quality", "type": "integer", "required": false, "description": "图片的相对质量，取值范围：1 - 100，数值以原图质量为标准，缺省为原图质量。 注意：此字段可能返回 null，表示取不到有效值。", "example": "50" } ] }, { "name": "EnhanceConfig", "type": "object", "required": false, "description": "图片增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SuperResolution", "type": "object", "required": false, "description": "超分配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： lq：针对低清晰度有较多噪声视频的超分； hq：针对高清晰度视频超分。 默认值：lq。 注意：此字段可能返回 null，表示取不到有效值。", "example": "lq" }, { "name": "Size", "type": "integer", "required": false, "description": "超分倍数，可选值： 2：目前只支持 2 倍超分。 默认值：2。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2" } ] }, { "name": "AdvancedSuperResolutionConfig", "type": "object", "required": false, "description": "高级超分配置。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： standard：通用超分 super：高级超分super版。 ultra：高级超分ultra版。 默认值：standard。 注意：此字段可能返回 null，表示取不到有效值。", "example": "standard" }, { "name": "Mode", "type": "string", "required": false, "description": "输出图片模式，默认percent。 aspect: 超分至指定宽高的较大矩形。 fixed: 超分至固定宽高，强制缩放。 percent: 超分倍率，可以为小数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "percent" }, { "name": "Percent", "type": "float", "required": false, "description": "超分倍率，可以为小数。 注意：当Mode等于percent时使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2.0" }, { "name": "Width", "type": "integer", "required": false, "description": "目标图片宽度，不能超过4096。 注意：当Mode等于aspect或fixed时，优先使用此配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1280" }, { "name": "Height", "type": "integer", "required": false, "description": "目标图片高度，不能超过4096。 注意：当Mode等于aspect或fixed时，优先使用此配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "720" }, { "name": "LongSide", "type": "integer", "required": false, "description": "目标图片长边长度，不能超过4096。 注意：当Mode等于aspect或fixed，且未配置Width和Height字段时使用此配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1280" }, { "name": "ShortSide", "type": "integer", "required": false, "description": "目标图片短边长度，不能超过4096。 注意：当Mode等于aspect或fixed，且未配置Width和Height字段时使用此配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1280" } ] }, { "name": "Denoise", "type": "object", "required": false, "description": "降噪配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "ImageQualityEnhance", "type": "object", "required": false, "description": "综合增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak normal strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "ColorEnhance", "type": "object", "required": false, "description": "色彩增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： weak normal strong 默认值：weak。 注意：此字段可能返回 null，表示取不到有效值。", "example": "weak" } ] }, { "name": "SharpEnhance", "type": "object", "required": false, "description": "细节增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Intensity", "type": "float", "required": false, "description": "强度，取值范围：0.0~1.0。 默认：0.0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "FaceEnhance", "type": "object", "required": false, "description": "人脸增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Intensity", "type": "float", "required": false, "description": "强度，取值范围：0.0~1.0。 默认：0.0。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" } ] }, { "name": "LowLightEnhance", "type": "object", "required": false, "description": "低光照增强配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Type", "type": "string", "required": false, "description": "类型，可选值： normal 默认值：normal。 注意：此字段可能返回 null，表示取不到有效值。", "example": "normal" } ] } ] }, { "name": "EraseConfig", "type": "object", "required": false, "description": "图片擦除配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "ImageEraseLogo", "type": "object", "required": false, "description": "图标擦除配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" }, { "name": "ImageAreaBoxes", "type": "array", "required": false, "description": "需要擦除的多个框选区域，最多开启16个区域。 注意：此字段可能返回 null，表示取不到有效值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "string" }, { "name": "DetectTypes", "type": "array", "required": false, "description": "图片框选区域类型，可选值： logo：图标； text：文字； watermark：水印； 注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"logo\", \"text\"]", "item_type": "string" } ] } ] }, { "name": "BlindWatermarkConfig", "type": "object", "required": false, "description": "盲水印配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "AddBlindWatermark", "type": "object", "required": false, "description": "增加盲水印 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" }, { "name": "EmbedInfo", "type": "object", "required": false, "description": "盲水印嵌入数据 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "ExtractBlindWatermark", "type": "object", "required": false, "description": "提取盲水印 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" } ] }, { "name": "RemoveBlindWatermark", "type": "object", "required": false, "description": "移除盲水印 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" } ] } ] }, { "name": "BeautyConfig", "type": "object", "required": false, "description": "美颜配置。", "example": "无", "children": [ { "name": "BeautyEffectItems", "type": "array", "required": false, "description": "美颜效果", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型名称。取值如下： Whiten：美白 BlackAlpha1：美黑 BlackAlpha2：较强美黑 FoundationAlpha2：美白-粉白 Clear：清晰度 Sharpen：锐化 Smooth：磨皮 BeautyThinFace：瘦脸 NatureFace：自然脸型 VFace：V脸 EnlargeEye：大眼 EyeLighten：亮眼 RemoveEyeBags：祛眼袋 ThinNose：瘦鼻 RemoveLawLine：祛法令纹 CheekboneThin：瘦颧骨 FaceFeatureLipsLut：口红 ToothWhiten：牙齿美白 FaceFeatureSoftlight：柔光 Makeup：美妆", "example": "Whiten" }, { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Value", "type": "integer", "required": false, "description": "效果强度，值范围：[0, 100]。", "example": "40" }, { "name": "ResourcePath", "type": "string", "required": false, "description": "附加资源路径。", "example": "/makeupRes/video_makeup_mitao" }, { "name": "ExtInfo", "type": "string", "required": false, "description": "自定义参数。", "example": "{\\\"Color\\\":\\\"#ff0000\\\"}" } ] }, { "name": "BeautyFilterItems", "type": "array", "required": false, "description": "美颜滤镜", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": true, "description": "类型名称。取值如下： Dongjing：东京 Qingjiaopian：轻胶片 Meiwei：美味", "example": "Qingjiaopian" }, { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启； OFF：关闭。 默认值：ON。", "example": "ON" }, { "name": "Value", "type": "integer", "required": false, "description": "效果强度，值范围：[-100, 100]。", "example": "70" } ] } ] }, { "name": "TransformConfig", "type": "object", "required": false, "description": "图片基础转换能力。", "example": "无", "children": [ { "name": "ImageResize", "type": "object", "required": false, "description": "图片缩放配置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "能力配置开关，可选值： ON：开启 OFF：关闭 默认值：ON。", "example": "ON" }, { "name": "Mode", "type": "string", "required": false, "description": "输出图片模式，可选模式： percent: 指定缩放倍率，可以为小数 mfit: 缩放至指定宽高的较大矩形 lfit: 缩放至指定宽高的较小矩形 fill: 缩放至指定宽高的较大矩形，并居中裁剪指定宽高 pad: 缩放至指定宽高的较小矩形，并填充到指定宽高 fixed: 缩放至固定宽高，强制缩放 默认值：percent。 注意：此字段可能返回 null，表示取不到有效值。", "example": "percent" }, { "name": "Percent", "type": "float", "required": false, "description": "缩放倍率，可以为小数，当Mode为percent时使用。 默认值：1.0。 取值范围：[0.1，10.0] 注意：此字段可能返回 null，表示取不到有效值。", "example": "1.0" }, { "name": "Width", "type": "integer", "required": false, "description": "目标图片宽度。 取值范围：[1，16384]。 注意：此字段在Mode非percent时优先使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3840" }, { "name": "Height", "type": "integer", "required": false, "description": "目标图片高度。 取值范围：[1，16384]。 注意：此字段在Mode非percent时优先使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2160" }, { "name": "LongSide", "type": "integer", "required": false, "description": "目标图片长边。 取值范围：[1，16384]。 注意：此字段在Mode非percent且未配置Width和Height时使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "3840" }, { "name": "ShortSide", "type": "integer", "required": false, "description": "目标图片短边。 取值范围：[1，16384]。 注意：此字段在Mode非percent且未配置Width和Height时使用。 注意：此字段可能返回 null，表示取不到有效值。", "example": "2160" } ] } ] } ] }, { "name": "ScheduleId", "type": "integer", "required": false, "description": "图片处理编排场景 ID。 - 30000：文字水印擦除 - 30010：图片扩展 - 30100：换装场景", "example": "30000" }, { "name": "AddOnParameter", "type": "object", "required": false, "description": "图片处理附加参数。", "example": "无", "children": [ { "name": "ImageSet", "type": "array", "required": false, "description": "附加图片输入。", "example": "无", "item_type": "object", "children": [ { "name": "Image", "type": "object", "required": false, "description": "图片路径。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输入来源对象的类型，支持： COS：COS源 URL：URL源 AWS-S3：AWS 源，目前只支持转码任务 VOD：点播专业版", "example": "NULL" }, { "name": "CosInputInfo", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 对象信息。", "example": "无" }, { "name": "UrlInputInfo", "type": "object", "required": false, "description": "当 Type 为 URL 时有效，则该项为必填，表示媒体处理 URL 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3InputInfo", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODInputInfo", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] } ] }, { "name": "OutputConfig", "type": "object", "required": false, "description": "图片处理输出配置。", "example": "无", "children": [ { "name": "AspectRatio", "type": "string", "required": false, "description": "输出图片的宽高比。可以配合ImageWidth 和 ImageHeight 使用，规则如下： 1. 仅指定 AspectRatio 时，根据原图输入进行自适应调整。 2. 指定 AspectRatio 和 ImageWidth 时，ImageHeight 由两者计算得出，反亦是如此。 3. 当AspectRatio、ImageWidth、ImageHeight 同时指定的时候，优先使用ImageWidth、ImageHeight。 可取值：1:1、3:2、2:3、3:4、4:3、4:5、5:4、9:16、16:9、21:9 支持该参数 ScheduleId: 30010(扩图)", "example": "\"16:9\"" }, { "name": "ImageHeight", "type": "integer", "required": false, "description": "图片输出高度，单位：像素。", "example": "1920" }, { "name": "ImageWidth", "type": "integer", "required": false, "description": "图片输出宽度，单位：像素。", "example": "1080" }, { "name": "ImageSize", "type": "string", "required": false, "description": "图片输出分辨率，取值：1K/2K/4K。", "example": "1K" }, { "name": "Format", "type": "string", "required": false, "description": "图片输出编码格式，可取值：PNG、JPG、WEBP、HEIF、AVIF。", "example": "PNG" }, { "name": "Quality", "type": "integer", "required": false, "description": "图片质量，对于某些输出格式可用，只有Format 有效的情况下生效，取值范围 0-100。", "example": "75" } ] }, { "name": "ExtPrompt", "type": "array", "required": false, "description": "图片处理附加 prompt，只针对某些场景可用。", "example": "无", "item_type": "object", "children": [ { "name": "Prompt", "type": "string", "required": false, "description": "图片处理相关的prompt。", "example": "one cat and one dog" } ] } ] }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "图片处理拓展参数。", "example": "{\"FilterConfig\":{\"Switch\":\"ON\"}}" } ], "required": [ "InputInfo" ] }, { "name": "ProcessLiveStream", "description": "对直播流媒体发起处理任务，功能包括： * 智能内容审核（画面鉴黄、敏感信息检测、声音鉴黄）； * 智能内容识别（人脸、文本全文、文本关键词、语音全文、语音关键词、语音实时翻译、物体识别、游戏打点）。 * 智能内容分析（拆条，集锦）。 * 质检（直播流格式诊断、音画内容检测（抖动、模糊、低光照、过曝光、黑边、白边、黑屏、白屏、花屏、噪点、马赛克、二\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "Url", "type": "string", "required": true, "description": "直播流 URL（必须是直播流地址，支持 rtmp，hls 和 flv, trtc,webrtc,srt等）。trtc地址如下： trtc: //trtc.rtc.qq.com/mps/\u0026lt;roomid\u0026gt;?sdkappid=\u0026lt;sdkappid\u0026gt;\u0026amp;userid=\u0026lt;userid\u0026gt;\u0026amp;usersig=\u0026lt;usersig\u0026gt;\u0026lt;roomid\u0026gt; 为trtc的房间号id, 为数字\u0026lt;sdkappid\u0026gt; 为trtc的sdk app id\u0026lt;userid\u0026gt; 为服务进入房间的用户id,可以区分谁是机器人\u0026lt;usersig\u0026gt; 为trtc 用户的签名webrtc 支持LEB的直播流，地址获取请参考srt支持地\ufffd\ufffd...", "example": "http://www.adc.com/adc.m3u8" }, { "name": "TaskNotifyConfig", "type": "object", "required": true, "description": "任务的事件通知信息，用于指定直播流处理的结果。", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型： TDMQ-CMQ：消息队列 \"URL\"： 指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同[解析直播事件通知接口](https://cloud.tencent.com/document/product/862/39229) 的输出参数 注：不填或为空时不发送回调，如需回调需填写对应类型值。", "example": "URL" }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "有 Queue 和 Topic 两种模型。", "example": "Queue" }, { "name": "CmqRegion", "type": "string", "required": false, "description": "TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 TDMQ-CMQ 的队列名。", "example": "mpstest-queue" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 TDMQ-CMQ 的主题名。", "example": "mpstest-topic" }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的 Key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0se***9idaY" } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "直播流处理输出文件的目标存储。如处理有文件输出，该参数为必填项。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputDir", "type": "string", "required": false, "description": "直播流处理生成的文件输出的目标目录，如/movie/201909/，如果不填为 / 目录。", "example": "/tmp/" }, { "name": "AiContentReviewTask", "type": "object", "required": false, "description": "视频内容审核类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容审核模板 ID。", "example": "10" } ] }, { "name": "AiRecognitionTask", "type": "object", "required": false, "description": "视频内容识别类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频智能识别模板 ID 。", "example": "10" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "用户扩展字段，一般场景不用填。", "example": "{\"ParaTest\":\"test\"}" } ] }, { "name": "AiAnalysisTask", "type": "object", "required": false, "description": "视频内容分析类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容分析模板 ID。", "example": "28" }, { "name": "ExtendedParameter", "type": "string", "required": false, "description": "扩展参数，其值为序列化的 json字符串。 注意：此参数为定制需求参数，参考如下： [智能檫除](https://cloud.tencent.com/document/product/862/101530) [智能拆条](https://cloud.tencent.com/document/product/862/112098) [高光集锦](https://cloud.tencent.com/document/product/862/107280) [智能横转竖](https://cloud.tencent.com/document/product/862/112112) 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"{\\\"htv\\\": {} }\"" } ] }, { "name": "AiQualityControlTask", "type": "object", "required": false, "description": "媒体质检类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": false, "description": "媒体质检模板 ID 。 可以直接使用预设模板，也可以在控制台自定义模板。预设模板如下： - 10：开启所有质检项； - 20：仅开启格式诊断对应质检项； - 30：仅开启无参考打分对应质检项； - 40：仅开启画面质量对应质检项。 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "ChannelExtPara", "type": "string", "required": false, "description": "渠道扩展参数json序列化字符串。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\\\"OutputDir\\\":\\\"/test/output/1abc***12345/\\\"}" } ] }, { "name": "SmartSubtitlesTask", "type": "object", "required": false, "description": "智能字幕任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": false, "description": "智能字幕模板 ID 。", "example": "10" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "用户扩展字段，一般场景不用填。", "example": "{\"ParaTest\":\"test\"}" } ] }, { "name": "SessionId", "type": "string", "required": false, "description": "用于去重的识别码，如果七天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不带或者带空字符串表示不做去重。", "example": "sdsxxx-xxxx" }, { "name": "SessionContext", "type": "string", "required": false, "description": "来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。", "example": "ceckxxxxx" }, { "name": "ScheduleId", "type": "integer", "required": false, "description": "直播编排ID。注意1：对于OutputStorage、OutputDir参数：当服务编排中子任务节点配置了OutputStorage、OutputDir时，该子任务节点中配置的输出作为子任务的输出。当服务编排中子任务节点没有配置OutputStorage、OutputDir时，若对直播流发起处理（ProcessLiveStream）有输出，将覆盖原有编排的默认输出。注意2：对于TaskNotifyConfig参数，若创建任务接口（ProcessLiveStream）有设置，将覆盖原有编排\ufffd\ufffd...", "example": "450001" }, { "name": "ResourceId", "type": "string", "required": false, "description": "资源ID，需要保证对应资源是开启状态。默认为帐号主资源ID。", "example": "vts-24000-0" } ], "required": [ "Url", "TaskNotifyConfig" ] }, { "name": "ProcessMedia", "description": "对 URL视频链接 或 COS 中的媒体文件发起处理任务，功能包括： - 音视频转码（例如普通转码、极速高清转码、音视频增强、添加明水印、添加数字水印）； - 音视频转自适应码流； - 视频转动图； - 对视频按指定时间点截图； - 对视频采样截图； - 对视频截图雪碧图； - 媒体质检（例如媒体格式诊断、音画内容检测、无参考打分，其中音画内容检测主要针对抖动、模糊、低光\ufffd...", "status": "online", "parameters": [ { "name": "InputInfo", "type": "object", "required": true, "description": "媒体处理的文件输入信息。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输入来源对象的类型，支持： COS：COS源 URL：URL源 AWS-S3：AWS 源，目前只支持转码任务 VOD：点播专业版", "example": "NULL" }, { "name": "CosInputInfo", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 对象信息。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": true, "description": "媒体处理对象文件的输入路径，如`/movie/201907/WildAnimal.mov`。", "example": "/movie/201907/WildAnimal.mov" } ] }, { "name": "UrlInputInfo", "type": "object", "required": false, "description": "当 Type 为 URL 时有效，则该项为必填，表示媒体处理 URL 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频的 URL。", "example": "NULL" } ] }, { "name": "S3InputInfo", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-us-125678" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域，目前支持： us-east-1 eu-west-3 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1 " }, { "name": "S3Object", "type": "string", "required": true, "description": "S3 bucket 中的媒体资源路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/test.mp4" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bb5******eff" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bbc5******eff" } ] }, { "name": "VODInputInfo", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理对象文件所在的 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理对象文件所在的 Bucket 所属园区", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": false, "description": "媒体处理对象文件的输入路径", "example": "/movie/201907/WildAnimal.mov" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "媒体处理输出文件的目标存储。不填则继承 InputInfo 中的存储位置。 注意：当InputInfo.Type为URL时，该参数是必填项", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputDir", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标目录，必选以 / 开头和结尾，如`/movie/201907/`。 如果不填，表示与 InputInfo 中文件所在的目录一致。", "example": "/movie/test/" }, { "name": "ScheduleId", "type": "integer", "required": false, "description": "编排ID。 注意1：对于OutputStorage、OutputDir参数： 当服务编排中子任务节点配置了OutputStorage、OutputDir时，该子任务节点中配置的输出作为子任务的输出。 当服务编排中子任务节点没有配置OutputStorage、OutputDir时，若创建任务接口（ProcessMedia）有指定输出，将覆盖原有编排的默认输出。 即输出设置的优先级：编排子任务节点 \u003e 任务接口指定 \u003e 对应编排内的配置 注意2：对于TaskNotifyC...", "example": "157482" }, { "name": "MediaProcessTask", "type": "object", "required": false, "description": "媒体处理类型任务参数。", "example": "无", "children": [ { "name": "TranscodeTaskSet", "type": "array", "required": false, "description": "视频转码任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频转码模板 ID。", "example": "20" }, { "name": "RawParameter", "type": "object", "required": false, "description": "视频转码自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定转码参数。", "example": "无", "children": [ { "name": "Container", "type": "string", "required": true, "description": "封装格式，可选值：mp4、flv、hls、mp3、flac、ogg、m4a。其中，mp3、flac、ogg、m4a 为纯音频文件。", "example": "mp4" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，取值： 0：保留； 1：去除。 默认值：0。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，取值： 0：保留； 1：去除。 默认值：0。", "example": "0" }, { "name": "VideoTemplate", "type": "object", "required": false, "description": "视频流配置参数，当 RemoveVideo 为 0，该字段必填。", "example": "无" }, { "name": "AudioTemplate", "type": "object", "required": false, "description": "音频流配置参数，当 RemoveAudio 为 0，该字段必填。", "example": "无" }, { "name": "TEHDConfig", "type": "object", "required": false, "description": "极速高清转码参数。", "example": "无" }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "扩展参数，序列化的 json 字符串。", "example": "{\"video_info\":{\"color_prim\":\"bt709\"}}" }, { "name": "EnhanceConfig", "type": "object", "required": false, "description": "音视频增强配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SubtitleTemplate", "type": "object", "required": false, "description": "字幕参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OverrideParameter", "type": "object", "required": false, "description": "视频转码自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分转码参数时，将使用填写的参数覆盖转码模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Container", "type": "string", "required": false, "description": "封装格式，可选值：mp4、flv、hls、mp3、flac、ogg、m4a。其中，mp3、flac、ogg、m4a 为纯音频文件。", "example": "mp4" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，取值： 0：保留； 1：去除。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，取值： 0：保留； 1：去除。", "example": "0" }, { "name": "VideoTemplate", "type": "object", "required": false, "description": "视频流配置参数。", "example": "无" }, { "name": "AudioTemplate", "type": "object", "required": false, "description": "音频流配置参数。", "example": "无" }, { "name": "TEHDConfig", "type": "object", "required": false, "description": "极速高清转码参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SubtitleTemplate", "type": "object", "required": false, "description": "字幕流配置参数。", "example": "无" }, { "name": "AddonAudioStream", "type": "array", "required": false, "description": "外挂音轨参数。", "example": "无", "item_type": "string" }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "转码扩展字段。", "example": "{\"audio_info\": {\"codec\": \"vivid\"}}" }, { "name": "AddOnSubtitles", "type": "array", "required": false, "description": "要插入的字幕文件。", "example": "无", "item_type": "string" } ] }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板 ID。", "example": "NULL" }, { "name": "RawParameter", "type": "object", "required": false, "description": "水印自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。", "example": "NULL" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。", "example": "NULL" }, { "name": "SvgContent", "type": "string", "required": false, "description": "SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。 不填或填0，表示水印从画面开始就出现； 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。 注：只用于视频场景，截图不支持。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "水印的结束时间偏移，单位：秒。 不填或填0，表示水印持续到画面结束； 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。 注：只用于视频场景，截图不支持。", "example": "NULL" } ] }, { "name": "BlindWatermark", "type": "object", "required": false, "description": "数字水印参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "数字水印模板ID", "example": "10" } ] }, { "name": "MosaicSet", "type": "array", "required": false, "description": "马赛克列表，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "CoordinateOrigin", "type": "string", "required": false, "description": "原点位置，目前仅支持： TopLeft：表示坐标原点位于视频图像左上角，马赛克原点为图片或文字的左上角。 默认值：TopLeft。", "example": "NULL" }, { "name": "XPos", "type": "string", "required": false, "description": "马赛克原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式： 当字符串以 % 结尾，表示马赛克 XPos 为视频宽度指定百分比，如 10% 表示 XPos 为视频宽度的 10%； 当字符串以 px 结尾，表示马赛克 XPos 为指定像素，如 100px 表示 XPos 为 100 像素。 默认值：0px。", "example": "NULL" }, { "name": "YPos", "type": "string", "required": false, "description": "马赛克原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式： 当字符串以 % 结尾，表示马赛克 YPos 为视频高度指定百分比，如 10% 表示 YPos 为视频高度的 10%； 当字符串以 px 结尾，表示马赛克 YPos 为指定像素，如 100px 表示 YPos 为 100 像素。 默认值：0px。", "example": "NULL" }, { "name": "Width", "type": "string", "required": false, "description": "马赛克的宽度。支持 %、px 两种格式： 当字符串以 % 结尾，表示马赛克 Width 为视频宽度的百分比大小，如 10% 表示 Width 为视频宽度的 10%； 当字符串以 px 结尾，表示马赛克 Width 单位为像素，如 100px 表示 Width 为 100 像素。 默认值：10%。", "example": "NULL" }, { "name": "Height", "type": "string", "required": false, "description": "马赛克的高度。支持 %、px 两种格式： 当字符串以 % 结尾，表示马赛克 Height 为视频高度的百分比大小，如 10% 表示 Height 为视频高度的 10%； 当字符串以 px 结尾，表示马赛克 Height 单位为像素，如 100px 表示 Height 为 100 像素。 默认值：10%。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "马赛克的起始时间偏移，单位：秒。不填或填0，表示马赛克从画面出现时开始显现。 不填或填0，表示马赛克从画面开始就出现； 当数值大于0时（假设为 n），表示马赛克从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示马赛克从离画面结束 n 秒前开始出现。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "马赛克的结束时间偏移，单位：秒。 不填或填0，表示马赛克持续到画面结束； 当数值大于0时（假设为 n），表示马赛克持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示马赛克持续到离画面结束 n 秒前消失。", "example": "NULL" } ] }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "转码后的视频的起始时间偏移，单位：秒。 不填或填0，表示转码后的视频从原始视频的起始位置开始； 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始； 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。", "example": "1.0" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "转码后视频的终止时间偏移，单位：秒。 不填或填0，表示转码后的视频持续到原始视频的末尾终止； 当数值大于0时（假设为 n），表示转码后的视频持续到原始视频第 n 秒时终止； 当数值小于0时（假设为 -n），表示转码后的视频持续到原始视频结束 n 秒前终止。", "example": "15.0" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转码后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转码后主文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_transcode_{definition}.{format}`。", "example": "{inputName}_transcode_{definition}.{format}" }, { "name": "SegmentObjectName", "type": "string", "required": false, "description": "转码后分片文件的输出路径（转码 HLS 时 ts 的路径），只能为相对路径。如果不填，则默认为：`{inputName}_transcode_{definition}_{number}.{format}`。", "example": "{inputName}_transcode_{definition}_{number}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "转码后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InitialValue", "type": "integer", "required": false, "description": "`{number}`变量的起始值，默认为0。", "example": "0" }, { "name": "Increment", "type": "integer", "required": false, "description": "`{number}`变量的增长步长，默认为1。", "example": "1" }, { "name": "MinLength", "type": "integer", "required": false, "description": "`{number}`变量的最小长度，不足时补占位符。默认为1。", "example": "1" }, { "name": "PlaceHolder", "type": "string", "required": false, "description": "`{number}`变量的长度不足时，补充的占位符。默认为\"0\"。", "example": "0" } ] }, { "name": "HeadTailParameter", "type": "object", "required": false, "description": "片头片尾参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "HeadSet", "type": "array", "required": false, "description": "片头列表。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[ { \"Type\": \"URL\", \"UrlInputInfo\": { \"Url\": \"htt", "item_type": "string" }, { "name": "TailSet", "type": "array", "required": false, "description": "片尾列表。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[ { \"Type\": \"URL\", \"UrlInputInfo\": { \"Url\": \"htt", "item_type": "string" } ] } ] }, { "name": "AnimatedGraphicTaskSet", "type": "array", "required": false, "description": "视频转动图任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频转动图模板 ID。", "example": "20000" }, { "name": "StartTimeOffset", "type": "float", "required": true, "description": "动图在视频中的开始时间，单位为秒。", "example": "1.5" }, { "name": "EndTimeOffset", "type": "float", "required": true, "description": "动图在视频中的结束时间，单位为秒。", "example": "11.2" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转动图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转动图后文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_animatedGraphic_{definition}.{format}`。", "example": "文件名_{变量名}.{format}" } ] }, { "name": "SnapshotByTimeOffsetTaskSet", "type": "array", "required": false, "description": "对视频按时间点截图任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "指定时间点截图模板 ID。", "example": "11028" }, { "name": "ExtTimeOffsetSet", "type": "array", "required": false, "description": "截图时间点列表，时间点支持 s、% 两种格式： 当字符串以 s 结尾，表示时间点单位为秒，如 3.5s 表示时间点为第3.5秒； 当字符串以 % 结尾，表示时间点为视频时长的百分比大小，如10%表示时间点为视频前第10%的时间。", "example": "[\"3.5s\", \"50%\"]", "item_type": "string" }, { "name": "TimeOffsetSet", "type": "array", "required": false, "description": "截图时间点列表，单位为秒。此参数已不再建议使用，建议您使用 ExtTimeOffsetSet 参数。", "example": "[7.5, 10]", "item_type": "float" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板 ID。", "example": "NULL" }, { "name": "RawParameter", "type": "object", "required": false, "description": "水印自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。", "example": "NULL" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。", "example": "NULL" }, { "name": "SvgContent", "type": "string", "required": false, "description": "SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。 不填或填0，表示水印从画面开始就出现； 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。 注：只用于视频场景，截图不支持。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "水印的结束时间偏移，单位：秒。 不填或填0，表示水印持续到画面结束； 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。 注：只用于视频场景，截图不支持。", "example": "NULL" } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "时间点截图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "时间点截图后图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_snapshotByTimeOffset_{definition}_{number}.{format}`\ufffd...", "example": "/mps/output/{inputName}_test_{definition}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "时间点截图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InitialValue", "type": "integer", "required": false, "description": "`{number}`变量的起始值，默认为0。", "example": "0" }, { "name": "Increment", "type": "integer", "required": false, "description": "`{number}`变量的增长步长，默认为1。", "example": "1" }, { "name": "MinLength", "type": "integer", "required": false, "description": "`{number}`变量的最小长度，不足时补占位符。默认为1。", "example": "1" }, { "name": "PlaceHolder", "type": "string", "required": false, "description": "`{number}`变量的长度不足时，补充的占位符。默认为\"0\"。", "example": "0" } ] } ] }, { "name": "SampleSnapshotTaskSet", "type": "array", "required": false, "description": "对视频采样截图任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "采样截图模板 ID。", "example": "10" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板 ID。", "example": "NULL" }, { "name": "RawParameter", "type": "object", "required": false, "description": "水印自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。", "example": "NULL" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。", "example": "NULL" }, { "name": "SvgContent", "type": "string", "required": false, "description": "SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。 不填或填0，表示水印从画面开始就出现； 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。 注：只用于视频场景，截图不支持。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "水印的结束时间偏移，单位：秒。 不填或填0，表示水印持续到画面结束； 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。 注：只用于视频场景，截图不支持。", "example": "NULL" } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "采样截图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "采样截图后图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_sampleSnapshot_{definition}_{number}.{format}`。", "example": "/{inputName}_snapshotByTimeOffsetTest_{definition}_{number}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "采样截图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InitialValue", "type": "integer", "required": false, "description": "`{number}`变量的起始值，默认为0。", "example": "0" }, { "name": "Increment", "type": "integer", "required": false, "description": "`{number}`变量的增长步长，默认为1。", "example": "1" }, { "name": "MinLength", "type": "integer", "required": false, "description": "`{number}`变量的最小长度，不足时补占位符。默认为1。", "example": "1" }, { "name": "PlaceHolder", "type": "string", "required": false, "description": "`{number}`变量的长度不足时，补充的占位符。默认为\"0\"。", "example": "0" } ] } ] }, { "name": "ImageSpriteTaskSet", "type": "array", "required": false, "description": "对视频截雪碧图任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "雪碧图模板 ID。", "example": "10001" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "截取雪碧图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "截取雪碧图后，雪碧图图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_imageSprite_{definition}_{number}.{format...", "example": "xxx_imageSprite_10001_0.png" }, { "name": "WebVttObjectName", "type": "string", "required": false, "description": "截取雪碧图后，Web VTT 文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_imageSprite_{definition}.{format}`。", "example": "xxx_imageSprite_10001_0.vtt" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "截取雪碧图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InitialValue", "type": "integer", "required": false, "description": "`{number}`变量的起始值，默认为0。", "example": "0" }, { "name": "Increment", "type": "integer", "required": false, "description": "`{number}`变量的增长步长，默认为1。", "example": "1" }, { "name": "MinLength", "type": "integer", "required": false, "description": "`{number}`变量的最小长度，不足时补占位符。默认为1。", "example": "1" }, { "name": "PlaceHolder", "type": "string", "required": false, "description": "`{number}`变量的长度不足时，补充的占位符。默认为\"0\"。", "example": "0" } ] } ] }, { "name": "AdaptiveDynamicStreamingTaskSet", "type": "array", "required": false, "description": "转自适应码流任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "转自适应码流模板 ID。", "example": "10" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板 ID。", "example": "NULL" }, { "name": "RawParameter", "type": "object", "required": false, "description": "水印自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。", "example": "NULL" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。", "example": "NULL" }, { "name": "SvgContent", "type": "string", "required": false, "description": "SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。 不填或填0，表示水印从画面开始就出现； 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。 注：只用于视频场景，截图不支持。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "水印的结束时间偏移，单位：秒。 不填或填0，表示水印持续到画面结束； 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。 注：只用于视频场景，截图不支持。", "example": "NULL" } ] }, { "name": "BlindWatermark", "type": "object", "required": false, "description": "数字水印参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "数字水印模板ID", "example": "10" } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转自适应码流后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转自适应码流后，manifest 文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：{inputName}_adaptiveDynamicStreaming_{definition}.{format...", "example": "{inputName}_adaptiveDynamicStreaming_{definition}.{format}" }, { "name": "SubStreamObjectName", "type": "string", "required": false, "description": "转自适应码流后，子流文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}`。", "example": "{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}" }, { "name": "SegmentObjectName", "type": "string", "required": false, "description": "转自适应码流（仅 HLS）后，分片文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}`。", "example": "{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}" }, { "name": "AddOnSubtitles", "type": "array", "required": false, "description": "外挂字幕功能，指定要插入的字幕文件。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "插入形式，可选值： subtitle-stream：插入字幕轨道 close-caption-708：CEA-708字幕编码到SEI帧 close-caption-608：CEA-608字幕编码到SEI帧 注意：此字段可能返回 null，表示取不到有效值。", "example": "subtitle-stream" }, { "name": "Subtitle", "type": "object", "required": false, "description": "字幕文件。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SubtitleName", "type": "string", "required": false, "description": "字幕名称 。 注意：仅支持中文、英文、数字、空格、下划线(_)、短横线(-)、句点(.)和中英文括号，长度不能超过64个字符。 注意：此字段可能返回 null，表示取不到有效值。", "example": "字幕1" }, { "name": "OutputFormat", "type": "string", "required": false, "description": "字幕输出格式。取值{\"WebVTT\",\"TTML\"}。 默认值：\"WebVTT\"", "example": "WebVTT" }, { "name": "DefaultTrack", "type": "boolean", "required": false, "description": "默认字幕轨道。为true时指定当前字幕为默认字幕轨道，最多可指定1条默认字幕轨道。 默认值：false", "example": "false" } ] }, { "name": "DrmInfo", "type": "object", "required": false, "description": "Drm信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "加密类型： - simpleaes 只能用于HLS，切片格式支持ts和mp4 只能使用切片模式，不能使用singlefile模式 - fairplay： 只能用于HLS，切片格式只能是mp4 可以使用切片模式或singlefile模式 - widevine： 可以用于HLS和DASH，切片格式只能是mp4 输出HLS：可以使用切片模式或singlefile模式 输出DASH：只能singlefile模式 - playready： 可以用于HLS和DASH，切片格式只能是mp4 输出HLS：可以使用切片模式或singlefile...", "example": "widevine" }, { "name": "SimpleAesDrm", "type": "object", "required": false, "description": "SimpleAes 加密信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SpekeDrm", "type": "object", "required": false, "description": "FairPlay，WideVine，PlayReady 加密信息。", "example": "无" } ] }, { "name": "DefinitionType", "type": "string", "required": false, "description": "自适应转码模板类型： Common：音视频类型 PureAudio：纯音频类型", "example": "Common" }, { "name": "SubtitleTemplate", "type": "object", "required": false, "description": "硬字幕（压制字幕）功能，指定字幕来源、字体大小、位置等字幕参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Path", "type": "string", "required": false, "description": "要压制到视频中的字幕文件地址。 注意：此字段可能返回 null，表示取不到有效值。", "example": "https://test-13xxxx46.cos.ap-nanjing.myqcloud.com/xxxxx/subtitle/1.srt" }, { "name": "StreamIndex", "type": "integer", "required": false, "description": "指定要压制到视频中的字幕轨道，Streamindex的取值从0开始，0表示使用源视频中的第一条字幕轨。如果指定了Path，则优先使用Path。Path 和 StreamIndex 至少指定一个。 - 注意：StreamIndex必须与源文件中的字幕轨索引一致。例如，源文件中的字幕轨为stream#0:3，则StreamIndex应为3，否则可能导致任务处理失败。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SubtitleFileInput", "type": "object", "required": false, "description": "要压制到视频中的字幕文件的输入信息，目前仅支持存储在COS的字幕文件 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "FontFileInput", "type": "object", "required": false, "description": "压制字幕字体文件的输入信息，目前仅支持url和cos。都填时url优先于cos。填了FontFileInput时FontFileInput优先于FontType", "example": "无" }, { "name": "FontType", "type": "string", "required": false, "description": "字体类型，支持： hei.ttf：黑体 song.ttf：宋体 kai.ttf（推荐）或 simkai.ttf：楷体 msyh.ttf：微软雅黑 msyhbd.ttf：微软雅黑加粗 hkjgt.ttf：华康金刚体 dhttx.ttf：典黑体特细 xqgdzt.ttf：喜鹊古字典体 qpcyt.ttf：巧拼超圆体 arial.ttf：仅支持英文 dinalternate.ttf：DIN Alternate Bold helveticalt.ttf：Helvetica helveticains.ttf：Helvetica Inserat trajanpro.ttf：TrajanPro-Bold korean.ttf：韩语 japanese.ttf：日语 thai.ttf：泰语 默...", "example": "kai.ttf" }, { "name": "FontSize", "type": "string", "required": false, "description": "字体大小，不指定则以字幕文件中为准。支持像素和百分比格式： - 像素：Npx，N范围：(0,4096]。 - 百分百：N%，N范围：(0,100]；例如10%表示字幕字体大小=10%*源视频高度。 不填且字幕文件无设置时，默认源视频高度的5%。 注意：此字段可能返回 null，表示取不到有效值。", "example": "50px" }, { "name": "FontColor", "type": "string", "required": false, "description": "字体颜色，格式：0xRRGGBB，默认值：0xFFFFFF（白色）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0xFFFFFF" }, { "name": "FontAlpha", "type": "float", "required": false, "description": "文字透明度，取值范围：(0, 1] 0：完全透明 1：完全不透明 默认值：1。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1.0" }, { "name": "YPos", "type": "string", "required": false, "description": "字幕y轴坐标位置，指定此参数会忽略字幕文件自带坐标；支持像素和百分比格式： - 像素：Npx，N范围：[0,4096]。 - 百分百：N%，N范围：[0,100]；例如10%表示字幕y坐标=10%*源视频高度。 默认值：源视频高度*4%。 注意：坐标轴原点在源视频中轴线底部，字幕基准点在字幕中轴线底部，参考下图： ![image](https://ie-mps-1258344699.cos.ap-nanjing.tencentcos.cn/common/cloud/mps-demo/102_ai_subtitle/subtitle_sty...", "example": "4%" }, { "name": "BoardY", "type": "string", "required": false, "description": "字幕背景底板的y轴坐标位置；支持像素和百分比格式： - 像素：Npx，N范围：[0,4096]。 - 百分百：N%，N范围：[0,100]；例如10%表示字幕背景底板y坐标=10%*源视频高度。 不传表示不开启字幕背景底板。 注意：坐标轴原点位于源视频的中轴线底部，字幕背景底板的基准点在其中轴线底部，参考下图： ![image](https://ie-mps-1258344699.cos.ap-nanjing.tencentcos.cn/common/cloud/mps-demo/102_ai_subtitle/subtitle_...", "example": "1%" }, { "name": "BoardWidth", "type": "integer", "required": false, "description": "底板的宽度，正整数。 - 代表像素时，取值范围：[0,4096]。 - 代表百分数时，[0, 100]。 开启底板且不填此值时，默认源视频宽像素的90%。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1920" }, { "name": "BoardHeight", "type": "integer", "required": false, "description": "底板的高度，正整数。 - 代表像素时，取值范围：[0,4096]。 - 代表百分数时，[0, 100]。 开启底板且不填此值时，默认为源视频高像素的15%。 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "BoardColor", "type": "string", "required": false, "description": "底板颜色。格式：0xRRGGBB， 默认值：0x000000（黑色）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0x000000" }, { "name": "BoardAlpha", "type": "float", "required": false, "description": "字幕背景板透明度，取值范围：[0, 1] 0：完全透明 1：完全不透明 默认值：0.8。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0.8" }, { "name": "OutlineWidth", "type": "float", "required": false, "description": "描边宽度。浮点数。 - 代表像素值时， [0, 1000]。 - 代表百分数时，[0, 100]。 不填默认源视频高度的0.3%。", "example": "1.0" }, { "name": "OutlineColor", "type": "string", "required": false, "description": "描边颜色。6位16进制RGB。不填默认黑色。", "example": "0x000000" }, { "name": "OutlineAlpha", "type": "float", "required": false, "description": "描边透明度。(0，1] 正浮点数。不填默认1，完全不透明", "example": "0.8" }, { "name": "ShadowWidth", "type": "float", "required": false, "description": "阴影宽度。浮点数。 - 代表像素值时， [0, 1000]。 - 代表百分数时，[0, 100]。 不填默认无阴影。", "example": "1.0" }, { "name": "ShadowColor", "type": "string", "required": false, "description": "阴影颜色。6位16进制RGB。不填默认黑色（有设置阴影的情况下）", "example": "0x000000" }, { "name": "ShadowAlpha", "type": "float", "required": false, "description": "阴影透明度。(0，1] 正浮点数。不填默认1，完全不透明（有设置阴影的情况下）", "example": "0.9" }, { "name": "LineSpacing", "type": "integer", "required": false, "description": "行间距。正整数。 - 代表像素值时， [0, 1000]。 - 代表百分数时，[0, 100]。不填默认0。", "example": "5" }, { "name": "Alignment", "type": "string", "required": false, "description": "对齐方式，取值：top: 顶部对齐，字幕顶部按位置固定，底部随行数变化。bottom: 底部对齐，字幕底部按位置固定，顶部随行数变化。不填默认底部对齐。", "example": "bottom" }, { "name": "BoardWidthUnit", "type": "integer", "required": false, "description": "默认0。为1时BoardWidth代表百分之几，以视频宽为基准", "example": "1" }, { "name": "BoardHeightUnit", "type": "integer", "required": false, "description": "默认0。为1时BoardHeight代表百分之几，以视频高为基准", "example": "1" }, { "name": "OutlineWidthUnit", "type": "integer", "required": false, "description": "默认0。为1时OutlineWidth代表百分之几，以视频高为基准", "example": "1" }, { "name": "ShadowWidthUnit", "type": "integer", "required": false, "description": "默认0。为1时ShadowWidth代表百分之几，以视频高为基准", "example": "1" }, { "name": "LineSpacingUnit", "type": "integer", "required": false, "description": "默认0。为1时LineSpacing代表百分之几，以视频高为基准", "example": "1" } ] }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "转码参数扩展字段", "example": "{\"audio_info\": {\"codec\": \"vivid\"}}" }, { "name": "KeyPTSList", "type": "array", "required": false, "description": "指定pts时间的帧设为关键帧，并切片。单位毫秒（允许相对偏差\u003c=1ms）。当同时指定gop和切片时长时，会共同作用。注意需开启RawPts，保持帧率随源，并确保传入的pts时间在源中是有对应帧的。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[1000, 2000]", "item_type": "integer" } ] } ] }, { "name": "AiContentReviewTask", "type": "object", "required": false, "description": "视频内容审核类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容审核模板 ID。", "example": "10" } ] }, { "name": "AiAnalysisTask", "type": "object", "required": false, "description": "视频内容分析类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容分析模板 ID。", "example": "28" }, { "name": "ExtendedParameter", "type": "string", "required": false, "description": "扩展参数，其值为序列化的 json字符串。 注意：此参数为定制需求参数，参考如下： [智能檫除](https://cloud.tencent.com/document/product/862/101530) [智能拆条](https://cloud.tencent.com/document/product/862/112098) [高光集锦](https://cloud.tencent.com/document/product/862/107280) [智能横转竖](https://cloud.tencent.com/document/product/862/112112) 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"{\\\"htv\\\": {} }\"" } ] }, { "name": "AiRecognitionTask", "type": "object", "required": false, "description": "视频内容识别类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频智能识别模板 ID 。", "example": "10" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "用户扩展字段，一般场景不用填。", "example": "{\"ParaTest\":\"test\"}" } ] }, { "name": "AiQualityControlTask", "type": "object", "required": false, "description": "媒体质检类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": false, "description": "媒体质检模板 ID 。 可以直接使用预设模板，也可以在控制台自定义模板。预设模板如下： - 10：开启所有质检项； - 20：仅开启格式诊断对应质检项； - 30：仅开启无参考打分对应质检项； - 40：仅开启画面质量对应质检项。 注意：此字段可能返回 null，表示取不到有效值。", "example": "10" }, { "name": "ChannelExtPara", "type": "string", "required": false, "description": "渠道扩展参数json序列化字符串。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{\\\"OutputDir\\\":\\\"/test/output/1abc***12345/\\\"}" } ] }, { "name": "SmartSubtitlesTask", "type": "object", "required": false, "description": "智能字幕", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": false, "description": "智能字幕模板 ID 。", "example": "110167" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "用户扩展字段，一般场景不用填。", "example": "用户扩展字段" }, { "name": "RawParameter", "type": "object", "required": false, "description": "智能字幕自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定智能字幕参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SubtitleType", "type": "integer", "required": true, "description": "智能字幕字幕语言类型 0: 源语言 1: 翻译语言 2: 源语言+翻译语言 当TranslateSwitch为OFF时仅支持取0 当TranslateSwitch为ON时仅支持取1或2", "example": "0" }, { "name": "VideoSrcLanguage", "type": "string", "required": true, "description": "智能字幕视频源语言 OCR识别仅支持以下语言： `zh_en`：中英 `multi`：其他 ASR识别和纯字幕翻译当前支持以下语言： `auto`：自动识别（仅在纯字幕翻译中支持） `zh`：简体中文 `en`：英语 `ja`：日语 `ko`：韩语 `zh-PY`：中英粤 `zh_medical`：中文医疗 `vi`：越南语 `ms`：马来语 `id`：印度尼西亚语 `fil`：菲律宾语 `th`：泰语 `pt`：葡萄牙语 `tr`：土耳其语 `ar`：阿拉伯语 `es`：西班牙语 `hi`\ufffd\ufffd...", "example": "zh" }, { "name": "SubtitleFormat", "type": "string", "required": false, "description": "智能字幕文件格式: - ASR识别翻译处理类型下： - vtt: WebVTT 格式字幕 - srt: SRT 格式字幕 - 不填或填空：不生成字幕文件 - 纯字幕翻译处理类型下： - original：与源文件一致 - vtt: WebVTT 格式字幕 - srt: SRT 格式字幕 - OCR识别翻译处理类型下： - vtt: WebVTT 格式字幕 - srt: SRT 格式字幕 **注意**： - ASR识别方式下，翻译大于等于2种语言时不允许传空或不传； - 纯字幕翻译和OCR识别翻译方式\ufffd\ufffd...", "example": "vtt" }, { "name": "TranslateSwitch", "type": "string", "required": false, "description": "字幕翻译开关 `ON`: 开启翻译 `OFF`: 关闭翻译 **注意**：纯字幕翻译方式下，不传默认是打开的，不允许传空或`OFF`； 注意：此字段可能返回 null，表示取不到有效值。", "example": "OFF" }, { "name": "TranslateDstLanguage", "type": "string", "required": false, "description": "字幕翻译目标语言 当TranslateSwitch为ON的时候生效，翻译语言列表： `ab`：阿布哈兹语 `ace`：亚齐语 `ach`：阿乔利语 `af`：南非荷兰语 `ak`：契维语（阿坎语） `am`：Amharic `ar`：阿拉伯语 `as`：阿萨姆语 `ay`：艾马拉语 `az`：阿塞拜疆语 `ba`：巴什基尔语 `ban`：巴厘语 `bbc`：巴塔克托巴语 `bem`：Bemba `bew`：Betawi `bg`：保加利亚语 `bho`：博杰普尔语 `bik`：Bikol `bm`：班巴拉语 `bn`：孟加拉语...", "example": "en" }, { "name": "AsrHotWordsConfigure", "type": "object", "required": false, "description": "ASR热词库参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Switch", "type": "string", "required": false, "description": "热词开关 注意：此字段可能返回 null，表示取不到有效值。", "example": "ON" }, { "name": "LibraryId", "type": "string", "required": false, "description": "热词库ID 注意：此字段可能返回 null，表示取不到有效值。", "example": "hwd-2670a776bb5eccccc324" } ] }, { "name": "ExtInfo", "type": "string", "required": false, "description": "自定义参数", "example": "\"{}\"" }, { "name": "ProcessType", "type": "integer", "required": false, "description": "字幕处理类型： - 0：ASR识别字幕 - 1：纯字幕翻译 - 2：OCR识别字幕 **注意**：不传的情况下默认类型为 ASR识别字幕", "example": "0" }, { "name": "SelectingSubtitleAreasConfig", "type": "object", "required": false, "description": "字幕OCR提取框选区域配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "AutoAreas", "type": "array", "required": false, "description": "自动选择自定义区域。 对选定区域，利用AI模型自动检测其中存在的选择目标并提取。", "example": "无", "item_type": "string" }, { "name": "SampleWidth", "type": "integer", "required": false, "description": "示例视频或图片的宽，单位像素值", "example": "200" }, { "name": "SampleHeight", "type": "integer", "required": false, "description": "示例视频或图片的高，单位像素值", "example": "1000" } ] } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "媒体处理输出文件的目标存储。不填则继承 InputInfo 中的存储位置。 **注意**：当InputInfo.Type为URL时，该参数是必填项。 注意：此字段可能返回 null，表示取不到有效值。", "example": "{ \"Type\": \"COS\", \"CosOutputStorage\": { \"Bucket\": \"xxxx-yyy\", \"Region\": \"region\" } }", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "生成字幕文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例: - 文件名_{变量名}.{format} - 文件名.{format} 绝对路径示例： - /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径: `{inputName}_smartsubtitle_{definition}.{format}`。", "example": "/storage/{inputName}_smartsubtitle_{definition}.{format}" } ] }, { "name": "SmartEraseTask", "type": "object", "required": false, "description": "智能擦除类型任务参数", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": false, "description": "智能擦除模板id。", "example": "101" }, { "name": "RawParameter", "type": "object", "required": false, "description": "智能擦除自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定智能擦除参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "EraseType", "type": "string", "required": true, "description": "擦除类型 - subtitle 去字幕 - watermark 去水印 - privacy 隐私保护", "example": "subtitle" }, { "name": "EraseSubtitleConfig", "type": "object", "required": false, "description": "字幕擦除配置； 当EraseType值为：subtitle，此字段为必填参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SubtitleEraseMethod", "type": "string", "required": true, "description": "字幕擦除方式。 **自动擦除：**通过AI模型自动识别视频中的字幕文本内容，进行无痕化擦除，生成新的视频。但画面干扰、特殊字幕样式可能会带来一定漏擦误擦问题，可以通过指定区域擦除处理。 当使用自动擦除时，若您不指定AutoAreas，将对默认区域（画面中下部）进行自动擦除；若指定AutoAreas，将改为对您指定的区域进行自动擦除。 **指定区域擦除：**若您的字幕位置较\ufffd...", "example": "auto" }, { "name": "SubtitleModel", "type": "string", "required": true, "description": "字幕擦除模型。 **标准版（推荐）：**若您的字幕样式标准，通常建议选择该版本，细节无痕化效果更好。 **区域版：**若您的字幕存在花体、阴影、动效等特殊样式，建议选择区域版，擦除面积更大，但细节效果不如标准版。 - standard 标准模型 - area 区域模型", "example": "standard" }, { "name": "OcrSwitch", "type": "string", "required": false, "description": "是否开启OCR字幕提取，默认取OFF。 当且仅当SubtitleEraseMethod取auto时支持开启OCR字幕提取，开启后将识别自动擦除区域内出现时间最长且最稳定的文字区域为字幕区域，对字幕区域中的文字进行提取和擦除。 - ON 开启 - OFF 关闭", "example": "ON" }, { "name": "SubtitleLang", "type": "string", "required": false, "description": "字幕语言，用于指导OCR识别，默认取zh_en；仅当OcrSwitch取\"ON\"时生效。 - zh_en 中英文 - multi 其他 其他具体支持识别如下语言： 中文、英文、日文、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语、印地语、阿拉伯语、印度-孟加拉语、印度-古吉拉特语、印度-卡纳达语 、印度-马拉亚拉姆\ufffd...", "example": "zh_en" }, { "name": "SubtitleFormat", "type": "string", "required": false, "description": "字幕文件格式，默认取vtt；仅当OcrSwitch取\"ON\"时生效。 - srt srt格式 - vtt WebVTT格式", "example": "vtt" }, { "name": "TransSwitch", "type": "string", "required": false, "description": "是否开启字幕翻译，默认取OFF；仅当OcrSwitch取\"ON\"时生效。 - ON 开启 - OFF 关闭", "example": "ON" }, { "name": "TransDstLang", "type": "string", "required": false, "description": "字幕翻译目标语言，默认取en；仅当TransSwitch取\"ON\"时生效。 当前支持以下语言： zh：简体中文 en：英语 ja：日语 ko：韩语 fr：法语 es：西班牙语 it：意大利语 de：德语 tr：土耳其语 ru：俄语 pt：葡萄牙语 vi：越南语 id：印度尼西亚语 ms：马来语 th：泰语 ar：阿拉伯语 hi：印地语", "example": "en" }, { "name": "AutoAreas", "type": "array", "required": false, "description": "自动擦除自定义区域。 对选定区域，利用AI模型自动检测其中存在的擦除目标并擦除。 注意：当擦除方式选择custom时，此参数将不会生效；修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "string" }, { "name": "CustomAreas", "type": "array", "required": false, "description": "指定擦除自定义区域。 对选定区域，在选定时间段内不进行检测识别直接进行擦除。 注意：修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "string" } ] }, { "name": "EraseWatermarkConfig", "type": "object", "required": false, "description": "水印擦除配置； 当EraseType值为：watermark，此字段为必填参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "WatermarkEraseMethod", "type": "string", "required": true, "description": "水印擦除方式。 **自动擦除：**通过A模型自动识别视频中的水印，擦除后生成新的视频。适用于动态水印。 当使用自动擦除时，若您不指定AutoAreas，将对视频全屏进行自动擦除；若指定AutoAreas，将改为对您指定的区域进行自动擦除。 **指定区域擦除：**针对位置较固定的静态水印，建议您直接指定擦除区域。 当您选择指定区域擦除时，请至少传入一个指定区域。 - auto 自动擦\ufffd\ufffd...", "example": "auto" }, { "name": "WatermarkModel", "type": "string", "required": true, "description": "水印擦除模型。 基础版：效果一般，性价比高，适合动画或背景较干净的视频。 高级版：效果更好，适合短剧等现实风格视频。 - basic 基础版 - advanced 高级版", "example": "advanced" }, { "name": "AutoAreas", "type": "array", "required": false, "description": "自动擦除自定义区域。 对选定区域，利用AI模型自动检测其中存在的擦除目标并擦除。 注意，当擦除方式为custom时，此参数将不会生效。修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "string" }, { "name": "CustomAreas", "type": "array", "required": false, "description": "指定擦除自定义区域。 对选定区域，在选定时间段内不进行检测识别直接进行擦除。 注意：修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "string" } ] }, { "name": "ErasePrivacyConfig", "type": "object", "required": false, "description": "隐私保护配置； 当EraseType值为：privacy，此字段为必填参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "PrivacyModel", "type": "string", "required": true, "description": "隐私保护擦除方式。 - blur 模糊 - mosaic 马赛克", "example": "blur" }, { "name": "PrivacyTargets", "type": "array", "required": true, "description": "隐私保护目标，（在API Explorer上使用时无需传入数组，添加相应项并填入对应值即可）。 - face 人脸 - plate 车牌", "example": "[\"face\",\"plate\"]", "item_type": "string" } ] } ] }, { "name": "OverrideParameter", "type": "object", "required": false, "description": "智能擦除自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分擦除参数时，将使用填写的参数覆盖智能擦除模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定智能擦除参数。", "example": "无", "children": [ { "name": "EraseType", "type": "string", "required": false, "description": "擦除类型 - subtitle 去字幕 - watermark 去水印 - privacy 隐私保护", "example": "subtitle" }, { "name": "EraseSubtitleConfig", "type": "object", "required": false, "description": "字幕擦除配置； 当EraseType值为：subtitle，此字段为必填参数", "example": "无", "children": [ { "name": "SubtitleEraseMethod", "type": "string", "required": false, "description": "字幕擦除方式。 **自动擦除：**通过AI模型自动识别视频中的字幕文本内容，进行无痕化擦除，生成新的视频。但画面干扰、特殊字幕样式可能会带来一定漏擦误擦问题，可以通过指定区域擦除处理。 当使用自动擦除时，若您不指定AutoAreas，将对默认区域（画面中下部）进行自动擦除；若指定AutoAreas，将改为对您指定的区域进行自动擦除。 **指定区域擦除：**若您的字幕位置较\ufffd...", "example": "auto" }, { "name": "SubtitleModel", "type": "string", "required": false, "description": "字幕擦除模型。 **标准版（推荐）：**若您的字幕样式标准，通常建议选择该版本，细节无痕化效果更好。 **区域版：**若您的字幕存在花体、阴影、动效等特殊样式，建议选择区域版，擦除面积更大，但细节效果不如标准版。 - standard 标准模型 - area 区域模型", "example": "standard" }, { "name": "OcrSwitch", "type": "string", "required": false, "description": "是否开启OCR字幕提取，默认取OFF。 当且仅当SubtitleEraseMethod取auto时支持开启OCR字幕提取，开启后将识别自动擦除区域内出现时间最长且最稳定的文字区域为字幕区域，对字幕区域中的文字进行提取和擦除。 - ON 开启 - OFF 关闭", "example": "ON" }, { "name": "SubtitleLang", "type": "string", "required": false, "description": "字幕语言，用于指导OCR识别，默认取zh_en；仅当OcrSwitch取\"ON\"时生效。 - zh_en 中英文 - multi 其他 其他具体支持识别如下语言： 中文、英文、日文、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语、印地语、阿拉伯语、印度-孟加拉语、印度-古吉拉特语、印度-卡纳达语 、印度-马拉亚拉姆\ufffd...", "example": "zh_en" }, { "name": "SubtitleFormat", "type": "string", "required": false, "description": "字幕文件格式，默认取vtt；仅当OcrSwitch取\"ON\"时生效。 - srt srt格式 - vtt WebVTT格式", "example": "vtt" }, { "name": "TransSwitch", "type": "string", "required": false, "description": "是否开启字幕翻译，默认取OFF；仅当OcrSwitch取\"ON\"时生效。 - ON 开启 - OFF 关闭", "example": "ON" }, { "name": "TransDstLang", "type": "string", "required": false, "description": "字幕翻译目标语言，默认取en；仅当TransSwitch取\"ON\"时生效。 当前支持以下语言： zh：简体中文 en：英语 ja：日语 ko：韩语 fr：法语 es：西班牙语 it：意大利语 de：德语 tr：土耳其语 ru：俄语 pt：葡萄牙语 vi：越南语 id：印度尼西亚语 ms：马来语 th：泰语 ar：阿拉伯语 hi：印地语", "example": "en" }, { "name": "AutoAreas", "type": "array", "required": false, "description": "自动擦除自定义区域。 对选定区域，利用AI模型自动检测其中存在的擦除目标并擦除。 注意：当擦除方式选择custom时，此参数将不会生效；修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "string" }, { "name": "CustomAreas", "type": "array", "required": false, "description": "指定擦除自定义区域。 对选定区域，在选定时间段内不进行检测识别直接进行擦除。 注意：修改模板时，清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "string" } ] }, { "name": "EraseWatermarkConfig", "type": "object", "required": false, "description": "水印擦除配置； 当EraseType值为：watermark，此字段为必填参数", "example": "无", "children": [ { "name": "WatermarkEraseMethod", "type": "string", "required": false, "description": "水印擦除方式。 **自动擦除：**通过A模型自动识别视频中的水印，擦除后生成新的视频。适用于动态水印。 当使用自动擦除时，若您不指定AutoAreas，将对视频全屏进行自动擦除；若指定AutoAreas，将改为对您指定的区域进行自动擦除。 **指定区域擦除：**针对位置较固定的静态水印，建议您直接指定擦除区域。 当您选择指定区域擦除时，请至少传入一个指定区域。 - auto 自动擦\ufffd\ufffd...", "example": "auto" }, { "name": "WatermarkModel", "type": "string", "required": false, "description": "水印擦除模型。 基础版：效果一般，性价比高，适合动画或背景较干净的视频。 高级版：效果更好，适合短剧等现实风格视频。 - basic 基础版 - advanced 高级版", "example": "basic" }, { "name": "AutoAreas", "type": "array", "required": false, "description": "自动擦除自定义区域。 对选定区域，利用AI模型自动检测其中存在的擦除目标并擦除。 注意，当擦除方式为custom时，此参数将不会生效。清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "string" }, { "name": "CustomAreas", "type": "array", "required": false, "description": "指定擦除自定义区域。 对选定区域，在选定时间段内不进行检测识别直接进行擦除。 注意：清除区域请传入[]，不传时将保持模板区域信息不变。", "example": "无", "item_type": "string" } ] }, { "name": "ErasePrivacyConfig", "type": "object", "required": false, "description": "隐私保护配置； 当EraseType值为：privacy，此字段为必填参数", "example": "无", "children": [ { "name": "PrivacyModel", "type": "string", "required": false, "description": "隐私保护擦除方式。 - blur 模糊 - mosaic 马赛克", "example": "blur" }, { "name": "PrivacyTargets", "type": "array", "required": false, "description": "隐私保护目标，（在API Explorer上使用时无需传入数组，添加相应项并填入对应值即可）。 - face 人脸 - plate 车牌", "example": "[\"face\"]", "item_type": "string" } ] } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} **注意**：目前不支持`BatchProcessMedia`接口。", "example": "{inputName}_smarterase.{format}" } ] }, { "name": "TaskNotifyConfig", "type": "object", "required": false, "description": "任务的事件通知信息，不填代表不获取事件通知。", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型，可选值： CMQ：已下线，建议切换到TDMQ-CMQ TDMQ-CMQ：消息队列 URL：指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同解析事件通知接口的输出参数 SCF：不推荐使用，需要在控制台额外配置SCF AWS-SQS：AWS 队列，只适用于 AWS 任务，且要求同区域 注：不填或为空时默认 TDMQ-CMQ，如需采用其他类型需填写对应类型值；如果使用TDMQ-CMQ消息队列，任务\ufffd...", "example": "URL" }, { "name": "NotifyMode", "type": "string", "required": false, "description": "工作流通知的模式，可取值有 Finish 和 Change，不填代表 Finish。", "example": "Finish " }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的模型，有 Queue 和 Topic 两种。", "example": "Queue " }, { "name": "CmqRegion", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。", "example": "mps_notify" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。", "example": "mps_que" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "AWS SQS 回调，NotifyType为 AWS-SQS 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NULL", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的key。", "example": "0se***9idaY" } ] }, { "name": "TasksPriority", "type": "integer", "required": false, "description": "任务流的优先级，数值越大优先级越高，取值范围是-10到 10，不填代表0。", "example": "0" }, { "name": "SessionId", "type": "string", "required": false, "description": "用于去重的识别码，如果三天内曾有过相同的识别码的请求，则本次的请求会返回错误。最长 50 个字符，不传该参数或者参数为空字符串则本次请求不做去重操作。", "example": "85c94a33-6227-43d5-8179-69b0602f6346" }, { "name": "SessionContext", "type": "string", "required": false, "description": "来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。", "example": "userxxxx" }, { "name": "TaskType", "type": "string", "required": false, "description": "任务类型，默认Online Online：实时任务 Offline：闲时任务，不保证实效性，默认3天内处理完", "example": "Online" }, { "name": "ResourceId", "type": "string", "required": false, "description": "资源ID，需要保证对应资源是开启状态。默认为账号主资源ID。", "example": "vts-24000-0" }, { "name": "SkipMateData", "type": "integer", "required": false, "description": "是否跳过元信息获取，可选值： 0：表示不跳过 1：表示跳过 默认值：0", "example": "0" } ], "required": [ "InputInfo" ] }, { "name": "RecognizeAudio", "description": "同步接口，返回语音识别结果", "status": "online", "parameters": [ { "name": "AudioData", "type": "string", "required": true, "description": "base64编码的音频数据", "example": "KwDn/zIA5v///wUA0v8D" }, { "name": "Source", "type": "string", "required": false, "description": "识别目标语言，为空默认 auto 自动识别语种。 注：如果自动识别语种识别效果不佳，可以指定语种提高准确率 当前支持语言： auto: 自动识别 zh: 简体中文 en: 英语 ja: 日语 ko: 韩语 vi: 越南语 ms: 马来语 id: 印度尼西亚语 fil: 菲律宾语 th: 泰语 pt: 葡萄牙语 tr: 土耳其语 ar: 阿拉伯语 es: 西班牙语 hi: 印地语 fr: 法语 de: 德语 it: 意大利语 yue: 粤语 ru: 俄语 af: 南非荷兰语 sq: 阿尔巴尼亚...", "example": "zh" }, { "name": "AudioFormat", "type": "string", "required": false, "description": "音频数据格式，默认为 pcm 支持的格式： pcm (16000 采样率的单声道 16 位采样 pcm 数据) ogg-opus (16000 / 24000 / 48000 采样率的单声道 opus 编码的 ogg 数据)", "example": "pcm" }, { "name": "SampleRate", "type": "integer", "required": false, "description": "音频的采样率 支持的采样率： pcm 16000 ogg-opus 16000 / 24000 / 48000", "example": "16000" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "扩展参数，默认不填，特殊需求使用", "example": "{\"key\":1}" } ], "required": [ "AudioData" ] }, { "name": "RecognizeMediaForZhiXue", "description": "智能媒体识别，包含表情和动作识别。仅用于智学，其他调用无效。", "status": "online", "parameters": [ { "name": "InputInfo", "type": "object", "required": true, "description": "输入媒体文件存储信息。", "example": "{ \"Type\": \"COS\", \"CosInputInfo\": { \"Bucket\": \"TopVideo-125xxx88\", \"Region\": \"ap-chongqing\", \"Object\": \"/movie/test.mp4\" }", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输入来源对象的类型，支持： COS：COS源 URL：URL源 AWS-S3：AWS 源，目前只支持转码任务 VOD：点播专业版", "example": "NULL" }, { "name": "CosInputInfo", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 对象信息。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": true, "description": "媒体处理对象文件的输入路径，如`/movie/201907/WildAnimal.mov`。", "example": "/movie/201907/WildAnimal.mov" } ] }, { "name": "UrlInputInfo", "type": "object", "required": false, "description": "当 Type 为 URL 时有效，则该项为必填，表示媒体处理 URL 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频的 URL。", "example": "NULL" } ] }, { "name": "S3InputInfo", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-us-125678" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域，目前支持： us-east-1 eu-west-3 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1 " }, { "name": "S3Object", "type": "string", "required": true, "description": "S3 bucket 中的媒体资源路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/test.mp4" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bb5******eff" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bbc5******eff" } ] }, { "name": "VODInputInfo", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理对象文件所在的 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理对象文件所在的 Bucket 所属园区", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": false, "description": "媒体处理对象文件的输入路径", "example": "/movie/201907/WildAnimal.mov" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "ExpressionConfig", "type": "object", "required": false, "description": "表情识别参数配置。默认开启。", "example": "{\"Switch\": \"ON\"}", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "表情识别任务开关，可选值： ON：开启； OFF：关闭。", "example": "ON" } ] }, { "name": "ActionConfig", "type": "object", "required": false, "description": "动作识别参数配置。默认开启。", "example": "{\"Switch\": \"ON\"}", "children": [ { "name": "Switch", "type": "string", "required": true, "description": "动作识别任务开关，可选值： ON：开启； OFF：关闭。", "example": "ON" } ] } ], "required": [ "InputInfo" ] }, { "name": "ResetWorkflow", "description": "重新设置一个已经存在且处于禁用状态的工作流。", "status": "online", "parameters": [ { "name": "WorkflowId", "type": "integer", "required": true, "description": "工作流 ID。", "example": "10" }, { "name": "WorkflowName", "type": "string", "required": true, "description": "工作流名称，最多128字符。同一个用户该名称唯一。", "example": "“”" }, { "name": "Trigger", "type": "object", "required": true, "description": "工作流绑定的触发规则，当上传视频命中该规则到该对象时即触发工作流。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "触发器的类型，可选值： CosFileUpload：COS触发 AwsS3FileUpload：AWS触发，目前只支持转码任务。只有编排支持，工作流不支持。", "example": "CosFileUpload" }, { "name": "CosFileUploadTrigger", "type": "object", "required": false, "description": "当 Type 为 CosFileUpload 时必填且有效，为 COS 触发规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "工作流绑定的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "CosVideoFile-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "工作流绑定的 COS Bucket 所属园区，如 ap-chongiqng。", "example": "ap-nanjing" }, { "name": "Dir", "type": "string", "required": false, "description": "工作流绑定的输入路径目录，必须为绝对路径，即以 `/` 开头和结尾。如`/movie/201907/`，不填代表根目录`/`。", "example": "/trigger-dir/" }, { "name": "Formats", "type": "array", "required": false, "description": "支持的所有格式如下： - 视频文件扩展名，支持以下选择，共15种： `.mp4`、`.avi`、`.mov`、`.wmv`、`.flv`、`.mkv`、`.mpg`、`.mpeg`、`.rm`、`.rmvb`、`.asf`、`.3gp`、`.webm`、`.ts`、`.m4v` - 音频文件扩展名，支持以下选择，共7种： `.mp3`、`.wav`、`.aac`、`.flac`、`.ogg`、`.m4a`、`.amr` - 字幕文件扩展名，支持以下选择，共2种： `.vtt`、`.srt` - `*`：支持任意文件格式 - 不传或者传空列表：支持系统预设\ufffd\ufffd...", "example": "[\"mp4\",\"flv\",\"mov\"]", "item_type": "string" } ] }, { "name": "AwsS3FileUploadTrigger", "type": "object", "required": false, "description": "当 Type 为 AwsS3FileUpload 时必填且有效，为 AWS S3 触发规则。 注意：目前AWS的S3、对应触发队列SQS、回调队列SQS的秘钥需要一致。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "绑定的 AWS S3 存储桶。", "example": "mps-test-s3" }, { "name": "S3Region", "type": "string", "required": true, "description": "绑定的桶所在 AWS 区域，目前支持： us-east-1 eu-west-3", "example": "us-east-1 " }, { "name": "Dir", "type": "string", "required": false, "description": "绑定的输入路径目录，必须为绝对路径，即以 `/` 开头和结尾。如`/movie/201907/`，不填代表根目录`/`。", "example": "/Dir/" }, { "name": "Formats", "type": "array", "required": false, "description": "允许触发的文件格式列表，如 [\"mp4\", \"flv\", \"mov\"]。不填代表所有格式的文件都可以触发工作流。", "example": "[\"mp4\", \"flv\", \"mov\"]", "item_type": "string" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "绑定的 AWS S3 存储桶的秘钥ID。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "绑定的 AWS S3 存储桶的秘钥Key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "绑定的 AWS S3 存储桶对应的 SQS事件队列。 注意：队列和桶需要在同一区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] } ] } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "视频处理的文件输出配置。不填则继承 Trigger 中的存储位置。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 名，如 TopRankVideo-125xxx88。如果不填，表示继承上层。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区，如 ap-chongqing。如果不填，表示继承上层。", "example": "ap-chongqing" } ] }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-test" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKI**********5W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网上传 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "d6abvc123********ABCS" } ] }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理生成的文件输出的目标 Bucket 的园区", "example": "ap-chongqing" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "OutputDir", "type": "string", "required": false, "description": "视频处理生成的文件输出的目标目录，必选以 / 开头和结尾，如`/movie/201907/`。 如果不填，表示与触发文件所在的目录一致，即`{inputDir}`。", "example": "无" }, { "name": "MediaProcessTask", "type": "object", "required": false, "description": "视频处理类型任务参数。", "example": "无", "children": [ { "name": "TranscodeTaskSet", "type": "array", "required": false, "description": "视频转码任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频转码模板 ID。", "example": "20" }, { "name": "RawParameter", "type": "object", "required": false, "description": "视频转码自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定转码参数。", "example": "无", "children": [ { "name": "Container", "type": "string", "required": true, "description": "封装格式，可选值：mp4、flv、hls、mp3、flac、ogg、m4a。其中，mp3、flac、ogg、m4a 为纯音频文件。", "example": "mp4" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，取值： 0：保留； 1：去除。 默认值：0。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，取值： 0：保留； 1：去除。 默认值：0。", "example": "0" }, { "name": "VideoTemplate", "type": "object", "required": false, "description": "视频流配置参数，当 RemoveVideo 为 0，该字段必填。", "example": "无" }, { "name": "AudioTemplate", "type": "object", "required": false, "description": "音频流配置参数，当 RemoveAudio 为 0，该字段必填。", "example": "无" }, { "name": "TEHDConfig", "type": "object", "required": false, "description": "极速高清转码参数。", "example": "无" }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "扩展参数，序列化的 json 字符串。", "example": "{\"video_info\":{\"color_prim\":\"bt709\"}}" }, { "name": "EnhanceConfig", "type": "object", "required": false, "description": "音视频增强配置 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SubtitleTemplate", "type": "object", "required": false, "description": "字幕参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OverrideParameter", "type": "object", "required": false, "description": "视频转码自定义参数，当 Definition 不填 0 时有效。 当填写了该结构中的部分转码参数时，将使用填写的参数覆盖转码模板中的参数。 该参数用于高度定制场景，建议您仅使用 Definition 指定转码参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Container", "type": "string", "required": false, "description": "封装格式，可选值：mp4、flv、hls、mp3、flac、ogg、m4a。其中，mp3、flac、ogg、m4a 为纯音频文件。", "example": "mp4" }, { "name": "RemoveVideo", "type": "integer", "required": false, "description": "是否去除视频数据，取值： 0：保留； 1：去除。", "example": "0" }, { "name": "RemoveAudio", "type": "integer", "required": false, "description": "是否去除音频数据，取值： 0：保留； 1：去除。", "example": "0" }, { "name": "VideoTemplate", "type": "object", "required": false, "description": "视频流配置参数。", "example": "无" }, { "name": "AudioTemplate", "type": "object", "required": false, "description": "音频流配置参数。", "example": "无" }, { "name": "TEHDConfig", "type": "object", "required": false, "description": "极速高清转码参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SubtitleTemplate", "type": "object", "required": false, "description": "字幕流配置参数。", "example": "无" }, { "name": "AddonAudioStream", "type": "array", "required": false, "description": "外挂音轨参数。", "example": "无", "item_type": "string" }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "转码扩展字段。", "example": "{\"audio_info\": {\"codec\": \"vivid\"}}" }, { "name": "AddOnSubtitles", "type": "array", "required": false, "description": "要插入的字幕文件。", "example": "无", "item_type": "string" } ] }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板 ID。", "example": "NULL" }, { "name": "RawParameter", "type": "object", "required": false, "description": "水印自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。", "example": "NULL" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。", "example": "NULL" }, { "name": "SvgContent", "type": "string", "required": false, "description": "SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。 不填或填0，表示水印从画面开始就出现； 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。 注：只用于视频场景，截图不支持。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "水印的结束时间偏移，单位：秒。 不填或填0，表示水印持续到画面结束； 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。 注：只用于视频场景，截图不支持。", "example": "NULL" } ] }, { "name": "BlindWatermark", "type": "object", "required": false, "description": "数字水印参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "数字水印模板ID", "example": "10" } ] }, { "name": "MosaicSet", "type": "array", "required": false, "description": "马赛克列表，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "CoordinateOrigin", "type": "string", "required": false, "description": "原点位置，目前仅支持： TopLeft：表示坐标原点位于视频图像左上角，马赛克原点为图片或文字的左上角。 默认值：TopLeft。", "example": "NULL" }, { "name": "XPos", "type": "string", "required": false, "description": "马赛克原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式： 当字符串以 % 结尾，表示马赛克 XPos 为视频宽度指定百分比，如 10% 表示 XPos 为视频宽度的 10%； 当字符串以 px 结尾，表示马赛克 XPos 为指定像素，如 100px 表示 XPos 为 100 像素。 默认值：0px。", "example": "NULL" }, { "name": "YPos", "type": "string", "required": false, "description": "马赛克原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式： 当字符串以 % 结尾，表示马赛克 YPos 为视频高度指定百分比，如 10% 表示 YPos 为视频高度的 10%； 当字符串以 px 结尾，表示马赛克 YPos 为指定像素，如 100px 表示 YPos 为 100 像素。 默认值：0px。", "example": "NULL" }, { "name": "Width", "type": "string", "required": false, "description": "马赛克的宽度。支持 %、px 两种格式： 当字符串以 % 结尾，表示马赛克 Width 为视频宽度的百分比大小，如 10% 表示 Width 为视频宽度的 10%； 当字符串以 px 结尾，表示马赛克 Width 单位为像素，如 100px 表示 Width 为 100 像素。 默认值：10%。", "example": "NULL" }, { "name": "Height", "type": "string", "required": false, "description": "马赛克的高度。支持 %、px 两种格式： 当字符串以 % 结尾，表示马赛克 Height 为视频高度的百分比大小，如 10% 表示 Height 为视频高度的 10%； 当字符串以 px 结尾，表示马赛克 Height 单位为像素，如 100px 表示 Height 为 100 像素。 默认值：10%。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "马赛克的起始时间偏移，单位：秒。不填或填0，表示马赛克从画面出现时开始显现。 不填或填0，表示马赛克从画面开始就出现； 当数值大于0时（假设为 n），表示马赛克从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示马赛克从离画面结束 n 秒前开始出现。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "马赛克的结束时间偏移，单位：秒。 不填或填0，表示马赛克持续到画面结束； 当数值大于0时（假设为 n），表示马赛克持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示马赛克持续到离画面结束 n 秒前消失。", "example": "NULL" } ] }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "转码后的视频的起始时间偏移，单位：秒。 不填或填0，表示转码后的视频从原始视频的起始位置开始； 当数值大于0时（假设为 n），表示转码后的视频从原始视频的第 n 秒位置开始； 当数值小于0时（假设为 -n），表示转码后的视频从原始视频结束 n 秒前的位置开始。", "example": "1.0" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "转码后视频的终止时间偏移，单位：秒。 不填或填0，表示转码后的视频持续到原始视频的末尾终止； 当数值大于0时（假设为 n），表示转码后的视频持续到原始视频第 n 秒时终止； 当数值小于0时（假设为 -n），表示转码后的视频持续到原始视频结束 n 秒前终止。", "example": "15.0" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转码后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转码后主文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_transcode_{definition}.{format}`。", "example": "{inputName}_transcode_{definition}.{format}" }, { "name": "SegmentObjectName", "type": "string", "required": false, "description": "转码后分片文件的输出路径（转码 HLS 时 ts 的路径），只能为相对路径。如果不填，则默认为：`{inputName}_transcode_{definition}_{number}.{format}`。", "example": "{inputName}_transcode_{definition}_{number}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "转码后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InitialValue", "type": "integer", "required": false, "description": "`{number}`变量的起始值，默认为0。", "example": "0" }, { "name": "Increment", "type": "integer", "required": false, "description": "`{number}`变量的增长步长，默认为1。", "example": "1" }, { "name": "MinLength", "type": "integer", "required": false, "description": "`{number}`变量的最小长度，不足时补占位符。默认为1。", "example": "1" }, { "name": "PlaceHolder", "type": "string", "required": false, "description": "`{number}`变量的长度不足时，补充的占位符。默认为\"0\"。", "example": "0" } ] }, { "name": "HeadTailParameter", "type": "object", "required": false, "description": "片头片尾参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "HeadSet", "type": "array", "required": false, "description": "片头列表。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[ { \"Type\": \"URL\", \"UrlInputInfo\": { \"Url\": \"htt", "item_type": "string" }, { "name": "TailSet", "type": "array", "required": false, "description": "片尾列表。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[ { \"Type\": \"URL\", \"UrlInputInfo\": { \"Url\": \"htt", "item_type": "string" } ] } ] }, { "name": "AnimatedGraphicTaskSet", "type": "array", "required": false, "description": "视频转动图任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频转动图模板 ID。", "example": "20000" }, { "name": "StartTimeOffset", "type": "float", "required": true, "description": "动图在视频中的开始时间，单位为秒。", "example": "1.5" }, { "name": "EndTimeOffset", "type": "float", "required": true, "description": "动图在视频中的结束时间，单位为秒。", "example": "11.2" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转动图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转动图后文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_animatedGraphic_{definition}.{format}`。", "example": "文件名_{变量名}.{format}" } ] }, { "name": "SnapshotByTimeOffsetTaskSet", "type": "array", "required": false, "description": "对视频按时间点截图任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "指定时间点截图模板 ID。", "example": "11028" }, { "name": "ExtTimeOffsetSet", "type": "array", "required": false, "description": "截图时间点列表，时间点支持 s、% 两种格式： 当字符串以 s 结尾，表示时间点单位为秒，如 3.5s 表示时间点为第3.5秒； 当字符串以 % 结尾，表示时间点为视频时长的百分比大小，如10%表示时间点为视频前第10%的时间。", "example": "[\"3.5s\", \"50%\"]", "item_type": "string" }, { "name": "TimeOffsetSet", "type": "array", "required": false, "description": "截图时间点列表，单位为秒。此参数已不再建议使用，建议您使用 ExtTimeOffsetSet 参数。", "example": "[7.5, 10]", "item_type": "float" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板 ID。", "example": "NULL" }, { "name": "RawParameter", "type": "object", "required": false, "description": "水印自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。", "example": "NULL" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。", "example": "NULL" }, { "name": "SvgContent", "type": "string", "required": false, "description": "SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。 不填或填0，表示水印从画面开始就出现； 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。 注：只用于视频场景，截图不支持。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "水印的结束时间偏移，单位：秒。 不填或填0，表示水印持续到画面结束； 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。 注：只用于视频场景，截图不支持。", "example": "NULL" } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "时间点截图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "时间点截图后图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_snapshotByTimeOffset_{definition}_{number}.{format}`\ufffd...", "example": "/mps/output/{inputName}_test_{definition}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "时间点截图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InitialValue", "type": "integer", "required": false, "description": "`{number}`变量的起始值，默认为0。", "example": "0" }, { "name": "Increment", "type": "integer", "required": false, "description": "`{number}`变量的增长步长，默认为1。", "example": "1" }, { "name": "MinLength", "type": "integer", "required": false, "description": "`{number}`变量的最小长度，不足时补占位符。默认为1。", "example": "1" }, { "name": "PlaceHolder", "type": "string", "required": false, "description": "`{number}`变量的长度不足时，补充的占位符。默认为\"0\"。", "example": "0" } ] } ] }, { "name": "SampleSnapshotTaskSet", "type": "array", "required": false, "description": "对视频采样截图任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "采样截图模板 ID。", "example": "10" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板 ID。", "example": "NULL" }, { "name": "RawParameter", "type": "object", "required": false, "description": "水印自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。", "example": "NULL" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。", "example": "NULL" }, { "name": "SvgContent", "type": "string", "required": false, "description": "SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。 不填或填0，表示水印从画面开始就出现； 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。 注：只用于视频场景，截图不支持。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "水印的结束时间偏移，单位：秒。 不填或填0，表示水印持续到画面结束； 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。 注：只用于视频场景，截图不支持。", "example": "NULL" } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "采样截图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "采样截图后图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_sampleSnapshot_{definition}_{number}.{format}`。", "example": "/{inputName}_snapshotByTimeOffsetTest_{definition}_{number}.{format}" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "采样截图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InitialValue", "type": "integer", "required": false, "description": "`{number}`变量的起始值，默认为0。", "example": "0" }, { "name": "Increment", "type": "integer", "required": false, "description": "`{number}`变量的增长步长，默认为1。", "example": "1" }, { "name": "MinLength", "type": "integer", "required": false, "description": "`{number}`变量的最小长度，不足时补占位符。默认为1。", "example": "1" }, { "name": "PlaceHolder", "type": "string", "required": false, "description": "`{number}`变量的长度不足时，补充的占位符。默认为\"0\"。", "example": "0" } ] } ] }, { "name": "ImageSpriteTaskSet", "type": "array", "required": false, "description": "对视频截雪碧图任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "雪碧图模板 ID。", "example": "10001" }, { "name": "OutputStorage", "type": "object", "required": false, "description": "截取雪碧图后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "截取雪碧图后，雪碧图图片文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：`{inputName}_imageSprite_{definition}_{number}.{format...", "example": "xxx_imageSprite_10001_0.png" }, { "name": "WebVttObjectName", "type": "string", "required": false, "description": "截取雪碧图后，Web VTT 文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_imageSprite_{definition}.{format}`。", "example": "xxx_imageSprite_10001_0.vtt" }, { "name": "ObjectNumberFormat", "type": "object", "required": false, "description": "截取雪碧图后输出路径中的`{number}`变量的规则。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "InitialValue", "type": "integer", "required": false, "description": "`{number}`变量的起始值，默认为0。", "example": "0" }, { "name": "Increment", "type": "integer", "required": false, "description": "`{number}`变量的增长步长，默认为1。", "example": "1" }, { "name": "MinLength", "type": "integer", "required": false, "description": "`{number}`变量的最小长度，不足时补占位符。默认为1。", "example": "1" }, { "name": "PlaceHolder", "type": "string", "required": false, "description": "`{number}`变量的长度不足时，补充的占位符。默认为\"0\"。", "example": "0" } ] } ] }, { "name": "AdaptiveDynamicStreamingTaskSet", "type": "array", "required": false, "description": "转自适应码流任务列表。", "example": "NULL", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "转自适应码流模板 ID。", "example": "10" }, { "name": "WatermarkSet", "type": "array", "required": false, "description": "水印列表，支持多张图片或文字水印，最大可支持 10 张。", "example": "无", "item_type": "object", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "水印模板 ID。", "example": "NULL" }, { "name": "RawParameter", "type": "object", "required": false, "description": "水印自定义参数，当 Definition 填 0 时有效。 该参数用于高度定制场景，建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。", "example": "NULL" }, { "name": "TextContent", "type": "string", "required": false, "description": "文字内容，长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。", "example": "NULL" }, { "name": "SvgContent", "type": "string", "required": false, "description": "SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。", "example": "NULL" }, { "name": "StartTimeOffset", "type": "float", "required": false, "description": "水印的起始时间偏移，单位：秒。不填或填0，表示水印从画面出现时开始显现。 不填或填0，表示水印从画面开始就出现； 当数值大于0时（假设为 n），表示水印从画面开始的第 n 秒出现； 当数值小于0时（假设为 -n），表示水印从离画面结束 n 秒前开始出现。 注：只用于视频场景，截图不支持。", "example": "NULL" }, { "name": "EndTimeOffset", "type": "float", "required": false, "description": "水印的结束时间偏移，单位：秒。 不填或填0，表示水印持续到画面结束； 当数值大于0时（假设为 n），表示水印持续到第 n 秒时消失； 当数值小于0时（假设为 -n），表示水印持续到离画面结束 n 秒前消失。 注：只用于视频场景，截图不支持。", "example": "NULL" } ] }, { "name": "BlindWatermark", "type": "object", "required": false, "description": "数字水印参数 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "数字水印模板ID", "example": "10" } ] }, { "name": "OutputStorage", "type": "object", "required": false, "description": "转自适应码流后文件的目标存储，不填则继承上层的 OutputStorage 值。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "媒体处理输出对象存储位置的类型，支持： COS：COS存储 AWS-S3：AWS 存储，只适用于AWS任务，且要求同区域 VOD：点播专业版", "example": "NULL" }, { "name": "CosOutputStorage", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "S3OutputStorage", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "VODOutputStorage", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 输出位置。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" } ] }, { "name": "OutputObjectPath", "type": "string", "required": false, "description": "转自适应码流后，manifest 文件的输出路径，可以为相对路径或者绝对路径。 若需定义输出路径，路径需以`.{format}`结尾。变量名请参考 [文件名变量说明](https://cloud.tencent.com/document/product/862/37039)。 相对路径示例： 文件名_{变量名}.{format} 文件名.{format} 绝对路径示例： /自定义路径/文件名_{变量名}.{format} 如果不填，则默认为相对路径：{inputName}_adaptiveDynamicStreaming_{definition}.{format...", "example": "{inputName}_adaptiveDynamicStreaming_{definition}.{format}" }, { "name": "SubStreamObjectName", "type": "string", "required": false, "description": "转自适应码流后，子流文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}`。", "example": "{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}" }, { "name": "SegmentObjectName", "type": "string", "required": false, "description": "转自适应码流（仅 HLS）后，分片文件的输出路径，只能为相对路径。如果不填，则默认为相对路径：`{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}`。", "example": "{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}" }, { "name": "AddOnSubtitles", "type": "array", "required": false, "description": "外挂字幕功能，指定要插入的字幕文件。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "item_type": "object", "children": [ { "name": "Type", "type": "string", "required": false, "description": "插入形式，可选值： subtitle-stream：插入字幕轨道 close-caption-708：CEA-708字幕编码到SEI帧 close-caption-608：CEA-608字幕编码到SEI帧 注意：此字段可能返回 null，表示取不到有效值。", "example": "subtitle-stream" }, { "name": "Subtitle", "type": "object", "required": false, "description": "字幕文件。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SubtitleName", "type": "string", "required": false, "description": "字幕名称 。 注意：仅支持中文、英文、数字、空格、下划线(_)、短横线(-)、句点(.)和中英文括号，长度不能超过64个字符。 注意：此字段可能返回 null，表示取不到有效值。", "example": "字幕1" }, { "name": "OutputFormat", "type": "string", "required": false, "description": "字幕输出格式。取值{\"WebVTT\",\"TTML\"}。 默认值：\"WebVTT\"", "example": "WebVTT" }, { "name": "DefaultTrack", "type": "boolean", "required": false, "description": "默认字幕轨道。为true时指定当前字幕为默认字幕轨道，最多可指定1条默认字幕轨道。 默认值：false", "example": "false" } ] }, { "name": "DrmInfo", "type": "object", "required": false, "description": "Drm信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "加密类型： - simpleaes 只能用于HLS，切片格式支持ts和mp4 只能使用切片模式，不能使用singlefile模式 - fairplay： 只能用于HLS，切片格式只能是mp4 可以使用切片模式或singlefile模式 - widevine： 可以用于HLS和DASH，切片格式只能是mp4 输出HLS：可以使用切片模式或singlefile模式 输出DASH：只能singlefile模式 - playready： 可以用于HLS和DASH，切片格式只能是mp4 输出HLS：可以使用切片模式或singlefile...", "example": "widevine" }, { "name": "SimpleAesDrm", "type": "object", "required": false, "description": "SimpleAes 加密信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "SpekeDrm", "type": "object", "required": false, "description": "FairPlay，WideVine，PlayReady 加密信息。", "example": "无" } ] }, { "name": "DefinitionType", "type": "string", "required": false, "description": "自适应转码模板类型： Common：音视频类型 PureAudio：纯音频类型", "example": "Common" }, { "name": "SubtitleTemplate", "type": "object", "required": false, "description": "硬字幕（压制字幕）功能，指定字幕来源、字体大小、位置等字幕参数。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Path", "type": "string", "required": false, "description": "要压制到视频中的字幕文件地址。 注意：此字段可能返回 null，表示取不到有效值。", "example": "https://test-13xxxx46.cos.ap-nanjing.myqcloud.com/xxxxx/subtitle/1.srt" }, { "name": "StreamIndex", "type": "integer", "required": false, "description": "指定要压制到视频中的字幕轨道，Streamindex的取值从0开始，0表示使用源视频中的第一条字幕轨。如果指定了Path，则优先使用Path。Path 和 StreamIndex 至少指定一个。 - 注意：StreamIndex必须与源文件中的字幕轨索引一致。例如，源文件中的字幕轨为stream#0:3，则StreamIndex应为3，否则可能导致任务处理失败。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "SubtitleFileInput", "type": "object", "required": false, "description": "要压制到视频中的字幕文件的输入信息，目前仅支持存储在COS的字幕文件 注意：此字段可能返回 null，表示取不到有效值。", "example": "无" }, { "name": "FontFileInput", "type": "object", "required": false, "description": "压制字幕字体文件的输入信息，目前仅支持url和cos。都填时url优先于cos。填了FontFileInput时FontFileInput优先于FontType", "example": "无" }, { "name": "FontType", "type": "string", "required": false, "description": "字体类型，支持： hei.ttf：黑体 song.ttf：宋体 kai.ttf（推荐）或 simkai.ttf：楷体 msyh.ttf：微软雅黑 msyhbd.ttf：微软雅黑加粗 hkjgt.ttf：华康金刚体 dhttx.ttf：典黑体特细 xqgdzt.ttf：喜鹊古字典体 qpcyt.ttf：巧拼超圆体 arial.ttf：仅支持英文 dinalternate.ttf：DIN Alternate Bold helveticalt.ttf：Helvetica helveticains.ttf：Helvetica Inserat trajanpro.ttf：TrajanPro-Bold korean.ttf：韩语 japanese.ttf：日语 thai.ttf：泰语 默...", "example": "kai.ttf" }, { "name": "FontSize", "type": "string", "required": false, "description": "字体大小，不指定则以字幕文件中为准。支持像素和百分比格式： - 像素：Npx，N范围：(0,4096]。 - 百分百：N%，N范围：(0,100]；例如10%表示字幕字体大小=10%*源视频高度。 不填且字幕文件无设置时，默认源视频高度的5%。 注意：此字段可能返回 null，表示取不到有效值。", "example": "50px" }, { "name": "FontColor", "type": "string", "required": false, "description": "字体颜色，格式：0xRRGGBB，默认值：0xFFFFFF（白色）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0xFFFFFF" }, { "name": "FontAlpha", "type": "float", "required": false, "description": "文字透明度，取值范围：(0, 1] 0：完全透明 1：完全不透明 默认值：1。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1.0" }, { "name": "YPos", "type": "string", "required": false, "description": "字幕y轴坐标位置，指定此参数会忽略字幕文件自带坐标；支持像素和百分比格式： - 像素：Npx，N范围：[0,4096]。 - 百分百：N%，N范围：[0,100]；例如10%表示字幕y坐标=10%*源视频高度。 默认值：源视频高度*4%。 注意：坐标轴原点在源视频中轴线底部，字幕基准点在字幕中轴线底部，参考下图： ![image](https://ie-mps-1258344699.cos.ap-nanjing.tencentcos.cn/common/cloud/mps-demo/102_ai_subtitle/subtitle_sty...", "example": "4%" }, { "name": "BoardY", "type": "string", "required": false, "description": "字幕背景底板的y轴坐标位置；支持像素和百分比格式： - 像素：Npx，N范围：[0,4096]。 - 百分百：N%，N范围：[0,100]；例如10%表示字幕背景底板y坐标=10%*源视频高度。 不传表示不开启字幕背景底板。 注意：坐标轴原点位于源视频的中轴线底部，字幕背景底板的基准点在其中轴线底部，参考下图： ![image](https://ie-mps-1258344699.cos.ap-nanjing.tencentcos.cn/common/cloud/mps-demo/102_ai_subtitle/subtitle_...", "example": "1%" }, { "name": "BoardWidth", "type": "integer", "required": false, "description": "底板的宽度，正整数。 - 代表像素时，取值范围：[0,4096]。 - 代表百分数时，[0, 100]。 开启底板且不填此值时，默认源视频宽像素的90%。 注意：此字段可能返回 null，表示取不到有效值。", "example": "1920" }, { "name": "BoardHeight", "type": "integer", "required": false, "description": "底板的高度，正整数。 - 代表像素时，取值范围：[0,4096]。 - 代表百分数时，[0, 100]。 开启底板且不填此值时，默认为源视频高像素的15%。 注意：此字段可能返回 null，表示取不到有效值。", "example": "100" }, { "name": "BoardColor", "type": "string", "required": false, "description": "底板颜色。格式：0xRRGGBB， 默认值：0x000000（黑色）。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0x000000" }, { "name": "BoardAlpha", "type": "float", "required": false, "description": "字幕背景板透明度，取值范围：[0, 1] 0：完全透明 1：完全不透明 默认值：0.8。 注意：此字段可能返回 null，表示取不到有效值。", "example": "0.8" }, { "name": "OutlineWidth", "type": "float", "required": false, "description": "描边宽度。浮点数。 - 代表像素值时， [0, 1000]。 - 代表百分数时，[0, 100]。 不填默认源视频高度的0.3%。", "example": "1.0" }, { "name": "OutlineColor", "type": "string", "required": false, "description": "描边颜色。6位16进制RGB。不填默认黑色。", "example": "0x000000" }, { "name": "OutlineAlpha", "type": "float", "required": false, "description": "描边透明度。(0，1] 正浮点数。不填默认1，完全不透明", "example": "0.8" }, { "name": "ShadowWidth", "type": "float", "required": false, "description": "阴影宽度。浮点数。 - 代表像素值时， [0, 1000]。 - 代表百分数时，[0, 100]。 不填默认无阴影。", "example": "1.0" }, { "name": "ShadowColor", "type": "string", "required": false, "description": "阴影颜色。6位16进制RGB。不填默认黑色（有设置阴影的情况下）", "example": "0x000000" }, { "name": "ShadowAlpha", "type": "float", "required": false, "description": "阴影透明度。(0，1] 正浮点数。不填默认1，完全不透明（有设置阴影的情况下）", "example": "0.9" }, { "name": "LineSpacing", "type": "integer", "required": false, "description": "行间距。正整数。 - 代表像素值时， [0, 1000]。 - 代表百分数时，[0, 100]。不填默认0。", "example": "5" }, { "name": "Alignment", "type": "string", "required": false, "description": "对齐方式，取值：top: 顶部对齐，字幕顶部按位置固定，底部随行数变化。bottom: 底部对齐，字幕底部按位置固定，顶部随行数变化。不填默认底部对齐。", "example": "bottom" }, { "name": "BoardWidthUnit", "type": "integer", "required": false, "description": "默认0。为1时BoardWidth代表百分之几，以视频宽为基准", "example": "1" }, { "name": "BoardHeightUnit", "type": "integer", "required": false, "description": "默认0。为1时BoardHeight代表百分之几，以视频高为基准", "example": "1" }, { "name": "OutlineWidthUnit", "type": "integer", "required": false, "description": "默认0。为1时OutlineWidth代表百分之几，以视频高为基准", "example": "1" }, { "name": "ShadowWidthUnit", "type": "integer", "required": false, "description": "默认0。为1时ShadowWidth代表百分之几，以视频高为基准", "example": "1" }, { "name": "LineSpacingUnit", "type": "integer", "required": false, "description": "默认0。为1时LineSpacing代表百分之几，以视频高为基准", "example": "1" } ] }, { "name": "StdExtInfo", "type": "string", "required": false, "description": "转码参数扩展字段", "example": "{\"audio_info\": {\"codec\": \"vivid\"}}" }, { "name": "KeyPTSList", "type": "array", "required": false, "description": "指定pts时间的帧设为关键帧，并切片。单位毫秒（允许相对偏差\u003c=1ms）。当同时指定gop和切片时长时，会共同作用。注意需开启RawPts，保持帧率随源，并确保传入的pts时间在源中是有对应帧的。 注意：此字段可能返回 null，表示取不到有效值。", "example": "[1000, 2000]", "item_type": "integer" } ] } ] }, { "name": "AiContentReviewTask", "type": "object", "required": false, "description": "视频内容审核类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容审核模板 ID。", "example": "10" } ] }, { "name": "AiAnalysisTask", "type": "object", "required": false, "description": "视频内容分析类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频内容分析模板 ID。", "example": "28" }, { "name": "ExtendedParameter", "type": "string", "required": false, "description": "扩展参数，其值为序列化的 json字符串。 注意：此参数为定制需求参数，参考如下： [智能檫除](https://cloud.tencent.com/document/product/862/101530) [智能拆条](https://cloud.tencent.com/document/product/862/112098) [高光集锦](https://cloud.tencent.com/document/product/862/107280) [智能横转竖](https://cloud.tencent.com/document/product/862/112112) 注意：此字段可能返回 null，表示取不到有效值。", "example": "\"{\\\"htv\\\": {} }\"" } ] }, { "name": "AiRecognitionTask", "type": "object", "required": false, "description": "视频内容识别类型任务参数。", "example": "无", "children": [ { "name": "Definition", "type": "integer", "required": true, "description": "视频智能识别模板 ID 。", "example": "10" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "用户扩展字段，一般场景不用填。", "example": "{\"ParaTest\":\"test\"}" } ] }, { "name": "TaskPriority", "type": "integer", "required": false, "description": "工作流的优先级，数值越大优先级越高，取值范围是 -10 到 10，不填代表 0。", "example": "无" }, { "name": "TaskNotifyConfig", "type": "object", "required": false, "description": "任务的事件通知信息，不填代表不获取事件通知。", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型，可选值： CMQ：已下线，建议切换到TDMQ-CMQ TDMQ-CMQ：消息队列 URL：指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同解析事件通知接口的输出参数 SCF：不推荐使用，需要在控制台额外配置SCF AWS-SQS：AWS 队列，只适用于 AWS 任务，且要求同区域 注：不填或为空时默认 TDMQ-CMQ，如需采用其他类型需填写对应类型值；如果使用TDMQ-CMQ消息队列，任务\ufffd...", "example": "URL" }, { "name": "NotifyMode", "type": "string", "required": false, "description": "工作流通知的模式，可取值有 Finish 和 Change，不填代表 Finish。", "example": "Finish " }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的模型，有 Queue 和 Topic 两种。", "example": "Queue " }, { "name": "CmqRegion", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。", "example": "mps_notify" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。", "example": "mps_que" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "AWS SQS 回调，NotifyType为 AWS-SQS 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NULL", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的key。", "example": "0se***9idaY" } ] } ], "required": [ "WorkflowId", "WorkflowName", "Trigger" ] }, { "name": "StartStreamLinkFlow", "description": "启动媒体传输流。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "流Id。", "example": "01941bb7827509dc0f320a9d3426" } ], "required": [ "FlowId" ] }, { "name": "StopStreamLinkFlow", "description": "停止媒体传输流。", "status": "online", "parameters": [ { "name": "FlowId", "type": "string", "required": true, "description": "流Id。", "example": "01937702c54509dc0f3269ca341f" } ], "required": [ "FlowId" ] }, { "name": "SyncDubbing", "description": "同步接口，返回克隆音色Id或合成音频结果", "status": "online", "parameters": [ { "name": "Text", "type": "string", "required": false, "description": "合成文本，语音合成时必填，文本长度不超过2000字符", "example": "你好" }, { "name": "TextLang", "type": "string", "required": false, "description": "文本语言，不填默认中文。 当前支持语言： zh 中文 (Chinese) en 英语 (English) ja 日语 (Japanese) de 德语 (German) fr 法语 (French) ko 韩语 (Korean) ru 俄语 (Russian) uk 乌克兰语 (Ukrainian) pt 葡萄牙语 (Portuguese) it 意大利语 (Italian) es 西班牙语 (Spanish) id 印度尼西亚语 (Indonesian) nl 荷兰语 (Dutch) tr 土耳其语 (Turkish) fil 菲律宾语 (Filipino) ms 马来语 (Malay) el 希腊语 (Greek) fi 芬兰语 (Finnish) hr 克罗地亚语 ...", "example": "zh" }, { "name": "VoiceId", "type": "string", "required": false, "description": "音色Id，指定音色合成时填写，支持系统音色和克隆音色。", "example": "s1_2GSzVAf00hl7+A+LJTNvVI6nFJB0qliIvR8wntPeaniVSstd7Z4E4UL8Hky3azMHVlDSps1zWW4nJ7ll9w==" }, { "name": "AudioData", "type": "string", "required": false, "description": "克隆音频base64编码。", "example": "UklGRoxnAABXQVZFZm10IBAAAAABAAEAgD4AAAB9AAACABAAZGF0YWhnAABBAEUAQwBFAEcARwBKAEsASABLAEsASQBNAEoASQBMAEwASwBNAE0ASwBLAEsATABKAEoASwBLAEwASgBLAEwA" }, { "name": "AudioLang", "type": "string", "required": false, "description": "克隆音频语言，默认中文。 当前支持语言同TextLang", "example": "zh" }, { "name": "ExtParam", "type": "string", "required": false, "description": "扩展参数，json字符串", "example": "{\"engine\": \"\"}" } ], "required": [] }, { "name": "TextTranslation", "description": "文本翻译", "status": "online", "parameters": [ { "name": "SourceText", "type": "string", "required": true, "description": "待翻译的文本，文本统一使用utf-8格式编码，非utf-8格式编码字符会翻译失败，请传入有效文本，html标记等非常规翻译文本可能会翻译失败。单次请求的文本长度需要低于2000字符。", "example": "hello" }, { "name": "Source", "type": "string", "required": true, "description": "源语言，支持： \"auto\": \"自动识别（识别为一种语言）\", \"ab\": \"阿布哈兹语\", \"ace\": \"亚齐语\", \"ach\": \"阿乔利语\", \"af\": \"南非荷兰语\", \"ak\": \"契维语（阿坎语）\", \"am\": \"Amharic\", \"ar\": \"阿拉伯语\", \"as\": \"阿萨姆语\", \"ay\": \"艾马拉语\", \"az\": \"阿塞拜疆语\", \"ba\": \"巴什基尔语\", \"ban\": \"巴厘语\", \"bbc\": \"巴塔克托巴语\", \"bem\": \"Bemba\", \"bew\": \"Betawi\", \"bg\": \"保加利亚语\", \"bho\": \"博杰普尔语\", \"bik\": \"Bikol\", \"bm\": \"班巴拉\ufffd\ufffd...", "example": "en" }, { "name": "Target", "type": "string", "required": true, "description": "目标语言，支持： \"ab\": \"阿布哈兹语\", \"ace\": \"亚齐语\", \"ach\": \"阿乔利语\", \"af\": \"南非荷兰语\", \"ak\": \"契维语（阿坎语）\", \"am\": \"Amharic\", \"ar\": \"阿拉伯语\", \"as\": \"阿萨姆语\", \"ay\": \"艾马拉语\", \"az\": \"阿塞拜疆语\", \"ba\": \"巴什基尔语\", \"ban\": \"巴厘语\", \"bbc\": \"巴塔克托巴语\", \"bem\": \"Bemba\", \"bew\": \"Betawi\", \"bg\": \"保加利亚语\", \"bho\": \"博杰普尔语\", \"bik\": \"Bikol\", \"bm\": \"班巴拉语\", \"bn\": \"孟加拉语\", \"br\": \"布列塔尼语...", "example": "zh" }, { "name": "UserExtPara", "type": "string", "required": false, "description": "用户拓展参数", "example": "用户扩展字段" } ], "required": [ "SourceText", "Source", "Target" ] }, { "name": "WithdrawsWatermark", "description": "提取视频中的盲水印。", "status": "online", "parameters": [ { "name": "InputInfo", "type": "object", "required": true, "description": "输入媒体文件存储信息。", "example": "无", "children": [ { "name": "Type", "type": "string", "required": true, "description": "输入来源对象的类型，支持： COS：COS源 URL：URL源 AWS-S3：AWS 源，目前只支持转码任务 VOD：点播专业版", "example": "NULL" }, { "name": "CosInputInfo", "type": "object", "required": false, "description": "当 Type 为 COS 时有效，则该项为必填，表示媒体处理 COS 对象信息。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 名，如 TopRankVideo-125xxx88。", "example": "TopRankVideo-125xxx88" }, { "name": "Region", "type": "string", "required": true, "description": "媒体处理对象文件所在的 COS Bucket 所属园区，如 ap-chongqing。", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": true, "description": "媒体处理对象文件的输入路径，如`/movie/201907/WildAnimal.mov`。", "example": "/movie/201907/WildAnimal.mov" } ] }, { "name": "UrlInputInfo", "type": "object", "required": false, "description": "当 Type 为 URL 时有效，则该项为必填，表示媒体处理 URL 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Url", "type": "string", "required": true, "description": "视频的 URL。", "example": "NULL" } ] }, { "name": "S3InputInfo", "type": "object", "required": false, "description": "当 Type 为 AWS-S3 时有效，则该项为必填，表示媒体处理 AWS S3 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "S3Bucket", "type": "string", "required": true, "description": "S3 bucket。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps-us-125678" }, { "name": "S3Region", "type": "string", "required": true, "description": "S3 bucket 对应的区域，目前支持： us-east-1 eu-west-3 注意：此字段可能返回 null，表示取不到有效值。", "example": "us-east-1 " }, { "name": "S3Object", "type": "string", "required": true, "description": "S3 bucket 中的媒体资源路径。 注意：此字段可能返回 null，表示取不到有效值。", "example": "/test.mp4" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bb5******eff" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "AWS 内网访问 媒体资源的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "6bbc5******eff" } ] }, { "name": "VODInputInfo", "type": "object", "required": false, "description": "当 Type 为 VOD 时有效，则该项为必填，表示媒体处理 点播专业版 对象信息。 注意：此字段可能返回 null，表示取不到有效值。", "example": "无", "children": [ { "name": "Bucket", "type": "string", "required": false, "description": "媒体处理对象文件所在的 *Bucket ID*", "example": "a00ehq6ocdmo0exn" }, { "name": "Region", "type": "string", "required": false, "description": "媒体处理对象文件所在的 Bucket 所属园区", "example": "ap-chongqing" }, { "name": "Object", "type": "string", "required": false, "description": "媒体处理对象文件的输入路径", "example": "/movie/201907/WildAnimal.mov" }, { "name": "SubAppId", "type": "integer", "required": false, "description": "点播专业版应用Id", "example": "220762" } ] } ] }, { "name": "TaskNotifyConfig", "type": "object", "required": false, "description": "任务的事件通知信息，不填代表不获取事件通知。", "example": "无", "children": [ { "name": "NotifyType", "type": "string", "required": false, "description": "通知类型，可选值： CMQ：已下线，建议切换到TDMQ-CMQ TDMQ-CMQ：消息队列 URL：指定URL时HTTP回调推送到 NotifyUrl 指定的地址，回调协议http+json，包体内容同解析事件通知接口的输出参数 SCF：不推荐使用，需要在控制台额外配置SCF AWS-SQS：AWS 队列，只适用于 AWS 任务，且要求同区域 注：不填或为空时默认 TDMQ-CMQ，如需采用其他类型需填写对应类型值；如果使用TDMQ-CMQ消息队列，任务\ufffd...", "example": "URL" }, { "name": "NotifyMode", "type": "string", "required": false, "description": "工作流通知的模式，可取值有 Finish 和 Change，不填代表 Finish。", "example": "Finish " }, { "name": "NotifyUrl", "type": "string", "required": false, "description": "HTTP回调地址，NotifyType为URL时必填。", "example": "http://www.qq.com/callback" }, { "name": "CmqModel", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的模型，有 Queue 和 Topic 两种。", "example": "Queue " }, { "name": "CmqRegion", "type": "string", "required": false, "description": "CMQ或TDMQ-CMQ 的园区，如 sh，bj 等。", "example": "sh" }, { "name": "TopicName", "type": "string", "required": false, "description": "当模型为 Topic 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。", "example": "mps_notify" }, { "name": "QueueName", "type": "string", "required": false, "description": "当模型为 Queue 时有效，表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。", "example": "mps_que" }, { "name": "AwsSQS", "type": "object", "required": false, "description": "AWS SQS 回调，NotifyType为 AWS-SQS 时必填。 注意：此字段可能返回 null，表示取不到有效值。", "example": "NULL", "children": [ { "name": "SQSRegion", "type": "string", "required": true, "description": "SQS 队列区域。 注意：此字段可能返回 null，表示取不到有效值。", "example": "ap-southeast-1" }, { "name": "SQSQueueName", "type": "string", "required": true, "description": "SQS 队列名称。 注意：此字段可能返回 null，表示取不到有效值。", "example": "mps123_s3_sqs" }, { "name": "S3SecretId", "type": "string", "required": false, "description": "读写SQS的秘钥id。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" }, { "name": "S3SecretKey", "type": "string", "required": false, "description": "读写SQS的秘钥key。 注意：此字段可能返回 null，表示取不到有效值。", "example": "AKIA*******123W" } ] }, { "name": "NotifyKey", "type": "string", "required": false, "description": "用于生成回调签名的key。", "example": "0se***9idaY" } ] }, { "name": "SessionContext", "type": "string", "required": false, "description": "来源上下文，用于透传用户请求信息，任务流状态变更回调将返回该字段值，最长 1000 个字符。", "example": "UserDefinedInfo" } ], "required": [ "InputInfo" ] } ] }