Domain name for API request: vod.intl.tencentcloudapi.com.
Creates a title and trailer template.
-Maximum supported template quantity: 100.
A maximum of 20 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: CreateHeadTailTemplate. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-17. |
| Region | No | String | Common Params. This parameter is not required. |
| Name | Yes | String | Template name, length limited to 64 characters. |
| SubAppId | No | Integer | VOD application ID. For customers who activate VOD after December 25, 2023, this field must be set to the app ID when accessing resources in VOD applications (whether the default application or a newly created application). |
| Comment | No | String | Template description information. The length cannot exceed 256 characters. |
| HeadCandidateSet.N | No | Array of String | Opening candidate list. Fill in the FileId of the video. During transcoding, the opening scene with the aspect ratio closest to that of the main content is automatically selected. If the aspect ratios are identical, candidates positioned towards the front take precedence. A maximum of 5 opening candidates is supported. |
| TailCandidateSet.N | No | Array of String | Ending candidate list. Fill in the FileId of the video. During transcoding, the ending with the aspect ratio closest to the main content is automatically selected. If the aspect ratios are identical, candidates positioned towards the front are prioritized. A maximum of 5 ending candidates is supported. |
| FillType | No | String | Filling method. When the video stream configuration width and height parameters are inconsistent with the aspect ratio of the original video, the processing method for transcoding is "padding". Optional filling methods: Default value: stretch. |
| Parameter Name | Type | Description |
|---|---|---|
| Definition | Integer | Opening and ending template ID. |
| 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. |
Create a Title and Trailer Template.
https://vod.intl.tencentcloudapi.com/?Action=CreateHeadTailTemplate
&Name=Template name
&Comment=Template description
&HeadCandidateSet.0=1234422xxxx123
&TailCandidateSet.0=1234422xxxx124
&<Common request parameters>{
"Response": {
"Definition": 1000,
"RequestId": "12ae8d8e-xxxx-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 |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation | Operation failed. |
| FailedOperation.InvalidVodUser | The VOD service is not activated. |
| InternalError | Internal error. |
| InternalError.GenDefinition | Internal error: Failed to create a template ID. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.Comment | Parameter error: description of this template. |
| InvalidParameterValue.Name | Parameter value error: Name exceeds the length limit. |
| InvalidParameterValue.Type | Type parameter value error. |
| LimitExceeded.TooMuchTemplate | Exceed the limit: The number of templates exceeds the upper limit of 100. If needed, submit a ticket (https://console.tencentcloud.com/workorder/category). |
| UnauthorizedOperation | Unauthorized operation. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback