Creating a Transcoding Template
Function
This API is used to create a transcoding template.
Calling Method
For details, see Calling APIs.
URI
POST /v1/{project_id}/template/transcodings
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID . |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
No |
String |
User token The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. |
|
Authorization |
No |
String |
Authentication information. This parameter is mandatory when AK/SK-based authentication is used. |
|
X-Project_Id |
No |
String |
Project ID. This parameter is mandatory when AK/SK-based authentication is used. It is same as the project ID in path parameters. |
|
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
template_name |
Yes |
String |
Name of a transcoding template |
|
video |
No |
Video object |
Video parameters |
|
audio |
No |
Audio object |
Audio parameters |
|
common |
Yes |
Common object |
Common parameters |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
output_policy |
No |
String |
Output policy:
The options are as follows:
|
|
codec |
No |
Integer |
Video codec. Possible values:
|
|
bitrate |
No |
Integer |
Average output bitrate Its value is 0 or an integer ranging from 40 to 30,000. Unit: kbit/s If this parameter is set to 0, the average output bitrate is an adaptive value. |
|
profile |
No |
Integer |
Encoding profile. The recommended value is 3. The default value is 0, indicating that the average output bitrate is adaptive to codec.
The options are as follows:
|
|
level |
No |
Integer |
Encoding level Options:
|
|
preset |
No |
Integer |
Encoding quality. Possible options:
Default value: 1 |
|
max_iframes_interval |
No |
Integer |
Maximum I-frame interval. The value ranges from 2 to 10. Default value: 5 Unit: second |
|
bframes_count |
No |
Integer |
Maximum B-frame interval The options are as follows:
Unit: frame |
|
frame_rate |
No |
Integer |
Frame rate. Its value is 0 or an integer ranging from 5 to 60. Unit: FPS
NOTE:
If the configured frame rate is not within the value range, the value is automatically changed to 0. If the configured frame rate is higher than the frame rate of the input file, the value is automatically changed to the frame rate of the input file. |
|
width |
No |
Integer |
Video width The options are as follows:
Unit: pixel Note: If this parameter is set to 0, the video width is an adaptive value. |
|
height |
No |
Integer |
Video height
Unit: pixel Note: If this parameter is set to 0, the video height is an adaptive value. |
|
black_cut |
No |
Integer |
Whether to enable black bar removal. Possible values:
|
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
output_policy |
No |
String |
Output policy:
The options are as follows:
|
|
codec |
No |
Integer |
Audio codec Possible options are:
|
|
sample_rate |
No |
Integer |
Audio sampling rate The options are as follows:
NOTE:
When the encoding format is MP3, the audio sampling ratio cannot be 6. |
|
bitrate |
No |
Integer |
Audio bitrate. The value is 0 or ranges from 8 to 1,000. Unit: kbit/s |
|
channels |
Yes |
Integer |
Number of audio channels Options:
When the media packaging format is audio (MP3), the number of audio channels cannot be set to 5.1. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
PVC |
No |
Boolean |
Whether to enable low-bitrate HD The options are as follows:
(The value 0 indicates that the function is disabled. Other positive integers and negative values indicate true.) |
|
hls_interval |
No |
Integer |
HLS segment duration. This parameter is used only when pack_type is set to 1 or 3. The value ranges from 2 to 10. Unit: second |
|
dash_interval |
No |
Integer |
DASH segment duration. This parameter is used only when pack_type is set to 2 or 3. The value ranges from 2 to 10. Unit: second |
|
pack_type |
Yes |
Integer |
Packaging type Possible options are:
NOTE:
If pack_type is set to 5 or 6, do not configure video parameters. |
Response Parameters
Status code: 201
|
Parameter |
Type |
Description |
|---|---|---|
|
template_id |
Integer |
ID of a custom transcoding template. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code |
|
error_msg |
String |
Error description |
Example Requests
Creates a customized transcoding template.
POST https://{endpoint}/v1/{project_id}/template/transcodings
{
"template_name" : "MP4_H.264_1920x1080_6000_HEAAC",
"video" : {
"codec" : 1,
"bitrate" : 6000,
"profile" : 3,
"level" : 15,
"preset" : 3,
"max_iframes_interval" : 5,
"black_cut" : 0,
"bframes_count" : 4,
"frame_rate" : 1,
"width" : 1920,
"height" : 1080
},
"audio" : {
"codec" : 1,
"sample_rate" : 4,
"bitrate" : 128,
"channels" : 2
},
"common" : {
"PVC" : false,
"hls_interval" : 5,
"dash_interval" : 5,
"pack_type" : 1
}
}
Example Responses
Status code: 201
Transcoding template created successfully.
{
"template_id" : 2000211
}
Status code: 403
Failed to create a transcoding template.
{
"error_code" : "MPC.10202",
"error_msg" : "Invalid request parameter."
}
Status Codes
|
Status Code |
Description |
|---|---|
|
201 |
Transcoding template created successfully. |
|
403 |
Failed to create a transcoding template. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
