tencent cloud

Feedback

CreateHeadTailTemplate

Last updated: 2024-01-02 12:23:37

    1. API Description

    Domain name for API request: vod.tencentcloudapi.com.

    Create HeadTail Template.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    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 limit is 64 characters.
    SubAppId No Integer The VOD application ID. For customers who activate VOD service from December 25, 2023, if they want to access resources in a VOD application (whether it's the default application or a newly created one), they must fill in this field with the application ID.
    Comment No String Template description information, length limit is 256 characters.
    HeadCandidateSet.N No Array of String Title candidate list, fill in the FileId of the video. When transcoding, the title closest to the aspect ratio of the feature film will be automatically selected (when the aspect ratio is the same, the front candidate will take precedence). Supports up to 5 candidate titles.
    TailCandidateSet.N No Array of String Ending candidate list, fill in the FileId of the video. When transcoding, the ending with the aspect ratio closest to the feature film will be automatically selected (when the aspect ratio is the same, the front candidate will take precedence). Supports up to 5 candidate endings.
    FillType No String Padding method. When the video stream configuration width and height parameters are inconsistent with the aspect ratio of the original video, the transcoding processing method is "padding". Optional filling method:
  • stretch: stretch, stretch each frame to fill the entire screen, which may cause the transcoded video to be "squashed" or "stretched";

  • gauss: Gaussian blur, keep the video aspect ratio unchanged, use Gaussian blur for the remaining edges;
  • white: leave blank, keep the video aspect ratio unchanged, use the remaining edges for the edge Use white filling;
  • black: Leave black, keep the video aspect ratio unchanged, and fill the remaining edges with black.

  • Default value: stretch.

    3. Output Parameters

    Parameter Name Type Description
    Definition Integer Head Tail Template Number
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 CreateHeadTailTemplate

    Create HeadTail Template.

    Input Example

    https://vod.tencentcloudapi.com/?Action=CreateHeadTailTemplate
    &Name=Template name
    &Comment=Template description
    &HeadCandidateSet.0=1234422xxxx123
    &TailCandidateSet.0=1234422xxxx124
    &<Public Request Parameter>
    

    Output Example

    {
        "Response": {
            "Definition": 1000,
            "RequestId": "12ae8d8e-xxxx-9d4b-5594145287e1"
        }
    }
    

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    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 Invalid parameter.
    InvalidParameterValue Incorrect parameter value.
    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.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support