tencent cloud

Feedback

DocumentationCloud Infinite
DocumentationCloud Infinite

Creating Animated Image Template

Last updated: 2024-02-29 09:57:29

Feature Description

This API (CreateMediaTemplate) is used to create an animated image template.


Request

Sample request

POST /template HTTP/1.1
Host: <BucketName-APPID>.ci.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>
Content-Type: application/xml

<body>
Note:
Authorization: Auth String (for more information, see Request Signature).
When this feature is used by a sub-account, relevant permissions must be granted. For more information, see Authorization Granularity.

Request headers

This API only uses common request headers. For more information, see Common Request Headers.

Request body

This request requires the following request body:
<Request>
<Tag>Animation</Tag>
<Name>TemplateName</Name>
<Container>
<Format>gif</Format>
</Container>
<Video>
<Codec>gif</Codec>
<Width>1280</Width>
<Height></Height>
<Fps>15</Fps>
<AnimateOnlyKeepKeyFrame>true</AnimateOnlyKeepKeyFrame>
</Video>
<TimeInterval>
<Start>0</Start>
<Duration>60</Duration>
</TimeInterval>
</Request>
The nodes are described as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required
Request
None
Request container
Container
Yes
Request has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
Tag
Request
Template type: Animation
String
Yes
Name
Request
Template name, which can contain letters, digits, underscores (_), hyphens (-), and asterisks (*).
String
Yes
Container
Request
Container format
Container
Yes
Video
Request
Video information
Container
No
TimeInterval
Request
Time interval
Container
No
Container has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
Format
Request.Container
Container format. Valid values: gif, hgif (higher-definition gif), webp
String
Yes
Video has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
Default Value
Constraints
Codec
Request.Video
Codec format
String
Yes
None
gif, webp
Width
Request.Video
Width
String
No
Original video width
Value range: [128, 4096]
Unit: px
If only Width is set, Height is calculated according to the original video aspect ratio.
Height
Request.Video
Height
String
No
Original video height
Value range: [128, 4096]
Unit: px
If only Height is set, Width is calculated according to the original video aspect ratio.
Fps
Request.Video
Frame rate
String
No
Original video frame rate
Value range: (0, 60]
Unit: fps
This parameter is optional. If it is not set, the video is played at the speed as per the original timestamp. This parameter specifies the frame rate for animated image playback.
AnimateOnly KeepKeyFrame
Request.Video
Keeps only key frames for animated images. If AnimateOnlyKeepKeyFrame is set to true, AnimateTimeIntervalOfFrame and AnimateFramesPerSecond don't need to be set. If AnimateOnlyKeepKeyFrame is set to false, either AnimateTimeIntervalOfFrame or AnimateFramesPerSecond must be set.
String
No
false
Valid values: true, false
This parameter specifies whether to keep only key frames for animated images
Priority: AnimateFramesPerSecond > AnimateOnlyKeepKeyFrame > AnimateTimeIntervalOfFrame
AnimateTime IntervalOfFrame
Request.Video
Frame sampling interval for animated images
String
No
None
Value range: (0, video duration]
Frame sampling interval for animated images
The value of this parameter must be less than the value of TimeInterval.Duration if TimeInterval.Duration is set.
AnimateFrames PerSecond
Request.Video
Number of frames sampled per second for animated images
String
No
None
Value range: (0, video frame rate)
Frame sampling frequency for animated images
Priority: AnimateFramesPerSecond > AnimateOnlyKeepKeyFrame > AnimateTimeIntervalOfFrame
Quality
Request.Video
Relative quality
String
No
None
Value range: [1, 100)
This parameter is valid for WEBP images and is not available for GIF images.
TimeInterval has the following sub-nodes:

TimeInterval has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
Default Value
Constraints
Start
Request.TimeInterval
Start time
String
No
0
[0, video duration]
Unit: second
Supports the float format, accurate to the millisecond.
Duration
Request.TimeInterval
Duration
String
No
Video duration
[0, video duration]
Unit: second
Supports the float format, accurate to milliseconds.

Response

Response headers

This response contains common response headers. For more information, see Common Response Headers.

Response body

