Modifying a Transcoding Template
Function
This API is used to modify a transcoding template.

When modifying a live transcoding template, Live will overwrite the configuration in the modification request. As a result, the modification request must include all template information under the specified domain and app, meaning that quality_info needs to include all template information.
Calling Method
For details, see Calling APIs.
URI
PUT /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. This parameter is mandatory when token authentication is used. 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 for AK/SK authentication. |
X-Sdk-Date |
No |
String |
Time when the request is sent. This parameter is mandatory for AK/SK authentication. |
X-Project-Id |
No |
String |
Project ID. This parameter is mandatory for AK/SK authentication. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
domain |
Yes |
String |
Ingest domain name. |
app_name |
Yes |
String |
Application name. |
trans_type |
No |
String |
Transcoding stream triggering mode. The default value is play. |
quality_info |
Yes |
Array of QualityInfo objects |
Video quality information. |
Response Parameters
Status code: 204
Transcoding template modified successfully.
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Code |
error_msg |
String |
Error description |
Example Requests
Modifies a transcoding template. Set the application name to live, transcoding quality to SD, transcoding format to H.264, width to 1920 pixels, and height to 1080 pixels.
PUT https://{endpoint}/v1/{project_id}/template/transcodings { "domain" : "play.example.com", "app_name" : "live", "quality_info" : [ { "quality" : "lsd", "hdlb" : "off", "codec" : "H264", "width" : 1920, "height" : 1080, "bitrate" : 4500, "video_frame_rate" : 20, "gop" : 4 }, { "quality" : "userdefine", "templateName" : "yourTemplateName", "hdlb" : "off", "codec" : "H264", "width" : 1920, "height" : 1080, "bitrate" : 4500, "video_frame_rate" : 20, "gop" : 4 } ] }
Example Responses
Status code: 400
Failed to modify the transcoding template.
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" }
Status Codes
Status Code |
Description |
---|---|
204 |
Transcoding template modified successfully. |
400 |
Failed to modify the 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.