AI MediaKit
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Authorization | String | 是 | Bearer {Your_API_Key} |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
video_url | String | 是 | https://example-video.com/input.mov | 待转码的视频 URL。
|
container_format | String | 是 | MP4 | 输出视频的封装格式。支持取值如下:
|
video | Object | 是 | - | |
audio | Object | 否 | - | |
metadata_keep_tags | Array of Strings | 否 | ["title", "artist"] | 需要从源视频保留的元信息标签列表。默认情况下,转码过程会丢弃大部分元信息(如标题、艺术家等)。使用此参数可以指定需要保留的标签键(Key)。此参数对 MPEGTS 封装格式无效。 |
metadata_add_tags | Array of Objects | 否 | [{"key": "album", "value": "2024 Remaster"}] | 需要为输出视频新增的元信息标签列表,每个标签由 key 和 value 组成。如果新增的标签与被保留的标签同名,此处的设置会覆盖源文件的值。此参数对 MPEGTS 封装格式无效。 |
media_output_destination | String | 否 | vod://my-space | 指定处理产物的目标存储位置。AI MediaKit 支持将处理产物存储至您的火山引擎视频点播(VOD)空间或对象存储(TOS)桶。
设置本参数后,任务结果中的 url 相关字段将返回形如 vod:// 或 tos:// 格式的资源地址,不再返回临时下载地址。 说明 首次使用此功能前,您需要先前往 AI MediaKit 控制台基础配置 > 授权管理页面,授权 AI MediaKit 将文件写入您的 VOD 空间或 TOS 桶。更多信息,请参阅开发指南处理产物存储至 VOD 或 TOS。 |
client_token | String | 否 | your_unique_request_id_132 | |
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。详情请参考项目与队列管理。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
codec | String | 是 | h264 | 视频编码格式。默认为 h264。支持取值:h264, h265。 |
scale_type | Integer | 否 | 2 | 视频画面缩放模式。默认为 0。
|
scale_mode | Integer | 否 | 2 | 视频画面填充与拉伸策略。此参数仅在 scale_type 为 1 或 2 时生效,用于处理您设定的目标尺寸与原视频的宽高比不一致的问题。默认为 0。
例如,您将一个 16:9 的视频,强制指定输出为 1:1 的 scale_width 和 scale_height:
|
scale_width | Integer | 否 | 1920 | 目标宽度,单位为 px。取值范围 [0, 4320]。仅当 scale_type 为 2(宽高限制模式)时生效。如果只传 scale_width 或 scale_height 之一,则另一边按比例缩放。 |
scale_height | Integer | 否 | 1080 | 目标高度,单位为 px。取值范围 [0, 4320]。仅当 scale_type 为 2(宽高限制模式)时生效。如果只传 scale_width 或 scale_height 之一,则另一边按比例缩放。 |
scale_short | Integer | 否 | 720 | 目标短边,单位为 px。取值范围 [0, 4320]。仅当 scale_type 为 1(长短边限制模式)时生效。如果只传 scale_short 或 scale_long 之一,则另一边按比例缩放。 |
scale_long | Integer | 否 | 1280 | 目标长边,单位为 px。取值范围 [0, 4320]。仅当 scale_type 为 1(长短边限制模式)时生效。如果只传 scale_short 或 scale_long 之一,则另一边按比例缩放。 |
bitrate_mode | String | 是 | crf | 码率控制模式。默认为 crf。
|
bitrate_crf | Number | 否 | 23 | CRF(Constant Rate Factor)参数,仅当 bitrate_mode 为 crf 时生效,即 crf 模式下的主要质量控制器。取值范围 [0, 51],默认为 25。数字越小,画质越高,文件体积越大。0 表示无损。 |
bitrate_kbps | Integer | 是 | 2500 | 视频码率的目标值,单位 Kbps。取值范围 [10, 50000],默认为 2000。其具体作用由 bitrate_mode 决定:
|
fps_mode | String | 否 | vfr | 帧率控制模式。只有在您设置了 fps 参数后,fps_mode 才会生效。如果您不提供 fps 参数,系统将完全遵循原视频的帧率,fps_mode 的设置会被忽略。默认为 vfr。
|
fps | Integer | 否 | 30 | 目标帧率,取值范围 [1, 240]。设置此参数会激活 fps_mode 的逻辑。在 vfr 模式下代表最大帧率,在 cfr 模式下代表恒定帧率。如不设置,则完全遵循原视频帧率。 |
is_hdr_to_sdr | Boolean | 否 | true | 是否将 HDR(高动态范围)视频转换为 SDR(标准动态范围)视频。默认为 true。设置为 false 则保留 HDR。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
codec | String | 是 | aac | 音频编码格式。默认为 aac。当前仅支持 aac。 |
sample_rate | Integer | 是 | 44100 | 音频采样率,单位为 Hz。默认为 44100。当前 aac 编码支持的采样率包括:8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000。 |
bitrate_mode | String | 是 | cbr | 音频码率控制模式。支持取值如下:
|
bitrate_kbps | Integer | 否 | 192 | 音频码率,单位为 Kbps。取值范围 [10, 500],默认值为 128。如不设置此参数,输出音频的码率将与原始音频保持一致。 |
channels | Integer | 否 | 2 | 音频声道数。支持以下取值:
|
volume_method | String | 否 | 2Pass | 音量均衡算法开关。将此参数设置为 2Pass 可启用两阶段响度分析与处理,此时 volume_integrated_loudness、 volume_true_peak、volume_loudness_range 参数将生效。不设置此参数则不处理音量。 |
volume_integrated_loudness | Number | 否 | -14 | 目标综合响度,用于设定音频的整体感知音量,单位 LUFS。取值范围 [-70, -5],默认值为 -12。当 volume_method 为 2Pass 时,此参数为必填项。 |
volume_true_peak | Number | 否 | -1.5 | 真实峰值电平,用于设置音频信号的最高上限以防止削波失真,单位 dBTP。取值范围 [-9, 0],默认值为 0。当 volume_method 为 2Pass 时,此参数为必填项。 |
volume_loudness_range | Number | 否 | 7 | 响度范围(动态范围),用于调节音频中最响亮和最安静部分之间的差异,单位 LU。取值范围 [1, 20],默认值为 7。当 volume_method 为 2Pass 时生效。 |
参数 | 类型 | 描述 |
success | Boolean | 任务是否成功提交。
|
task_id | String | 任务的唯一标识符。仅在 success 为 true 时返回有效值。您可以使用此 ID 来查询任务状态和结果。 |
request_id | String | 本次 API 请求的唯一标识符,可用于问题排查。 |
error | Object |
参数 | 类型 | 描述 |
code | String | |
type | String | 错误的宏观类型。例如 BadRequest。 |
message | String | 对错误的详细描述,可用于开发调试。 |
param | String | (可选)指出导致错误的具体参数。 |
参数 | 类型 | 描述 |
video_url | String | 输出视频地址。地址类型根据请求时是否设置 media_output_destination 而不同:
|
duration | Number | 视频时长,单位为秒。 |
resolution | String | 转码后视频的分辨率。可能取值包括: "240p", "360p", "480p", "540p", "720p", "1080p", "2k", "4k"。 |
video_codec | String | 视频编码格式,例如 h264 或 h265。 |