SubmitJobs - ApsaraVideo Media Processing - Alibaba Cloud Documentation Center

Submits transcoding jobs. If the transcoding jobs and workflows created in the ApsaraVideo Media Processing (MPS) console cannot meet your business requirements, you can call the SubmitJobs operation to submit transcoding jobs. Specify transcoding parameters as required when you call the SubmitJobs operation.

Operation description

SubmitJobs is an asynchronous operation. After you submit transcoding jobs, the jobs are added to an MPS queue to be scheduled and run. The transcoding jobs may not have been complete when the response is returned. After you call this operation, you can call the QueryJobList operation to query the job results. You can also associate a Message Service (MNS) queue or topic with the MPS queue to receive notifications on the jobs. For more information, see Receive notifications.
An input file can be up to 100 GB in size. If the size of the input file exceeds this limit, the job may fail.
If you use an intelligent preset template to transcode an input file, you must first call the SubmitAnalysisJob operation to submit a preset template analysis job. After the analysis job is complete, you can call the QueryAnalysisJobList operation to obtain the available preset templates for the input file. When you submit a transcoding job, set TemplateId to the ID of an available preset template. If you specify a preset template that is not in the available preset templates, the transcoding job fails.
If you use a static preset template to transcode an input file, you do not need to submit a preset template analysis job.
If you want to use multiple accounts in MPS, you can create Resource Access Management (RAM) users by using your Alibaba Cloud account. For more information, see Create a RAM user and grant permissions to the RAM user. If the Alibaba Cloud account that is used to query transcoding jobs is not the one that is used to submit the transcoding jobs, no data is returned.
For information about transcoding FAQ, see FAQ about MPS.

