创建采样截图模板

最近更新时间:2019-09-05 16:53:40

1. 接口描述

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

创建用户自定义采样截图模板,数量上限:16。

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateSampleSnapshotTemplate
Version String 公共参数,本接口取值:2018-07-17
Region String 公共参数,本接口不需要传递此参数。
Width Integer 图片宽度,取值范围: [128, 4096],单位:px。
Height Integer 图片高度,取值范围: [128, 4096],单位:px。
SampleType String 采样截图类型,取值:
  • Percent:按百分比。
  • Time:按时间间隔。
  • SampleInterval Integer 采样间隔。
  • 当 SampleType 为 Percent 时,指定采样间隔的百分比。
  • 当 SampleType 为 Time 时,指定采样间隔的时间,单位为秒。
  • Name String 采样截图模板名称,长度限制:64 个字符。
    Format String 图片格式,取值为 jpg 和 png。默认为 jpg。
    Comment String 模板描述信息,长度限制:256 个字符。
    SubAppId Integer 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。

    3. 输出参数

    参数名称 类型 描述
    Definition Integer 采样截图模板唯一标识。
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 创建采样截图模板

    输入示例

    https://vod.tencentcloudapi.com/?Action=CreateSampleSnapshotTemplate
    &Name=采样截图模板1
    &Width=540
    &Height=960
    &SampleType=Percent
    &SampleInterval=10
    &Format=jpg
    &<公共请求参数>

    输出示例

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

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalError 内部错误。
    InvalidParameterValue.Comment 参数错误:对该模板的描述。
    InvalidParameterValue.Format 参数值错误:Format。
    InvalidParameterValue.Height 参数错误:高度。
    InvalidParameterValue.Name 参数值错误:Name 超过长度限制。
    InvalidParameterValue.SampleInterval 参数值错误:SampleInterval。
    InvalidParameterValue.SampleType 参数值错误:SampleType。
    InvalidParameterValue.Width 参数错误:宽度。
    LimitExceeded.TooMuchTemplate 超过限制值:模板数超限。
    UnauthorizedOperation 未授权操作。