AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 智能媒体管理 开发参考 API参考（2020-09-30） API目录 媒体处理 CreateMediaConvertTask - 创建媒体转码任务

CreateMediaConvertTask - 创建媒体转码任务

更新时间：
产品详情
我的收藏

创建一个异步的媒体转码任务，提供媒体转码、媒体拼接、视频截帧、视频转动图等相关音视频媒体文件处理能力。

接口说明

  • 请确保在使用该接口前，已充分了解智能媒体管理产品的收费方式和价格。
  • 调用该接口前，请确保当前 Region 已经存在可用的项目（Project），详见项目管理。
    注意 异步任务不保证时效。
  • 使用该接口进行媒体转码时，默认只处理一路视频/音频/字幕流，同时支持配置处理的视频/音频/字幕流数量。
  • 使用该接口进行媒体拼接时，最大支持的媒体数量为 11 个，此时配置的转码、截帧等参数将作用于拼接后媒体数据。
  • 该接口为异步接口，获取任务开始执行后，任务信息只保存 7 天，超过 7 天则无法再获取。调用 GetTask 或 ListTasks 接口获取返回的TaskId，查看任务信息。也可以通过设置 Notification 消息通知参数，通过消息通知获取任务信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用前面加 * 表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
imm:CreateMediaConvertTaskcreate
*Project
acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}
    无
无

请求参数

名称类型必填描述示例值
ProjectNamestring是

项目名称，获取方式请参见创建项目。

test-project
Sourcesarray<object>是

媒体文件列表。若列表元素大于 1 个则表示开启 Concat（拼接）功能，Concat 顺序为输入视频文件 URI 的顺序。

object是

源媒体文件。

URIstring否

OSS 地址规则为oss://${Bucket}/${Object}，其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称，${Object}为包含文件扩展名的文件完整路径。

oss://test-bucket/test-object
StartTimedouble否

媒体转码开始时间，单位为秒。取值范围如下：

  • 0（默认）：从媒体起始时间开始转码。
  • n（大于 0）：从媒体起始时间 n 秒后开始转码。
0
Durationdouble否

媒体转码时长。单位为秒，默认值为 0，表示到视频结束时间。

0
Subtitlesarray<object>否

添加字幕列表，默认为空。

object否

字幕信息。

URIstring否

OSS 地址规则为oss://${Bucket}/${Object}，其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称，${Object}为包含文件扩展名的文件完整路径。 支持的字幕格式为：srt，vtt，mov_text，ass，dvd_sub，pgs。

oss://test-bucket/test-object
TimeOffsetdouble否

字幕延迟时间，单位为秒，默认为 0。

10.5
Languagestring否

字幕语言，参考标准为 ISO 639-2，默认为空。

eng
Attachedboolean否

将当前源媒体文件作为同步播放的音频流或视频流添加到输出媒体文件中，默认值为 false。

说明
  • AlignmentIndex 参数指向 Source 的 Attached 参数不能为 true。
    •
    		false
    AlignModestring否

    添加音视频流的对齐策略，取值范围如下：

    • false（默认）：不对齐。
    • loop：循环音频、视频内容以对齐。
    • pad：通过填充静音帧、黑帧视频对齐。
    说明
  • 仅当 Attached 参数为 true 时有效。
    •
    		false
    DisableVideoboolean否

    是否禁用该源媒体文件中的视频，取值范围如下：

    • true：禁用。
    • false（默认）：不禁用。
    		false
    DisableAudioboolean否

    是否禁用该源媒体文件中的音频，取值范围如下：

    • true：禁用。
    • false（默认）：不禁用。
    		false
    Targetsarray<object>是

    媒体处理任务列表，支持配置多任务。

    object是

    Targets 数组元素的详细信息。

    URIstring否

    媒体转码输出文件的 OSS 地址。

    OSS 地址规则为oss://${Bucket}/${Object}，其中${Bucket}为和当前项目处于同一区域(Region)的 OSS Bucket 名称，${Object}为包含文件扩展名的文件完整路径。

    • 当 URI 存在拓展名时转码输出的媒体文件 OSS 地址均为 URI，若输出文件为多个会存在覆盖的情况。
    • 当 URI 不存在拓展名时转码输出的媒体文件 OSS 地址由 URI、Container 与 Segment 参数共同决定，例如 URI 为oss://examplebucket/outputVideo：
      • 当 Container 为mp4，Segment 为空时，生成媒体文件的 OSS 地址为oss://examplebucket/outputVideo.mp4。
      • 当 Container 为ts，Segment 中 Format 为hls时，将产生 OSS 地址为oss://examplebucket/outputVideo.m3u8的 m3u8 文件以及多个拥有oss://examplebucket/outputVideo前缀的 ts 文件。
    		oss://test-bucket/test-target-object.mp4
    Containerstring否

    媒体容器类型。可选容器类型如下：

    • 音视频容器：mp4、mkv、mov、asf、avi、mxf、ts、flv
    • 音频容器：mp3、aac、flac、oga、ac3、opus
      注意 Container 与 URI 参数需要同时设置。若只进行字幕提取，截帧，截雪碧图或媒体转动图，则需要将 Container 与 URI 同时设为空值，此时设置的 Segment，Video，Audio 和 Speed 等参数无意义。
    		mp4
    Speedfloat否

    媒体倍速播放设置，取值范围为[0.5,1.0]，默认为 1.0。

    说明 转码后媒体文件与源媒体文件默认播放速度的比值，非倍速转码。
    		1.0
    Segmentobject否

    媒体切片设置，默认不进行切片。

    Formatstring否

    媒体切片方式。取值范围如下：

    • hls
    • dash
    		hls
    Durationdouble否

    切片长度。单位为秒。

    		30
    StartNumberinteger否

    起始序号，仅支持 hls，默认为 0。

    		5
    VideoTargetVideo否

    视频处理参数配置。

    注意 当 Video 为空值时，会将第一路视频流（若存在）直接拷贝到输出文件。

    AudioTargetAudio否

    音频处理参数配置。

    注意 当 Audio 为空值时，会将第一路音频流（若存在）直接拷贝到输出文件。

    SubtitleTargetSubtitle否

    字幕处理参数配置。

    注意 当 Subtitle 为空值时，会将第一路字幕流（若存在）直接拷贝到输出文件。

    ImageTargetImage否

    截帧，截雪碧图，媒体转动图参数配置。

    StripMetadataboolean否

    去除媒体文件 metadata，如title、album等，默认为 false。

    UserDatastring否

    用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。

    		{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}
    Tagsobject否

    自定义标签，用于对异步任务进行搜索、过滤。

    		{"test":"val1"}
    CredentialConfigCredentialConfig否

    如无特殊需求，请保持留空即可。

    链式授权配置。更多信息，请参见使用链式授权访问其他实体资源。

    NotificationNotification否

    消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见异步通知消息格式。

    AlignmentIndexinteger否

    在进行媒体拼接时，主媒体文件（提供Video、Audio中默认转码参数，包括分辨率、帧率等）在拼接列表中的序号，默认为 0（对齐拼接列表中第一个媒体文件）。

    		0

    返回参数

    名称类型描述示例值
    object

    响应结构体

    RequestIdstring

    请求 ID。

    		CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6
    EventIdstring

    事件 ID。

    		0ED-1Bz8z71k5TtsUejT4UJ16Es****
    TaskIdstring

    任务 ID。

    		MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6",
  "EventId": "0ED-1Bz8z71k5TtsUejT4UJ16Es****",
  "TaskId": "MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****"
}

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-05-09OpenAPI 入参发生变更查看变更详情
    2023-04-03OpenAPI 入参发生变更查看变更详情
    2023-03-09OpenAPI 入参发生变更查看变更详情
    2022-08-16OpenAPI 入参发生变更查看变更详情
    2022-08-16OpenAPI 入参发生变更查看变更详情
    上一篇：媒体处理下一篇：DetectMediaMeta - 获取媒体文件元信息