Creating a Transcoding Template
Function
Creates a transcoding template. Using this function will incur live transcoding fees.
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. 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.
|
quality_info |
Yes |
Array of QualityInfo objects |
Video quality information. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
quality |
Yes |
String |
The options are as follows:
|
templateName |
No |
String |
Customizes a template name.
|
PVC |
No |
String |
Indicates whether to use narrowband HD transcoding. Note: This field is no longer used. Use hdlb instead. The options are as follows:
Default value: off |
hdlb |
No |
String |
Indicates whether to enable low-bitrate HD. The image quality is better than PVC. Note: When the hdlb field is used to enable low-bitrate HD, the PVC field does not take effect. The options are as follows:
Default value: off |
codec |
No |
String |
Video encoding format. The options are as follows:
The default value is H264. |
width |
No |
Integer |
Long side of the video. The landscape is a width, that is, a long side, and the portrait is a height. Unit: pixel. The options are as follows:
Note: If the input value of both sides is 0, the output video resolution is the same as the source video resolution. If the value of one side is set to 0, the output video resolution will be scaled proportionally according to the input value of the other side. Default value: 0 |
height |
No |
Integer |
Short side of the video. The landscape is a width, and the portrait is a height, that is, a short side. Unit: pixel. The options are as follows:
Note: If the input value of both sides is 0, the output video resolution is the same as the source video resolution. If the value of one side is set to 0, the output video resolution will be scaled proportionally according to the input value of the other side. Default value: 0 |
bitrate |
Yes |
Integer |
Bitrate of the transcoded video. Unit: kbit/s Value range: 40–30,000 |
video_frame_rate |
No |
Integer |
Frame rate of the transcoded video. Unit: FPS Value range: 0–60. The value 0 indicates that the frame rate remains unchanged. Default value: 0 |
protocol |
No |
String |
Protocol type supported by transcoded outputs. The default value is RTMP. Currently, only RTMP is supported. The options are as follows:
|
iFrameInterval |
No |
Integer |
Maximum I-frame interval. Unit: number of frames Value range: 0–500. Default value: 50. Note: If you want to set the I-frame interval using iFrameInterval, set gop to 0 or do not set gop. |
gop |
No |
Integer |
I-frame interval by time. Unit: second Value range: 0–10. Default value: 2. Note: If gop is not 0, the I-frame interval is set based on gop, and the iFrameInterval field does not take effect. |
bitrate_adaptive |
No |
String |
Adaptive bitrate parameter. The options are as follows:
Default value: off |
i_frame_policy |
No |
String |
Policy for outputting I-frames during encoding. The options are as follows:
Default value: auto |
Response Parameters
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error Code |
error_msg |
String |
Error description |
Example Requests
Creates 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.
POST 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 create a transcoding template.
{ "error_code" : "LIVE.100011001", "error_msg" : "Request Illegal" }
SDK Sample Code
The SDK sample code is as follows.
Creates 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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.live.v1.region.LiveRegion; import com.huaweicloud.sdk.live.v1.*; import com.huaweicloud.sdk.live.v1.model.*; import java.util.List; import java.util.ArrayList; public class CreateTranscodingsTemplateSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); LiveClient client = LiveClient.newBuilder() .withCredential(auth) .withRegion(LiveRegion.valueOf("<YOUR REGION>")) .build(); CreateTranscodingsTemplateRequest request = new CreateTranscodingsTemplateRequest(); StreamTranscodingTemplate body = new StreamTranscodingTemplate(); List<QualityInfo> listbodyQualityInfo = new ArrayList<>(); listbodyQualityInfo.add( new QualityInfo() .withQuality("lsd") .withHdlb(QualityInfo.HdlbEnum.fromValue("off")) .withCodec(QualityInfo.CodecEnum.fromValue("H264")) .withWidth(1920) .withHeight(1080) .withBitrate(4500) .withVideoFrameRate(20) .withGop(4) ); listbodyQualityInfo.add( new QualityInfo() .withTemplateName("yourTemplateName") .withQuality("userdefine") .withHdlb(QualityInfo.HdlbEnum.fromValue("off")) .withCodec(QualityInfo.CodecEnum.fromValue("H264")) .withWidth(1920) .withHeight(1080) .withBitrate(4500) .withVideoFrameRate(20) .withGop(4) ); body.withQualityInfo(listbodyQualityInfo); body.withAppName("live"); body.withDomain("play.example.com"); request.withBody(body); try { CreateTranscodingsTemplateResponse response = client.createTranscodingsTemplate(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Creates 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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklive.v1.region.live_region import LiveRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklive.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = LiveClient.new_builder() \ .with_credentials(credentials) \ .with_region(LiveRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateTranscodingsTemplateRequest() listQualityInfobody = [ QualityInfo( quality="lsd", hdlb="off", codec="H264", width=1920, height=1080, bitrate=4500, video_frame_rate=20, gop=4 ), QualityInfo( template_name="yourTemplateName", quality="userdefine", hdlb="off", codec="H264", width=1920, height=1080, bitrate=4500, video_frame_rate=20, gop=4 ) ] request.body = StreamTranscodingTemplate( quality_info=listQualityInfobody, app_name="live", domain="play.example.com" ) response = client.create_transcodings_template(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creates 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.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := live.NewLiveClient( live.LiveClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateTranscodingsTemplateRequest{} hdlbQualityInfo:= model.GetQualityInfoHdlbEnum().OFF codecQualityInfo:= model.GetQualityInfoCodecEnum().H264 widthQualityInfo:= int32(1920) heightQualityInfo:= int32(1080) videoFrameRateQualityInfo:= int32(20) gopQualityInfo:= int32(4) templateNameQualityInfo:= "yourTemplateName" hdlbQualityInfo1:= model.GetQualityInfoHdlbEnum().OFF codecQualityInfo1:= model.GetQualityInfoCodecEnum().H264 widthQualityInfo1:= int32(1920) heightQualityInfo1:= int32(1080) videoFrameRateQualityInfo1:= int32(20) gopQualityInfo1:= int32(4) var listQualityInfobody = []model.QualityInfo{ { Quality: "lsd", Hdlb: &hdlbQualityInfo, Codec: &codecQualityInfo, Width: &widthQualityInfo, Height: &heightQualityInfo, Bitrate: int32(4500), VideoFrameRate: &videoFrameRateQualityInfo, Gop: &gopQualityInfo, }, { TemplateName: &templateNameQualityInfo, Quality: "userdefine", Hdlb: &hdlbQualityInfo1, Codec: &codecQualityInfo1, Width: &widthQualityInfo1, Height: &heightQualityInfo1, Bitrate: int32(4500), VideoFrameRate: &videoFrameRateQualityInfo1, Gop: &gopQualityInfo1, }, } request.Body = &model.StreamTranscodingTemplate{ QualityInfo: listQualityInfobody, AppName: "live", Domain: "play.example.com", } response, err := client.CreateTranscodingsTemplate(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
201 |
Transcoding template created successfully. |
400 |
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