MediaConvertJobConfig

Updated at:

Parameter

Type

Description

Example

object

The configurations of the transcoding task.

JobName

string

The task name.

  • Maximum length: 64 bytes.

Name

Inputs

array

The input file list for the transcoding task.

object

Input file configurations.

Name

string

The input file name, which can be referenced by InputRef in the output configuration.

InputVideo

InputFile

object

The input file.

Type

string

The type of the media file. Valid values:

  • OSS: an OSS object.

  • Media: a media asset.

OSS

Media

string

The URL or ID of the media file.

  • If Type is OSS, this is the file URL (OSS or HTTP). Do not use a signed URL, as it may cause authentication failure.

  • If Type is Media, this is the media asset ID. The source stream is used by default.

http://bucket.loction.aliyuncs.com/path/to/video.mp4

OutputGroups

array

The output group configurations.

object

Output group configurations.

Name

string

The name of the output group.

hls-group

GroupConfig

object

The configuration for this output group.

Type

string

The type of the output group. Valid values:

  • File: An individual file.

  • Hls: HLS files for adaptive bitrate streaming.

Hls

OutputFileBase

object

The base output directory. All files generated by this output group are stored in this directory.

Type

string

The type of the output file. Valid values:

  • OSS: an OSS object.

  • Media: a media asset.

OSS

Media

string

The media asset location.

  • If Type is OSS, this is the destination URL (OSS or HTTP).

  • If Type is Media, this is the destination media asset ID.

oss://bucket/path/to/dir

ManifestName

string

The manifest file name. Applicable only when Type is Hls or Dash.

manifest

ManifestExtend

object

Extension configuration for an existing manifest. References an existing manifest and combines it with the current output group results to generate a new manifest.

InputRef

string

The Name of an input that contains the manifest to extend.

Input-Manifest

Excludes

array

Streams to exclude from the referenced manifest. Conditions within a single exclusion object use AND logic. Multiple exclusion objects use OR logic.

object

Stream exclusion condition.

Language

string

Excludes streams by their Language field. Must conform to RFC 5646.

en

Name

string

Excludes streams by their Name field.

audio-1

Type

string

Excludes streams by their Type field.

Valid values:

  • Audio

  • Subtitle

Audio

Outputs

array

The output stream configurations. Each object defines a specific rendition.

object

Output stream configuration.

Name

string

A label for this output. Does not affect the filename.

group-output

TemplateId

string

The ID of the transcoding template.

****96e8864746a0b6f3****

OutputFileName

string

The output filename. Used together with OutputFileBase from GroupConfig.

720p.mp4

Priority

integer

The priority of the task, from 1 to 10. A higher value indicates a higher priority. Default: 6.

6

Features

string

Additional feature parameters. See MediaConvertJobFeature for details.

{}

OverrideParams

string

A JSON string of parameters that override the template settings.

{}

HlsGroupConfig

object

HLS-specific manifest settings for this stream. Effective only when the group Type is Hls.

Type

string

The stream type.

Valid values:

  • video: Video stream.

  • audio: Audio stream.

  • subtitle: Subtitle stream.

  • hybrid: A stream containing both audio and video.

Default value: hybrid.

hybrid

AudioGroup

string

The audio group this video stream references. Effective when Type is video.

Default value: audio.

audio

SubtitleGroup

string

The subtitle group this video or hybrid stream references. Effective when Type is video or hybrid.

Default value: subtitle.

subtitle

Name

string

The NAME attribute for this stream in the HLS manifest. Required when Type is audio or subtitle.

audio

Group

string

The GROUP-ID attribute for this stream in the HLS manifest. Effective when Type is audio or subtitle.

Default value: Same as the Type value.

audio

Language

string

The LANGUAGE attribute for this stream in the HLS manifest (must conform to RFC 5646). Effective when Type is audio or subtitle.

zh

IsDefault

string

Whether this is the default stream within its group. Effective when Type is audio or subtitle. Only one stream per group can be the default.

false

Forced

string

Whether this stream must be played. Effective when Type is audio or subtitle.

true

AutoSelect

string

Whether this stream should be automatically selected by the player. Effective when Type is audio or subtitle.

true