Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to create a custom transcoding template. Up to 100 templates can be created.
A maximum of 100 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: CreateTranscodeTemplate. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Container | Yes | String | Container format. Valid values: mp4, flv, hls, mp3, flac, ogg, m4a, and wav. Among them, mp3, flac, ogg, m4a, and wav are for audio-only files. |
| SubAppId | No | Integer | Video-on-demand (VOD) application ID. Customers who activate on-demand services from December 25, 2023 must fill this field with the app ID to access resources in on-demand applications (whether default or newly created application). |
| Name | No | String | Transcoding template name. The length cannot exceed 64 characters. |
| Comment | No | String | Template description, with a length limit of 256 characters. |
| RemoveVideo | No | Integer | Whether to remove video data. Available values: |
| RemoveAudio | No | Integer | Remove audio data. Available values: |
| VideoTemplate | No | VideoTemplateInfo | Video stream configuration parameters. This field is required when RemoveVideo is 0. |
| AudioTemplate | No | AudioTemplateInfo | Audio stream configuration parameters. This field is required when RemoveAudio is 0. |
| TEHDConfig | No | TEHDConfig | TSC transcoding parameter. |
| EnhanceConfig | No | EnhanceConfig | Audio/Video enhancement configuration. |
| SegmentType | No | String | Segment type, valid when Container is hls. Available values: |
| StdExtInfo | No | String | Extended parameter. |
| Parameter Name | Type | Description |
|---|---|---|
| Definition | Integer | Unique identifier of the transcoding template. |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
Creating a Transcoding Template
POST / HTTP/1.1
Host: vod.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateTranscodeTemplate
<Common request parameters>
{
"RemoveVideo": 0,
"Container": "mp4",
"Name": "Transcoding Template 1",
"AudioTemplate": {
"SampleRate": 200,
"Codec": "libfdk_aac",
"Bitrate": 200
},
"VideoTemplate": {
"Codec": "libx264",
"Bitrate": 256,
"Fps": 45
},
"RemoveAudio": 0
}
{
"Response": {
"Definition": 1008,
"RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.AudioBitrate | Invalid parameter: audio stream bitrate. |
| InvalidParameterValue.AudioChannel | Incorrect parameter value: AudioChannel. |
| InvalidParameterValue.AudioCodec | Invalid parameter: audio stream encoder. |
| InvalidParameterValue.AudioSampleRate | Invalid parameter: audio stream sample rate. |
| InvalidParameterValue.Bitrate | Invalid audio/video bitrate. |
| InvalidParameterValue.Codec | Invalid audio/video codec. |
| InvalidParameterValue.Comment | Invalid parameter: template description. |
| InvalidParameterValue.Container | Invalid parameter: container. |
| InvalidParameterValue.FillType | Invalid parameter: incorrect fill type. |
| InvalidParameterValue.Fps | Invalid parameter: video frame rate. |
| InvalidParameterValue.Height | Invalid parameter: height. |
| InvalidParameterValue.Name | Incorrect parameter value: Name exceeds the length limit. |
| InvalidParameterValue.RemoveAudio | Incorrect parameter value: RemoveAudio. |
| InvalidParameterValue.RemoveVideo | Incorrect parameter value: RemoveVideo. |
| InvalidParameterValue.Resolution | Invalid parameter: incorrect resolution. |
| InvalidParameterValue.ResolutionAdaptive | Invalid ResolutionAdaptive. |
| InvalidParameterValue.TEHDType | Incorrect parameter value: TEHD Type is invalid. |
| InvalidParameterValue.Type | Incorrect Type parameter value. |
| InvalidParameterValue.Vcrf | Incorrect vcrf. |
| InvalidParameterValue.VideoBitrate | Invalid parameter: video stream bitrate. |
| InvalidParameterValue.VideoCodec | Invalid parameter: video stream encoder. |
| InvalidParameterValue.Width | Invalid parameter: width. |
| LimitExceeded.TooMuchTemplate | Limit exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