The response body returns application/xml data. The following contains all the nodes:
<Response>
<Template>
<Name>TemplateName</Name>
<TemplateId></TemplateId>
<Tag>Animation</Tag>
<TransTpl>
<Container>
<Format>gif</Format>
</Container>
<Video>
<Codec>gif</Codec>
<Width>1280</Width>
<Height></Height>
<Fps>15</Fps>
<AnimateOnlyKeepKeyFrame>true</AnimateOnlyKeepKeyFrame>
</Video>
<TimeInterval>
<Start>0</Start>
<Duration>60</Duration>
</TimeInterval>
</TransTpl>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</Template>
</Response>
The nodes are as described below:
Node Name (Keyword)
Parent Node
Description
Type
Response
None
Response container
Container
Response has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
TemplateId
Response
Template ID
String
Name
Response
Template name
String
BucketId
Response
Template bucket
String
Category
Response
Template category: Custom or Official
String
Tag
Response
Template type: Animation
String
UpdateTime
Response
Update time
String
CreateTime
Response
Creation time
String
TransTpl
Response
Template parameters
Container
Container has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
Format
Response.TransTpl.Container
Container format: gif, hgif (higher-definition gif), webp
String
Yes
Video has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
Default Value
Constraints
Codec
Response. TransTpl.Video
Codec format
String
Yes
None
gif, webp
Width
Response. TransTpl.Video
Width
String
No
Original video width
Value range: [128, 4096]
Unit: px
If only Width is set, Height is calculated according to the original video aspect ratio.
Height
Response. TransTpl.Video
Height
String
No
Original video height
Value range: [128, 4096]
Unit: px
If only Height is set, Width is calculated according to the original video aspect ratio.
Fps
Response. TransTpl.Video
Frame rate
String
No
Original video frame rate
Value range: (0, 60]
Unit: fps
If the frame rate is greater than 60, set this parameter to 60. This optional parameter specifies the frame rate for animated image playback. If it is not set, the animated image will be played back at the speed of the original timestamp.
AnimateOnly KeepKeyFrame
Response. TransTpl.Video
Keeps only keyframes for animated images
String
No
false
Valid values: true, false
Specifies whether to keep only keyframes for animated images
AnimateTime IntervalOfFrame
Response. TransTpl.Video
Frame sampling interval for animated images
String
No
None
Value range: (0, video duration]
Frame sampling interval for animated images
The value of this parameter must be less than the value of TimeInterval.Duration if TimeInterval.Duration is set.
AnimateFrames PerSecond
Response. TransTpl.Video
Number of frames sampled per second for animated images
String
No
None
Value range: (0, video frame rate)
Frame sampling frequency for animated images
Priority: AnimateFramesPerSecond > AnimateOnlyKeepKeyFrame > AnimateTimeIntervalOfFrame
Quality
Response. TransTpl.Video
Relative quality
String
No
None
Value range: [1, 100)
This parameter is valid for WEBP images and is not available for GIF images.
TimeInterval has the following sub-nodes:
Node Name (Keyword)
Parent Node
Description
Type
Required
Default Value
Constraints
Start
Response.TransTpl.TimeInterval
Start time
String
No
0
[0, video duration]
Unit: second
Supports the float format, accurate to the millisecond.
Duration
Response.TransTpl.TimeInterval
Duration
String
No
Video duration
[0, video duration]
Unit: second
Supports the float format, accurate to milliseconds.

Error codes

There are no special error messages for this request. For common error messages, see Error Codes.

Samples

Request

POST /template HTTP/1.1
Authorization:q-sign-algorithm=sha1&q-ak=AKIDZfbOAo7cllgPvF9cXFrJD0a1ICvR****&q-sign-time=1497530202;1497610202&q-key-time=1497530202;1497610202&q-header-list=&q-url-param-list=&q-signature=28e9a4986df11bed0255e97ff90500557e0ea057
Host:bucket-1250000000.ci.ap-beijing.myqcloud.com
Content-Length: 1666
Content-Type: application/xml



<Request>
<Tag>Animation</Tag>
<Name>TemplateName</Name>
<Container>
<Format>gif</Format>
</Container>
<Video>
<Codec>gif</Codec>
<Width>1280</Width>
<Height></Height>
<Fps>15</Fps>
<AnimateOnlyKeepKeyFrame>true</AnimateOnlyKeepKeyFrame>
</Video>
<TimeInterval>
<Start>0</Start>
<Duration>60</Duration>
</TimeInterval>
</Request>

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 15 Jun 2017 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NTk0MjdmODlfMjQ4OGY3XzYzYz****=



<Response>
<Template>
<Name>TemplateName</Name>
<TemplateId></TemplateId>
<Tag>Animation</Tag>
<TransTpl>
<Container>
<Format>gif</Format>
</Container>
<Video>
<Codec>gif</Codec>
<Width>1280</Width>
<Height></Height>
<Fps>15</Fps>
<AnimateOnlyKeepKeyFrame>true</AnimateOnlyKeepKeyFrame>
</Video>
<TimeInterval>
<Start>0</Start>
<Duration>60</Duration>
</TimeInterval>
</TransTpl>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</Template>
</Response>


Catalog

In The Article

Creating Animated Image Template

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support