QPS limits

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped, and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Input	string	Yes	The information about the input file. For more information, see the "Input" section of the Parameter details topic. Note The path of an Object Storage Service (OSS) object must be URL-encoded in UTF-8 before you use the path in MPS. The OSS bucket must reside in the same region as your MPS service.	a/b/c/test-cn.srt
Outputs	string	Yes	The job output configurations. For more information, see the "Output" section of the Parameter details topic. Specify the value in a JSON array of Output objects. You can specify up to 30 Output objects.	[{"OutputObject":"exampleOutput.mp4","TemplateId":"6181666213ab41b9bc21da8ff5ff**","WaterMarks":[{"InputFile":{"Bucket":"exampleBucket","Location":"oss-cn-hangzhou","Object":"image_01.png"},"WaterMarkTemplateId":"9b772ce2740d4d55876d8b542d47**"}],"UserData":"testid-001"}]
OutputBucket	string	Yes	The name of the OSS bucket that stores the output file. For more information about the term bucket, see Terms .	exampleBucket
OutputLocation	string	No	The region in which the OSS bucket that stores the output file resides. The OSS bucket must reside in the same region as MPS. For more information about the term bucket, see Terms .	oss-cn-hangzhou
PipelineId	string	Yes	The ID of the MPS queue. For more information, see Terms . To obtain the ID of an MPS queue, you can log on to the MPS console and choose Global Settings > MPS Queue and Callback in the left-side navigation pane. If you want to receive asynchronous message notifications, associate an MNS queue or topic with the MPS queue. For more information, see Receive notifications.	dd3dae411e704030b921e52698e5****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
JobResultList	object []	The transcoding jobs that are generated.
Job	object	The details of the job. If the job fails to be submitted, no job ID is generated.
CreationTime	string	The time when the job was created.	2014-01-10T12:00:00Z
Percent	long	The transcoding progress.	100
FinishTime	string	The time when the job was complete.	2014-01-10T12:20:00Z
State	string	The state of the job. Valid values: Submitted TranscodeFail	Submitted
JobId	string	The job ID.	31fa3c9ca8134f9cec2b4b0b0f78****
Code	string	The error code returned if the job failed. This parameter is not returned if the job was successful.	InternalError
Message	string	The error message returned if the job failed. This parameter is not returned if the job was successful.	The operation has failed due to some unknown error, exception or failure.
Output	object	The output of the job.
Video	object	The video configurations. Note If this parameter is specified, AliyunVideoCodec in the template specified by TemplateId is overwritten.
Bufsize	string	The size of the buffer. Unit: KB. Default value: 6000.	1000
Degrain	string	The strength of the independent noise reduction algorithm.	5
BitrateBnd	object	The average bitrate range of the video.
Max	string	The upper limit of the total bitrate. Unit: Kbit/s.	20
Min	string	The lower limit of the total bitrate. Unit: Kbit/s.	10
PixFmt	string	The pixel format of the video. The default pixel format can be yuv420p or the pixel format of the input file. Valid values: standard pixel formats such as yuv420p and yuvj420p. Note** If a non-standard pixel format such as yuvj420p(pc, bt470bg/bt470bg/smpte170m) is used, compatibility with the pixel format must be configured. Otherwise, the transcoding job fails.	yuvj420p
Pad	string	The black borders that are added to the video. The value is in the width:height:left:top format. Unit: pixel.	1280:800:0:140
Codec	string	The video codec. Valid values: H.264, H.265, GIF, and WEBP. Default value: H.264.	H.264
Height	string	The height of the video. Unit: pixel. Default value: the height of the input video.	1280
Qscale	string	The level of quality control on the video.	15
Crop	string	The method of video cropping. Valid values: border: Black borders are automatically detected and removed. A value in the format of width:height:left:top: The video is cropped based on the custom settings.	1280:800:0:140
Bitrate	string	The bitrate of the output video. Unit: Kbit/s.	10
Maxrate	string	The maximum bitrate of the video. Unit: Kbit/s.	10
MaxFps	string	The maximum frame rate.	15
Profile	string	The encoding profile. This parameter is returned only for the H.264 codec. Default value: high. Valid values: Note If multiple definitions are involved, we recommend that you use baseline for the lowest definition to ensure normal playback on low-definition devices, and use main or high for other definitions. baseline: applicable to mobile devices. main: applicable to standard-definition devices. high: applicable to high-definition devices.	baseline
Crf	string	The constant rate factor. If Crf is returned, the value of Bitrate is invalid. Default value if the value of Codec is H.264: 23. Default value if the value of Codec is H.265: 26.	22
Gop	string	The maximum interval between keyframes or the maximum number of frames in a frame group. Unit: seconds. Default value: 10. If the maximum number of frames is returned, the value does not have a unit.	1
Width	string	The width of the video. Unit: pixel. Default value: the width of the input video.	1080
Fps	string	The frame rate. Unit: frames per second. Valid values: 0 to 60. The value is 60 if the frame rate of the input file exceeds 60. Default value: the frame rate of the input file.	60
Preset	string	The preset video algorithm. Default value: medium. Valid values: veryfast fast medium slow slower	veryfast
ScanMode	string	The scan mode. Valid values: If this parameter is empty, the scan mode of the input file is used. auto: automatic deinterlacing. progressive: progressive scan. interlaced: interlaced scan. By default, this parameter is empty. Best practice: Interlaced scan consumes less bandwidth than progressive scan, but the image quality is poor. Therefore, mainstream video production uses progressive scan. If progressive scan or interlaced scan is used when the scan mode of the input file is neither of them, the transcoding job fails. We recommend that you use the scan mode of the input file or automatic deinterlacing to improve compatibility.	interlaced
ResoPriority	string	The priority of the resource.	1
TransConfig	object	The general transcoding configurations. Note If this parameter is specified in the request, the corresponding parameter in the specified transcoding template are overwritten.
IsCheckAudioBitrate	string	Indicates whether the audio bitrate is checked. If the bitrate of the output audio is higher than that of the input audio, the input bitrate is retained and the specified audio bitrate does not take effect. This parameter has a lower priority than IsCheckAudioBitrateFail. Valid values: true false Default value: If this parameter is empty and the codec of the output audio is different from the codec of the input audio, the default value is false. If this parameter is empty and the codec of the output audio is the same as the codec of the input audio, the default value is true.	false
TransMode	string	The transcoding mode. Valid values: onepass: transcoding based on one-pass algorithms, which has higher accuracy. twopass: transcoding based on two-pass algorithms, which has lower accuracy. CBR: transcoding based on a fixed bitrate.	onepass
IsCheckReso	string	Indicates whether the resolution is checked. If the output resolution is higher than the input resolution based on the width or height, the input resolution is retained. Valid values: true false Default value: false.	false
IsCheckVideoBitrateFail	string	Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, a transcoding failure is returned without transcoding the video. This parameter has a higher priority thanIsCheckVideoBitrate. Valid values: true false Default value: false.	true
AdjDarMethod	string	The method of resolution adjustment. Default value: none. Valid values: rescale: The video image is resized. crop: The video image is cropped. pad: The video image is scaled out to fill the view. none: The resolution is not adjusted.	crop
IsCheckVideoBitrate	string	Indicates whether the video bitrate is checked. If the bitrate of the output video is higher than that of the input video, the input bitrate is retained. Valid values: true false Default value: false.	false
IsCheckResoFail	string	Indicates whether the resolution is checked. This parameter has a higher priority than IsCheckReso. If the output resolution is higher than the input resolution based on the width or height, a transcoding failure is returned without transcoding the video. Valid values: true false Default value: false.	false
IsCheckAudioBitrateFail	string	Indicates whether the audio bitrate is checked. This parameter has a higher priority than IsCheckAudioBitrate. If the bitrate of the output audio is higher than that of the input audio, a transcoding failure is returned without transcoding the audio. Valid values: false true	true
Encryption	object	The encryption configurations. Only outputs in the M3U8 format are supported.
Type	string	The encryption type. Only hls-aes-128 may be returned.	hls-aes-128
Key	string	The key that is used to encrypt the video.	encryptionkey128
KeyType	string	The key encryption method. Keys cannot be transmitted to MPS in plaintext. Keys must be encrypted by using Base64 or Key Management Service (KMS). For example, if the key is encryptionkey128, you can encrypt the key by using the following method: Base64("encryptionkey128") or KMS(Base64("encryptionkey128").	Base64
Id	string	The encryption ID.	31fa3c9ca8134f9cec2b4b0b0f78****
KeyUri	string	The URL that is used to request the key. The URL is Base64-encoded.	https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/
SkipCnt	string	The number of unencrypted frames at the beginning of the video. Leaving these frames unencrypted enables video playback to quickly start.	3
WaterMarkList	object []	The watermarks. Note If watermarks are truncated or fail to be generated, check whether the text watermarks that you add contain special characters. If the text watermarks contain special characters, you must escape the special characters before you add the watermarks. Alternatively, you can submit a ticket to contact Alibaba Cloud customer service for compatibility processing.
Type	string	The type of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. For more information, see Parameter details. Valid values: Image Text	Image
ReferPos	string	The position of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Valid values: TopRight TopLeft BottomRight BottomLeft	TopRight
Dx	string	The horizontal offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Default value: 0. The value can be an integer or a decimal number. An integer indicates the pixel value of the horizontal offset. Valid values: [8,4096]. Unit: pixel. A decimal number indicates the ratio of the horizontal offset to the width in the output video resolution. Valid values: (0,1). The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.	1
Width	string	The width of the watermark image. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number. An integer indicates the pixel value of the watermark width. Valid values: [8,4096]. Unit: pixel. A decimal number indicates the ratio of the watermark width to the width in the output video resolution. Valid values: (0,1). The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.	1080
Height	string	The height of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number. An integer indicates the pixel value of the watermark height. Valid values: [8,4096]. Unit: pixel. A decimal number indicates the ratio of the watermark height to the height in the output video resolution. Valid values: (0,1). The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.	1280
InputFile	object	The watermark input file. PNG images and MOV files are supported.
Object	string	The name of the OSS object that is used as the input file.	example-logo-****.png
Location	string	The ID of the OSS region in which the input file is stored.	oss-cn-hangzhou
Bucket	string	The name of the OSS bucket in which the input file is stored.	example-bucket
WaterMarkTemplateId	string	The ID of the watermark template.	88c6ca184c0e47098a5b665e2a12****
Dy	string	The vertical offset of the watermark image relative to the output video. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. The value can be an integer or a decimal number. An integer indicates the pixel value of the vertical offset. Valid values: [8,4096]. Unit: pixel. A decimal number indicates the ratio of the vertical offset to the height in the output video resolution. Valid values: (0,1). The decimal number can be accurate to four decimal places, such as 0.9999. Excess digits are automatically deleted.	1
WaterMarkConfigUrl	string	The URL of the watermark configuration file.	http://example.com/configure
DeWatermark	string	The configurations of watermark blurring. The value is a JSON object. For more information, see the DeWatermark section of the Parameter details topic.	{"0": [{"l": 10,"t": 10,"w": 10,"h": 10},{"l": 100,"t": 0.1,"w": 10,"h": 10}],"128000": [],"250000": [{"l": 0.2,"t": 0.1,"w": 0.01,"h": 0.05}]}
M3U8NonStandardSupport	object	The non-standard support configuration for M3U8. The value is a JSON object. For more information, see the M3U8NonStandardSupport section of the Parameter details topic.
TS	object	The non-standard support configurations for TS files. The value is a JSON object. For more information, see the TS section of the Parameter details topic.
SizeSupport	boolean	Indicates whether the size of the TS file is generated in the output M3U8 video. Valid values: true false	true
Md5Support	boolean	Indicates whether the output of the MD5 value of the TS file is supported in the M3U8 video. Valid values: true false	true
Priority	string	The priority of the job in the MPS queue to which the job is added. A value of 10 indicates the highest priority. Default value: 6.	5
Audio	object	The audio configurations. Note If this parameter is specified in the request, the corresponding configurations in the specified transcoding template are overwritten.
Profile	string	The codec profile of the audio. Note Valid values if the value of Codec is aac: aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld.	aac_low
Codec	string	The audio codec. Valid values: aac, mp3, vorbis, and flac. Default value: aac.	aac
Samplerate	string	The sampling rate. Valid values: 22050, 32000, 44100, 48000, and 96000. Unit: Hz. Default value: 44100. Note If the video container format is FLV and the audio codec is MP3, the value of this parameter cannot be 32000, 48000, or 96000. If the audio codec is MP3, the value of this parameter cannot be 96000.	32000
Qscale	string	The level of quality control on the audio.	15
Channels	string	The number of sound channels. If the value of Codec is mp3, the value of this parameter can only be 1 or 2. If the value of Codec is aac, the value of this parameter can only be 1, 2, 4, 5, 6, or 8. Default value: 2.	6
Volume	object	The volume configurations.
Method	string	The method that is used to adjust the volume. Valid values: auto dynamic linear	auto
Level	string	The volume adjustment range. Unit: decibel. Default value: -20.	-20
Bitrate	string	The audio bitrate of the output file. Unit: Kbit/s. Default value: 128.	128
AudioStreamMap	string	The sequence number of the audio stream. Format: 0:a:{Sequence number}. Example: 0:a:0. The sequence number is the index of the audio stream in the list and starts from 0. If no sequence number is specified, the default audio stream is used.	0:a:0
MergeList	object []	The configurations for merging clips.
Start	string	The start point in time of the clip. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Examples: 01:59:59.999 and 32000.23.	00000.50
RoleArn	string	The Alibaba Cloud Resource Name (ARN) of the Resource Access Management (RAM) role used for delegated authorization.	acs:ram::<your uid>:role/<your role name>
MergeURL	string	The OSS URL of the clip. Example: `http://example-bucket-**.oss-cn-hangzhou.aliyuncs.com/example-object-**.flv`. The OSS URL of the object must be URL-encoded by using the UTF-8 standard.	http://example-bucket-**.oss-cn-hangzhou.aliyuncs.com/example-object-**.flv
Duration	string	The duration of the clip. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Examples: 01:59:59.999 and 32000.23.	00000.20
SuperReso	object	The configurations for using the resolution of the source video.
IsHalfSample	string	Indicates whether parameters related to the sampling rate are obtained. Valid values: true false	true
UserData	string	The custom data.	example data
OutSubtitleList	object []	The output subtitles.
Map	string	The video track. Format: `0:{Stream}:{Stream sequence number}`, which is `0:v:{video_index}`. The value of Stream is v, which indicates a video stream. The sequence number is the index of the video stream in the list and starts from 0.	0:v:0
OutSubtitleFile	object	The details of the output file.
RoleArn	string	The ARN of the RAM role used for delegated authorization.	acs:ram::<your uid>:role/<your role name>
Object	string	The name of the OSS object that is used as the output file.	example-output.flv
Location	string	The ID of the OSS region in which the output file is stored.	oss-cn-hangzhou
Bucket	string	The name of the OSS bucket in which the input file is stored.	example-bucket-****
Success	boolean	Indicates whether the job was created. Valid values: true false	true
Message	string	The error message returned if the job failed to be created. This parameter is not returned if the job was created.	The specified parameter “%s” cannot be null.
DigiWaterMark	object	The digital watermarks.
Type	string	The type of the watermark. If this parameter is specified in the request, the corresponding parameter in the watermark template is overwritten. Valid values: Image (default) Text	Image
Alpha	string	The transparency of the text or image. Value values: (0,1]. Default value: 1.0.	1.0
InputFile	object	The details of the input file.
Object	string	The name of the OSS object that is used as the input file.	example-intput.flv
Location	string	The ID of the OSS region in which the input file is stored.	oss-cn-hangzhou
Bucket	string	The name of the OSS bucket in which the input file is stored.	example-bucket-****
VideoStreamMap	string	The sequence number of the video stream. Format: 0:a:{Sequence number}. Example: 0:a:0. The sequence number is the index of the video stream in the list and starts from 0. If no sequence number is specified, the default video stream is used.	0:a:0
OutputFile	object	The details of the output file.
RoleArn	string	The ARN of the RAM role used for delegated authorization.	acs:ram::<your uid>:role/<your role name>
Object	string	The name of the OSS object that is used as the output file.	example-output.flv
Location	string	The ID of the OSS region in which the output file is stored.	oss-cn-hangzhou
Bucket	string	The name of the OSS bucket in which the input file is stored.	example-bucket-****
AmixList	object []	The audio tracks that are mixed.
Map	string	The audio track that is mixed. Format: 0:a:{audio_index}. Example: 0:a:0.	0:a:0
Start	string	The start time. The value is in the number or time format. Examples: 1:25:36.240 and 32000.23.	0
AmixURL	string	The URL of the audio track that is mixed as the background music. The URL can be an OSS URL or the string `input`. A value of input indicates that two audio tracks are mixed in a video.	https://outpu***.oss-cn-shanghai.aliyuncs.com/mp4-to-mp3%5E1571025263578816%40.mp3
Duration	string	The duration of the mixed audio track. The value is in the number or time format.	20
MixDurMode	string	The mode to specify the mixing duration. Valid values: first and long. first: The length of the output media equals the length of the input media. long: The length of the output media equals the length of the output media or the length of the input media, whichever is longer. Default value: long.	long
Rotate	string	The rotation angle of the video, in the clockwise direction.	180
Container	object	The container format configurations.
Format	string	The container format. Default value: mp4. Video formats include FLV, MP4, HLS (M3U8 + TS), and MPEG-DASH (MPD + fMP4). Audio formats include MP3, MP4, Ogg, FLAC, and M4A. Image formats include GIF and WebP. If the container format is GIF, the video codec must be GIF. If the container format is WebP, the video codec must be WebP. If the container format is FLV, the video codec cannot be H.265.	flv
Clip	object	The information about the clip.
TimeSpan	object	The time span of the clip.
Seek	string	The start time. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.	01:59:59.999
Duration	string	The duration of the clip. Format: `hh:mm:ss[.SSS]` or `sssss[.SSS]`. Valid values: `[00:00:00.000,23:59:59.999]` or `[0.000,86399.999]`.	01:00:59.999
MergeConfigUrl	string	The URL of the merging configuration file. Only one of MergeList and MergeConfigUrl takes effect. The configuration file specified by MergeConfigUrl can contain up to 50 clips. MergeConfigUrl indicates the URL of the configuration file for merging clips. Make sure that the configuration file is stored as an object in OSS and that MPS can access the OSS object. For information about the file content, see the details about merging parameters. Example of the content of the merging configuration file: `{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}`.	`{"MergeList":[{"MergeURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4"}]}
OpeningList	object []	The opening parts. The value is a JSON object.
openUrl	string	The OSS URL of the opening part.	http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv
Start	string	The amount of time after which the opening part is played. The value starts from 0. Unit: seconds. Default value: 0.	1
Width	string	The width of the opening part. Valid values: values in the range of (0,4096), -1, and full. Default value: -1. A value of -1 indicates that the width of the source of the opening part is retained. A value of full indicates that the width of the main part is used for the opening part.	1920
Height	string	The height of the opening part. Valid values: values in the range of (0,4096), -1, and full. Default value: -1. A value of -1 indicates that the height of the source of the opening part is retained. A value of full indicates that the height of the main part is used for the opening part.	1080
MuxConfig	object	The transmuxing configurations. If this parameter is specified in the request, the corresponding configurations in the specified transcoding template are overwritten.
Webp	object	The transmuxing configurations for WebP.
Loop	string	The loop count.	0
Gif	object	The transmuxing configurations for GIF.
FinalDelay	string	The duration for which the final frame is paused. Unit: centisecond.	0
DitherMode	string	The color dithering algorithm of the palette. Valid values: sierra and bayer.	bayer
Loop	string	The loop count.	0
IsCustomPalette	string	Indicates whether a custom palette is used. Valid values: true false	false
Segment	object	The segment configuration. The value is a JSON object.
Duration	string	The length of the segment. The value is an integer. Unit: seconds. Valid values: [1,10]. Default value: 10.	20
TailSlateList	object []	The ending parts. The value is a JSON object.
Start	string	The start time.	1
BgColor	string	The color of the bars that are added to the ending part if the size of the ending part is smaller than that of the main part. Default value: White. For more information, see Background colors.	White
IsMergeAudio	boolean	Indicates whether the audio content of the ending part is merged. Valid values: true false	false
Width	string	The width of the ending part. Valid values: values in the range of (0,4096), -1, and full. A value of -1 indicates that the width of the source of the ending part is retained. A value of full indicates that the width of the main part is used for the ending part. Default value: -1.	1920
Height	string	The height of the ending part. Valid values: values in the range of (0,4096), -1, and full. A value of -1 indicates that the height of the source of the ending part is retained. A value of full indicates that the height of the main part is used for the ending part. Default value: -1.	1080
BlendDuration	string	The duration of the transition between the main part and the ending part. A fade transition is used: The last frame of the main part fades out, and the first frame of the ending part fades in. Unit: seconds. Default value: 0.	2
TailUrl	string	The OSS URL of the ending part.	http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv
TemplateId	string	The ID of the transcoding template.	S00000000-000010
SubtitleConfig	object	The subtitle configurations.
ExtSubtitleList	object []	The external subtitles. The value is a JSON array that contains up to four objects.
CharEnc	string	The character set used by the external subtitle. Valid values: UTF-8, GBK, BIG5, and auto. Default value: auto. Note If this parameter is set to auto, the detected character set may not be the actual character set. We recommend that you set this parameter to another value.	UTF-8
FontName	string	The font of the hardcoded subtitles converted from external subtitles. Default value: SimSun. For more information, see Fonts .	"WenQuanYi Zen Hei", "Yuanti SC Regular", "SimSun"
Input	object	The OSS object that is used as the external subtitle. The value is a JSON object. Files in the SRT or ASS format are supported.
Object	string	The name of the OSS object that is used as the input file.	example-output.flv
Location	string	The ID of the OSS region in which the input file is stored.	oss-cn-hangzhou
Bucket	string	The name of the OSS bucket in which the input file is stored.	example-bucket-****
SubtitleList	object []	The subtitles.
Map	string	The audio track. Format: `0:{Stream}:{Stream sequence number}`, which is `0:a:{audio_index}`. The value of Stream is a, which indicates an audio stream. The sequence number is the index of the audio stream in the list and starts from 0.	0:a:0
Properties	object	The media properties.
Width	string	The width of the video.	1280
Height	string	The height of the video.	720
Duration	string	The duration of the video.	55
Fps	string	The frame rate of the video. The value is a number.	25
Bitrate	string	The bitrate of the video.	1000
FileFormat	string	The format of the video.	QuickTime / MOV
Streams	object	The stream information.
VideoStreamList	object []	The video streams.
Index	string	The sequence number of the video stream. The value indicates the position of the video stream in all video streams.	0
Timebase	string	The time base of the video stream.	1/24000
AvgFPS	string	The average frame rate of the video stream.	23.976025
PixFmt	string	The pixel format of the video stream.	yuv420p
Sar	string	The sample aspect ratio (SAR) of the video stream.	1:1
Lang	string	The language of the video stream. For more information, see FFmpeg documentation and ISO 639.	eng
CodecLongName	string	The full name of the codec.	H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10
Height	string	The height of the video stream in pixels.	720
NumFrames	string	The total number of frames.	25
Bitrate	string	The bitrate of the video stream.	1496.46
CodecTagString	string	The tag string of the codec.	avc1
HasBFrames	string	Indicates whether the video stream contains B-frames.	2
Profile	string	The codec profile.	high
StartTime	string	The start time of the video stream.	0.000000
NetworkCost	object	The network bandwidth that was consumed.
PreloadTime	string	The amount of time consumed to preload the video stream.	8
AvgBitrate	string	The average bitrate of the video stream.	100
CostBandwidth	string	The maximum bandwidth that was consumed.	10
Dar	string	The display aspect ratio (DAR) of the video stream.	16:9
CodecName	string	The short name of the codec.	h264
Width	string	The width of the video stream in pixels.	1280
Duration	string	The duration of the video stream.	17.225542
Fps	string	The frame rate of the video stream.	23.976025
CodecTag	string	The tag of the codec.	0x31637661
CodecTimeBase	string	The codec time base.	1001/48000
Level	string	The codec level.	51
AudioStreamList	object []	The audio streams.
Timebase	string	The time base of the audio stream.	1/44100
Index	string	The sequence number of the audio stream. The value indicates the position of the audio stream in all audio streams.	1
SampleFmt	string	The sampling format.	fltp
ChannelLayout	string	The output layout of the sound channels.	stereo
Lang	string	The language of the audio stream. For more information, see FFmpeg documentation and ISO 639.	eng
Samplerate	string	The sampling rate of the audio stream.	44100
CodecLongName	string	The full name of the codec.	AAC (Advanced Audio Coding)
Channels	string	The number of sound channels.	2
NumFrames	string	The total number of frames.	25
Bitrate	string	The bitrate of the audio stream.	128.806
CodecTagString	string	The tag string of the codec.	mp4a
StartTime	string	The start time of the audio stream.	0.000000
CodecName	string	The short name of the codec.	aac
Duration	string	The duration of the audio stream.	17.159546
CodecTag	string	The tag of the codec.	0x6134706d
CodecTimeBase	string	The codec time base.	1/44100
SubtitleStreamList	object []	The subtitle streams.
Index	string	The sequence number of the subtitle stream. The value indicates the position of the subtitle stream in all subtitle streams.	1
Lang	string	The language of the subtitle stream. For more information, see FFmpeg documentation and ISO 639.	eng
Format	object	The format information.
StartTime	string	The start time.	0.000000
NumPrograms	string	The total number of program streams.	0
Size	string	The size of the file.	3509895
NumStreams	string	The total number of media streams.	2
FormatLongName	string	The full name of the container format.	QuickTime / MOV
Duration	string	The total duration.	55
Bitrate	string	The total bitrate.	1000
FormatName	string	The short name of the container format. Valid values: mov, mp4, m4a, 3gp, 3g2, and mj2.	mov
FileSize	string	The size of the file.	3509895
PipelineId	string	The ID of the MPS queue.	88c6ca184c0e47098a5b665e2a126797
Input	object	The information about the job input.
Object	string	The name of the OSS object that is used as the job input.	example.flv
Location	string	The ID of the OSS region in which the job input is stored.	oss-cn-hangzhou
Bucket	string	The name of the OSS bucket in which the job input is stored.	example-bucket-****
MNSMessageResult	object	The message sent by MNS to notify users of the job result.
MessageId	string	The ID of the error message returned if the job failed. This parameter is not returned if the job was successful.	123
ErrorMessage	string	The error message returned if the job failed. This parameter is not returned if the job was successful.	The resource operated "%s" cannot be found.
ErrorCode	string	The error code returned if the job failed. This parameter is not returned if the job was successful.	InvalidParameter.ResourceNotFound
Success	boolean	Indicates whether the job was successful. Valid values: true false	true
Code	string	The error code returned if the job failed to be created. This parameter is not returned if the job was created.	InvalidParameter.NullValue
Message	string	The error message returned if the job failed to be created. This parameter is not returned if the job was created.	The specified parameter "%s" cannot be null.
RequestId	string	The request ID.	25818875-5F78-4A45S71F6-D73936451234

Examples

Sample success responses

JSONformat

{
  "JobResultList": {
    "JobResult": [
      {
        "Job": {
          "CreationTime": "2014-01-10T12:00:00Z",
          "Percent": 100,
          "FinishTime": "2014-01-10T12:20:00Z",
          "State": "Submitted",
          "JobId": "31fa3c9ca8134f9cec2b4b0b0f78****",
          "Code": "InternalError",
          "Message": "The operation has failed due to some unknown error, exception or failure.",
          "Output": {
            "Video": {
              "Bufsize": "1000",
              "Degrain": "5",
              "BitrateBnd": {
                "Max": "20",
                "Min": "10"
              },
              "PixFmt": "yuvj420p",
              "Pad": "1280:800:0:140",
              "Codec": "H.264",
              "Height": "1280",
              "Qscale": "15",
              "Crop": "1280:800:0:140",
              "Bitrate": "10",
              "Maxrate": "10",
              "MaxFps": "15",
              "Profile": "baseline",
              "Crf": "22",
              "Gop": "1",
              "Width": "1080",
              "Fps": "60",
              "Preset": "veryfast",
              "ScanMode": "interlaced",
              "ResoPriority": "1"
            },
            "TransConfig": {
              "IsCheckAudioBitrate": "false",
              "TransMode": "onepass",
              "IsCheckReso": "false",
              "IsCheckVideoBitrateFail": "true",
              "AdjDarMethod": "crop",
              "IsCheckVideoBitrate": "false",
              "IsCheckResoFail": "false",
              "IsCheckAudioBitrateFail": "true"
            },
            "Encryption": {
              "Type": "hls-aes-128",
              "Key": "encryptionkey128",
              "KeyType": "Base64",
              "Id": "31fa3c9ca8134f9cec2b4b0b0f78****",
              "KeyUri": "https://1161758785*****.cn-shanghai.fc.aliyuncs.com/2016-08-15/proxy/HLS-decyptServer/decyptServer/",
              "SkipCnt": "3"
            },
            "WaterMarkList": {
              "WaterMark": [
                {
                  "Type": "Image",
                  "ReferPos": "TopRight",
                  "Dx": "1",
                  "Width": "1080",
                  "Height": "1280",
                  "InputFile": {
                    "Object": "example-logo-****.png",
                    "Location": "oss-cn-hangzhou",
                    "Bucket": "example-bucket"
                  },
                  "WaterMarkTemplateId": "88c6ca184c0e47098a5b665e2a12****",
                  "Dy": "1"
                }
              ]
            },
            "WaterMarkConfigUrl": "http://example.com/configure",
            "DeWatermark": "{\"0\": [{\"l\": 10,\"t\": 10,\"w\": 10,\"h\": 10},{\"l\": 100,\"t\": 0.1,\"w\": 10,\"h\": 10}],\"128000\": [],\"250000\": [{\"l\": 0.2,\"t\": 0.1,\"w\": 0.01,\"h\": 0.05}]}",
            "M3U8NonStandardSupport": {
              "TS": {
                "SizeSupport": true,
                "Md5Support": true
              }
            },
            "Priority": "5",
            "Audio": {
              "Profile": "aac_low",
              "Codec": "aac",
              "Samplerate": "32000",
              "Qscale": "15",
              "Channels": "6",
              "Volume": {
                "Method": "auto",
                "Level": "-20"
              },
              "Bitrate": "128"
            },
            "AudioStreamMap": "0:a:0",
            "MergeList": {
              "Merge": [
                {
                  "Start": "00000.50",
                  "RoleArn": "acs:ram::<your uid>:role/<your role name>",
                  "MergeURL": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example-object-****.flv",
                  "Duration": "00000.20"
                }
              ]
            },
            "SuperReso": {
              "IsHalfSample": "true"
            },
            "UserData": "example data",
            "OutSubtitleList": {
              "OutSubtitle": [
                {
                  "Map": "0:v:0",
                  "OutSubtitleFile": {
                    "RoleArn": "acs:ram::<your uid>:role/<your role name>",
                    "Object": "example-output.flv",
                    "Location": "oss-cn-hangzhou",
                    "Bucket": "example-bucket-****"
                  },
                  "Success": true,
                  "Message": "The specified parameter “%s” cannot be null."
                }
              ]
            },
            "DigiWaterMark": {
              "Type": "Image",
              "Alpha": "1.0",
              "InputFile": {
                "Object": "example-intput.flv",
                "Location": "oss-cn-hangzhou",
                "Bucket": "example-bucket-****"
              }
            },
            "VideoStreamMap": "0:a:0",
            "OutputFile": {
              "RoleArn": "acs:ram::<your uid>:role/<your role name>",
              "Object": "example-output.flv",
              "Location": "oss-cn-hangzhou",
              "Bucket": "example-bucket-****"
            },
            "AmixList": {
              "Amix": [
                {
                  "Map": "0:a:0",
                  "Start": "0",
                  "AmixURL": "https://outpu***.oss-cn-shanghai.aliyuncs.com/mp4-to-mp3%5E1571025263578816%40.mp3",
                  "Duration": "20",
                  "MixDurMode": "long"
                }
              ]
            },
            "Rotate": "180",
            "Container": {
              "Format": "flv"
            },
            "Clip": {
              "TimeSpan": {
                "Seek": "01:59:59.999",
                "Duration": "01:00:59.999"
              }
            },
            "MergeConfigUrl": "`{\"MergeList\":[{\"MergeURL\":\"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/video_01.mp4\"}]}",
            "OpeningList": {
              "Opening": [
                {
                  "openUrl": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv",
                  "Start": "1",
                  "Width": "1920",
                  "Height": "1080"
                }
              ]
            },
            "MuxConfig": {
              "Webp": {
                "Loop": "0"
              },
              "Gif": {
                "FinalDelay": "0",
                "DitherMode": "bayer",
                "Loop": "0",
                "IsCustomPalette": "false"
              },
              "Segment": {
                "Duration": "20"
              }
            },
            "TailSlateList": {
              "TailSlate": [
                {
                  "Start": "1",
                  "BgColor": "White",
                  "IsMergeAudio": false,
                  "Width": "1920",
                  "Height": "1080",
                  "BlendDuration": "2",
                  "TailUrl": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv"
                }
              ]
            },
            "TemplateId": "S00000000-000010",
            "SubtitleConfig": {
              "ExtSubtitleList": {
                "ExtSubtitle": [
                  {
                    "CharEnc": "UTF-8",
                    "FontName": "\"WenQuanYi Zen Hei\", \"Yuanti SC Regular\", \"SimSun\"",
                    "Input": {
                      "Object": "example-output.flv",
                      "Location": "oss-cn-hangzhou",
                      "Bucket": "example-bucket-****"
                    }
                  }
                ]
              },
              "SubtitleList": {
                "Subtitle": [
                  {
                    "Map": "0:a:0"
                  }
                ]
              }
            },
            "Properties": {
              "Width": "1280",
              "Height": "720",
              "Duration": "55",
              "Fps": "25",
              "Bitrate": "1000",
              "FileFormat": "QuickTime / MOV",
              "Streams": {
                "VideoStreamList": {
                  "VideoStream": [
                    {
                      "Index": "0",
                      "Timebase": "1/24000",
                      "AvgFPS": "23.976025",
                      "PixFmt": "yuv420p",
                      "Sar": "1:1",
                      "Lang": "eng",
                      "CodecLongName": "H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10",
                      "Height": "720",
                      "NumFrames": "25",
                      "Bitrate": "1496.46",
                      "CodecTagString": "avc1",
                      "HasBFrames": "2",
                      "Profile": "high",
                      "StartTime": "0.000000",
                      "NetworkCost": {
                        "PreloadTime": "8",
                        "AvgBitrate": "100",
                        "CostBandwidth": "10"
                      },
                      "Dar": "16:9",
                      "CodecName": "h264",
                      "Width": "1280",
                      "Duration": "17.225542",
                      "Fps": "23.976025",
                      "CodecTag": "0x31637661",
                      "CodecTimeBase": "1001/48000",
                      "Level": "51"
                    }
                  ]
                },
                "AudioStreamList": {
                  "AudioStream": [
                    {
                      "Timebase": "1/44100",
                      "Index": "1",
                      "SampleFmt": "fltp",
                      "ChannelLayout": "stereo",
                      "Lang": "eng",
                      "Samplerate": "44100",
                      "CodecLongName": "AAC (Advanced Audio Coding)",
                      "Channels": "2",
                      "NumFrames": "25",
                      "Bitrate": "128.806",
                      "CodecTagString": "mp4a",
                      "StartTime": "0.000000",
                      "CodecName": "aac",
                      "Duration": "17.159546",
                      "CodecTag": "0x6134706d",
                      "CodecTimeBase": "1/44100"
                    }
                  ]
                },
                "SubtitleStreamList": {
                  "SubtitleStream": [
                    {
                      "Index": "1",
                      "Lang": "eng"
                    }
                  ]
                }
              },
              "Format": {
                "StartTime": "0.000000",
                "NumPrograms": "0",
                "Size": "3509895",
                "NumStreams": "2",
                "FormatLongName": "QuickTime / MOV",
                "Duration": "55",
                "Bitrate": "1000",
                "FormatName": "mov"
              },
              "FileSize": "3509895"
            }
          },
          "PipelineId": "88c6ca184c0e47098a5b665e2a126797",
          "Input": {
            "Object": "example.flv",
            "Location": "oss-cn-hangzhou",
            "Bucket": "example-bucket-****"
          },
          "MNSMessageResult": {
            "MessageId": "123",
            "ErrorMessage": "The resource operated \"%s\" cannot be found.",
            "ErrorCode": "InvalidParameter.ResourceNotFound"
          }
        },
        "Success": true,
        "Code": "InvalidParameter.NullValue",
        "Message": "The specified parameter \"%s\" cannot be null."
      }
    ]
  },
  "RequestId": "25818875-5F78-4A45S71F6-D73936451234"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history