AI MediaKit
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Authorization | String | 是 | Bearer {Your_API_Key} |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
audio_url | String | 是 | https://example.com/source.wav | 待转码的音频 URL。
|
container_format | String | 否 | MP3 | 目标封装格式。建议填写。系统会根据封装格式自动选择对应的编码器:
|
audio | Object | 否 | - | |
metadata_keep_tags | Array of Strings | 否 | ["title", "artist"] | 需要从源音频保留的元信息标签列表。默认情况下,转码过程会丢弃大部分元信息(如标题、艺术家等)。使用此参数可以指定需要保留的标签键(Key)。 |
metadata_add_tags | Array of Objects | 否 | [{"key": "album", "value": "Remastered 2024"}] | 需要为输出音频新增的元信息标签列表,每个标签由 key 和 value 组成。如果新增的标签与被保留的标签同名,此处的设置会覆盖源文件的值。 |
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。详情请参考项目与队列管理。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
sample_rate | Integer | 否 | 44100 | 音频采样率,单位为 Hz。默认为 48000。建议根据您的目标编码器填写。不同编码器支持的采样率不同:
|
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 | 错误详情对象,仅在 success 为 false 时返回。详见下文 Error 对象。 |
参数 | 类型 | 描述 |
code | String | |
type | String | 错误的宏观类型。例如 BadRequest。 |
message | String | 对错误的详细描述,可用于开发调试。 |
param | String | (可选)指出导致错误的具体参数。 |
参数 | 类型 | 描述 |
audio_url | String | 输出音频的地址。地址类型根据请求时是否设置 media_output_destination 而不同:
|
duration | Number | 音频时长,单位为秒。 |