Domain name for API request: vod.intl.tencentcloudapi.com.
This API is used to create a title and trailer template.
-The maximum supported template quantity is 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 on-demand services after December 25, 2023, they must fill this field with the application ID when accessing resources in on-demand applications (whether it's 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 Credits Candidate List. Fill in the FileId of the video. During transcoding, a title candidate with the aspect ratio closest to the main content will be automatically selected (when identical, precedence is given to candidates positioned towards the front). Supports up to 5 title candidates. |
| TailCandidateSet.N | No | Array of String | Ending candidate list. Fill in the FileId of the video. During transcoding, the system will automatically select the ending with the closest aspect ratio to the main content (if identical, the candidate positioned towards the front takes precedence). Supports up to 5 ending candidates. |
| FillType | No | String | Filling method. When 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 mode: 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 HeadTail Template.
https://vod.intl.tencentcloudapi.com/?Action=CreateHeadTailTemplate
&Name=Template name
&Comment=Template description
&HeadCandidateSet.0=1234422xxxx123
&TailCandidateSet.0=1234422xxxx124
&<Public Request Parameter>
{
"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 generate template ID. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.Comment | Invalid parameter: template description. |
| InvalidParameterValue.Name | Incorrect parameter value: Name exceeds the length limit. |
| InvalidParameterValue.Type | Incorrect Type parameter value. |
| LimitExceeded.TooMuchTemplate | Limit exceeded: The number of templates exceeds the upper limit of 100. If you need more, pleaseSubmit a ticket. |
| UnauthorizedOperation | Unauthorized operation. |
文档反馈