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:CreateMediaConvertTask

create

*Project

acs:imm:{#regionId}:{#accountId}:project/{#ProjectName}

无

请求参数

名称	类型	必填	描述	示例值
ProjectName	string	是	项目名称，获取方式请参见创建项目。	test-project
Sources	array<object>	是	媒体文件列表。若列表元素大于 1 个则表示开启 Concat（拼接）功能，Concat 顺序为输入视频文件 URI 的顺序。
	array<object>	否	源媒体文件。
URI	string	否	OSS 地址规则为`oss://${Bucket}/${Object}`，其中`${Bucket}`为和当前项目处于同一区域(Region)的 OSS Bucket 名称，`${Object}`为包含文件扩展名的文件完整路径。	oss://test-bucket/test-object
StartTime	number	否	媒体转码开始时间，单位为秒。取值范围如下： 0（默认）：从媒体起始时间开始转码。 n（大于 0）：从媒体起始时间 n 秒后开始转码。	0
Duration	number	否	媒体转码时长。单位为秒，默认值为 0，表示到视频结束时间。	0
Subtitles	array<object>	否	添加字幕列表，默认为空。
	object	否	字幕信息。
URI	string	否	OSS 地址规则为`oss://${Bucket}/${Object}`，其中`${Bucket}`为和当前项目处于同一区域(Region)的 OSS Bucket 名称，`${Object}`为包含文件扩展名的文件完整路径。支持的字幕格式为：srt，vtt，mov_text，ass，dvd_sub，pgs。	oss://test-bucket/test-object
TimeOffset	number	否	字幕延迟时间，单位为秒，默认为 0。	10.5
Language	string	否	字幕语言，参考标准为 ISO 639-2，默认为空。	eng
Attached	boolean	否	将当前源媒体文件作为同步播放的音频流或视频流添加到输出媒体文件中，默认值为 false。说明 AlignmentIndex 参数指向 Source 的 Attached 参数不能为 true。	false
AlignMode	string	否	添加音视频流的对齐策略，取值范围如下： false（默认）：不对齐。 loop：循环音频、视频内容以对齐。 pad：通过填充静音帧、黑帧视频对齐。说明仅当 Attached 参数为 true 时有效。	false
DisableVideo	boolean	否	是否禁用该源媒体文件中的视频，取值范围如下： true：禁用。 false（默认）：不禁用。	false
DisableAudio	boolean	否	是否禁用该源媒体文件中的音频，取值范围如下： true：禁用。 false（默认）：不禁用。	false
Targets	array<object>	否	媒体处理任务列表，支持配置多任务。
	array<object>	否	Targets 数组元素的详细信息。
URI	string	否	媒体转码输出文件的 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
Container	string	否	媒体容器类型。可选容器类型如下：音视频容器：mp4、mkv、mov、asf、avi、mxf、ts、flv 音频容器：mp3、aac、flac、oga、ac3、opus 重要 Container 与 URI 参数需要同时设置。若只进行字幕提取，截帧，截雪碧图或媒体转动图，则需要将 Container 与 URI 同时设为空值，此时设置的 Segment，Video，Audio 和 Speed 等参数无意义。	mp4
Speed	number	否	媒体倍速播放设置，取值范围为[0.5,1.0]，默认为 1.0。说明转码后媒体文件与源媒体文件默认播放速度的比值，非倍速转码。	1.0
Segment	object	否	媒体切片设置，默认不进行切片。
Format	string	否	媒体切片方式。取值范围如下： hls dash	hls
Duration	number	否	切片长度。单位为秒。	30
StartNumber	integer	否	起始序号，仅支持 hls，默认为 0。	5
Video	TargetVideo	否	视频处理参数配置。重要当 Video 为空值时，会将第一路视频流（若存在）直接拷贝到输出文件。
Audio	TargetAudio	否	音频处理参数配置。重要当 Audio 为空值时，会将第一路音频流（若存在）直接拷贝到输出文件。
Subtitle	TargetSubtitle	否	字幕处理参数配置。重要当 Subtitle 为空值时，会将第一路字幕流（若存在）直接拷贝到输出文件。
Image	TargetImage	否	截帧，截雪碧图，媒体转动图参数配置。
StripMetadata	boolean	否	去除媒体文件 metadata，如`title`、`album`等，默认为 false。
Data	object	否	数据流保留配置，默认不保留数据流。重要仅当 Container 为 mp4 时支持保留数据流。
Stream	array	否	需要处理的源文件数据流索引号列表。空值（默认）表示不保留数据流，索引号-1 表示保留所有数据流。示例：[0,1]处理索引号为 0 和 1 的数据流；[1]处理索引号为 1 的数据流；[-1]处理所有数据流。说明只处理索引号存在的数据流，索引号对应的数据流不存在时将忽略该索引号。
	integer	否	需要处理的数据流索引号。	0
AttachedPicture	object	否	封面图保留配置，默认不保留封面图。重要仅当 Container 为 mp4、mkv 时支持保留封面图。
Stream	array	否	需要处理的源文件封面图索引号列表。空值（默认）表示不保留封面图，索引号-1 表示保留所有封面图。示例：[0,1]处理索引号为 0 和 1 的封面图；[1]处理索引号为 1 的封面图；[-1]处理所有封面图。说明只处理索引号存在的封面图，索引号对应的封面图不存在时将忽略该索引号。
	integer	否	需要处理的封面图索引号。	0
UserData	string	否	用户自定义信息，在异步消息通知中会为您返回，用于方便您系统内对消息通知进行关联处理。最大长度为 2048 字节。	{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"}
Tags	object	否	自定义标签，用于对异步任务进行搜索、过滤。	{"test":"val1"}
CredentialConfig	CredentialConfig	否	如无特殊需求，请保持留空即可。链式授权配置。更多信息，请参见使用链式授权访问其他实体资源。
Notification	Notification	否	消息通知配置，详细内容请单击 Notification 查看，异步通知消息格式请参见异步通知消息格式。
AlignmentIndex	integer	否	在进行媒体拼接时，主媒体文件（提供`Video`、`Audio`中默认转码参数，包括分辨率、帧率等）在拼接列表中的序号，默认为 0（对齐拼接列表中第一个媒体文件）。	0
TargetGroups	array<object>	否	媒体打包任务列表，将输入媒体文件转换并打包为 HLS 输出，每个 TargetGroup 对应一个 HLS Master Playlist，支持配置多任务。
	array<object>	否
URI	string	否	打包任务输出的 HLS Master Playlist 文件的 OSS 地址。	oss://test-bucket/test-object/master.m3u8
Targets	array<object>	否	媒体打包子任务列表，每个 Target 对应 HLS Master Playlist 中的一个变体流（#EXT-X-STREAM-INF），并生成对应的 HLS Media Playlist。
	array<object>	否
URI	string	否	打包子任务输出的 HLS Media Playlist 文件的 OSS 地址。重要该 URI 必须与 TargetGroups.URI 位于同一级目录或其子目录下。	oss://test-bucket/test-target-object.mp4
Container	string	否	打包容器类型，仅支持 mp4, ts	mp4
Speed	number	否	媒体倍速播放设置，取值范围为[0.5,1.0]，默认为 1.0。说明转码后媒体文件与源媒体文件默认播放速度的比值，非倍速转码。	1.0
Segment	object	否	媒体打包配置
Format	string	否	媒体打包格式，仅支持 hls。	hls
Duration	number	否	分片时长，单位为秒。	30
StartNumber	integer	否	分片起始序号，默认为 0。	5
Video	TargetVideo	否	视频处理参数配置。重要当 Video 为空值时，会将第一路视频流（若存在）直接拷贝到输出文件。
Audio	TargetAudio	否	音频处理参数配置。重要当 Audio 为空值时，会将第一路音频流（若存在）直接拷贝到输出文件。
Subtitle	TargetSubtitle	否	字幕处理参数配置。重要需要通过 Subtitle.ExtractSubtitle 参数打包字幕流，其中 Subtitle.ExtractSubtitle.URI 必须与 TargetGroups.URI 位于同一级目录或其子目录下。Subtitle.ExtractSubtitle.Format 必须为 vtt。只需要在一个 Target 中配置既可打包所有字幕流。
StripMetadata	boolean	否	去除元数据，默认为 false。

返回参数

名称	类型	描述	示例值
	object	响应结构体
RequestId	string	请求 ID。	CA995EFD-083D-4F40-BE8A-BDF75FFFE0B6
EventId	string	事件 ID。	0ED-1Bz8z71k5TtsUejT4UJ16Es****
TaskId	string	任务 ID。	MediaConvert-adb1ee28-c4c9-42a7-9f54-3b8eadcb****

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。