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

创建截图模板


单次接口请求只能创建一种截图类型,支持指定时间点截图、采样截图、雪碧图。

请求参数

字段

类型

是否必填

示例

描述

Action

String

CreateSnapshotTemplate

公共参数,本接口取值:CreateSnapshotTemplate

TemplateType

String

ImageSprite

创建模板类型

  • SampleSnapshot
  • SnapshotByTimeOffset
  • ImageSprite

SpaceName

String

other_space1

应用空间

默认为:default_space

SnapshotByTimeOffsetTemplate

SnapshotByTimeOffsetTemplate


指定时间点截图

SampleSnapshotTemplate

SampleSnapshotTemplate


采样截图

ImageSpriteTemplate

ImageSpriteTemplate


雪碧图


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


返回参数

参数名称

类型

描述

SnapshotTemplateId

String

截图模板Id

API示例

  1. 请求示例创建指定时间点截图模板
curl -X POST 'https://vod.streamlakeapi.com/?Action=CreateSnapshotTemplate' \
-H 'Content-Type: application/json' \
-d '{"SnapshotByTimeOffsetTemplate" : {<SnapshotByTimeOffsetTemplate>}}' \
-H <公共请求参数>


2. 创建采样截图模板

curl -X POST 'https://vod.streamlakeapi.com/?Action=CreateSnapshotTemplate' \
-H 'Content-Type: application/json' \
-d '{"SampleSnapshotTemplate" : {<SampleSnapshotTemplate>}}' \
-H <公共请求参数>


  1. 创建雪碧图模板
curl -X POST 'https://vod.streamlakeapi.com/?Action=CreateSnapshotTemplate' \
-H 'Content-Type: application/json' \
-d '{"ImageSpriteTemplate" : {<ImageSpriteTemplate>}}' \
-H <公共请求参数>


返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
"ResponseMeta": {
"RequestId":"CixgpmAFOYcAAAAAAAAAAw",
"ErrorCode":"",
"ErrorMessage":""
},
"ResponseData": {
"SnapshotTemplateId": "42rqdewFar4"
}
}


错误码

ErrorCode

ErrorMessage

说明

状态码

InvalidArgument

TemplateType required arguments are missing

必填参数TemplateType 为空

400

InvalidArgument

SnapshotByTimeOffsetTemplate required arguments are missing

必填参数SnapshotByTimeOffsetTemplate 为空

400

InvalidArgument

SampleSnapshotTemplate required arguments are missing

必填参数SampleSnapshotTemplate 为空

400

InvalidArgument

ImageSpriteTemplate required arguments are missing

必填参数ImageSpriteTemplate 为空

400

InvalidArgument

Width and Height can not both be null

宽和高必填其中之一

400

上一篇:创建水印模板下一篇:创建任务流模板
该篇文档内容是否对您有帮助?
有帮助没帮助