Modifying a Transcoding Template Group
Function
This API is used to modify a custom transcoding template group.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/template_group/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 |
|---|---|---|---|
group_id |
Yes |
String |
ID of a template group |
name |
No |
String |
Name of the template group |
videos |
No |
Array of VideoObj objects |
List of output video configurations |
audio |
No |
Audio object |
Audio information |
video_common |
No |
VideoCommon object |
Common video information |
common |
No |
Common object |
Common information |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
width |
Yes |
Integer |
Video width, in pixels
|
height |
Yes |
Integer |
Video height, in pixels
|
bitrate |
Yes |
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. |
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 |
|---|---|---|---|
output_policy |
No |
String |
Output policy:
The options are as follows:
|
codec |
No |
Integer |
Video codec Possible values:
|
profile |
No |
Integer |
Encoding profile. The recommended value is 3. Possible options are:
|
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. The value is 0 (adaptive) or an integer ranging from 5 to 60. Unit: FPS |
black_cut |
No |
Integer |
Whether to enable black bar removal.
|
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: 400
Parameter |
Type |
Description |
|---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error description |
Example Requests
Updates a transcoding template group.
PUT https://{endpoint}/v1/{project_id}/template_group/transcodings
{
"group_id" : "bd55741ccdf04e678f800c010aa12b68",
"name" : "test_group",
"videos" : [ {
"width" : 480,
"height" : 270,
"bitrate" : 200
}, {
"width" : "1280",
"height" : "720",
"bitrate" : "700"
} ],
"audio" : {
"codec" : 1,
"sample_rate" : 1,
"channels" : 2,
"bitrate" : 0
},
"video_common" : {
"codec" : 1,
"black_cut" : 0,
"profile" : 3,
"level" : 15,
"preset" : 3,
"max_iframes_interval" : 5,
"bframes_count" : 4,
"frame_rate" : 0
},
"common" : {
"PVC" : false,
"pack_type" : 1,
"hls_interval" : 5,
"dash_interval" : 5
}
}
Example Responses
Status code: 400
Failed to modify the transcoding template group.
{
"error_code" : "MPC.10212",
"error_msg" : "Operation failed."
}
Status Codes
Status Code |
Description |
|---|---|
204 |
Transcoding template group modified successfully. |
400 |
Failed to modify the transcoding template group. |
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
