AI MediaKit
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Authorization | String | 是 | Bearer {Your_API_Key} |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
video_url | String | 是 | https://example.com/video.mp4 | 待擦除字幕的视频 URL。
|
model_version | String | 否 | v4 | 擦除算法版本,默认值为 v4。
|
mode | String | 否 | Subtitle | 字幕擦除模式,默认值为 Subtitle。
|
output_encode_mode | String | 否 | Quality | 输出视频编码模式,默认值为 Quality。
|
erase_ratio_location | Array | 否 | [{"top_...}, {"top_...}] | 注意
|
time_segment_filter | Object | 否 | {"mode": "selected", ...} | |
subtitle_filter | Object | 否 | {"max_text_height_ratio": 0.1} | |
media_output_destination | String | 否 | vod://my-space | 指定处理产物的目标存储位置。AI MediaKit 支持将处理产物存储至您的火山引擎视频点播(VOD)空间或对象存储(TOS)桶。
设置本参数后,任务结果中的 url 相关字段将返回形如 vod:// 或 tos:// 格式的资源地址,不再返回临时下载地址。 说明 首次使用此功能前,您需要先授权 AI MediaKit 将文件写入您的 VOD 空间或 TOS 桶。请前往 AI MediaKit 控制台基础配置 > 授权管理页面,根据您的需要,为 AI MediaKit 服务授予相应的权限。更多信息,请参阅开发指南处理产物存储至 VOD 或 TOS。 |
client_token | String | 否 | your_unique_request_id_136 | |
callback_args | String | 否 | your_custom_callback_args | |
callback_url | String | 否 | https://example.com/callback | 用于接收该任务结果回调的 URL 地址。如果提供此参数,其优先级将高于在控制台配置的全局回调地址。地址必须以 http:// 或 https:// 开头。请参考事件回调了解回调接收机制和回调消息结构。 |
queue_id | String | 否 | q00a9731598092652e4a95292434198 | 任务提交的目标队列 ID。如不传,默认会使用系统自动创建的队列 ID。您可以将不同业务或优先级的任务提交到不同的队列,以实现按队列对应的项目进行分账。您可以在 AI MediaKit 控制台队列管理页面创建和管理队列,系统会自动分配一个队列 ID。详情请参考按项目或 API Key 分账。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
top_left_x | Number | 是 | 0.1 | 框选区域左上角相对于视频左上角在 X 轴上的偏移比例。取值范围为 [0,1]。其中 0 表示无偏移(与视频左边缘对齐),1 表示完全偏移(与视频右边缘对齐)。 |
top_left_y | Number | 是 | 0.8 | 框选区域左上角相对于视频左上角在 Y 轴上的偏移比例。取值范围为 [0,1],其中 0 表示无偏移(与视频上边缘对齐),1 表示完全偏移(与视频下边缘对齐)。 |
bottom_right_x | Number | 是 | 0.9 | 框选区域右下角相对于视频左上角在 X 轴上的偏移比例,取值范围为 [0,1],其中 0 表示无偏移(与视频左边缘对齐),1 表示完全偏移(与视频右边缘对齐)。 |
bottom_right_y | Number | 是 | 0.95 | 框选区域右下角相对于视频左上角在 Y 轴上的偏移比例,取值范围为 [0,1],其中 0 表示无偏移(与视频上边缘对齐),1 表示完全偏移(与视频下边缘对齐)。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
mode | String | 是 | selected | 时间段处理模式。
|
segments | Array | 是 | [{"start_time": 10, "end_time": 60}] |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
start_time | Number | 是 | 10 | 片段起始时间,单位为秒,取值需大于等于 0。 |
end_time | Number | 是 | 60 | 片段结束时间,单位为秒,取值需大于 start_time。 |
erase_ratio_location | Array | 否 | [{"top_...}] |
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
min_text_height_ratio | Number | 否 | 0.01 | 文字高度最小比例(相对视频高度),取值范围为 [0,1]。默认值为 0.01(即 1%)。低于此高度的文本不会被判定为字幕。 |
max_text_height_ratio | Number | 否 | 0.1 | 文字高度最大比例(相对视频高度),取值范围为 [0,1]。高于此高度的文本不会被判定为字幕。不传时的默认值与 model_version 有关:
|
center_offset_ratio | Number | 否 | 0.08 | 文字区域中心相对视频宽度中心的最大偏离比例,取值范围为 [0,1]。默认值为 0.08。超过此偏离比例的文本不会被判定为字幕。 |
参数 | 类型 | 描述 |
success | Boolean | 任务是否成功提交。
|
task_id | String | 任务的唯一标识符。仅在 success 为 true 时返回有效值。您可以使用此 ID 来查询任务状态和结果。 |
request_id | String | 本次 API 请求的唯一标识符,可用于问题排查。 |
error | Object | 错误详情对象,仅在 success 为 false 时返回。详见下文 Error 对象。 |
参数 | 类型 | 描述 |
code | String | |
type | String | 错误的宏观类型。例如 BadRequest。 |
message | String | 对错误的详细描述,可用于开发调试。 |
param | String | (可选)指出导致错误的具体参数。 |
参数 | 类型 | 示例值 | 描述 |
video_url | String | https://example.volcvideo.com/output.mp4?auth_key=... | 擦除字幕后的视频文件地址。地址类型根据请求时是否设置 media_output_destination 而不同:
|
duration | Number | 180.5 | 输出视频的总时长(单位:秒)。 |