tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
云点播
    文档
    Download PDF

    ModifyHeadTailTemplate

    最后更新时间：2024-03-27 16:09:13
    下载PDF

      1. API Description

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

      Modify 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: ModifyHeadTailTemplate.
      Version Yes String Common Params. The value used for this API: 2018-07-17.
      Region No String Common Params. This parameter is not required.
      Definition Yes Integer HeadTail template ID.
      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.
      Name No String Template name, length limit is 64 characters. Not passing means not modifying.
      Comment No String Template description, limited to 256 characters. Passing nothing means no modification, passing empty means clearing it.
      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. Not passing it means no modification, passing an empty array means clearing it.
      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 titles. Not passing it means no modification, passing an empty array means clearing it.
      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.

      • The default value is not to be modified.

      3. Output Parameters

      Parameter Name Type Description
      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.

      4. Example

      Example1 Modify HeadTail Template

      Modify HeadTail Template

      Input Example

      https://vod.tencentcloudapi.com/?Action=ModifyHeadTailTemplate
&Definition=10000
&Name=Template1
&HeadCandidateSet.0=1234422xxxx123
&TailCandidateSet.0=1234422xxxx124
&<Public Request Parameter>

      Output Example

      {
    "Response": {
        "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
      FailedOperation Operation failed.
      InternalError Internal error.
      InvalidParameter Invalid parameter.
      InvalidParameterValue Incorrect parameter value.
      InvalidParameterValue.Comment Invalid parameter: template description.
      InvalidParameterValue.Name Incorrect parameter value: Name exceeds the length limit.
      InvalidParameterValue.StorageRegions Invalid StorageRegions.
      ResourceNotFound.TemplateNotExist The resource does not exist: the template does not exist.
      UnauthorizedOperation Unauthorized operation.
      联系我们

      联系我们，为您的业务提供专属服务。

      联系我们
      技术支持

      如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

      提交工单
      7x24 电话支持
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      隐私条款服务条款缓存条款