创建雪碧图模板

最近更新时间:2024-03-12 02:01:29

我的收藏

1. 接口描述

接口请求域名: vod.tencentcloudapi.com 。

创建用户自定义雪碧图模板,数量上限:16。

默认接口请求频率限制:100次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateImageSpriteTemplate。
Version String 公共参数,本接口取值:2018-07-17。
Region String 公共参数,此参数为可选参数。
SampleType String 采样类型,取值:
  • Percent:按百分比。
  • Time:按时间间隔。

  • 示例值:Percent
    SampleInterval Integer 采样间隔。
  • 当 SampleType 为 Percent 时,指定采样间隔的百分比。
  • 当 SampleType 为 Time 时,指定采样间隔的时间,单位为秒。

  • 示例值:10
    RowCount Integer 雪碧图中小图的行数。
    注意:小图的行数会影响最终大图的高度,大图的高度最大为15000像素,其中大图的高度为小图行数与小图高度的乘积。
    示例值:5
    ColumnCount Integer 雪碧图中小图的列数。
    注意:小图的列数会影响最终大图的宽度,大图的宽度最大为15000像素,其中大图的宽度为小图列数与小图宽度的乘积。
    示例值:10
    SubAppId Integer 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
    示例值:1490012345
    Name String 雪碧图模板名称,长度限制:64 个字符。
    示例值:雪碧图模板1
    Comment String 模板描述信息,长度限制:256 个字符。
    示例值:test template
    FillType String 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
  • stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
  • black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。

  • 默认值:black 。
    示例值:black
    Width Integer 雪碧图中小图的宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。
  • 当 Width、Height 均为 0,则分辨率同源;
  • 当 Width 为 0,Height 非 0,则 Width 按比例缩放;
  • 当 Width 非 0,Height 为 0,则 Height 按比例缩放;
  • 当 Width、Height 均非 0,则分辨率按用户指定。

  • 默认值:0。
    注意:小图的宽度会影响最终大图的宽度,大图的宽度最大为15000像素,其中大图的宽度为小图列数与小图宽度的乘积。
    示例值:128
    Height Integer 雪碧图中小图的高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。
  • 当 Width、Height 均为 0,则分辨率同源;
  • 当 Width 为 0,Height 非 0,则 Width 按比例缩放;
  • 当 Width 非 0,Height 为 0,则 Height 按比例缩放;
  • 当 Width、Height 均非 0,则分辨率按用户指定。

  • 默认值:0。
    注意:小图的高度会影响最终大图的高度,大图的高度最大为15000像素,其中大图的高度为小图行数与小图高度的乘积。
    示例值:128
    ResolutionAdaptive String 分辨率自适应,可选值:
  • open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;
  • close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。

  • 默认值:open。
    示例值:open
    Format String 图片格式,取值:
  • jpg:jpg 格式;
  • png:png 格式;
  • webp:webp 格式。

  • 默认值:jpg。
    示例值:jpg

    3. 输出参数

    参数名称 类型 描述
    Definition Integer 雪碧图模板唯一标识。
    示例值:1008
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建雪碧图模板

    创建雪碧图模板

    输入示例

    POST / HTTP/1.1
    Host: vod.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreateImageSpriteTemplate
    <公共请求参数>
    
    {
        "ColumnCount": "10",
        "Name": "雪碧图模板1",
        "RowCount": "5",
        "SampleType": "Percent",
        "Height": "128",
        "Width": "128",
        "SampleInterval": "10"
    }

    输出示例

    {
        "Response": {
            "Definition": 1008,
            "RequestId": "12ae8d8e-dce3-4151-9d4b-5594145287e1"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    FailedOperation 操作失败。
    InternalError 内部错误。
    InvalidParameterValue.ColumnCount 参数值错误:ColumnCount。
    InvalidParameterValue.Comment 参数错误:对该模板的描述。
    InvalidParameterValue.Height 参数错误:高度。
    InvalidParameterValue.Name 参数值错误:Name 超过长度限制。
    InvalidParameterValue.Resolution 参数错误:分辨率错误。
    InvalidParameterValue.RowCount 参数值错误:RowCount。
    InvalidParameterValue.SampleInterval 参数值错误:SampleInterval。
    InvalidParameterValue.SampleType 参数值错误:SampleType。
    InvalidParameterValue.Width 参数错误:宽度。
    LimitExceeded.TooMuchTemplate 超过限制值:模板数超过上限 100 个,如需更多请提交工单
    UnauthorizedOperation 未授权操作。