云点播修改雪碧图模板-服务端 API 文档-文档中心-腾讯云

1. 接口描述

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

修改用户自定义雪碧图模板。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ModifyImageSpriteTemplate。
Version	是	String	公共参数，本接口取值：2018-07-17。
Region	否	String	公共参数，此参数为可选参数。
Definition	是	Integer	雪碧图模板唯一标识。示例值：10001
SubAppId	否	Integer	点播应用 ID。从2023年12月25日起开通点播的客户，如访问点播应用中的资源（无论是默认应用还是新创建的应用），必须将该字段填写为应用 ID。示例值：123
Name	否	String	雪碧图模板名称，长度限制：64 个字符。示例值：雪碧图模板1
Width	否	Integer	雪碧图中小图的宽度，取值范围： [128, 4096]，单位：px。示例值：128
Height	否	Integer	雪碧图中小图的高度，取值范围： [128, 4096]，单位：px。示例值：128
ResolutionAdaptive	否	String	分辨率自适应，可选值： open：开启，此时，Width 代表视频的长边，Height 表示视频的短边； close：关闭，此时，Width 代表视频的宽度，Height 表示视频的高度。默认值：open。示例值：open
SampleType	否	String	采样类型，取值： Percent：按百分比。 Time：按时间间隔。示例值：Percent
SampleInterval	否	Integer	采样间隔。当 SampleType 为 Percent 时，指定采样间隔的百分比。当 SampleType 为 Time 时，指定采样间隔的时间，单位为秒。示例值：10
RowCount	否	Integer	雪碧图中小图的行数。示例值：5
ColumnCount	否	Integer	雪碧图中小图的列数。示例值：10
FillType	否	String	填充方式，当视频流配置宽高参数与原始视频的宽高比不一致时，对转码的处理方式，即为“填充”。可选填充方式： stretch：拉伸，对每一帧进行拉伸，填满整个画面，可能导致转码后的视频被“压扁“或者“拉长“； black：留黑，保持视频宽高比不变，边缘剩余部分使用黑色填充。默认值：black 。示例值：stretch
Comment	否	String	模板描述信息，长度限制：256 个字符。示例值：123
Format	否	String	图片格式，取值： jpg：jpg 格式； png：png 格式； webp：webp 格式。示例值：jpg

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改雪碧图模板

输入示例

POST / HTTP/1.1
Host: vod.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyImageSpriteTemplate
<公共请求参数>

{
    "ColumnCount": "10",
    "Definition": "10001",
    "Name": "雪碧图模板1",
    "RowCount": "5",
    "SampleType": "Percent",
    "Height": "128",
    "Width": "128",
    "SampleInterval": "10"
}

输出示例

{
    "Response": {
        "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。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidParameterValue.ColumnCount	参数值错误：ColumnCount。
InvalidParameterValue.Height	参数错误：高度。
InvalidParameterValue.Name	参数值错误：Name 超过长度限制。
InvalidParameterValue.Resolution	参数错误：分辨率错误。
InvalidParameterValue.RowCount	参数值错误：RowCount。
InvalidParameterValue.SampleInterval	参数值错误：SampleInterval。
InvalidParameterValue.SampleType	参数值错误：SampleType。
InvalidParameterValue.Width	参数错误：宽度。
ResourceNotFound.TemplateNotExist	资源不存在：模板不存在。
UnauthorizedOperation	未授权操作。

修改雪碧图模板

本页目录：