调用 `GetExecution` 接口指定 `RunId` 获取媒体处理任务执行结果。 ## 注意事项 * 本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见 [QPS 限制](https://www.volcengine.com/docs/4/1333456)。 * 当前仅支持查询 **30 天**内的任务。 ## 请求说明 - 请求方式：**GET** - 请求地址：**https://vod.volcengineapi.com?Action=GetExecution&Version=2025-01-01** ## 调试 ## 请求参数下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见[公共请求参数](https://www.volcengine.com/docs/4/4357#%E8%AF%B7%E6%B1%82%E5%8F%82%E6%95%B0)。 ### Query | 参数 | 类型 | 是否必选 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | ---- | | Action | String | 是 | `GetExecution` | 接口名称。当前 API 的名称为 `GetExecution`。 | | Version | String | 是 | `2025-01-01` | 接口版本。当前 API 支持的版本为 `2025-01-01` 和 `2023-07-01`。推荐使用 `2025-01-01` 版本。 | | RunId | String | 是 | `hb:ebd05bee1f3873***f7316c742b5f` | 执行 ID。用于唯一指示当前这次媒体处理任务。可通过 StartExecution 接口的返回参数获取。 | #{.custom-md-table-5}# ## 返回参数下表仅列出本接口特有的返回参数。更多信息请见[公共返回参数](https://www.volcengine.com/docs/4/4357#%E5%85%AC%E5%85%B1%E8%BF%94%E5%9B%9E%E5%8F%82%E6%95%B0)。 | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | RunId | String | `c5cacd4946bd880a5fd9f74159b03ae8` | 执行 ID。 | | Status | String | `Success` | 任务状态。取值如下： |\ | | | | - `Success`：任务成功 |\ | | | | |\ | | | | - `Failed`：任务失败 |\ | | | | |\ | | | | - `PendingStart`：任务排队中 |\ | | | | |\ | | | | - `Running`：任务执行中 |\ | | | | |\ | | | | - `Terminated`：任务被终止 | | Meta | Object of [ExecutionMeta](#executionmeta) | `-` | 任务元信息。 | | Control | Object of [RuntimeControl](#runtimecontrol) | `-` | 任务控制配置。 | | Input | Object of [Input](#input) | `-` | 任务输入文件信息。 | | MultiInputs | Array of [Input](#input) | `-` | 输入文件信息数组。 | | Operation | Object of [Operation](#operation) | `-` | 媒体处理操作配置。 | | Output | Object of [Output](#output) | `-` | 任务输出文件信息。 | | Code | String | `InternalError` | 任务错误码。具体取值如下： |\ | | | | * `InvalidParameter.InvalidMediaStream`：解析音视频流失败 |\ | | | | * `InvalidParameter.MissingMediaStream`：缺少音视频流 |\ | | | | * `InvalidParameter.InvalidUriError`：用户地址非法 |\ | | | | * `InvalidParameter.MissingSubtitleStream`：缺少字幕流 |\ | | | | * `InvalidParameter.InvalidParam`：参数错误 |\ | | | | * `InvalidParameter.InvalidVidOrUri`：输入源不存在 |\ | | | | * `InternalError`：内部错误 |\ | | | | * `InternalError.DownloadError`：系统下载错误 |\ | | | | * `InternalError.UploadError`：系统上传错误 |\ | | | | * `InternalError.ExecutionTimeout`：执行超时 | | SpaceName | String | `test` | 点播空间名。您可通过以下方式获取空间名称： |\ | | | | * 在视频点播控制台[空间管理页面](https://console.volcengine.com/vod/overview/)查看当前账号下所有空间的名称。 |\ | | | | * 调用 [ListSpace](https://www.volcengine.com/docs/4/107686) 接口获取当前账号下所有空间的名称。 |\ | | | | :::warning |\ | | | | 当 `Input` 和 `MultiInputs` 参数均为空时（如视频生成任务场景），此参数为必填项。 |\ | | | | ::: | #{.custom-md-table-4}# ### ExecutionMeta | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | SpaceName | String | `docspace` | 点播空间名称。 | | Trigger | String | `API` | 任务来源。取值如下： |\ | | | | - `API`：调用接口触发 |\ | | | | - `AutoTrigger`：上传自动触发 |\ | | | | - `TranscodeStrategy`：转码策略触发 | | CreateTime | String | `2025-01-23T10:05:54Z` | 任务创建时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。 | | StartTime | String | `2025-01-23T10:05:55Z` | 任务开始时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。 | | EndTime | String | `2025-01-23T10:08:17Z` | 任务结束时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。 | #{.custom-md-table-4}# ### RuntimeControl | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | ClientToken | String | `QqS3o5L4BLFCDxGZ&b` | 用户请求凭证，用于区分不同请求。大小写敏感，不超过 64 个 ASCII 码可打印字符。默认情况下，视频点播转码服务在接收到触发工作流请求后，会执行幂等行为。这意味着，如果判定当前请求与之前发送的请求相同，则不会重复执行该请求。关于幂等行为、目的和条件，请参考[工作流幂等说明](https://www.volcengine.com/docs/4/1218689)。若您希望跳过幂等行为，例如修改了某一工作流所绑定的媒体处理模板中的配置，想要对同一个 Vid 重新执行相同的工作流，则可以设置此参数。 | | CallbackArgs | String | `Example` | 自定义字段，将在[媒体处理任务执行完成](https://www.volcengine.com/docs/4/1283222)事件中透传返回。字段长度最大为 512 字节。 | | Priority | Integer | `0` | 任务优先级。默认值为 0。取值范围为 \[-5,5\]。数字越大，优先级越高。 | | EnableLowPriority | Boolean | `true` | 是否开启闲时转码。取值如下： |\ | | | | - `true`：开启。 |\ | | | | - `false`：关闭。 |\ | | | | :::tip |\ | | | | 对于闲时转码功能的介绍和使用场景，请见[闲时转码](https://www.volcengine.com/docs/4/99791)。 |\ | | | | ::: | #{.custom-md-table-4}# ### Input | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `Vid` | 输入文件类型。取值如下： |\ | | | | * `Vid`：Vid 模式。此模式下，您还需设置 `Vid` 参数。 |\ | | | | * `DirectUrl`：DirectUrl 模式。此模式下，您还需设置 `DirectUrl` 参数。 |\ | | | | * `FileId`: FileId 模式。此模式下，您还需设置 `FileId` 参数。 |\ | | | | :::warning |\ | | | | * 仅**巨量广告预审任**务支持 FileId 模式。 |\ | | | | * **文件删除任务**仅支持 DirectUrl 模式。 |\ | | | | ::: | | Vid | String | `v0ccfeg7007acsg***fog65ubr7niqng` | 待处理视频的 Vid。您需要在调用本接口前，通过任一方式将视频[上传](https://www.volcengine.com/docs/4/2887?lang=zh)至点播空间，并获取其 `Vid`。 |\ | | | | :::warning |\ | | | | 您必须设置 `Vid`、`DirectUrl` 或 `FileId` 参数之一，但不能同时设置这三个参数。 |\ | | | | ::: | | DirectUrl | Object of [DirectUrl](#directurl) | `-` | 通过 DirectUrl 模式指定待处理视频的信息。您需要在调用本接口前，通过任一方式将视频[上传](https://www.volcengine.com/docs/4/2887?lang=zh)至点播空间，并获取其相关信息。 |\ | | | | :::warning |\ | | | | 您必须设置 `Vid`、`DirectUrl` 或 `FileId` 参数之一，但不能同时设置这三个参数。 |\ | | | | ::: | | FileId | Object of [FileIdInfo](#fileidinfo) | `-` | 转码产物 ID 信息。 |\ | | | | :::warning |\ | | | | 您必须设置 `Vid`、`DirectUrl` 或 `FileId` 参数之一，但不能同时设置这三个参数。 |\ | | | | ::: | | Tag | String | `FirstFrame` | 标识输入的类型，用于区分不同场景下的输入内容。支持的取值如下： |\ | | | | * `FirstFrame`：视频生成任务中表示输入图片作为视频首帧。 |\ | | | | * `LastFrame`：视频生成任务中表示输入图片使用视频尾帧。仅 doubao-seedance-lite 模型支持使用图片作为尾帧生成视频。 |\ | | | | * `ImageSet`：OCR 提取字幕任务中表示输入为图集。 | | Schema | String | `Template` | 动态输入 Schema，用于启用任务串联功能，将前一个任务的输出结果，动态地作为下一个任务的输入，例如实现“先视频生成，再对生成结果进行超分”这类链式处理流程。如需启用任务串联功能，您需将 `Schema` 参数的值设置为 `Template`，再在 `Input` 对象的其他字段（如 `Vid`, `DirectUrl.FileName`）中使用 [Go Template](https://pkg.go.dev/text/template#Template.Option) 语法来引用上游节点的输出。详细使用说明，请见[使用动态输入 Schema 实现任务串联](https://www.volcengine.com/docs/4/1923423?lang=zh)。 | #{.custom-md-table-4}# ### Operation | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `Task` | 处理类型。取值如下： |\ | | | | - `Template`：单模板任务。 |\ | | | | - `Task`：单任务。 |\ | | | | - `Workflow`: 工作流任务。 | | Task | Object of [OperationTask](#operationtask) | `-` | 单任务配置。当 `Type` 为 `Task` 时需要设置此参数。 | | Template | Object of [OperationTemplate](#operationtemplate) | `-` | 单模板任务配置。当 `Type` 为 `Template` 时需要设置此参数。 | | Workflow | Object of [OperationWorkflow](#operationworkflow) | `-` | 工作流任务配置。当 `Type` 为 `Workflow` 时需要设置此参数。 | #{.custom-md-table-4}# ### Output | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `Task` | 任务类型： |\ | | | | - `Task`：单任务输出结果。 |\ | | | | - `Template`：单模板任务输出结果。 |\ | | | | - `Workflow`: 工作流任务输出结果。 | | Template | Object of [OutputTemplate](#outputtemplate) | `-` | 单模板任务输出结果。 | | Task | Object of [OutputTask](#outputtask) | `-` | 单任务输出结果。 | | Workflow | Object of [OutputWorkflow](#outputworkflow) | `-` | 工作流任务输出结果。 | #{.custom-md-table-4}# ### DirectUrl | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | SpaceName | String | `test` | 空间名称。可调用 [ListSpace](https://www.volcengine.com/docs/4/107686) 获取当前账号下所有空间的信息。 | | FileName | String | `example.mp4` | 文件路径。音视频上传至视频点播服务后，您可通过[媒资上传完成事件](https://www.volcengine.com/docs/4/4655)获取 `FileName`。 | | BucketName | String | `tos-cn-v-cd3a11` | 存储桶名称。可调用 [ListSpace](https://www.volcengine.com/docs/4/107686) 获取空间所绑定的存储桶名称。 | #{.custom-md-table-4}# ### FileIdInfo | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Vid | String | `v0ccfeg7007acsg***fog65ubr7niqng` | 视频 ID。音视频上传至视频点播服务后，您可通过[媒资上传完成事件](https://www.volcengine.com/docs/4/4655)获取 `Vid`。 | | FileId | String | `v02b69g10***ldb8vjafvmg` | 转码产物文件 ID。可通过 [GetMediaInfos](https://www.volcengine.com/docs/4/1256363) 接口从返回参数 `TranscodeInfos` 中获取转码产物的文件 ID。 | #{.custom-md-table-4}# ### OperationTask | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `Highlight` | 任务类型： |\ | | | | * `Highlight`: 高光智剪任务。 |\ | | | | * `AdAudit`: 巨量广告预审任务。 |\ | | | | * `AudioExtract`: 人声背景音分离任务。 |\ | | | | * `Vision`: 长视频理解任务。 |\ | | | | * `Asr`: ASR 提取字幕任务。 |\ | | | | * `Storyline`: 故事线分析任务。 |\ | | | | * `Segment`: 场景切分任务。 |\ | | | | * `Ocr`: OCR 提取字幕任务。 |\ | | | | * `Erase`: 精细化字幕擦除任务。 |\ | | | | * `Enhance`: 画质增强任务。 |\ | | | | * `FileDelete`: 文件删除任务。 |\ | | | | * `VideoSummary`: 视频分段摘要任务。 |\ | | | | * `VideoGeneration`：视频生成任务。 |\ | | | | * `VideoUnderstanding`：长视频理解任务（支持在视频理解时进行场景切分）。 |\ | | | | * `VideoMatting`：智能抠图任务。 | | Highlight | Object of [OperationTaskHighlight](#operationtaskhighlight) | `-` | 高光智剪任务配置。当 `Type` 为 `Highlight`时需要设置此参数。 | | Vision | Object of [OperationTaskVision](#operationtaskvision) | `-` | 视频理解任务配置。当 `Type` 为 `Vision`时需要设置此参数。 | | AdAudit | Object of [OperationTaskAdAudit](#operationtaskadaudit) | `-` | 巨量广告预审任务配置。当 `Type` 为 `AdAudit` 时需要设置此参数。 | | AudioExtract | Object of [OperationTaskAudioExtract](#operationtaskaudioextract) | `-` | 人声背景音分离任务配置。当 `Type` 为 `AudioExtract` 时需要设置此参数。 | | Asr | Object of [OperationTaskAsr](#operationtaskasr) | `-` | ASR 提取字幕任务配置。当 `Type` 为 `Asr`时需要设置此参数。 | | Storyline | Object of [OperationTaskStoryline](#operationtaskstoryline) | `-` | 故事线分析任务配置。当 `Type` 为 `Storyline` 时需要设置此参数。 | | Ocr | Object of [OperationTaskOcr](#operationtaskocr) | `-` | OCR 提取字幕任务配置。当 `Type` 为 `Ocr`时需要设置此参数。 | | Erase | Object of [OperationTaskErase](#operationtaskerase) | `-` | 精细化字幕擦除任务配置。当 `Type` 为 `Erase` 时需要设置此参数。 | | Enhance | Object of [VolcEnhanceTaskParams](#volcenhancetaskparams) | `-` | 画质增强任务配置。当 `Type` 为 `Enhance` 时需要设置此参数。 | | Segment | Object of [OperationTaskSegment](#operationtasksegment) | `-` | 场景切分任务配置。当 `Type` 为 `Segment` 时需要设置此参数。 | | FileDelete | Object of [OperationTaskFileDelete](#operationtaskfiledelete) | `-` | 文件删除任务配置。当 `Type` 为 `FileDelete` 时需要设置此参数。 | | VideoMatting | Object of [OperationTaskVideoMatting](#operationtaskvideomatting) | `-` | 智能抠图任务配置。当 `Type` 为 `VideoMatting` 时需要设置此参数。 | | VideoSummary | Object of [OperationTaskVideoSummary](#operationtaskvideosummary) | `-` | 视频分段摘要任务配置。当 `Type` 为 `VideoSummary` 时需要设置此参数。 | | VideoGeneration | Object of [OperationTaskVideoGeneration](#operationtaskvideogeneration) | `-` | 视频生成任务配置。当 `Type` 为 `VideoGeneration` 时需要设置此参数。 | | VideoUnderstanding | Object of [OperationTaskVideoUnderstanding](#operationtaskvideounderstanding) | `-` | 视频理解任务配置。当 `Type` 为 `VideoUnderstanding` 时需要设置此参数。 | #{.custom-md-table-4}# ### OperationTemplate | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `TranscodeVideo` | 单模板任务类型。取值如下： |\ | | | | - `TranscodeVideo`：视频转码模板任务。 |\ | | | | - `ByteHD`：极智超清模板任务。 |\ | | | | - `TranscodeAudio`：音频转码模板任务。 |\ | | | | - `Enhance`：画质增强模板任务。 | | TranscodeVideo | Object of [OperationTemplateTranscodeVideo](#operationtemplatetranscodevideo) | `-` | 视频转码模板任务配置。当 `Type` 取值为 `TranscodeVideo` 时，需要设置此参数。 | | ByteHD | Object of [OperationTemplateByteHD](#operationtemplatebytehd) | `-` | 极智超清模板任务配置。当 `Type` 取值为 `ByteHD` 时，需要设置此参数。 | | TranscodeAudio | Object of [OperationTemplateTranscodeAudio](#operationtemplatetranscodeaudio) | `-` | 音频转码模板任务配置。当 `Type` 取值为 `TranscodeAudio` 时，需要设置此参数。 | | Enhance | Object of [OperationTemplateEnhance](#operationtemplateenhance) | `-` | 画质增强模板任务配置。当 `Type` 取值为 `Enhance` 时，需要设置此参数。 | #{.custom-md-table-4}# ### OperationWorkflow | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Nodes | Array of [OperationWorkflowNode](#operationworkflownode) | `-` | 工作流节点定义。 | #{.custom-md-table-4}# ### OutputTemplate | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `TranscodeVideo` | 单模板任务类型。取值如下： |\ | | | | - `TranscodeVideo`：视频转码模板任务。 |\ | | | | - `ByteHD`：极智超清模板任务。 |\ | | | | - `TranscodeAudio`：音频转码模板任务。 |\ | | | | - `Enhance`：画质增强模板任务。 | | TranscodeVideo | Object of [TranscodeInfo](#transcodeinfo) | `-` | 视频转码模板任务输出。仅当 `Type` 取值为 `TranscodeVideo` 时，返回该参数。 | | ByteHD | Object of [TranscodeInfo](#transcodeinfo) | `-` | 极智超清模板任务输出。仅当 `Type` 取值为 `ByteHD` 时，返回该参数。 | | TranscodeAudio | Object of [TranscodeInfo](#transcodeinfo) | `-` | 音频转码模板任务输出。仅当 `Type` 取值为 `TranscodeAudio` 时，返回该参数。 | | Enhance | Object of [TranscodeInfo](#transcodeinfo) | `-` | 画质增强模板任务输出。仅当 `Type` 取值为 `Enhance` 时，返回该参数。 | #{.custom-md-table-4}# ### OutputTask | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `Highlight` | 任务类型： |\ | | | | * `Highlight`: 高光智剪任务。 |\ | | | | * `AdAudit`: 巨量广告预审任务。 |\ | | | | * `AudioExtract`: 人声背景音分离任务。 |\ | | | | * `Vision`: 长视频理解任务。 |\ | | | | * `Asr`: ASR 提取字幕任务。 |\ | | | | * `Storyline`: 故事线分析任务。 |\ | | | | * `Segment`: 场景切分任务。 |\ | | | | * `Ocr`: OCR 文本识别任务。 |\ | | | | * `Erase`: 精细化字幕擦除任务。 |\ | | | | * `Enhance`: 画质增强任务。 |\ | | | | * `FileDelete`: 文件删除任务。 |\ | | | | * `VideoSummary`: 视频分段摘要任务。 |\ | | | | * `VideoGeneration`：视频生成任务。 |\ | | | | * `VideoUnderstanding`：长视频理解任务（支持在视频理解时进行场景切分）。 |\ | | | | * `VideoMatting`：智能抠图任务。 | | Highlight | Object of [OutputTaskHighlight](#outputtaskhighlight) | `-` | 高光智剪任务输出结果。 | | AudioExtract | Object of [OutputTaskAudioExtract](#outputtaskaudioextract) | `-` | 人声背景音分离任务输出结果。 | | Vision | Object of [OutputTaskVision](#outputtaskvision) | `-` | 视频理解任务输出结果。 | | AdAudit | Object of [OutputTaskAdAudit](#outputtaskadaudit) | `-` | 巨量广告预审任务输出结果。 | | Storyline | Object of [OutputTaskStoryline](#outputtaskstoryline) | `-` | 故事线分析任务输出结果。 | | Asr | Object of [OutputTaskAsr](#outputtaskasr) | `-` | 语音转写任务输出结果。 | | Segment | Object of [OutputTaskSegment](#outputtasksegment) | `-` | 场景切分任务输出结果。 | | Ocr | Object of [OutputTaskOcr](#outputtaskocr) | `-` | OCR 文本识别任务输出结果。 | | Erase | Object of [OutputTaskErase](#outputtaskerase) | `-` | 精细化字幕擦除任务输出结果。 | | Enhance | Object of [TranscodeInfo](#transcodeinfo) | `-` | 画质增强任务输出结果。 | | FileDelete | Object of [OutputTaskFileDelete](#outputtaskfiledelete) | `-` | 文件删除任务输出结果。 | | VideoMatting | Object of [OutputVideoMatting](#outputvideomatting) | `-` | 智能抠图任务输出结果。 | | VideoSummary | Object of [OutputTaskVideoSummary](#outputtaskvideosummary) | `-` | 视频分段摘要任务输出结果。 | | VideoGeneration | Object of [OutputTaskVideoGeneration](#outputtaskvideogeneration) | `-` | 视频生成任务输出结果。 | | VideoUnderstanding | Object of [OutputVideoUnderstanding](#outputvideounderstanding) | `-` | 视频理解任务输出结果。 | #{.custom-md-table-4}# ### OutputWorkflow | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Nodes | Array of [OperationWorkflowNodeOutput](#operationworkflownodeoutput) | `-` | 工作流中各节点的输出结果。 | #{.custom-md-table-4}# ### OperationTaskHighlight | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Model | String | `Miniseries` | 高光智剪任务所使用的模型类型，用于指定视频内容的分析模式。支持的取值如下： |\ | | | | * `Miniseries`：（默认）短剧模型。 |\ | | | | * `Game`: 游戏模型。本模式不支持多输入。 | | Mode | String | `StorylineCuts` | 高光智剪任务的模式： |\ | | | | * 当 `Model` 为 `Miniseries` 时，支持以下取值： |\ | | | | * `StorylineCuts`：故事线混剪模式，在高光片段模式基础上融入故事线信息。 |\ | | | | * 当 `Model` 为 `Game` 时，支持以下取值： |\ | | | | * `MiniGame`：小游戏模式 | | Edit | Object of [OperationTaskHighlightEdit](#operationtaskhighlightedit) | `-` | 剪辑成片配置。仅当 `Mode` 为 `StorylineCuts` 时生效。配置此参数后，系统将在高光分析完成后，直接基于分析结果自动剪辑并输出高光视频，而不仅仅是返回分析数据。 | | HighlightCuts | Object of [OperationTaskHighlightCuts](#operationtaskhighlightcuts) | `-` | 高光片段配置。仅当 `Model` 取值为 `Miniseries` 且 `Mode` 为 `StorylineCuts`时生效。 | | OpeningHook | Object of [OperationTaskHighlightOpeningHook](#operationtaskhighlightopeninghook) | `-` | 精彩前置功能配置。开启精彩前置功能后，系统将自动分析并提取视频中最精彩的片段，将其置于视频开头，以吸引观众。仅当 `Model` 取值为 `Miniseries` 且 `Mode` 为 `StorylineCuts`时生效。 | | MiniGame | Object of [OperationTaskHighlightMiniGame](#operationtaskhighlightminigame) | | 小游戏分析配置。仅当 `Model` 取值为 `Game` 且 `Mode` 取值为 `MiniGame` 时生效。 | #{.custom-md-table-4}# ### OperationTaskVision | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Prompt | String | `\n# 角色\n你是一个视频理解的专家，擅长理解和分析视频。\n\n# 任务\n输入的内容是从爆火网络视频中总结的视频分段描述文本和视频音频转译的文本，请根据输入的内容理解视频，并详细描述一下视频的内容.\n\n# 视频分段描述文本\n{{PLACEHOLDER_VIDEO_CLIP_RESULT}}\n\n# 视频转音频文本\n{{PLACEHOLDER_ASR_RESULT}}` | 大模型提示词。使用 UTF-8 编码。长度不可超过 30000 个字符。根据 `Model` 参数所配置的视频理解模式，提示词中需包含相应占位符： |\ | | | | * **VLM + LLM 模式**：需包含以下两个占位符 |\ | | | | * `{{PLACEHOLDER_ASR_RESULT}}`：控制是否启用 ASR（语音识别）。 |\ | | | | * `{{PLACEHOLDER_VIDEO_CLIP_RESULT}}`：控制是否进行视频切片。 |\ | | | | * **仅 VLM 或仅 LLM 模式**：只需包含 `{{PLACEHOLDER_ASR_RESULT}}`占位符。 | | Model | Object of [OperationTaskVisionModel](#operationtaskvisionmodel) | `-` | 大模型配置。您可通过此参数配置对视频的理解模式。支持以下三种模式： |\ | | | | * **纯视觉理解（仅 VLM）**：适用于需要分析视频画面内容的场景（如不超过 10 分钟的短视频）。会进行视频截图，建议截图分辨率设为 240p 以获得更多截图。推荐使用支持 128k 及以上上下文的模型（如 `doubao-seed-1.6-thinking`）。 |\ | | | | * **纯音频理解（仅LLM）**：适用于无需理解视频画面内容的场景（如演讲视频等）。 |\ | | | | * **多模态理解（VLM+LLM）**：适用于长视频理解（最长支持 2 小时）。会将长视频切分成多个片段，使用 VLM 分别理解每个片段，最后用 LLM 汇总各片段理解结果。 | | Segment | Object of [OperationTaskVisionSegment](#operationtaskvisionsegment) | `-` | 视频分段理解配置。用于指定视频理解任务的起始和结束时间。若不设置 `Start`，则默认从视频开头开始；若不设置 `End`，则默认到视频结尾结束。`End` 要大于 `Start`。 | | SnapshotParam | Object of [OperationTaskVisionSnapshotParam](#operationtaskvisionsnapshotparam) | `-` | 截图策略配置。视频理解处理过程中会对视频进行截图。默认截图策略为均匀时间间隔截图最多 50 张。若您需要更改截图策略，可传入此参数。 | | NeedAsrSpeaker | Boolean | `true` | 是否在 ASR（语音识别）结果中包含说话人信息并用于大模型的推理。默认值为 `false`。 |\ | | | | * `true`：包含说话人信息并用于推理，需要 `AsrAppType` 为录音识别大模型 `volc.bigasr.auc_turbo` 才生效； |\ | | | | * `false`：不包含说话人信息。 | | ResponseFormatType | String | `json_object` | 指定视频理解结果的输出格式。支持的取值如下： |\ | | | | * `""`：默认值，不产生任何效果，大模型输出的格式由 Prompt 中指定。 |\ | | | | * `json_object`：大模型会参考 Prompt 中指定的 JSON 格式稳定输出准确的 JSON 格式。 | #{.custom-md-table-4}# ### OperationTaskAdAudit | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | AdvertiserId | String | `18202155***64928` | 广告主 ID。 | | BusinessType | String | `ad` | 广告投放渠道： |\ | | | | - `ad`：[巨量广告](https://ad.oceanengine.com/pages/login/index.html) |\ | | | | - `qianchuan`：[巨量千川](https://bytedance.larkoffice.com/docx/KD9rdtXAsorh2vxZMOOcDu2jntc?bk_entity_id=enterprise_43198424) |\ | | | | - `local_life`：[巨量本地推](https://bytedance.larkoffice.com/docx/CtYkdaJPtoHZbCxug8ycr3fLno9) | #{.custom-md-table-4}# ### OperationTaskAudioExtract | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Voice | Boolean | `true` | 是否提取人声。 | #{.custom-md-table-4}# ### OperationTaskAsr | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `speech` | 识别类型，取值如下： |\ | | | | - `speech`: 对话 |\ | | | | - `singing`: 歌唱 | | Language | String | `cmn-Hans-CN` | 识别提示语言，取值如下： |\ | | | | - `cmn-Hans-CN`: 简体中文 |\ | | | | - `cmn-Hant-CN`: 繁体中文 |\ | | | | - `eng-US`: 英语 |\ | | | | - `jpn-JP`: 日语 |\ | | | | - `kor-KR`: 韩语 |\ | | | | - `rus-RU`: 俄语 |\ | | | | - `fra-FR`: 法语 |\ | | | | - `por-PT`: 葡萄牙语 |\ | | | | - `spa-ES`: 西班牙语 |\ | | | | - `vie-VN`: 越南语 |\ | | | | - `mya-MM`: 缅甸语 |\ | | | | - `nld-NL`: 荷兰语 |\ | | | | - `deu-DE`: 德语 |\ | | | | - `ind-ID`: 印尼语 |\ | | | | - `ita-IT`: 意大利语 |\ | | | | - `pol-PL`: 波兰语 |\ | | | | - `tha-TH`: 泰语 |\ | | | | - `tur-TR`: 土耳其语 |\ | | | | - `ara-SA`: 阿拉伯语 |\ | | | | - `msa-MY`: 马来语 |\ | | | | - `ron-RO`: 罗马尼亚语 |\ | | | | - `fil-PH`: 菲律宾语 |\ | | | | - `hin-IN`: 印地语 | | WithSpeakerInfo | Boolean | `true` | 是否开启使说话人识别功能。开启后，会通过返回参数 `speaker` 返回说话人信息。 | | WithConfidence | Boolean | `true` | 是否返回置信度。如设为 `true`，会通过返回参数 `Confidence` 返回置信度。 | | Mode | String | `-` | 工作模式。缺省为标准模式。 |\ | | | | :::warning |\ | | | | 使用其它模式需[提交工单](https://console.volcengine.com/ticket/createTicketV2/?step=2&Service=vod)联系火山引擎技术支持团队申请。 |\ | | | | ::: | #{.custom-md-table-4}# ### OperationTaskStoryline | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | WithSnapshot | Boolean | `true` | 是否开启视频截图。取值如下： |\ | | | | - `true`：开启。 |\ | | | | - `false`：（默认）关闭。 | | ClipDuration | Double | `60` | 视频片段预期时长，取值范围为 10 至 90 秒。若未填写此值，默认时长为 30 秒。最终输出的片段会尽量趋近于所设定的值。 | #{.custom-md-table-4}# ### OperationTaskOcr | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | WithImageSet | Boolean | `true` | 当输入为 Vid 时，是否对视频中的图集进行 OCR 识别。若视频中无图集，则返回空的识别结果。 |\ | | | | :::warning |\ | | | | 使用前请[提交工单](https://console.volcengine.com/ticket/createTicketV2/?step=2&Service=vod)联系火山引擎技术支持团队申请开通白名单。 |\ | | | | ::: | | Mode | String | `-` | 工作模式。决定了 OCR 识别结果的输出粒度和维度。OCR 算法会自动识别视频画面中的所有文本，并将其分类为“字幕”或“其它”（如 LOGO、水印、场景文字等）。支持的取值如下： |\ | | | | * `Subtitle`（默认）：**字幕模式**。仅在任务结果中返回被识别为“字幕”类型的文本内容。适用于快速提取对话的场景。 |\ | | | | * `Detailed`：**详细模式**。在任务结果中输出所有被识别到的文本（包含“字幕”和“其它”全部类型）。此外，该模式还会额外输出每文本的类别标签及在画面中的位置信息。适用于内容安全审核、画面深度分析等精细化场景。 |\ | | | | :::warning |\ | | | | 使用其它模式需[提交工单](https://console.volcengine.com/ticket/createTicketV2/?step=2&Service=vod)联系火山引擎技术支持团队申请。 |\ | | | | ::: | #{.custom-md-table-4}# ### OperationTaskErase | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Mode | String | `Auto` | 字幕擦除模式，取值如下： |\ | | | | - `Auto`：自动擦除模式。在此模式下，系统将启用 OCR 识别，并依据检测结果进行擦除操作。 |\ | | | | - `Manual`：(Beta) 手动擦除模式。在此模式下，系统不会启用 OCR 识别，仅擦除白色字幕内容。 |\ | | | | :::tip |\ | | | | 不同模式的用途及适用场景说明如下： |\ | | | | - 一般情况下，可将 `Mode` 设置为 `Auto`，再将 `Auto.Type` 设置为 `Subtitle`（仅字幕）或 `Text`（字幕和其它渲染文本），以擦除指定类型的文本。 |\ | | | | - 若您对擦除区域有特殊需求，可通过设置 `Locations` 来指定擦除框，仅擦除框内经 OCR 识别的文本。 |\ | | | | - 在需要擦除**中英文外的小语种字幕**的场景中，可将 `Mode` 设置为 `Manual`，并设置 `Locations` 来指定擦除框。 |\ | | | | ::: | | Auto | Object of [OperationTaskEraseAuto](#operationtaskeraseauto) | `-` | 自动擦除模式配置 | | Manual | Object of [OperationTaskEraseManual](#operationtaskerasemanual) | `-` | 手动擦除模式配置 | | WithEraseInfo | Boolean | `true` | 是否返回擦除信息详情 | | NewVid | Boolean | `true` | 是否为擦除后的视频生成一个新的 `Vid`。 | | EraseOption | Object of [OperationTaskEraseOption](#operationtaskeraseoption) | `-` | 擦除选项。可用于指定仅对视频的特定时间片段进行或跳过字幕擦除，实现更精细的控制。 | | VideoOption | Object of [OperationTaskEraseVideoOption](#operationtaskerasevideooption) | `-` | 视频编码配置，用于指定字幕擦除后生成视频的编码方式。 | #{.custom-md-table-4}# ### VolcEnhanceTaskParams | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `Moe` | 增强模型类型。默认为 `Custom`。 |\ | | | | * `Custom`: 自定义增强模型。您需要通过 `Modules` 参数，手动组合一个或多个独立的增强算子（如超分、插帧等）。 |\ | | | | * `Moe`:（推荐）场景化增强模型。您需要通过 `MoeEnhance` 参数选择一个针对特定场景（如短剧、AIGC 等）的预设模板，系统会自动应用最优的算子组合。 | | Modules | Array of [VolcEnhanceParam](#volcenhanceparam) | `-` | 自定义增强算子列表。当 `Type` 为 `Custom` 时，此参数为必填，用于配置一个或多个独立的增强模块。 | | MoeEnhance | Object of [VolcMoeEnhanceParam](#volcmoeenhanceparam) | `-` | 场景化增强配置。当 `Type` 为 `Moe` 时，此参数为必填。 | #{.custom-md-table-4}# ### OperationTaskSegment | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | NoFile | Boolean | `true` | 是否生成切片文件： |\ | | | | - `true`: 不生成切片文件 |\ | | | | - `false`:（默认）生成切片文件 | | ClipFade | Boolean | `true` | 是否将检测到的淡入/淡出片段作为独立的切片输出。 |\ | | | | * `false`:（默认）不独立输出。淡入/淡出片段会被视为其前后场景的一部分，合并到相邻的切片中。 |\ | | | | * `true`: 独立输出。如果视频中存在明显的淡入/淡出过渡，系统会将其分割成一个独立的切片。 | | Threshold | Double | `10` | 场景切分的敏感度阈值。取值范围为 `[0, 100]`。 |\ | | | | * 取值越低，算法对场景变化的感知越敏感，切分出的片段越多。 |\ | | | | * 取值越高，算法越倾向于将微小的变化视为同一场景，切分出的片段越少。 |\ | | | | 当您同时设置 `MinDuration`, `MaxDuration` 和 `Threshold` 时，系统会按照以下两阶段逻辑进行切分，以确保所有约束都得到满足： |\ | | | | 1. 算法首先会根据您设置的 `Threshold` 和 `MinDuration` 进行切分。 |\ | | | | 2. 第一阶段切分完毕后，如发现有切片的时长超过您设置的 `MaxDuration`，系统会忽略 `Threshold` 的影响，再进行切分，确保最终时长都不超过 `MaxDuration`。 | | MaxDuration | Double | `30` | 单个切片的最大时长，单位为秒，无默认值。系统会确保最终生成的任何切片时长都不高于此值。 | | MinDuration | Double | `3` | 单个切片的最小时长，单位为秒，无默认值。系统会确保最终生成的任何切片时长都不低于此值。 | #{.custom-md-table-4}# ### OperationTaskFileDelete | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | SkipError | Boolean | `true` | 在多输入的情况下，当单个文件删除失败时，是否忽略错误继续删除剩余文件。默认值为 `false`，即终止文件删除并返回错误。 | #{.custom-md-table-4}# ### OperationTaskVideoMatting | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Model | String | `Human` | 抠图模型，支持的取值如下： |\ | | | | * `Human`：人像抠图。可从复杂场景中识别人像主体并将其抠出，适用于背景替换等场景。 |\ | | | | * `GreenScreen`：绿幕抠图。专门用于处理在绿幕前拍摄的视频。 | | VideoOption | Object of [OperationTaskVideoMattingVideoOption](#operationtaskvideomattingvideooption) | `-` | 视频生成配置。用于指定抠图后输出视频的封装格式等参数。如不传 `VideoOption` ，则默认生成 WEBM 格式视频。 | | NewVid | Boolean | `true` | 是否生成新的 Vid： |\ | | | | * `true`：为抠图后生成的视频分配一个新的 Vid。 |\ | | | | * `false`：（默认）不生成新的 Vid。 | #{.custom-md-table-4}# ### OperationTaskVideoSummary | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | OnlyTimeline | Boolean | `true` | 是否仅输出时间线。默认为 `false`，生成的视频分段摘要中，将包含时间、阶段主题、阶段摘要、阶段细节信息。若 `OnlyTimeline` 设置为 `true`，则结果中仅返回时间段信息，即大模型仅进行分段，不生成摘要。 | | ExtraDescription | String | `本视频为医学教学视频，按照相关知识点对视频进行分段` | 补充任务提示词。默认为空。建议您在效果不达预期时，通过本字段在任务 Prompt 中补充信息。不超过 1000 字符。 | | BestSegmentDuration | Integer | `180` | 期望的视频分段时长，单位为秒，默认值为 180。 |\ | | | | :::tip |\ | | | | 最终输出的分段视频时长可能不会与您所设置的 `BestSegmentDuration` 严格相符。 |\ | | | | ::: | #{.custom-md-table-4}# ### OperationTaskVideoGeneration | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Prompt | String | `生成一段展示城市夜景的视频，包含闪烁的霓虹灯和流动的车流。` | 视频生成任务的提示词，用于指导大模型生成视频内容。字符长度限制为 [1,500]。 | | NewVid | Boolean | `true` | 是否为大模型生成的视频生成新的 `Vid`： |\ | | | | * `true`：为生成的视频分配一个新的 `Vid`。 |\ | | | | * `false`：（默认）不会生成新的 `Vid`。 | | VideoOption | Object of [OperationTaskVideoGenerationVideoOption](#operationtaskvideogenerationvideooption) | `-` | 视频生成配置。 | #{.custom-md-table-4}# ### OperationTaskVideoUnderstanding | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Prompt | String | `-` | 视频理解任务的提示词。使用 UTF-8 编码。长度不可超过 30000 个字符。 | | WithSegment | Boolean | `true` | 是否开启场景切分。开启后，系统会依据转场情况对输入视频进行切分，并输出切片。 | | Segment | Object of [OperationTaskVideoUnderstandingSegment](#operationtaskvideounderstandingsegment) | `-` | 场景切分配置。 | | Model | Object of [OperationTaskVideoUnderstandingModel](#operationtaskvideounderstandingmodel) | `-` | 模型参数。 | #{.custom-md-table-4}# ### OperationTemplateTranscodeVideo | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | TemplateId | String | `ddc7d66386***6056a` | 视频转码模板 ID。可在视频点播控制台创建模板并获取模板 ID，详见[视频转码模板](https://www.volcengine.com/docs/4/65682)。 | | WatermarkTemplateId | String | `v0dc24g10***c1cepmu6g` | 水印贴片模板 ID。若设置此参数，系统会在转码过程中将不同形式的水印以数据元素的形式和原视频画面融合和拼接，输出带水印的新视频文件。可在视频点播控制台创建模板并获取模板 ID，详见[水印贴片模板](https://www.volcengine.com/docs/4/65686)。 | #{.custom-md-table-4}# ### OperationTemplateByteHD | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | TemplateId | String | `ddc66386***6056a` | 极智超清模板 ID。可在视频点播控制台创建模板并获取模板 ID，详见[极智超清模板](https://www.volcengine.com/docs/4/165177)。 | | WatermarkTemplateId | String | `v0dc24g10***c1cepmu6g` | 水印贴片模板 ID。若设置此参数，系统会在转码过程中将不同形式的水印以数据元素的形式和原视频画面融合和拼接，输出带水印的新视频文件。可在视频点播控制台创建模板并获取模板 ID，详见[水印贴片模板](https://www.volcengine.com/docs/4/65686)。 | #{.custom-md-table-4}# ### OperationTemplateTranscodeAudio | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | TemplateId | String | `ddc7d66386***6056a` | 音频转码模板 ID。可在视频点播控制台创建模板并获取模板 ID，详见[音频转码模板](https://www.volcengine.com/docs/4/65683)。 | #{.custom-md-table-4}# ### OperationTemplateEnhance | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | TemplateId | String | `ddc7d66386***6056a` | 画质增强模板 ID。可在视频点播控制台创建模板并获取模板 ID，详见[画质增强模板](https://www.volcengine.com/docs/4/117971)。 | #{.custom-md-table-4}# ### OperationWorkflowNode | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Name | String | `FileDelete` | 节点名称。工作流中的节点不能有重复命名。 | | Input | Object of [Input](#input) | `-` | 媒体处理任务的输入文件信息。默认采用外层的 `Input` 或 `MultiInputs`作为工作流节点中任务的输入。若在此处进行指定，则会使用此处指定的输入。 | | MultiInputs | Array of [Input](#input) | `-` | 媒体处理任务的输入文件信息数组。默认采用外层的 `Input` 或 `MultiInputs`作为工作流节点中任务的输入。若在此处进行指定，则会使用此处指定的输入。 | | Operation | Object of [WorkflowOperation](#workflowoperation) | `-` | 节点媒体处理操作配置。 | | Dependencies | Array of String | `["Ocr","Asr"]` | 所依赖的节点名称。 | | Policy | Object of [OperationWorkflowNodePolicy](#operationworkflownodepolicy) | `-` | 节点执行策略配置。 | | SpaceName | String | `test` | 点播空间名。您可通过以下方式获取空间名称： |\ | | | | * 在视频点播控制台[空间管理页面](https://console.volcengine.com/vod/overview/)查看当前账号下所有空间的名称。 |\ | | | | * 调用 [ListSpace](https://www.volcengine.com/docs/4/107686) 接口获取当前账号下所有空间的名称。 |\ | | | | :::warning |\ | | | | 当 `Input` 和 `MultiInputs` 参数均为空时（如视频生成任务场景），此参数为必填项。 |\ | | | | ::: | #{.custom-md-table-4}# ### TranscodeInfo | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | FileId | String | `v02b69g10***ldb8vjafvmg` | 文件 ID。 | | Md5 | String | `4d4a***803b23e` | 文件 MD5 值。 | | FileType | String | `video` | 文件类型，取值如下： |\ | | | | - `video`：（默认）非加密视频 |\ | | | | - `audio`：非加密音频 |\ | | | | - `private_evideo`: 私有加密视频（新版） |\ | | | | - `private_eaudio`: 私有加密音频（新版） |\ | | | | - `standard_evideo`: HLS 标准加密视频 |\ | | | | - `standard_eaudio`: HLS 标准加密音频 |\ | | | | - `evideo`：加密视频（旧版） |\ | | | | - `eaudio`：加密音频（旧版） | | LogoType | String | `aa` | 水印贴片标签。即您在视频点播控制台创建水印贴片模板时配置的自定义水印贴片标签，详见[水印贴片模板](https://www.volcengine.com/docs/4/65686)。 | | Encrypt | Boolean | `true` | 是否加密。取值如下： |\ | | | | - `true`：加密。 |\ | | | | - `false`：不加密。 | | Format | String | `MP4` | 编码格式。 | | Duration | Float | `10.04` | 转码流时长，单位为秒。 | | Size | Double | `1449027` | 文件大小，单位为字节。 | | StoreUri | String | `tos-vod--v-3***b28/main.m3u8` | 文件存储地址。 | | VideoStreamMeta | Object of [VideoStreamMeta](#videostreammeta) | `-` | 视频流信息。 | | AudioStreamMeta | Object of [AudioStreamMeta](#audiostreammeta) | `-` | 音频流信息。 | | CreateTime | String | `2025-01-14T09:13:06Z` | 文件创建时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。 | | DynamicRange | String | `HDR` | 动态范围。取值如下： |\ | | | | - `HDR`：高动态范围 |\ | | | | - `SDR`：标准动态范围 | | TosStorageClass | String | `STANDARD` | 文件存储类型。取值如下： |\ | | | | - `STANDARD`：标准存储 |\ | | | | - `ARCHIVE`：归档存储 |\ | | | | - `IA`：低频存储 | | EncodedType | String | `default` | 加密类型： |\ | | | | - `default`: 非加密 |\ | | | | |\ | | | | - `encrypt`: 加密 | | Encryption | Object of [TranscodeEncryption](#transcodeencryption) | `-` | 加密信息 | #{.custom-md-table-4}# ### OutputTaskHighlight | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Duration | Double | `75.093333` | 输入视频总时长，单位为秒。 | | Clips | Array of [HighlightClip](#highlightclip) | `-` | 高光片段信息。当请求参数 `Highlight.Mode` 为 `Clips`（高光片段模式）时返回。 | | Edits | Array of [MediaFileInfo](#mediafileinfo) | `-` | 自动剪辑产物信息。当您在请求参数中配置了 `Highlight.Edit` 时，此字段会返回自动剪辑生成的高光视频的信息。 | | HighlightCuts | Object of [OutputTaskHighlightCuts](#outputtaskhighlightcuts) | `-` | 高光片段信息。当请求参数 `Highlight.Mode` 为 `StorylineCuts`（混剪模式）时返回。 | | StorylineCuts | Object of [OutputTaskHighlightStorylineCuts](#outputtaskhighlightstorylinecuts) | `-` | 混剪信息。当请求参数 `Highlight.Mode` 为 `StorylineCuts`（混剪模式）时返回。 | #{.custom-md-table-4}# ### OutputTaskAudioExtract | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Duration | Double | `152.085` | 视频时长，单位为秒。 | | Voice | Object of [MediaFileInfo](#mediafileinfo) | `-` | 人声文件信息。 | | Background | Object of [MediaFileInfo](#mediafileinfo) | `-` | 剥离人声后的背景声文件信息。 | #{.custom-md-table-4}# ### OutputTaskVision | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Duration | Double | `70.1` | 视频时长，单位为秒。 | | SnapshotsNumber | Integer | `50` | 截图张数。 | | Model | Object of [OutputTaskVisionModelUsage](#outputtaskvisionmodelusage) | `-` | 视频理解任务大模型用量。 | | Content | String | `视频展示的是xxx。以下是视频的具体内容xxx` | 视频理解结果。 | | Mode | String | | | #{.custom-md-table-4}# ### OutputTaskAdAudit | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Status | String | `AuditResult__PASS` | 审核状态： |\ | | | | - `AuditResult__PASS`: 审核通过 |\ | | | | - `AuditResult__REJECT`: 审核不通过 | | Code | Integer | `1000127` | 拒绝码。内部参数，暂不生效。 | | Reason | String | `您好，素材中不得涉及虚假宣传或误导用户的内容xxx` | 审核建议。 | | Label | Array of Integer | `["10139"]` | 审核流控标。内部参数，暂不生效。 | | Duration | Double | `152.085` | 视频时长，单位为秒。 | #{.custom-md-table-4}# ### OutputTaskStoryline | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Duration | Double | `1801.1` | 输入视频总时长，单位为秒。 | | Summaries | Array of String | `-` | 视频简介。 | | AllTags | Array of [OutputTaskStorylineTags](#outputtaskstorylinetags) | `-` | 视频标签。 | | Storylines | Array of [OutputTaskStorylineItem](#outputtaskstorylineitem) | `-` | 高光片段信息。 | | Clips | Array of [OutputTaskStorylineClip](#outputtaskstorylineclip) | `-` | 视频片段信息。 | | Titles | Array of String | `-` | 视频标题。 | #{.custom-md-table-4}# ### OutputTaskAsr | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Duration | Double | `70.1` | 视频时长，单位为秒。 | | Confidence | Double | `Float` | 置信度。 | | Utterances | Array of [Utterance](#utterance) | `-` | 声音信息。 | #{.custom-md-table-4}# ### OutputTaskSegment | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Duration | Double | `70.1` | 视频时长，单位为秒。 | | Segments | Array of [OutputTaskSegmentItem](#outputtasksegmentitem) | `-` | 视频切片信息。 | #{.custom-md-table-4}# ### OutputTaskOcr | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Duration | Double | `180.5` | 视频时长，单位为秒。 | | Texts | Array of [OutputTaskOcrText](#outputtaskocrtext) | `-` | OCR 文本识别输出信息。 | | ImageSet | Array of [OutputTaskOcrImageSet](#outputtaskocrimageset) | `-` | 图集 OCR 结果。 | | Mode | String | `-` | 工作模式。支持取值如下： |\ | | | | * `Subtitle`：默认模式。 |\ | | | | * `Detailed`：会在任务结果中输出 OCR 识别的文本类型和位置信息。 |\ | | | | :::warning |\ | | | | 使用其它模式需[提交工单](https://console.volcengine.com/ticket/createTicketV2/?step=2&Service=vod)联系火山引擎技术支持团队申请。 |\ | | | | ::: | #{.custom-md-table-4}# ### OutputTaskErase | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Duration | Double | `152.085` | 输出视频时长，单位为秒。 | | File | Object of [MediaFileInfo](#mediafileinfo) | `-` | 输出文件信息 | | Info | Object of [OutputTaskEraseInfo](#outputtaskeraseinfo) | `-` | 擦除详细信息。仅当提交任务时 `Erase.WithEraseInfo` 设为 `true`时会返回该值。 | #{.custom-md-table-4}# ### OutputTaskFileDelete | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Info | Array of [OutputTaskFileDeleteInfo](#outputtaskfiledeleteinfo) | `-` | 文本删除结果。顺序与输入文件顺序保持一致。 | #{.custom-md-table-4}# ### OutputVideoMatting | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Duration | Double | `70.1` | 视频时长，单位为秒。 | | Model | String | `Human` | 抠图模型，支持的取值如下： |\ | | | | * `Human`：人像抠图，识别人像主体并从复杂场景中抠出，输出透明底视频，适用于背景替换等场景。 |\ | | | | * `GreenScreen`：绿幕抠图，输入绿幕视频并输出透明底抠像视频。 | | Video | Object of [MediaFileInfo](#mediafileinfo) | `-` | 生成视频文件信息 | #{.custom-md-table-4}# ### OutputTaskVideoSummary | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Duration | Double | `180.5` | 视频时长，单位为秒。 | | Content | String | `xxx` | 视频分段摘要。 | #{.custom-md-table-4}# ### OutputTaskVideoGeneration | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Duration | Double | `10.5` | 视频生成任务的输出视频时长，单位为秒。 | | Resolution | String | `1080p` | 生成视频的分辨率，取值如下： |\ | | | | * `480p` |\ | | | | * `720p` |\ | | | | * `1080p` | | Model | String | `doubao-seedance-pro` | 视频生成任务所使用的模型。取值如下： |\ | | | | * `doubao-seedance-pro`：专业版模型。 |\ | | | | * `doubao-seedance-lite`：轻量版模型。 | | Video | Object of [MediaFileInfo](#mediafileinfo) | `-` | 生成视频文件信息 | #{.custom-md-table-4}# ### OutputVideoUnderstanding | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Duration | Double | `152.085` | 视频时长，单位为秒。 | | Segments | Array of [OutputVideoUnderstandingSegment](#outputvideounderstandingsegment) | `-` | 场景切分后的视频理解结果。 | | Content | String | `-` | 非场景切分的视频理解结果。 | #{.custom-md-table-4}# ### OperationWorkflowNodeOutput | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Name | String | `FileDelete` | 节点名称。 | | Status | String | `Success` | 节点状态。 | | Code | String | `-` | 节点错误码。 | | Output | Object of [WorkflowOutput](#workflowoutput) | `-` | 节点输出结果。 | #{.custom-md-table-4}# ### OperationTaskHighlightEdit | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Mode | String | `HighlightClips` | 剪辑模式。支持以下取值： |\ | | | | * `HighlightClips`：智能片段剪辑模式。系统将自动应用一套默认的剪辑参数，快速生成效果均衡的高光集锦视频。此模式无需额外配置。 |\ | | | | * `CustomEdit`: 自定义剪辑模式。您可以通过 `CustomEdit` 参数，详细自定义最终输出视频的编码、分辨率等。 |\ | | | | * `MiniseriesEdit`：短剧三要素模板剪辑。使用预设的视觉模板，为高光视频一键添加“短剧三要素”（剧名、角标、提示语）。 |\ | | | | :::warning |\ | | | | “短剧三要素”（`MiniseriesEdit` 模式）**仅适用于竖屏短剧**，暂不支持横屏剧。 |\ | | | | ::: | | CustomEdit | Object of [OperationTaskHighlightCustomEdit](#operationtaskhighlightcustomedit) | `-` | 自定义剪辑参数。当 `Mode` 为 `CustomEdit` 时，此参数为必填，用于详细配置最终输出视频的参数。 | | MiniseriesEdit | Object of [OperationTaskHighlightMiniseriesEdit](#operationtaskhighlightminiseriesedit) | `-` | 短剧模板剪辑模式的详细参数。当 `Mode` 为 `MiniseriesEdit` 时，此参数为必填。 | #{.custom-md-table-4}# ### OperationTaskHighlightCuts | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | WithStoryboard | Boolean | `true` | 是否在任务结果中输出详细的分镜信息。取值如下： |\ | | | | * `true`：系统会在高光分析结果中包含 `Storyboard` 数组，输出算法基于分镜理解得出的视频片段信息。每个片段涵盖片段开始时间、结束时间、高光打分、字幕信息、剧情描述以及片段源自哪个输入视频等信息。 |\ | | | | * `false`：（默认）不输出分镜信息。 | | MinDuration | Double | `60` | 期望输出高光片段的最小时长，单位为秒，默认值为 90。 |\ | | | | :::warning |\ | | | | 在实际高光分析过程中，为确保剧情的连贯性并保留“钩子”剧情，算法所输出高光视频的时长可能不会与您所设置的 `MinDuration` 和 `MaxDuration` 严格相符。 |\ | | | | ::: | | MaxDuration | Double | `180` | 期望输出高光片段的最大时长，单位为秒。默认值为 300。若您指定最大时长，系统会将混剪结果截断至合适长度，可能不会使用全部输入视频片段。 | | MaxNumber | Integer | `1` | 输出高光片段的最多片段数，默认值为 6。 | | MiniseriesOption | Object of [OperationTaskHighlightCutsMiniseriesOption](#operationtaskhighlightcutsminiseriesoption) | `-` | 短剧场景下的专属配置，目前用于指定剪辑模式（顺剪/混剪）。仅在短剧模型下生效。 | #{.custom-md-table-4}# ### OperationTaskHighlightOpeningHook | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | WithOpeningHook | Boolean | `true` | 是否启用精彩前置功能： |\ | | | | * `true`: 开启精彩前置功能。系统将自动分析并提取视频中最精彩的片段，将其置于视频开头，以吸引观众。 |\ | | | | * `false`:（默认）关闭精彩前置功能。 | | MinDuration | Double | `5` | 视频开头精彩片段的最小时长，单位为秒，默认为 `5`。 | | MaxDuration | Double | `15` | 视频开头精彩片段的最大时长，单位为秒，默认值为 `15`。 | | MinClipDuration | Double | `5` | 设置构成视频开头精彩片段的单个高光片段的最小持续时长。单位为秒，默认值为 `5`。视频开头的精彩片段可能会由多个高光片段拼接而成。此参数用于避免因拼接过多过短片段而导致的画面频闪问题，以确保最终成片的视觉流畅性。 |\ | | | | :::warning |\ | | | | 请确保 `MinClipDuration` 大于 `MinDuration`，否则可能会导致输出多个独立的前置精彩片段。 |\ | | | | ::: | | MinScore | Double | `3` | 设置构成视频开头精彩片段的单个高光片段的高光打分下限，默认值为 `3`。视频开头精彩片段可能会由多个高光片段拼接而成，此参数用于筛选高质量片段以确保开场效果。 | #{.custom-md-table-4}# ### OperationTaskHighlightMiniGame | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Name | String | `王XX耀` | 游戏名称，用于在高光智剪任务中标识游戏内容，最大长度为 5000 个字符。 | | PlayDefinition | String | `玩家需要控制角色在限定时间内完成指定任务，通过收集道具和击败敌人来获得分数。` | 游戏玩法描述，用于在高光智剪任务中详细说明游戏的玩法规则或特点，最大长度为 5000 个字符。 | | HighlightDefinition | String | `玩家在游戏中连续击败多名对手，完成五杀操作，展现出极高的操作技巧和反应速度。` | 高光描述，用于在高光智剪任务中详细说明游戏中的高光时刻或精彩瞬间，最大长度为 5000 个字符。 | #{.custom-md-table-4}# ### OperationTaskVisionModel | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | DoubaoVisionEndpoint | String | `ep-202412***75335-cg2p7` | 豆包 VLM (Vision Language Model) 模型的推理接入点 ID。具体请见[开通豆包大模型并获取 Endpoint ID](https://www.volcengine.com/docs/4/1478242#f7674b4c)。 |\ | | | | :::warning |\ | | | | `DoubaoVisionEndpoint` 和 `DoubaoTextEndpoint` 二选一必填。 |\ | | | | ::: | | AsrAppId | String | `3500***054` | 语音识别 (ASR) 产品的 APP ID。具体请见[开通大模型流式语音识别服务并获取 APP ID](https://www.volcengine.com/docs/4/1478242#%E5%BC%80%E9%80%9A%E5%A4%A7%E6%A8%A1%E5%9E%8B%E6%B5%81%E5%BC%8F%E8%AF%AD%E9%9F%B3%E8%AF%86%E5%88%AB%E6%9C%8D%E5%8A%A1%E5%B9%B6%E8%8E%B7%E5%8F%96-app-id). | | AsrAppType | String | `volc.bigasr.sauc.duration` | 语音识别 (ASR) 产品中流式语音识别大模型的类型，需与您开通的服务类型保持一致。取值如下： |\ | | | | - `volc.bigasr.sauc.duration`: 小时版 |\ | | | | - `volc.bigasr.sauc.concurrent`: 并发版 | | DoubaoTextEndpoint | String | `ep-202412***75335-cg2p7` | 豆包 LLM (Large Language Model) 模型的推理接入点 ID。具体请见[开通豆包大模型并获取 Endpoint ID](https://www.volcengine.com/docs/4/1478242#f7674b4c)。 |\ | | | | :::warning |\ | | | | `DoubaoVisionEndpoint` 和 `DoubaoTextEndpoint` 二选一必填。 |\ | | | | ::: | #{.custom-md-table-4}# ### OperationTaskVisionSegment | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Start | Double | `100` | 起始时间，单位为秒。 | | End | Double | `200` | 结束时间，单位为秒。 | #{.custom-md-table-4}# ### OperationTaskVisionSnapshotParam | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Resolution | String | `720p` | 视频截图的分辨率，取值如下： |\ | | | | - `240p` |\ | | | | - `360p` |\ | | | | - `480p` |\ | | | | - `720p` |\ | | | | - `1080p` | | Fps | Double | `1` | 每秒截取的帧数。 | | Area | Object of [RatioRectangle](#ratiorectangle) | `-` | 截图区域配置。 | #{.custom-md-table-4}# ### OperationTaskEraseAuto | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `Subtitle` | 文本擦除类型: |\ | | | | - `Subtitle`: 擦除 OCR 检测为字幕的文本 |\ | | | | - `Text`: (Beta) 擦除除场景文字（如宫殿门牌匾等）以外的字幕及其他文本（如人物介绍等）。 | | Locations | Array of [OperationTaskEraseLocation](#operationtaskeraselocation) | `-` | 擦除框数组。添加擦除框后，系统仅擦除框内文本。 | | SubtitleFilter | Object of [OperationTaskEraseSubtitleFilter](#operationtaskerasesubtitlefilter) | `-` | 用于指定擦除文字的高度和距离视频宽度中心的比例，精确控制擦除范围。 |\ | | | | :::warning |\ | | | | 仅当 `Mode` 为 `Auto`、`Type` 为 `Subtitle` 时生效。 |\ | | | | ::: | #{.custom-md-table-4}# ### OperationTaskEraseManual | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Locations | Array of [OperationTaskEraseLocation](#operationtaskeraselocation) | `-` | 擦除框数组。添加擦除框后，系统仅擦除框内文本。 | #{.custom-md-table-4}# ### OperationTaskEraseOption | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | ClipFilter | Object of [OperationTaskEraseOptionClipFilter](#operationtaskeraseoptionclipfilter) | `-` | 视频片段过滤器。用于定义一个或多个时间片段，并指定对这些片段执行的操作模式（擦除或跳过）。 | #{.custom-md-table-4}# ### OperationTaskEraseVideoOption | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | EncodeMode | String | `Size` | 编码模式，支持以下两种取值： |\ | | | | * `Quality`（默认值）：画质优先模式。此模式下，系统会采用较高的目标码率进行编码，以确保高画质。这通常会导致输出文件的码率显著高于源文件，文件体积也相应增大。 |\ | | | | * `Size`：大小优先模式。在保证一定画质的前提下，使输出码率尽量向源视频码率对齐。 | #{.custom-md-table-4}# ### VolcEnhanceParam | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `SR` | 自定义增强的算子类型。支持的取值如下： |\ | | | | * `SR`：智能超分 |\ | | | | * `AudioDenoise`：音频降噪 |\ | | | | * `SDR2HDR`：SDR 转 HDR |\ | | | | * `EnhanceVFI`：智能插帧 |\ | | | | * `SDREnhance`：SDR 增强 | #{.custom-md-table-4}# ### VolcMoeEnhanceParam | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Config | String | `common` | 场景化模板类型。用于选择一个针对特定业务场景的预设画质增强模板。支持的取值如下： |\ | | | | * `common`: 通用模板 |\ | | | | * `ugc`: UGC 短视频 |\ | | | | * `short_series`: 短剧 |\ | | | | * `aigc`: AIGC 内容 |\ | | | | * `old_film`: 老片修复 | | Target | Object of [VolcMoeTarget](#volcmoetarget) | `-` | 输出视频配置。用于指定输出视频的分辨率和帧率。如果不传，系统将默认保持与源视频一致。 | | VideoStrategy | Object of [VolcVideoStrategyParam](#volcvideostrategyparam) | `-` | 视频增强策略。用于控制视频增强的类型和强度。 | #{.custom-md-table-4}# ### OperationTaskVideoMattingVideoOption | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Format | String | `WEBM` | 输出视频的封装格式，支持的取值如下： |\ | | | | * `MOV` |\ | | | | * `WEBM` | #{.custom-md-table-4}# ### OperationTaskVideoGenerationVideoOption | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Model | String | `doubao-seedance-pro` | 视频生成任务所使用的模型。支持的取值如下： |\ | | | | * `doubao-seedance-pro`：专业版模型。 |\ | | | | * `doubao-seedance-lite`：轻量版模型。 | | Resolution | String | `1080p` | 生成视频的分辨率。支持的取值如下： |\ | | | | * `480p` |\ | | | | * `720p`（默认） |\ | | | | * `1080p` |\ | | | | :::warning |\ | | | | 使用 `doubao-seedance-lite` 并选择设置尾帧图片时，仅支持生成 `480p` 和 `720p`。 |\ | | | | ::: | | AspectRatio | String | `16:9` | 生成视频的宽高比。支持的取值如下： |\ | | | | * `21:9` |\ | | | | * `16:9`（默认） |\ | | | | * `4:3` |\ | | | | * `1:1` |\ | | | | * `3:4` |\ | | | | * `9:16` |\ | | | | * `adaptive`：根据所上传图片的比例自动选择最合适的宽高比（图生视频时默认）。 | | Duration | Integer | `5` | 生成视频的时长，单位为秒。默认值为 `5`，支持设置为 `5` 或 `10`。 | | Fps | Integer | `24` | 视频生成的帧率，默认值为 `24`，当前仅支持设为 `24`。 | | Watermark | Boolean | `true` | 是否在生成的视频中包含“AI生成”水印。默认值为 `false`，即不包含水印。 | | Seed | String | `123456789` | 种子整数，用于控制生成内容的随机性。取值范围为 `[-1, 2^32-1]` 之间的整数，默认值为 `-1`。 | | FixedCamera | Boolean | `false` | 是否固定摄像头视角。默认值为 `false`，即不固定摄像头视角。若设置为 `true`，平台会在用户提示词中追加固定摄像头，但实际效果不保证。 | #{.custom-md-table-4}# ### OperationTaskVideoUnderstandingSegment | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | MinDuration | Double | `3` | 单个切片的最小时长，单位为秒，无默认值。系统会确保最终生成的任何切片时长都不低于此值。 |\ | | | | :::tip |\ | | | | 若处理场景变化较快的视频，建议设置切片最小时长 > =1 秒，以避免对过短的切片执行视频理解。 |\ | | | | ::: | | MaxDuration | Double | `30` | 单个切片的最大时长，单位为秒，无默认值。系统会确保最终生成的任何切片时长都不高于此值。 | | Threshold | Double | `10` | 场景切分的敏感度阈值。取值范围为 `[0, 100]`。 |\ | | | | * 取值越低，算法对场景变化的感知越敏感，切分出的片段越多。 |\ | | | | * 取值越高，算法越倾向于将微小的变化视为同一场景，切分出的片段越少。 |\ | | | | 当您同时设置 `MinDuration`, `MaxDuration` 和 `Threshold` 时，系统会按照以下两阶段逻辑进行切分，以确保所有约束都得到满足： |\ | | | | 1. 算法首先会根据您设置的 `Threshold` 和 `MinDuration` 进行切分。 |\ | | | | 2. 第一阶段切分完毕后，如发现有切片的时长超过您设置的 `MaxDuration`，系统会忽略 `Threshold` 的影响，再进行切分，确保最终时长都不超过 `MaxDuration`。 | #{.custom-md-table-4}# ### OperationTaskVideoUnderstandingModel | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Temperature | Double | `1` | 采样温度，控制生成文本时对每个候选词的概率分布进行平滑的程度。当取值为 `0 `时模型仅考虑对数概率最大的一个 token。默认值为 `1`，取值范围为 `[0, 2]`。较高的值（如 `0.8`）会使输出更加随机，而较低的值（如 `0.2`）会使输出更加集中确定。 |\ | | | | :::tip |\ | | | | 通常建议仅调整 `temperature` 或 `top_p` 其中之一，不建议两者都修改。 |\ | | | | ::: | | TopP | Double | `0.7` | 采样概率阈值。模型会考虑概率质量在 `top_p` 内的 token 结果。当取值为 `0` 时模型仅考虑对数概率最大的一个 token。默认值为 `0.7`，取值范围为 `[0, 1]`。`0.1` 意味着只考虑概率质量最高的前 10% 的 token，取值越大生成的随机性越高，取值越低生成的确定性越高。 |\ | | | | :::tip |\ | | | | 通常建议仅调整 `temperature` 或 `top_p` 其中之一，不建议两者都修改。 |\ | | | | ::: | #{.custom-md-table-4}# ### WorkflowOperation | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `Task` | 处理类型。当前仅支持设为 `Task`（单任务）。 | | Task | Object of [OperationTask](#operationtask) | `-` | 单任务配置。当 `Type` 为 `Task` 时需要设置此参数。 |\ | | | | :::warning |\ | | | | 当前仅支持 ASR 语言转写、OCR 提取字幕和文件删除任务。 |\ | | | | ::: | #{.custom-md-table-4}# ### OperationWorkflowNodePolicy | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | NodeFail | String | `Abort` | 前置节点失败时的处理策略，默认值为 `Abort`。支持的取值如下： |\ | | | | - `Abort`：前置节点失败，终止运行。 |\ | | | | - `Ignore`：忽略前置节点错误。 | #{.custom-md-table-4}# ### VideoStreamMeta | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Codec | String | `h265` | 视频编码格式。 | | Height | Integer | `1080` | 视频高度，单位为 px。 | | Width | Integer | `1920` | 视频宽度，单位为 px。 | | Duration | Float | `10.04` | 视频时长，单位为秒。 | | Definition | String | `2k` | 视频清晰度。 | | Bitrate | Integer | `967525` | 视频码率，单位为 bps。 | | Fps | Float | `25` | 视频帧率，单位为 fps。 | #{.custom-md-table-4}# ### AudioStreamMeta | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Codec | String | `aac` | 音频编码格式。 | | Duration | Float | `10.027` | 音频时长，单位为秒。 | | SampleRate | Integer | `44100` | 音频采样率。 | | Bitrate | Integer | `128989` | 音频码率，单位为 bps。 | | Quality | String | `higher` | 音频质量。取值如下： |\ | | | | - `higher`：高音质。 |\ | | | | - `highest`：音乐音质。 |\ | | | | - `medium`：普通音质。 | | Channels | Integer | | 音频声道数 | #{.custom-md-table-4}# ### TranscodeEncryption | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Kid | String | `kid` | 加密密钥 ID | #{.custom-md-table-4}# ### HighlightClip | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Start | Double | `0.52` | 高光片段开始时间，单位为秒。 | | End | Double | `3.52` | 高光片段结束时间，单位为秒。 | | VideoIndex | Integer | `0` | 输入视频标识，用以指明该片段源自哪个输入视频，编号从 0 开始。 | #{.custom-md-table-4}# ### MediaFileInfo | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Size | String | `2519064` | 文件大小，单位为字节。 | | FileName | String | `9c78b9bbb841***586252231dadc9422_speech.aac` | 文件路径。详见[基于 FileName 获取文件访问 URL](https://www.volcengine.com/docs/4/67351?lang=zh#%E8%87%AA%E8%A1%8C%E6%8B%BC%E6%8E%A5)。 | | Vid | String | `v0299fg***4d103gsqljht10tatbreg` | 文件 Vid。详见[如何基于 Vid 获取文件访问 URL](https://www.volcengine.com/docs/4/67351?lang=zh#openapi-%E6%9C%8D%E5%8A%A1%E7%AB%AF-sdk)。 | #{.custom-md-table-4}# ### OutputTaskHighlightCuts | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Cuts | Array of [OutputTaskHighlightCutsDetail](#outputtaskhighlightcutsdetail) | `-` | 高光片段信息。 | | Storyboard | Array of [OutputTaskHighlightCutsStoryboard](#outputtaskhighlightcutsstoryboard) | `-` | 视频分镜信息。算法会基于分镜理解分析输出视频片段信息。仅当请求中 `WithStoryboard` 参数为 `true` 时返回。 | #{.custom-md-table-4}# ### OutputTaskHighlightStorylineCuts | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Segments | Array of [OutputTaskHighlightSegment](#outputtaskhighlightsegment) | `-` | 视频片段信息。算法会基于分镜理解分析输出视频片段，包含的信息最为全面。 | | Storylines | Array of [OutputTaskHighlightStoryline](#outputtaskhighlightstoryline) | `-` | 故事线信息。算法会将 `segments` 中属于同一故事情节的部分整理成连贯的故事线。 | | CutSegments | Array of [OutputTaskHighlightCutSegments](#outputtaskhighlightcutsegments) | `-` | 算法根据 `StartExecution` 接口请求参数中输入的条件限制，从故事线中提取最精彩的片段。若请求参数中没有条件限制，则默认剔除视频中高光分数 ≤1 以及 1 < 高光分数 ≤2 且无台词的片段。 | #{.custom-md-table-4}# ### OutputTaskVisionModelUsage | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | DoubaoInputTokens | Integer | `2564` | 豆包 VLM 输入令牌数量。 | | DoubaoOutputTokens | Integer | `528` | 豆包 VLM 输出令牌数量。 | | DoubaoTotalTokens | Integer | `3092` | 豆包 VLM 总计令牌数量。 | | DoubaoTextInputTokens | Integer | `2564` | 豆包 LLM 输入令牌数量。 | | DoubaoTextTotalTokens | Integer | `528` | 豆包 LLM 输出令牌数量。 | | DoubaoTextOutputTokens | Integer | `3092` | 豆包 LLM 总计令牌数量。 | #{.custom-md-table-4}# ### OutputTaskStorylineTags | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Tags | Array of String | `刑侦追凶` | 视频标签。 | #{.custom-md-table-4}# ### OutputTaskStorylineItem | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Title | String | `雨夜少女遇害案发` | 高光片段标题。 | | Summary | String | `-` | 高光片段简介。 | | Clips | Array of Integer | `[0, 1, 2, 3, 4, 5, 6]` | 高光片段索引。假设此字段为 `[0, 1, 2]`，对应 `Clips` 中的第 0、1、2 个片段。 | #{.custom-md-table-4}# ### OutputTaskStorylineClip | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | VideoIndex | Integer | `0` | 输入视频标识，用以指明该片段源自哪个输入视频，编号从 0 开始。 | | Title | String | `雨夜少女遇害案发` | 视频片段标题。 | | Summary | String | `2002年雨夜发生恶性xxx` | 视频片段简介。 | | Snapshot | String | `uuid/0.jpg` | 截图的文件路径 FileName。您可通过以下方式将 FileName 转换成可访问的 URL： |\ | | | | * 在视频点播控制台[生成访问地址](https://www.volcengine.com/docs/4/67347#获取媒资访问地址) |\ | | | | * [CDN 自签算](https://www.volcengine.com/docs/4/1130370#鉴权示例) | | Score | Double | `3.5` | 高光打分，取值范围为 [1,5]。 | | Dialogue | String | `对话` | 视频对话。 | | Start | Double | `133.0` | 片段开始时间，单位为秒。 | | End | Double | `181.0` | 片段结束时间，单位为秒。 | #{.custom-md-table-4}# ### Utterance | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Attribute | Object of [UtteranceAttribute](#utteranceattribute) | `-` | 声音属性。 | | Text | String | `火山引擎视频云` | 识别的文本信息。 | | Start | Double | `13.88` | 开始时间，单位为秒。 | | End | Double | `15.88` | 结束时间，单位为秒。 | #{.custom-md-table-4}# ### OutputTaskSegmentItem | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Start | Double | `0` | 切片开始时间，单位为秒。 | | End | Double | `1.41` | 切片结束时间，单位为秒。 | | Frames | Array of Integer | `[0, 84]` | 开始帧和结束帧。 | | File | Object of [MediaFileInfo](#mediafileinfo) | `-` | 切片文件。 | #{.custom-md-table-4}# ### OutputTaskOcrText | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Text | String | `-` | OCR 识别文本。图片上的多行文本用换行符 `\n` 分隔。 | | Start | Double | `60` | 截图在视频中的开始时间，单位为秒。 | | End | Double | `61` | 截图在视频中的结束时间，单位为秒。 | | DetailedInfo | Object of [OutputTaskOcrTextDetailedInfo](#outputtaskocrtextdetailedinfo) | `-` | OCR 识别文本详细信息。仅当 `Mode` 为 `Detailed` 时返回。 | #{.custom-md-table-4}# ### OutputTaskOcrImageSet | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Text | String | `-` | OCR 识别文本。图片上的多行文本用换行符 `\n` 分隔。 | | FileName | String | `-` | 图集上传后存在点播服务的文件路径 FileName。 | #{.custom-md-table-4}# ### OutputTaskEraseInfo | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Width | Integer | `1920` | 擦除后视频的宽度，单位为像素。 | | Height | Integer | `1080` | 擦除后视频的高度，单位为像素。 | | Areas | Array of [OutputTaskEraseArea](#outputtaskerasearea) | `-` | 擦除区域信息 | #{.custom-md-table-4}# ### OutputTaskFileDeleteInfo | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Status | String | `Deleted` | 文件删除状态，取值如下： |\ | | | | - `Deleted`: 已删除 |\ | | | | - `Failed`: 删除失败 |\ | | | | - `Skipped`: 已跳过 | #{.custom-md-table-4}# ### OutputVideoUnderstandingSegment | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Start | Double | `100` | 起始时间，单位为秒。 | | End | Double | `200` | 结束时间，单位为秒。 | | Frames | Array of Integer | `[0, 84]` | 开始帧和结束帧。从首帧开始。 | | File | Object of [MediaFileInfo](#mediafileinfo) | `-` | 切片文件信息。 | | Content | String | `-` | 视频理解结果。 | #{.custom-md-table-4}# ### WorkflowOutput | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `Task` | 工作流节点的任务类型，当前仅支持 `Task`（单任务） | | Task | Object of [OutputTask](#outputtask) | `-` | 工作流节点的输出结果。 | #{.custom-md-table-4}# ### OperationTaskHighlightCustomEdit | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Output | Object of [OperationTaskHighlightCustomEditOutput](#operationtaskhighlightcustomeditoutput) | `-` | 编码输出配置。用于配置终输出视频的编码格式、码率、帧率、分辨率等参数。 | | Canvas | Object of [OperationTaskHighlightCustomEditCanvas](#operationtaskhighlightcustomeditcanvas) | `-` | 渲染画布配置。用于定义最终输出视频的宽高、背景色等参数。 | #{.custom-md-table-4}# ### OperationTaskHighlightMiniseriesEdit | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Template | String | `热门短剧1` | “短剧三要素”视觉模板名称。不同的模板决定了剧名、角标、提示语的位置和样式。支持的取值如下： |\ | | | | * `热门短剧1` |\ | | | | * `热门短剧2` |\ | | | | * `热门短剧3` |\ | | | | * `热门短剧4` |\ | | | | * `热门短剧5` |\ | | | | :::tip |\ | | | | 具体效果，请见[短剧三要素视觉模板](https://www.volcengine.com/docs/4/1995605?lang=zh#b0c32e28)。 |\ | | | | ::: | | Title | String | `《短剧名称》` | 短剧名称。在高光视频画面上展示剧名，用于品牌识别和引导用户搜索。不得超过 22 个字。 | | Hint | String | `影视效果请勿模仿` | 短剧提示语。画面左右两侧的一行文字，可以是概括视频核心冲突或亮点的引导性文字，也可以是类似“影视效果请勿模仿无不良价值观引导”的免责声明。不得超过 20 个字。 | #{.custom-md-table-4}# ### OperationTaskHighlightCutsMiniseriesOption | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | CutMode | String | `Mixed` | 剪辑模式，决定了视频片段的组织方式。支持的取值如下： |\ | | | | * `Mixed`：（默认）混剪模式。算法会打乱原始时序，优先组合最精彩、最具冲突感的片段，以达到最佳营销效果。 |\ | | | | * `Sequential`：顺剪模式。算法会基本保持原始剧情的时间顺序进行剪辑（去除片头片尾等非正片内容）。 | #{.custom-md-table-4}# ### RatioRectangle | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | TopLeftX | Double | `0` | 框选区域左上角相对于视频左上角在X轴上的偏移比例，取值范围为[0,1]，其中 0 表示无偏移（与视频左边缘对齐），1 表示完全偏移（与视频右边缘对齐）。 | | TopLeftY | Double | `0` | 框选区域左上角相对于视频左上角在 Y 轴上的偏移比例，取值范围为 [0,1]，其中 0 表示无偏移（与视频上边缘对齐），1 表示完全偏移（与视频下边缘对齐）。 | | BottomRightX | Double | `0` | 框选区域右下角相对于视频左上角在 X 轴上的偏移比例，取值范围为 [0,1]，其中 0 表示无偏移（与视频左边缘对齐），1 表示完全偏移（与视频右边缘对齐）。 | | BottomRightY | Double | `0` | 框选区域右下角相对于视频左上角在 Y 轴上的偏移比例，取值范围为 [0,1]，其中 0 表示无偏移（与视频上边缘对齐），1 表示完全偏移（与视频下边缘对齐）。 | #{.custom-md-table-4}# ### OperationTaskEraseLocation | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | RatioLocation | Object of [RatioRectangle](#ratiorectangle) | `-` | 擦除框位置信息 |\ | | | | :::tip |\ | | | | 关于设置擦除框参数的详细介绍，请见[提交字幕精细化擦除任务](https://www.volcengine.com/docs/4/1555155#%E6%AD%A5%E9%AA%A4-1%EF%BC%9A%E6%8F%90%E4%BA%A4%E7%B2%BE%E7%BB%86%E5%8C%96%E5%AD%97%E5%B9%95%E6%93%A6%E9%99%A4%E4%BB%BB%E5%8A%A1)。 |\ | | | | ::: | #{.custom-md-table-4}# ### OperationTaskEraseSubtitleFilter | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | MinTextHeightRatio | Double | `0.01` | 文字高度最小比例，默认值为 `0.01`，即视频高度的 1%。 | | MaxTextHeightRatio | Double | `0.1` | 文字高度最大比例，默认值为 `0.1`，即视频高度的 10%。 | | RectangleCenterOffsetRatio | Double | `0.1` | 文字区域中心偏离视频宽中心的比例。默认值为 `0.08`，即 8%。 | #{.custom-md-table-4}# ### OperationTaskEraseOptionClipFilter | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Mode | String | `Skip` | 片段处理模式。决定了如何处理 `Clips` 数组中定义的时间片段。 |\ | | | | * `Skip`: 跳过模式。系统将擦除整个视频，但会跳过 `Clips` 数组中指定的片段区域，使其字幕保持原样。 |\ | | | | * `Selected`: 选中模式。系统将仅对 `Clips` 数组中指定的片段区域进行字幕擦除，视频的其他部分保持原样。 | | Clips | Array of [OperationTaskEraseOptionClip](#operationtaskeraseoptionclip) | `-` | 目标时间片段数组。 | #{.custom-md-table-4}# ### VolcMoeTarget | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Res | String | `1080p` | 目标分辨率。支持的取值如下所示。 |\ | | | | * `240p` |\ | | | | * `360p` |\ | | | | * `480p` |\ | | | | * `540p` |\ | | | | * `720p` |\ | | | | * `1080p` |\ | | | | * `2k` |\ | | | | * `4k` |\ | | | | :::warning |\ | | | | 此参数与 `resolution_limit` 互斥，**不可同时配置**。 |\ | | | | ::: | | ResLimit | Integer | `1080` | 指定输出视频的短边像素值，取值范围为 `[64, 2160]`。设置后，系统将锁定视频的短边像素值为设定值，并在保持原视频宽高比的前提下，等比缩放至该限制值。示例：若原视频为 640x480 (4:3)，设置 `resolution_limit` 为 720，则输出视频的短边将提升至 720，宽度等比缩放至 960。 |\ | | | | :::warning |\ | | | | 此参数与 `resolution` 互斥，**不可同时配置**。 |\ | | | | ::: | | Fps | Float | `30` | 目标帧率，单位为 fps。若未指定 `fps` 参数，输出视频将保持与原始片源一致的帧率。取值范围为 `(0, 120]`。建议不超过原片的 4 倍。 | | Bitrate | Integer | `2000` | 设置输出视频的目标平均码率。该参数将决定视频的视觉质量和最终的文件体积。取值范围为 `[10, 50000]`。为确保不同场景下的画质稳定性，系统会根据视频内容的复杂度进行动态调整。实际输出码率将在您设定目标的 **0.8 倍至 1.5 倍**之间波动。请参考[不同输出分辨率的推荐码率表](https://www.volcengine.com/docs/4/117971#692790fd)进行设置。 | #{.custom-md-table-4}# ### VolcVideoStrategyParam | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | RepairStyle | Integer | `1` | 画质增强类型： |\ | | | | * `0`：**标准版**。兼顾处理速度与视频画质，适用于视频分发场景的画质增强。 |\ | | | | * `1`：**专业版**。极致画质增强，保障镜头级画质效果，适用于影视级视频制作。 |\ | | | | :::tip |\ | | | | 画质增强类型不同，对应的算法强度不同，费用也不同，详细价格请参见[画质增强（升级版）](https://www.volcengine.com/docs/4/1941013#810bf860)。 |\ | | | | ::: | | RepairStrength | Integer | `0` | 视频增强强度，支持的取值如下： |\ | | | | * `-50`：轻度（高保真）。进行轻微增强，效果更贴近原片质感。 |\ | | | | * `0`：中等。提供平衡的画质提升效果。 | #{.custom-md-table-4}# ### OutputTaskHighlightCutsDetail | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Clips | Array of [OutputTaskHighlightsCutDetailClip](#outputtaskhighlightscutdetailclip) | `-` | 高光片段信息 | #{.custom-md-table-4}# ### OutputTaskHighlightCutsStoryboard | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | VideoIndex | Integer | `0` | 输入视频标识，用以指明该片段源自哪个输入视频，编号从 0 开始。 | | Start | Double | `133.0` | 片段开始时间，单位为秒。 | | End | Double | `181.0` | 片段结束时间，单位为秒。 | | Score | Double | `3.5` | 高光打分，取值范围为 [1,5]。 | | Ocr | String | `字幕` | 字幕 OCR 识别。仅识别位于画面下半部分且居中的字幕。 | | Description | String | `描述` | 画面描述。 | #{.custom-md-table-4}# ### OutputTaskHighlightSegment | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Start | Double | `133.0` | 片段开始时间，单位为秒。 | | End | Double | `181.0` | 片段结束时间，单位为秒。 | | Score | Double | `3.5` | 高光值，取值范围为 \[1,5\]。 | | Ocr | String | `字幕` | 字幕 OCR 识别。仅识别位于画面下半部分且居中的字幕。 | | Description | String | `描述` | 画面描述。 | | Location | String | `公司` | 地点标签。 | | Shot | String | `特写` | 景别标签： |\ | | | | - `特写`: 面部或细节 |\ | | | | |\ | | | | - `近景`: 胸部以上 |\ | | | | |\ | | | | - `中景`: 腰部以上 |\ | | | | |\ | | | | - `全景`: 全身 |\ | | | | |\ | | | | - `远景`: 环境为主 | | VideoIndex | Integer | `0` | 输入视频标识，用以指明该片段源自哪个输入视频，编号从 0 开始。 | #{.custom-md-table-4}# ### OutputTaskHighlightStoryline | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Title | String | `标题` | 标题 | | Description | String | `描述` | 描述 | | Score | Double | `3.5` | 高光打分，取值范围为 [1,5] | | Segments | Array of Integer | `[0,1,2]` | 片段索引信息，编号从 0 开始 | #{.custom-md-table-4}# ### OutputTaskHighlightCutSegments | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Segments | Array of Integer | `[0,1,2]` | 片段索引信息，编号从 0 开始 | #{.custom-md-table-4}# ### UtteranceAttribute | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Confidence | Double | `0.914009673595429` | 置信度。 | | Event | String | `speech` | 识别类型，取值如下： |\ | | | | - `speech`: 对话 |\ | | | | - `singing`: 歌唱 | | Speaker | String | `1` | 识别的说话人。 | #{.custom-md-table-4}# ### OutputTaskOcrTextDetailedInfo | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Label | String | `Subtitle` | OCR 识别文本的类别，支持的取值如下： |\ | | | | * `Subtitle`：字幕文本 |\ | | | | * `Others`：其他文本 | | PixelRectangle | Object of [PixelRectangle](#pixelrectangle) | `-` | OCR 识别文本的位置信息。 | #{.custom-md-table-4}# ### OutputTaskEraseArea | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Start | Double | `13.88` | 开始时间，单位为秒。 | | End | Double | `15.88` | 结束时间，单位为秒。 | | PixelRectangle | Array of [PixelRectangle](#pixelrectangle) | `-` | 擦除区域位置信息 | #{.custom-md-table-4}# ### OperationTaskHighlightCustomEditOutput | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Alpha | Boolean | `false` | 输出视频中是否包含 alpha 通道。默认值为 `false`。 |\ | | | | :::tip |\ | | | | `Alpha` 的优先级高于 `VideoCodec`。当 `Alpha` 为 `true` 时，`VideoCodec` 默认采用 `VP9`，而不再关注您设置的 `VideoCodec` 参数。 |\ | | | | ::: | | Format | String | `mp4` | 输出文件的封装格式。取值如下： |\ | | | | * （默认）`mp4` |\ | | | | * `hls` |\ | | | | * `mp3` |\ | | | | :::tip |\ | | | | * `Format` 的优先级高于 `VideoCodec`。 |\ | | | | * 当 `Format` 设为 `hls` 时，表示以 HLS 格式输出视频，此时 `VideoCodec` 仅支持设为 `h264` 和 `h265`。 |\ | | | | * 当 `DisableVideo` 参数取值为 `true` 时，`Format` 取值为 `mp3` 才生效，表示 MP3 音频导出专用格式。 |\ | | | | ::: | | Fps | Double | `30` | 输出视频的帧率。单位为 fps。默认值为 30。 | | Codec | Object of [OperationTaskHighlightCustomEditOutputCodec](#operationtaskhighlightcustomeditoutputcodec) | `-` | 音视频编码参数设置。 | | DisableVideo | Boolean | `false` | 是否仅输出音频： |\ | | | | * `false`: （默认）输出音视频。 |\ | | | | * `true`: 仅输出音频。 |\ | | | | :::tip |\ | | | | `DisableVideo` 和 `DisableAudio` 同时设为 `false` 时，最终输出一个完整的音视频文件。 |\ | | | | ::: | | DisableAudio | Boolean | `false` | 是否仅输出视频： |\ | | | | * `false`: （默认）输出音视频。 |\ | | | | * `true`: 仅输出视频。 | | CanvasWithMax | Boolean | `false` | 画布分辨率是否遵循最大分辨率。默认为 `false`。如设为 `true`，画布分辨率与资源中的最大分辨率保持一致。 |\ | | | | :::tip |\ | | | | 最大分辨率是指宽*高的值在所有资源中最大。画布分辨率相关参数的优先级按以下顺序递减： |\ | | | | 1. Int 型的 `Canvas.Width` 和 `Canvas.Height` |\ | | | | 2. `CanvasWithMax` |\ | | | | 3. `CanvaswithRatio` |\ | | | | 4. String 型的 `Canvas.Width` 和 `Canvas.Height` |\ | | | | ::: | | CanvasWithRatio | Boolean | `false` | 画布分辨率是否遵循长短边比。默认为 `false`。如设为 `true`，画布分辨率保持固定的长短边比。长短边比默认为 16:9。您也可以通过 `Canvas` 中的 `Long`、`Short`、`Ratio` 参数设置长、短边以及长短边比。 | | AudioPhaseDetect | Boolean | `false` | 是否进行音频反相检测。默认关闭。当片源时长较长时，该操作较为耗时。 | #{.custom-md-table-4}# ### OperationTaskHighlightCustomEditCanvas | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Width | Integer | `720` | 输出视频的宽。单位为 pixel，默认值为 720。取值范围为 [160,8192]。 |\ | | | | :::tip |\ | | | | `Canvas` 还支持通过表达式来自动匹配某个 Element 的宽和高。具体请见[通过表达式指定画布宽高](https://www.volcengine.com/docs/4/102412#%E9%80%9A%E8%BF%87%E8%A1%A8%E8%BE%BE%E5%BC%8F%E6%8C%87%E5%AE%9A%E7%94%BB%E5%B8%83%E5%AE%BD%E9%AB%98)。 |\ | | | | ::: | | Height | Integer | `1280` | 输出视频的高。单位为 pixel，默认值为 1280。取值范围为 [160,8192]。 | | BackgroundColor | String | `#FF0000FF` | 画布颜色。RGBA 类型，默认值为 `#00000000`。 | | Long | Integer | `1280` | 输出视频画布的长边。单位为 pixel，默认值为 1280。取值范围为 [160,8192]。 |\ | | | | :::warning |\ | | | | 此参数仅当 `CanvasWithRatio` 为 `true` 时生效。 |\ | | | | ::: | | Short | Integer | `720` | 输出视频画布的短边。单位为 pixel，默认值为 720。取值范围为 [160,8192]。 |\ | | | | :::warning |\ | | | | * 此参数仅当 `CanvasWithRatio` 为 `true` 时生效。 |\ | | | | * 同时设置短边和长边时，短边的优先级高于长边。 |\ | | | | ::: | | Index | String | `0|0` | 设置输出视频画布的屏幕方向（横屏还是竖屏）与哪个资源保持一致。默认值为 `0|0`，即对齐第 0 个 Track 的第 0 个 Element。当 `Index` 设为 `MAX` 时，则表示跟随基准分辨率，也就是与资源中的最大分辨率保持一致。 |\ | | | | :::warning |\ | | | | 此参数仅当 `CanvasWithRatio` 为 `true` 时生效。 |\ | | | | ::: | | Ratio | String | `16:9` | 输出视频画布的长短边比，默认值为 `16:9`。当 `Ratio` 设为 `-1:-1` 或者 `-1`，则表示跟随指定输入源。 |\ | | | | :::warning |\ | | | | 此参数仅当 `CanvasWithRatio` 为 `true` 时生效。 |\ | | | | ::: | #{.custom-md-table-4}# ### OperationTaskEraseOptionClip | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Start | Double | `10` | 片段的起始时间，单位为秒。 | | End | Double | `20` | 片段的结束时间，单位为秒。 | #{.custom-md-table-4}# ### OutputTaskHighlightsCutDetailClip | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | Type | String | `HighlightClip` | 片段类型： |\ | | | | * `HighlightClip`：普通高光片段 |\ | | | | * `OpeningHook`：视频前置精彩片段。仅当请求参数 `WithOpeningHook` 为 `true` 时返回。 | | Score | Double | `3.5` | 高光打分，取值范围为 [1,5]。 | | Start | Double | `13.88` | 该片段在原始视频中的起始时间点，单位为秒。 | | End | Double | `15.88` | 该片段在原始视频中的结束时间点，单位为秒。 | | VideoIndex | Integer | `0` | 输入视频标识，用以指明该片段源自哪个输入视频，编号从 0 开始。 | | CutStart | Double | `13.88` | 该片段在最终高光混剪视频中的起始时间点，单位为秒。 | | CutEnd | Double | `15.88` | 该片段在最终高光混剪视频中的结束时间点，单位为秒。 | #{.custom-md-table-4}# ### PixelRectangle | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | TopLeftX | Integer | `108` | 擦除区域左上角相对于视频左上角在 X 轴上的偏移，单位为像素 | | TopLeftY | Integer | `960` | 擦除区域左上角相对于视频左上角在 Y 轴上的偏移，单位为像素 | | BottomRightX | Integer | `1067` | 擦除区域右下角相对于视频左上角在 X 轴上的偏移，单位为像素 | | BottomRightY | Integer | `1919` | 擦除区域右下角相对于视频左上角在 Y 轴上的偏移，单位为像素 | #{.custom-md-table-4}# ### OperationTaskHighlightCustomEditOutputCodec | 参数 | 类型 | 示例值 | 描述 | | ---- | ---- | ---- | ---- | | VideoCodec | String | `h264` | 视频编码格式。取值如下： |\ | | | | * `h264`: （默认）H.264 |\ | | | | * `vp9`: VP9 |\ | | | | * `h265`: H.265 | | Preset | String | `medium` | 用于调节视频编码速度和质量。默认值为 `medium`。仅当 `VideoCodec` 设为 `h264`、`h265` 时生效。 | | Crf | Integer | `23` | 恒定质量因子 CRF。默认值为 `23`。 |\ | | | | :::tip |\ | | | | 仅当 `VideoCodec` 设为 `h264`、`h265` 时生效。 |\ | | | | ::: | | VideoBitRate | Integer | `2000` | 视频编码码率。单位为 bps。该参数如不设置，视频编码码率通过 `Crf` 控制。设置该参数后，`Crf` 设置不生效。 | | AudioCodec | String | `aac` | 音频编码格式。默认值为 `aac`。支持的取值有 `aac`。 | | AudioBitrate | Integer | `128` | 音频编码码率。默认值为 128。单位为 kbps。 | #{.custom-md-table-4}# ## 请求示例 ```json GET https://vod.volcengineapi.com?Action=GetExecution&Version=2025-01-01&RunId=bb:e4c7f76cb7bddxxxxaf3b05155164 ``` ## 返回示例 ### 高光智剪输出结果 ```json { "ResponseMetadata": { "RequestId": "2025090820092***774A2A749E05DCD1", "Action": "GetExecution", "Version": "2025-01-01", "Service": "vod", "Region": "cn-north-1" }, "Result": { "RunId": "lb:5c320217a2b***335641293cb39beeb", "Status": "Success", "Meta": { "SpaceName": "test-doc", "Trigger": "API", "CreateTime": "2025-09-08T11:58:41Z", "StartTime": "2025-09-08T11:58:42Z", "EndTime": "2025-09-08T12:09:08Z" }, "MultiInputs": [ { "Type": "Vid", "Vid": "v02399g100***j9aljht5kim11hp0" }, { "Type": "Vid", "Vid": "v02399g1000***9aljht4nmunv9ng" }, { "Type": "Vid", "Vid": "v02399g100***qpj9aljhta75lgba20" } ], "Operation": { "Type": "Task", "Task": { "Type": "Highlight", "Highlight": { "Mode": "StorylineCuts", "OpeningHook": { "WithOpeningHook": true }, "HighlightCuts": { "WithStoryboard": true, "MinDuration": 60, "MaxDuration": 180, "MaxNumber": 2 } } } }, "Output": { "Type": "Task", "Task": { "Type": "Highlight", "Highlight": { "Duration": 350.27, "HighlightCuts": { "Cuts": [ { "Clips": [ { "Type": "OpeningHook", "Score": 4.8, "Start": 90.43, "End": 99.57, "VideoIndex": 2, "CutStart": 0.0, "CutEnd": 9.13 }, { "Type": "HighlightClip", "Score": 4.8, "Start": 9.47, "End": 13.33, "VideoIndex": 0, "CutStart": 9.13, "CutEnd": 13.0 }, { "Type": "HighlightClip", "Score": 2.3, "Start": 31.13, "End": 37.3, "VideoIndex": 1, "CutStart": 75.57, "CutEnd": 81.73 } ] } ], "Storyboard": [ { "VideoIndex": 0, "Start": 9.47, "End": 13.33, "Score": 4.8, "Ocr": "陆斯年，我们分手吧！", "Description": "视频展示了一对情侣在公园里散步的场景...表明女子提出了分手的请求。" }, { "VideoIndex": 0, "Start": 15.83, "End": 24.2, "Score": 4.2, "Ocr": "怎么了？是我哪里惹你，不高兴了吗？...", "Description": "视频展示了一对男女在夜晚户外的场景...营造出一种温馨但略带紧张的氛围。" } ] } } } } } } ``` ### 故事线分析输出结果 ```json { "ResponseMetadata": { "RequestId": "20250224103***6D653DF9F47BAC876F3", "Action": "GetExecution", "Version": "2023-07-01", "Service": "vod", "Region": "cn-north-1" }, "Result": { "RunId": "dc00c56e2e1ea***249bc081b79e6a3", "Status": "Success", "Meta": { "SpaceName": "xxx", "Trigger": "API", "CreateTime": "2025-02-23T08:59:07Z", "StartTime": "2025-02-23T08:59:09Z", "EndTime": "2025-02-23T08:59:18Z" }, "Control": { "ClientToken": "11212" }, "MultiInputs": [ { "Type": "Vid", "Vid": "v0ccfeg7007***qlm7og65tu3orai10" }, { "Type": "Vid", "Vid": "v0ccfeg7007***qlm7og65tu3orai11" } ], "Operation": { "Type": "Task", "Task": { "Type": "Storyline", "Storyline": { "WithSnapshot": true } } }, "Output": { "Type": "Task", "Task": { "Type": "Storyline", "Storyline": { "Duration": 1801.1, "Summaries": [ "刑侦三大队调查一起由入室盗窃引发的恶性案件，14岁少女遇害引发社会震动。警方通过指纹比对发现跨省连环作案线索，锁定以空调维修为掩护的王氏兄弟。", "追捕过程中遭遇嫌疑人逃脱、队员牺牲、团队解散等重重困境，程兵带领队员跨越多省追踪十二年，最终通过DNA技术锁定改名潜逃的王二勇。在零口供情况下凭借完整证据链将其定罪，完成使命。" ], "AllTags": [ { "Tags": [ "刑侦追凶", "悬疑案件", "坚持不懈" ] }, { "Tags": [ "团队合作", "法律正义" ] } ], "Storylines": [ { "Title": "雨夜少女遇害案发", "Summary": "2002年雨夜发生恶性入室盗窃***锁定王大勇、王二勇兄弟为嫌疑人。", "Clips": [ 0, 1, 2, 3, 4, 5, 6 ] }, { "Title": "三大队内部协作与冲突", "Summary": "三大队面临破案压力，程兵与二大队产生职权冲突。老警员张青良追捕时受伤致死，因程序问题未被认定工伤。队员们在夜市摊点讨论案件分配，展现警队荣誉感与内部竞争矛盾。", "Clips": [ 7, 8, 9, 10 ] } ], "Clips": [ { "Start": 61.0, "End": 133.0, "Snapshot": "uuid/0.jpg", "Dialogue": "陈序孟雅晴", "Title": "雨夜中的犯罪现场", "Summary": "画面展示了一个雨夜中的犯罪现场，时间为2002年9月21日0时40分，地点在广东台平。现场有一辆警车，周围拉起警戒线，几位警察正在进行调查工作，整个场景充满了紧张和神秘的氛围。", "Score": 3.5, "VideoIndex": 0 }, { "Start": 133.0, "End": 181.5, "Snapshot": "uuid/1.jpg", "Dialogue": "程队，死者是个女孩，***程队，把楼下警戒线撤了吧，别等天还没亮呢，人都围上来了。是，程队。", "Title": "程队调查少女遇害案", "Summary": "在一个雨夜，程队和警员们在案发现场调查一起少女遇害案***最后，程队吩咐警员撤掉楼下警戒线，以免天亮后引来围观人群。", "Score": 3.5, "VideoIndex": 0 }, { "Start": 181.5, "End": 228.0, "Snapshot": "uuid/2.jpg", "Dialogue": "房间里不乱***指纹呀，凶器上面都没有。", "Title": "警察调查犯罪现场", "Summary": "警察在一个昏暗的房间内调查犯罪现场，房间内抽屉和柜子被翻过，电话线被剪断，推测凶手是有计划的惯犯。警察怀疑是外来人员作案，可能有案底，但采集指纹和凶器上都没有发现线索。", "Score": 3.0, "VideoIndex": 0 }, { "Start": 228.0, "End": 274.5, "Snapshot": "uuid/3.jpg", "Dialogue": "程队，在死者身体里，***他们家空调装哪了？", "Title": "法医对死者进行尸检", "Summary": "在一个昏暗的室内***程队疑惑地询问死者家空调的安装位置。", "Score": 3.0, "VideoIndex": 0 }, { "Start": 274.5, "End": 321.0, "Snapshot": "uuid/4.jpg", "Dialogue": "在主卧。程队，我查过了。您怎么来了，师父？***我刚接到领导的电话，希望尽快破案，透个底，再说吧。", "Title": "师徒二人勘查现场", "Summary": "在案发现场的主卧内，程队和他的师父正在勘查。***程队刚接到领导电话，要求尽快破案，但具体细节还需进一步商讨。", "Score": 3.0, "VideoIndex": 0 }, { "Start": 321.0, "End": 367.5, "Snapshot": "uuid/5.jpg", "Dialogue": "等等，扣子，扣子上是不是有犯罪嫌疑人的。***老哥，别在这坐着了，回酒店等消息。", "Title": "警方展开调查，多线并行推进案件", "Summary": "刑警们在案发现场发现了带有犯罪嫌疑人指纹的扣子，***随后，刑警们劝慰受害者家属，让其回酒店等待消息。", "Score": 3.5, "VideoIndex": 1 }, { "Start": 367.5, "End": 418.0, "Snapshot": "uuid/6.jpg", "Dialogue": "师父，跟局里汇报吧。五天。程队，坐这坐这，***我和同学们在警校的目标就是，进三大队当程队的兵，就为这事我请全班吃了三顿饭。", "Title": "三大队众人讨论案件归属", "Summary": "在昏暗的楼道中，警察们围在师父身边，有人提出向局里汇报，称需要五天时间***有人回忆起在警校时，全班同学的目标就是进三大队当程队的兵，为了这还请全班吃了三顿饭。", "Score": 3.0, "VideoIndex": 1 }, { "Start": 418.0, "End": 473.0, "Snapshot": "uuid/7.jpg", "Dialogue": "你先把这顿结了去，跟二大队一块***道理我都懂，黄金七十二小时嘛，犯罪现场的痕迹最清晰，罪犯活动的活跃度，以及现场排查人员的记忆最完整，这警校都教过。", "Title": "程队结账请客，众人探讨破案时间", "Summary": "在一个夜晚的街边摊***大家边吃边聊，氛围轻松又带有对案件的认真思考。", "Score": 3.0, "VideoIndex": 1 }, { "Start": 473.0, "End": 521.0, "Snapshot": "uuid/8.jpg", "Dialogue": "但是，我觉得时间越充足越好嘛***小徐，人年轻的时候啊，都想办大案，好像不办大案，这警察就白当了一样，是吧？", "Title": "警察们压力下的聚餐", "Summary": "在一个夜晚的露天餐馆，几位警察围坐在一张桌子旁，讨论着案件的压力和期限***整个场景充满了紧张而又坚定的氛围。", "Score": 3.5, "VideoIndex": 1 }, { "Start": 521.0, "End": 569.0, "Snapshot": "uuid/9.jpg", "Dialogue": "可你知道，这大案的背后，是多少家庭悲剧，有多少人改变了人生。反正到了我这岁数啊，最怕的就是办大案，干久了你就明白了。来，记住了，张队，谢了，还帮我们把账结了。又是一场硬仗。杨队，省厅下来的，也得跟三大队学习，他说的。", "Title": "老刑警的感慨", "Summary": "在一个夜晚的户外场景中，几位刑警围坐在一起***最后他们提到省厅下来的人也得向三大队学习，预示着即将面临的艰巨任务。", "Score": 3.0, "VideoIndex": 1 } ] } } } } } ``` ### 场景切分输出结果 ```json { "ResponseMetadata": { "RequestId": "2025042317***C699CDA75E7EFD086978", "Action": "GetExecution", "Version": "2023-07-01", "Service": "vod", "Region": "cn-north-1" }, "Result": { "RunId": "lb:87e2fcbc4***b3c079a60473949a6", "Status": "Success", "Meta": { "SpaceName": "transcode-newapi", "Trigger": "API", "CreateTime": "2025-04-23T09:19:59Z", "StartTime": "2025-04-23T09:19:59Z", "EndTime": "2025-04-23T09:27:36Z" }, "Control": { "ClientToken": "1235" }, "Input": { "Type": "Vid", "Vid": "v028adg1***04b0j2ljhtfnjj11q80" }, "Operation": { "Type": "Task", "Task": { "Type": "Segment", "Segment": {} } }, "Output": { "Type": "Task", "Task": { "Type": "Segment", "Segment": { "Duration": 158.584, "Segments": [ { "Start": 0, "End": 1.4166666, "Frames": [ 0, 84 ], "File": { "Size": "23747", "FileName": "68392bf19439***db268ea9b9ff97a05.mp4" } }, { "Start": 1.4166666, "End": 2.6333334, "Frames": [ 85, 157 ], "File": { "Size": "439707", "FileName": "40902fd61***65bbe7555c2dfa44c66.mp4" } }, { "Start": 2.6333334, "End": 3.7166667, "Frames": [ 158, 222 ], "File": { "Size": "520831", "FileName": "be2d7825d***b169344814b6d6505c5.mp4" } }, { "Start": 3.7166667, "End": 4.85, "Frames": [ 223, 290 ], "File": { "Size": "209380", "FileName": "9403738a4e***9bee480eafddc30a3.mp4" } } ] } } } } } ``` ### 精细化字幕擦除输出结果 ```json { "ResponseMetadata": { "RequestId": "2025061319***36839B74F9C61BF62AC5", "Action": "GetExecution", "Version": "2023-07-01", "Service": "vod", "Region": "cn-north-1" }, "Result": { "RunId": "hb:e3eb1668d4***1420ac9505746c893", "Status": "Success", "Meta": { "SpaceName": "test-doc", "Trigger": "API", "CreateTime": "2025-06-13T09:34:35Z", "StartTime": "2025-06-13T09:34:36Z", "EndTime": "2025-06-13T09:41:25Z" }, "Control": { "ClientToken": "12345" }, "Input": { "Type": "Vid", "Vid": "v0346fg10002****18qljht1um8cfkn0" }, "Operation": { "Type": "Task", "Task": { "Type": "Erase", "Erase": { "Mode": "Manual", "Manual": { "Locations": [ { "RatioLocation": { "TopLeftX": 0.1, "TopLeftY": 0.5, "BottomRightX": 0.988888, "BottomRightY": 0.9999 } } ] }, "WithEraseInfo": true } } }, "Output": { "Type": "Task", "Task": { "Type": "Erase", "Erase": { "Duration": 57.099, "File": { "Size": "152295931", "FileName": "0b7c1420fee3***39792b847b8a59f02" }, "Info": { "Width": 1080, "Height": 1920, "Areas": [ { "Start": 0, "End": 57.08, "PixelRectangle": [ { "TopLeftX": 108, "TopLeftY": 960, "BottomRightX": 1067, "BottomRightY": 1919 } ] } ] } } } } } } ``` ### 视频分段摘要输出结果 ```json { "ResponseMetadata": { "RequestId": "20250708145***E5D2C3720F110C906FBF", "Action": "GetExecution", "Version": "2025-01-01", "Service": "vod", "Region": "cn-north-1" }, "Result": { "RunId": "lb:629d040ece***8acdf6451d658894ac", "Status": "Success", "Meta": { "SpaceName": "test-jinling", "Trigger": "API", "CreateTime": "2025-07-08T06:42:59Z", "StartTime": "2025-07-08T06:43:00Z", "EndTime": "2025-07-08T06:54:03Z" }, "Input": { "Type": "Vid", "Vid": "v02399g1000***00naljht67gjhcdhg" }, "Operation": { "Type": "Task", "Task": { "Type": "VideoSummary", "VideoSummary": {} } }, "Output": { "Type": "Task", "Task": { "Type": "VideoSummary", "VideoSummary": { "Duration": 159.1, "Content": "\n\n{\"视频标题\":\"富家女与贫困学霸的四年恋：破产分手与难堪重逢\",\"视频摘要\":\"讲述富家女大学***‘麻利点别出岔子’\"}}]}" } } } } } ``` ## 错误码本接口无特有的错误码。更多信息请见[公共错误码](https://www.volcengine.com/docs/4/65595)。 ## 服务端 SDK 视频点播为 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API。本接口仅 VOD SDK 2.0 支持，详见 [V2.0 SDK 介绍与迁移说明](https://www.volcengine.com/docs/4/1617647)。