This topic describes the details of some parameters used in the ApsaraVideo Media Processing (MPS) API.
Input
Parameter | Type | Required | Description |
---|---|---|---|
Bucket | String | Yes | The Object Storage Service (OSS) bucket that stores the input file. You must grant the read permissions on the bucket to MPS on the Access Control page in the OSS console. For more information, see the descriptions related to buckets in Terms. |
Location | String | Yes | The OSS region in which the OSS bucket resides. For more information, see the description of the term region in Terms. |
Object | String | Yes | The OSS object that is used as the input file. The URL of the OSS object must comply with RFC 2396 and be encoded in UTF-8, with reserved characters being percent-encoded. For more information about encoding, see URL encoding. For more information about OSS objects, see the description of the term object in Terms. |
Referer | String | No | The configuration of the OSS hotlink protection. The setting of this parameter is equivalent to the configuration in the OSS console. This parameter is required if you want to configure OSS hotlink protection for a transcoding task. |
Output
Parameter | Type | Required | Description |
---|---|---|---|
OutputObject | String | Yes | The name of the OSS object that is used as the output file.
|
TemplateId | String | Yes | The ID of the transcoding template. You can specify a custom or preset transcoding template. |
Container | String | No | If you set this parameter, the parameter setting overwrites the setting of the corresponding parameter in the transcoding template. For more information, see the Container section in this topic. |
Video | String | No | If you set this parameter, the parameter setting overwrites the setting of the corresponding parameter in the transcoding template. For more information, see the Video section in this topic. |
Audio | String | No | If you set this parameter, the parameter setting overwrites the setting of the corresponding parameter in the transcoding template. For more information, see the Audio section in this topic. |
AudioStreamMap | String | No | The sequence number of the audio stream.
|
MuxConfig | String | No | If you set this parameter, the parameter setting overwrites the setting of the corresponding parameter in the transcoding template. For more information, see the MuxConfig section in this topic. |
TransConfig | String | No | The configuration of the transcoding process. If you set this parameter, the parameter setting overwrites the setting of the corresponding parameter in the transcoding template. For more information, see the TransConfig section in this topic. |
Clip | String | No | The clip. The value must be a JSON object. For more information, see the Clip section in this topic. Example: |
WaterMarks | WaterMark[] | No | The watermarks. The value must be a JSON array. For more information, see the WaterMarks section in this topic.
|
MergeList | String | No | The configuration of clip merging. You can merge up to four clips. For more information, see the MergeList section in this topic.
|
MergeConfigUrl | String | No | You can specify only one of the MergeList and MergeConfigUrl parameters.
|
M3U8NonStandardSupport | String | No | The non-standard support of the M3U8 format. For more information, see the M3U8NonStandardSupport section in this topic. Example: {"TS":{"Md5Support":true,"SizeSupport":true}} . |
Encryption | String | No | The encryption configuration. An encrypted file is generated in the M3U8 format.
|
SubtitleConfig | String | No | The subtitle configuration. The value must be a JSON object.
|
OpeningList | String | No | The opening parts. The value must be a JSON object.
|
TailSlateList | String | No | The ending parts. The value must be a JSON object.
|
DeWatermark | String | No | The configurations of watermark blurring. The value is a JSON object. For more information, see the DeWatermark section in this topic. |
Amix | String | No | The mixing configuration. This parameter is suitable for scenarios where background music is added or two audio tracks in a video are merged. For more information, see the Amix section in this topic. If you specify this parameter, you must also specify the AudioStreamMap parameter to select the audio tracks of the input video. The value of this parameter must be a JSON object. Example:{"AmixURL":"[{"AmixURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/tail.flv","Start":"1","Duration":"2"}]"}] . |
UserData | String | No | The custom data, which can be up to 1,024 bytes in size. |
Priority | String | No | The priority of the job in the MPS queue to which the job is added.
|
Rotate | String | No | The video rotation angle in the clockwise direction. Valid values: [0, 360). |
Container
Parameter | Type | Required | Description |
---|---|---|---|
Format | String | No | The format of the container.
|
Video
Parameter | Type | Required | Description | Description |
---|---|---|---|---|
Codec | String | No | The video codec. | Valid values: H.264, H.265, GIF, and WEBP. Default value: H.264. |
Profile | String | No | The encoding profile. | Valid values: baseline, main, and high. Default value: high.
If multiple definitions exist, we recommend that you set this parameter to baseline for the lowest definition to ensure normal playback on low-end devices. Set this parameter to main or high for other definitions. Note This parameter is valid only when the Codec parameter is set to H.264. |
Bitrate | String | No | The bitrate of the output video. |
|
Crf | String | No | The constant rate factor. |
Note If you specify this parameter, the setting of the Bitrate parameter becomes invalid. |
Width | String | No | The width. |
|
Height | String | No | The height. |
|
Fps | String | No | The frame rate. |
|
Gop | String | No | The group of pictures (GOP) size. The GOP size can be the maximum interval of keyframes or the maximum number of frames in a frame group. | If you specify the maximum interval of keyframes, the unit (s) is required.
|
Preset | String | No | The preset video algorithm. | Valid values: veryfast, fast, medium, slow, and slower. Default value: medium. Note This parameter is valid only when the Codec parameter is set to H.264. |
ScanMode | String | No | The scan mode. | Valid values: interlaced and progressive. |
Bufsize | String | No | The buffer size. |
|
Maxrate | String | No | The maximum bitrate of the output video. | Valid values: [10, 50000]. Unit: Kbit/s. |
PixFmt | String | No | The pixel format for video color encoding. | Standard pixel formats such as yuv420p and yuvj420p are supported. The default pixel format can be yuv420p or the original color format. |
Remove | String | No | Specifies whether to delete the video stream. |
|
Crop | String | No | The method of video cropping. | Valid values:
|
Pad | String | No | The black borders to be added to the video. | Format: width:height:left:top. Example: 1280:800:0:140. |
LongShortMode | String | No | Specifies whether to enable the auto-rotate screen feature. |
Default value: false. |
Container format | Audio codec | Video codec |
---|---|---|
FLV | AAC and MP3 | H.264 |
MP4 | AAC and MP3 | H.264 and H.265 |
TS | AAC and MP3 | H.264 and H.265 |
M3U8 | AAC and MP3 | H.264 and H.265 |
GIF | No | GIF |
Video stream parameter/Codec | H.264 | H.265 | GIF |
---|---|---|---|
Profile | Y | N | N |
Bitrate | Y | Y | N |
Crf | Y | Y | N |
Width | Y | Y | Y |
Height | Y | Y | Y |
Fps | Y | Y | Y |
Gop | Y | Y | N |
Preset | Y | N | N |
ScanMode | Y | Y | Y |
Bufsize | Y | Y | N |
Maxrate | Y | Y | N |
PixFmt | Y | Y | bgr8 |
Audio
Parameter | Type | Required | Description |
---|---|---|---|
Codec | String | No | The audio codec. Valid values: AAC, MP3, VORBIS, and FLAC. Default value: AAC. |
Profile | String | No | The codec profile of the audio. Valid values when the audio codec is set to AAC: aac_low, aac_he, aac_he_v2, aac_ld, and aac_eld. |
Samplerate | String | No | The sampling rate.
Note
|
Bitrate | String | No | The audio bitrate of the output file.
|
Channels | String | No | The number of sound channels. Default value: 2. Note
|
Remove | String | No | Specifies whether to delete the audio stream.
|
Volume | String | No | The volume configuration. For more information, see the Volume section in this section. |
Container | Audio Codecs |
---|---|
mp3 | MP3 |
mp4 | AAC |
ogg | VORBIS and FLAC |
flac | FLAC |
Volume
Parameter | Type | Required | Description |
---|---|---|---|
Method | String | No | The volume adjustment method. Valid values: auto, dynamic, and linear. |
IntegratedLoudnessTarget | String | No | The new volume.
|
TruePeak | String | No | The peak volume.
|
LoudnessRangeTarget | String | No | The range of the volume.
|
MuxConfig
Parameter | Type | Required | Description |
---|---|---|---|
Segment | String | No | The segment configuration. The value must be a JSON object.
|
Segment
Parameter | Type | Required | Description |
---|---|---|---|
Duration | String | No | The length of the segment.
Default value: 10. |
ForceSegTime | String | No | Specifies the points in time at which you want to segment the media file. You can specify up to 10 points in time. Separate the points in time with commas (,).
|
TransConfig
Parameter | Type | Required | Description |
---|---|---|---|
TransMode | String | No | The transcoding mode.
|
AdjDarMethod | String | No | The method of resolution adjustment.
|
IsCheckReso | String | No | Specifies whether to check the resolution. If this parameter is specified and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, the resolution of the input file is retained after transcoding.
|
IsCheckResoFail | String | No | Specifies whether to check the resolution. If this parameter is specified and the system detects that the resolution of the output file is higher than that of the input file based on the width or height, an error that indicates a transcoding failure is returned.
|
IsCheckVideoBitrate | String | No | Specifies whether to check the video bitrate. If this parameter is specified and the system detects that the video bitrate of the output file is greater than that of the input file, the video bitrate of the input file is retained after transcoding.
|
IsCheckAudioBitrate | String | No | Specifies whether to check the audio bitrate. If this parameter is specified and the system detects that the audio bitrate of the output file is greater than that of the input file, the audio bitrate of the input file is retained after transcoding. In this case, the setting of the Bitrate parameter is invalid. This parameter has a lower priority than the IsCheckAudioBitrateFail parameter.
|
IsCheckAudioBitrateFail | String | No | Specifies whether to check the audio bitrate. This parameter has a higher priority than the IsCheckAudioBitrate parameter.
|
IsCheckVideoBitrateFail | String | No | Specifies whether to check the video bitrate. This parameter has a higher priority than the IsCheckVideoBitrate parameter.
|
Clip
Parameter | Type | Required | Description |
---|---|---|---|
TimeSpan | String | No | The time span of the clip to be captured from the original file. For more information, see the TimeSpan section in this topic. |
ConfigToClipFirstPart | Boolean | No | Specifies whether to crop the first part of the file into a clip before clip merging.
|
TimeSpan
Parameter | Type | Required | Description |
---|---|---|---|
Seek | String | No | The start point in time of the clip.
Examples: 01:59:59.999 and 32000.23. |
Duration | String | No | The duration of the clip.
Example: 01:00:59.999 or 32000.23. |
End | String | No | The length of the end part of the original video to be cropped out. If you specify this parameter, the setting of the Duration parameter becomes invalid.
Example: 01:00:59.999 or 32000.23. |
WaterMarks
Parameter | Type | Required | Description |
---|---|---|---|
WaterMarkTemplateId | String | No | The ID of the watermark template. If you do not specify this parameter, the default watermark template that contains the following settings is used:
|
InputFile | String | Yes | The watermark input. You can use an image in the PNG format or a file in the MOV format as the watermark input. |
Width | String | No | The watermark width. If you specify this parameter, the watermark width setting in the template is ignored. The value can be an integer or a decimal number.
|
Height | String | No | The watermark height. If you specify this parameter, the watermark height setting in the template is ignored. The value can be an integer or a decimal number.
|
Dx | String | No | The horizontal offset of the watermark relative to the output video image. If you specify this parameter, the horizontal offset setting in the template is ignored. Default value: 0 The value can be an integer or a decimal number.
|
Dy | String | No | The vertical offset of the watermark relative to the output video image. If you specify this parameter, the vertical offset setting in the template is ignored. Default value: 0. The value can be an integer or a decimal number.
|
ReferPos | String | No | The position of the watermark. If you specify this parameter, the watermark position setting in the template is ignored. Valid values: TopRight, TopLeft, BottomRight, and BottomLeft. |
Type | String | No | The type of the watermark. If you specify this parameter, the watermark type setting in the template is ignored. Valid values: Image and Text. Default value: Image.
Note If you set this parameter to Text, you must specify the TextWaterMark parameter. |
Timeline | String | No | The timeline of the watermark. If you specify this parameter, the watermark timeline setting in the template is ignored. For more information, see the Timeline section in this topic. |
TextWaterMark | String | No | The configuration of the text watermark. If the watermark is a text watermark, you must specify this parameter. The value must be a JSON object.
|
Config in the AddWaterMarkTemplate operation
Parameter | Type | Required | Description |
---|---|---|---|
Width | String | No | The watermark width. The value can be an integer or a decimal number.
|
Height | String | No | The watermark height. The value can be an integer or a decimal number.
|
Dx | String | No | The horizontal offset of the watermark relative to the output video image. Default value: 0. The value can be an integer or a decimal number.
|
Dy | String | No | The vertical offset of the watermark relative to the output video image. Default value: 0. The value can be an integer or a decimal number.
|
ReferPos | String | No | The position of the watermark.
|
Type | String | No | The type of the watermark. Valid values: Image and Text.
|
Timeline | String | No | The timeline of the watermark. For more information, see the Timeline section in this topic. |
The following list provides notes on the Width and Height parameters:
- If you do not specify the Width or Height parameter, the watermark width is 0.12 times the width of the output video resolution, and the watermark height is proportionally scaled based on the watermark width and the aspect ratio of the original image.
- If you specify only the Width parameter, the watermark height is proportionally scaled based on the specified width and the aspect ratio of the original image. If you specify only the Height parameter, the watermark width is proportionally scaled based on the specified height and the aspect ratio of the original image.
- You can also specify both the Width and Height parameters to determine the width and height of the watermark.
Timeline
Parameter | Type | Required | Description |
---|---|---|---|
Start | String | No | The beginning of the time range during which the watermark is displayed.
|
Duration | String | No | The display duration of the watermark.
|
TextWaterMark
Parameter | Type | Required | Description |
---|---|---|---|
Content | String | Yes | The text to be displayed as the watermark. The text must be encoded in the Base64 format. For example, if the original text is Test Text Watermark, the encoded text is |
FontName | String | No | The front of the text. Default value: SimSun. For more information, see Fonts. |
FontSize | Int | No | The size of the text.
|
FontColor | String | No | The color of the text. For more information, see Text colors. |
FontAlpha | Int | No | The transparency of the text.
|
Top | Int | No | The top margin of the text.
|
Left | Int | No | The left margin of the text.
|
BorderWidth | Int | No | The outline width of the text.
|
BorderColor | String | No | The outline color of the text.
|
MergeList
Parameter | Type | Required | Description |
---|---|---|---|
MergeURL | String | Yes | The OSS URL of the clip.
|
Start | String | No | The start point in time of the clip.
|
Duration | String | No | The duration of the clip.
|
M3U8NonStandardSupport
Parameter | Type | Required | Description |
---|---|---|---|
TS | String | No | The non-standard support of the M3U8 format for the TS format. The value must be a JSON object. For more information, see the TS section in this topic. |
TS
Parameter | Type | Required | Description |
---|---|---|---|
Md5Support | Boolean | No | Specifies whether to support the generation of the MD5 hash value of the TS file in the output M3U8 video. |
SizeSupport | Boolean | No | Specifies whether to support the generation of the size information about the TS file in the output M3U8 video. |
Encryption
Parameter | Type | Required | Description |
---|---|---|---|
Type | String | Yes | The encryption type. Set the value to hls-aes-128. |
Key | String | Yes | The key that is used to encrypt the video.
|
KeyUri | String | Yes | The URL that is used to request the key. The URL is encrypted in the Base64 format. |
KeyType | String | Yes | The key cannot be transmitted to MPS in plaintext. You must encrypt the key. You can encrypt the key in the Base64 format or use KMS to encrypt the key. Note Alibaba Cloud provides the master key. To obtain the master key, submit a ticket. Base64 is a basic encryption format. If you use KMS, the key is first encrypted in the Base64 format and then encrypted by KMS. |
SubtitleConfig
Parameter | Type | Required | Description |
---|---|---|---|
ExtSubtitleList | ExtSubtitle[] | No | The external subtitles. The value must be a JSON array that contains up to four JSON objects.
|
ExtSubtitle
Parameter | Type | Required | Description |
---|---|---|---|
Input | String | Yes | The OSS object for the external subtitle. The value must be a JSON object.
Note
|
CharEnc | String | No | The character set used by the external subtitle.
Note If you set this parameter to auto, the detected character set may not be the actual character set. We recommend that you set this parameter to another value. |
Opening
Parameter | Type | Required | Description |
---|---|---|---|
OpenUrl | String | Yes | The OSS URL of the opening part of the video. |
Start | String | No | The amount of time after which the opening part is played.
|
Width | String | No | The width of the opening part.
|
Height | String | No | The height of the opening part.
|
TailSlate
Parameter | Type | Required | Description |
---|---|---|---|
TailUrl | String | Yes | The OSS URL of the ending part of the video. |
BlendDuration | String | No | The amount of time between the end of the main part and the beginning of the ending part. During the video part transition, the last frame of the main part fades out, and the first frame of the ending part fades in. Unit: seconds. Default value: 0. |
Width | String | No | The width of the ending part.
|
Height | String | No | The height of the ending part.
|
IsMergeAudio | Boolean | No | Specifies whether to merge the audio content in the ending part. Default value: true. |
BgColor | String | No | The color of the borders 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. |
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
}
]
}
- L: a number that indicates the left margin of the blurred area.
- T: a number that indicates the top margin of the blurred area.
- W: a number that indicates the width of the blurred area.
- H: a number that indicates the height of the blurred area.
If the value of the L, T, W, or H field is greater than 1, the number indicates the pixel value. Otherwise, the number indicates the ratio of the pixel value to the corresponding pixel value of the watermark source. The blurred area is specified based on the nearest integers of the values of the L, T, W, and H fields.
- Blur two watermarks in the video image starting from the first frame. The first watermark is 10 × 10 pixels away from the upper-left corner of the video image and is 10 × 10 pixels in size. The second watermark is 100 pixels away from the left side of the video image and is 10 × 10 pixels in size. The distance between the top of the video image and the watermark is calculated by using the following formula: 0.1 × Height of the source.
- Blur the two watermarks in the video image within the first 128,000 milliseconds.
- Blur the watermark in the video image starting from the 250,000th millisecond. The watermark width is 0.01 times the width of the source, and the watermark height is 0.05 times the height of the source. The distance between the left side of the video image and the watermark is calculated by using the following formula: 0.2 × Width of the source. The distance between the top of the video image and the watermark is calculated by using the following formula: 0.1 × Height of the source.
Amix
Parameter | Type | Required | Description |
---|---|---|---|
AmixURL | String | Yes | The URL of the audio track to be mixed as the background music. The URL must be an OSS URL or the value of the Input parameter in the form of a string. If you want to mix two audio tracks in a video, set this parameter to the value of the Input parameter in the form of a string. |
Map | String | No | The audio track to be mixed. Format: 0:a:{audio_index}. Example: 0:a:0. |
MixDurMode | String | No | The mode to specify the mixing duration. Valid values: first and longest.
|
Start | String | No | The start point in time. You can specify a numeric value or a time value. Examples: 1:25:36.240 and 32000.23. |
Duration | String | No | The duration. You can specify a numeric value or a time value. |
SnapshotConfig
Parameter | Type | Required | Description |
---|---|---|---|
Format | String | No | The snapshot format.
|
BlackLevel | String | No | The threshold that is used to filter out black frames for the first snapshot to be captured. This feature is available if you request the system to capture multiple snapshots.
A smaller value indicates a smaller proportion of black pixels in the video image.
If you want to filter out pure black frames for the first snapshot, we recommend that you set this parameter to 100. For example, if you set the Time parameter to 0 and the Num parameter to 10, and you want to filter out pure black frames for the first snapshot, set this parameter to 100. |
PixelBlackThreshold | String | No | The color value threshold that determines whether a pixel is black.
Note:
|
OutputFile | String | Yes | The configuration of the output. This value must be a JSON object. For more information, see the OutputFile section in this topic. |
TileOutputFile | String | No | The configuration of the output in tile mode. The value must be a JSON object in the same format as the OutputFile parameter.
|
Time | String | Yes | The point in time at which a snapshot is captured. Unit: milliseconds. |
Interval | String | No | The interval for snapshot capturing.
|
Num | String | No | The number of snapshots to be captured. If you want to asynchronously capture snapshots in sequence, you must specify a parameter value greater than 0.
|
Width | String | No | The width of a snapshot.
|
Height | String | No | The height of a snapshot.
|
FrameType | String | No | The snapshot type. Valid values:
|
TileOut | String | No | The tiling configuration. The value must be a JSON object. For more information, see the TileOut section in this topic. |
SubOut | String | No | The configuration of the tiled snapshot in the WebVTT format. For more information, see the SubOut Webvtt section in this topic. |
OutputFile
Parameter | Type | Required | Description |
---|---|---|---|
Bucket | String | Yes | The OSS bucket that stores the output. For more information, see the description of the term object in Terms. |
Location | String | Yes | The OSS region in which the OSS bucket resides. For more information, see the description of the term region in Terms. |
Object | String | Yes | The one or more OSS objects that are generated as the output. The objects must be in the JPG format, and their URLs must comply with RFC 2396 and be encoded in UTF-8, with reserved characters being percent-encoded. For more information, see URL encoding. Example: %7BObjectPrefix%7D%7BFileName%7D%7BCount%7D.jpg. In this case, if the input file is a/b/c.flv, the output snapshots may be a/b/c00001.jpg and a/b/c00002.jpg. The placeholders in the URL will be replaced with the actual values used in your business operations.
Notes: If you want to asynchronously capture multiple snapshots in sequence, the specified URL must contain %7BCount%7D. The {Count} placeholder can distinguish between different snapshots. For example, if you set the Num parameter to 3 and set the Object parameter to %7BCount%7D.jpg for OutputFile, the output snapshots are named 00001.jpg, 00002.jpg, and 00003.jpg. |
TileOut
Parameter | Type | Required | Description |
---|---|---|---|
Lines | String | No | The number of rows that the tiled snapshot contains.
|
Columns | String | No | The number of columns that the tiled snapshot contains.
|
CellWidth | String | No | The width of a single snapshot before tile. The default value is the value of the Width parameter in SnapshotConfig. |
CellHeight | String | No | The height of a single snapshot before tile. The default value is the value of the Height parameter in SnapshotConfig. |
Margin | String | No | The margin width of the tiled snapshot.
|
Padding | String | No | The spacing between two adjacent snapshots. Default value: 0. Unit: pixel. |
Color | String | No | The background color.
|
IsKeepCellPic | String | No | Specifies whether to retain single snapshots.
|
SubOut Webvtt
Parameter | Type | Required | Description |
---|---|---|---|
IsSptFrag | String | No | Specifies whether to tile the snapshots.
|
NotifyConfig
Parameter | Type | Required | Description |
---|---|---|---|
QueueName | String | No | The name of the queue that is created in Message Service (MNS).
|
Topic | String | No | The name of the topic that is created in MNS.
|
Parameters related to input in the SubmitJobs operation
Parameter | Type | Required | Description |
---|---|---|---|
Bucket | String | Yes | The OSS bucket that stores the input file.
|
Location | String | Yes | The OSS region in which the OSS bucket resides. For more information, see the description of the term region in Terms. |
Object | String | Yes | The OSS object that is used as the input file.
|
Audio | String | No | The audio configuration of the input file. The value must be a JSON object. Note This parameter is required if the input file is in the ADPCM or PCM format.
|
Container | String | No | The container configuration of the input file. The value must be a JSON object. Note This parameter is required if the input file is in the ADPCM or PCM format.
|
InputContainer
Parameter | Type | Required | Description |
---|---|---|---|
Format | String | Yes | The audio format of the input file. Valid values: alaw, f32be, f32le, f64be, f64le, mulaw, s16be, s16le, s24be, s24le, s32be, s32le, s8, u16be, u16le, u24be, u24le, u32be, u32le, and u8. |
InputAudio
Parameter | Type | Required | Description |
---|---|---|---|
Channels | String | Yes | The number of sound channels in the input file. Valid values: [1, 8]. |
Samplerate | String | Yes | The audio sampling rate of the input file.
|
AnalysisConfig
Parameter | Type | Required | Description |
---|---|---|---|
QualityControl | String | No | The configuration of the output file quality. The value must be a JSON object. For more information, see the AnalysisConfig section in this topic. |
PropertiesControl | String | No | The property configuration. The value must be a JSON object. For more information, see the PropertiesControl section in this topic. |
QualityControl
Parameter | Type | Required | Description |
---|---|---|---|
RateQuality | String | No | The quality level of the output file.
|
MethodStreaming | String | No | The playback mode. Valid values: network and local. Default value: network. |
PropertiesControl
Parameter | Type | Required | Description |
---|---|---|---|
Deinterlace | String | No | Specifies whether to forcibly runs deinterlacing. Valid values:
|
Crop | String | No | The cropping configuration of the video image.
|
Crop
Parameter | Type | Required | Description |
---|---|---|---|
Mode | String | No | The cropping mode. This parameter is required if the value of the Crop parameter is not an empty JSON object. Valid values:
|
Width | Integer | No. | The width of the video image after the margins are cropped out.
|
Height | Integer | No. | The height of the video image after the margins are cropped out.
|
Top | Integer | No. | The top margin to be cropped out.
|
Left | Integer | No. | The left margin to be cropped out.
|
TransFeatures
Parameter | Type | Required | Description |
---|---|---|---|
MergeList | String | No | The URLs of the clips to be merged.
|
Parameters related to output in the SubmitJobs operation
Parameter | Type | Required | Description |
---|---|---|---|
URL | String | No | The OSS URL of the output file.
|
Bucket | String | No |
|
Location | String | No |
|
Object | String | No |
|
MultiBitrateVideoStream
Parameter | Type | Required | Description |
---|---|---|---|
URI | String | No | The name of the output video stream, which must end with .m3u8. Example: a/b/test.m3u8. Format: ^[a-z]{1}[a-z0-9./-]+$. |
RefActivityName | String | Yes | The name of the associated activity. |
ExtXStreamInfo | Json | Yes | The information about the stream. Example: {"BandWidth": "111110","Audio": "auds","Subtitles": "subs"} . |
ExtXMedia
Parameter | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Required. The name of the resource, which can be up to 64 bytes in length and must be encoded in UTF-8. This parameter corresponds to NAME in the HTTP Live Streaming (HLS) V5 protocol. |
Language | String | No | Optional. The language of the resource, which must comply with RFC 5646. This parameter corresponds to LANGUAGE in the HLS V5 protocol. |
URI | String | Yes | Required. The path of the resource. Format: ^[a-z]{1}[a-z0-9./-]+$. Example: a/b/c/d/audio-1.m3u8. |
MasterPlayList
Parameter | Type | Required | Description |
---|---|---|---|
MultiBitrateVideoStreams | JsonArray | Yes | The array of multiple streams. Example: [{"RefActivityName": "video-1","ExtXStreamInfo": {"BandWidth": "111110","Audio":"auds","Subtitles": "subs"}}] . |
ExtXStreamInfo
Parameter | Type | Required | Description |
---|---|---|---|
BandWidth | String | Yes | The bandwidth. Required. The upper limit of the total bitrate. This parameter corresponds to BANDWIDTH in the HLS V5 protocol. |
Audio | String | No | Optional. The ID of the audio stream group. This parameter corresponds to AUDIO in the HLS V5 protocol. |
Subtitles | String | No | Optional. The ID of the subtitle stream group. This parameter corresponds to SUBTITLES in the HLS V5 protocol. |
AdaptationSet
Parameter | Type | Required | Description |
---|---|---|---|
Group | String | Yes | Required. The name of the group. Example:
|
Lang | String | No | The language. You can specify this parameter for audio and subtitle resources. |
Representation
Parameter | Type | Required | Description |
---|---|---|---|
Id | String | Yes | Required. The ID of the stream. Example:
|
URI | String | Yes | Required. The path of the resource. Format: ^[a-z]{1}[a-z0-9./-]+$. Example: a/b/c/d/video-1.mpd. |
InputConfig
Parameter | Type | Required | Description |
---|---|---|---|
Format | String | Yes | Required. The format of the input subtitle file. Valid values: stl, ttml, and vtt. |
InputFile | String | Yes |
|