创建一个异步的媒体转码任务,提供媒体转码、媒体拼接、视频截帧、视频转动图等相关音视频媒体文件处理能力。
接口说明
- 请确保在使用该接口前,已充分了解智能媒体管理产品的收费方式和价格。
- 调用该接口前,请确保当前 Region 已经存在可用的项目(Project),详见项目管理。
- 使用该接口进行媒体转码时,默认只处理一路视频/音频/字幕流,同时支持配置处理的视频/音频/字幕流数量。
- 使用该接口进行媒体拼接时,最大支持的媒体数量为 11 个,此时配置的转码、截帧等参数将作用于拼接后媒体数据。
- 该接口为异步接口,获取任务开始执行后,任务信息只保存 7 天,超过 7 天则无法再获取。调用 GetTask 或 ListTasks 接口获取返回的
TaskId
,查看任务信息。也可以通过设置 Notification 消息通知参数,通过消息通知获取任务信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
imm:CreateMediaConvertTask | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ProjectName | string | 是 | 项目名称,获取方式请参见创建项目。 | test-project |
Sources | array<object> | 是 | 媒体文件列表。若列表元素大于 1 个则表示开启 Concat(拼接)功能,Concat 顺序为输入视频文件 URI 的顺序。 | |
object | 是 | 源媒体文件。 | ||
URI | string | 否 | OSS 地址规则为 | oss://test-bucket/test-object |
StartTime | double | 否 | 媒体转码开始时间,单位为秒。取值范围如下:
| 0 |
Duration | double | 否 | 媒体转码时长。单位为秒,默认值为 0,表示到视频结束时间。 | 0 |
Subtitles | array<object> | 否 | 添加字幕列表,默认为空。 | |
object | 否 | 字幕信息。 | ||
URI | string | 否 | OSS 地址规则为 | oss://test-bucket/test-object |
TimeOffset | double | 否 | 字幕延迟时间,单位为秒,默认为 0。 | 10.5 |
Language | string | 否 | 字幕语言,参考标准为 ISO 639-2,默认为空。 | eng |
Targets | array<object> | 是 | 媒体处理任务列表,支持配置多任务。 | |
object | 是 | Targets 数组元素的详细信息。 | ||
URI | string | 否 | 媒体转码输出文件的 OSS 地址。 OSS 地址规则为
| oss://test-bucket/test-target-object.mp4 |
Container | string | 否 | 媒体容器类型。可选容器类型如下:
| mp4 |
Speed | float | 否 | 媒体倍速播放设置,取值范围为[0.5,2],默认为 1.0。 说明
转码后媒体文件与源媒体文件默认播放速度的比值,非倍速转码。
| 1.0 |
Segment | object | 否 | 媒体切片设置,默认不进行切片。 | |
Format | string | 否 | 媒体切片方式。取值范围如下:
| hls |
Duration | double | 否 | 切片长度。单位为秒。 | 30 |
StartNumber | integer | 否 | 起始序号,仅支持 hls,默认为 0。 | 5 |
Video | TargetVideo | 否 | 视频处理参数配置。 注意 当 Video 为空值时,会将第一路视频流(若存在)直接拷贝到输出文件。 | |
Audio | TargetAudio | 否 | 音频处理参数配置。 注意 当 Audio 为空值时,会将第一路音频流(若存在)直接拷贝到输出文件。 | |
Subtitle | TargetSubtitle | 否 | 字幕处理参数配置。 注意 当 Subtitle 为空值时,会将第一路字幕流(若存在)直接拷贝到输出文件。 | |
Image | TargetImage | 否 | 截帧,截雪碧图,媒体转动图参数配置。 | |
StripMetadata | boolean | 否 | 去除媒体文件 metadata,如 | |
UserData | string | 否 | 用户自定义信息,在异步消息通知中会为您返回,用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。 | {"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"} |
Tags | object | 否 | 自定义标签,用于对异步任务进行搜索、过滤。 | {"test":"val1"} |
CredentialConfig | CredentialConfig | 否 | 如无特殊需求,请保持留空即可。 链式授权配置。更多信息,请参见使用链式授权访问其他实体资源。 | |
Notification | Notification | 否 | 消息通知配置,详细内容请单击 Notification 查看,异步通知消息格式请参见异步通知消息格式。 | |
AlignmentIndex | integer | 否 | 在进行媒体拼接时,主媒体文件(提供 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6",
"EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es****",
"TaskId": "MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-05-09 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-03 | OpenAPI 入参发生变更 | 查看变更详情 |
2023-03-09 | OpenAPI 入参发生变更 | 查看变更详情 |
2022-08-16 | OpenAPI 入参发生变更 | 查看变更详情 |
2022-08-16 | OpenAPI 入参发生变更 | 查看变更详情 |