logologo
售前咨询
点播云
文档中心服务端API媒体处理查询截图模板详情

查询截图模板详情


请求参数

字段

类型

是否必填

示例

描述

Action

String

DescribeSnapshotTemplate

公共参数,拉取上传,取值:DescribeSnapshotTemplate

TemplateType

String

SampleSnapshot

模板类型。可选值:

  • SampleSnapshot:采样截图
  • SnapshotByTimeOffset:指定时间截图
  • ImageSprite:雪碧图

SpaceName

String

other_space1

应用空间

默认为:default_space

SnapshotTemplateId

String

f1f1r13r

模板Id



返回参数

字段

类型

示例

描述

CreateTime

String

2021-12-05T10:20:09Z

模板的创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

UpdateTime

String

2021-12-05T10:20:09Z

模板的更新时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC时间)。

TemplateType

String

SampleSnapshot

模板类型。可选值:

  • SampleSnapshot:采样截图
  • SnapshotByTimeOffset:指定时间截图
  • ImageSprite:雪碧图

SampleSnapshotTemplate

SampleSnapshotTemplate


当模板类型为SampleSnapshot时,返回采样截图模板

SnapshotByTimeOffsetTemplate

SnapshotByTimeOffsetTemplate


当模板类型为SnapshotByTimeOffset时,返回时间点截图模板

ImageSpriteTemplate

ImageSpriteTemplate


当模板类型为ImageSprite时,返回雪碧图模板


SampleSnapshotTemplate

字段

类型

是否必填(创建)

示例

描述

SnapshotTemplateId

String

xxx

模板ID

Name

String

snapshot_template

截图模板名称,长度限制:64 个字符。只可设置字母、数字、中划线、下划线。

  • 创建接口,需要传入
  • 更新接口,不需要传入

Description

String

test xxx

模板描述信息,长度限制:256 个字符。

SampleType

String

Time

采样截图类型,取值:

  • Time:按时间间隔。

默认值为Time

Interval

Integer

10

采样间隔。值必须大于0。

  • 当 SampleType 为 Time 时,指定采样间隔的时间,单位为秒。

Format

String

png

该模板计划使用的输出格式。

  • 支持输出的静图格式:jpeg、png

默认为jpeg

Width

Integer

宽和高必填其中一个

10

截图输出的宽,单位px。范围[0,4096]。如果为0则根据高进行缩放。宽高不能同时为0。同时设置宽高会对生成图宽高进行自适应调整。

默认值为0。

Height

Integer

宽和高必填其中一个

10

截图输出的高,单位px。范围[0,4096]。如果为0则根据宽进行缩放。宽高不能同时为0。同时设置宽高会对生成图宽高进行自适应调整。

默认值为0。

OffsetTime

Integer

10

截图指定时间的起始点,单位:s。若不指定则默认从0s开始。如果视频时长小于offsetTime则默认offsetTime从0s开始。

默认值为0。

SnapshotByTimeOffsetTemplate

字段

类型

是否必填(创建)

示例

描述

SnapshotTemplateId

String

xxx

模板ID

Name

String

snapshot_template

截图模板名称,长度限制:64 个字符。只可设置字母、数字、中划线、下划线。

  • 创建接口,需要传入
  • 更新接口,不需要传入

Description

String

test xxx

模板描述信息,长度限制:256 个字符。

Format

String

png

该模板计划使用的输出格式。

  • 支持输出的静图格式:jpeg、png

默认值为jpeg

Width

Integer

10

截图输出的宽,单位px。范围[0,4096]。如果为0则根据高进行缩放。同时设置宽高会对生成图宽高进行自适应调整。

默认值为0。

Height

Integer

10

截图输出的高,单位px。范围[0,4096]。如果为0则根据宽进行缩放。同时设置宽高会对生成图宽高进行自适应调整。

默认值为0。

OffsetTime

Integer

10

截图指定时间的起始点,单位:s。若不指定则默认从0s开始。如果视频时长小于offsetTime则默认offsetTime从0s开始。OffsetTime必须大于等于0。

默认值为0。

ImageSpriteTemplate

字段

类型

是否必填(创建)

示例

描述

SnapshotTemplateId

String

xxx

模板ID

Name

String

String

雪碧图模板名称,长度限制:64 个字符。只可设置字母、数字、中划线、下划线。

Description

String

String

模板描述信息,长度限制:256 个字符。

SampleType

String

String

采样类型,取值:

  • Time:按时间间隔。

默认为Time

SampleInterval

Integer

Integer

采样间隔。

  • 当 SampleType 为 Time 时,指定采样间隔的时间,单位为秒。值必须大于0。

RowCount

Integer

Integer

雪碧图中小图的行数。值必须大于0。

行数*列数必须小于200。

ColumnCount

Integer

Integer

雪碧图中小图的列数。值必须大于0。

行数*列数必须小于200。

Width

Integer

宽和高必填其中一个

Integer

雪碧图中小图的宽度,单位px。范围[0,480]。如果为0则根据高进行缩放。如果为0则根据高进行等比缩放宽高不能同时为0。同时设置宽高会对生成图宽高进行自适应调整。

默认值为0。

Height

Integer

宽和高必填其中一个

Integer

雪碧图中小图的高度,单位px。范围[0,480]。如果为0则根据高进行缩放。如果为0则根据宽进行等比缩放宽高不能同时为0。同时设置宽高会对生成图宽高进行自适应调整。

默认值为0。

Format

String

String

图片格式,取值:

  • jpeg:jpeg 格式;
  • png:png 格式;
  • webp:webp 格式。

默认值:jpeg


API示例

请求示例

curl -X POST 'https://vod.streamlakeapi.com/?Action=DescribeSnapshotTemplate' \
-H 'Content-Type: application/json' \
-d '{"TemplateType" : "SampleSnapshot","SnapshotTemplateId" : "xxxx"}' \
-H <公共参数>

错误码

ErrorCode

ErrorMessage

说明

状态码

ResourceNotFound

Template not found.

截图模板不存在

404

InvalidArgument

SnapshotTemplateId required arguments are missing

必填参数SnapshotTemplateId 为空

400

InvalidArgument

TemplateType required arguments are missing

必填参数TemplateType 为空

400

上一篇:查询转码模板详情下一篇:查询水印模板详情
该篇文档内容是否对您有帮助?
有帮助没帮助