tencent cloud

Creating Templates
Download PDF
Last updated: 2025-09-09 11:59:15
Creating Templates
Last updated: 2025-09-09 11:59:15
Download PDF

Feature Description

Create an audio/video splicing template.

Authorization Description

When used by a sub-account, the ci:CreateMediaTemplate permission is required. For details, see Cloud Infinite actions.

Activating a Service

Using this feature requires enabling Cloud Infinite in advance and binding a bucket. For details, see Bind Bucket.
Use this feature requires enabling Media Processing Service in advance via console or API. For details, see Enable Media Processing Service.

Use Limits

When using this API, please confirm the relevant restrictions first. For details, see Usage Limits.


Request

Requesting an Instance

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 details, see Request Signature document.

Request header.

Common Headers

This request uses common request headers. For details, see Common Request Headers.

Non-common Headers

This request has no special request header information.

Request body.

The implementation of this request operation requires the following request body.
<Request>
    <Tag>Concat</Tag>
    <Name>TemplateName</Name>
    <ConcatTemplate>
        <ConcatFragment>
            <Mode>Start</Mode>
            <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/start.mp4</Url>
        </ConcatFragment>
        <ConcatFragment>
            <Mode>End</Mode>
            <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/end.mp4</Url>
        </ConcatFragment>
        <Audio>
            <Codec>mp3</Codec>
            <Samplerate></Samplerate>
            <Bitrate></Bitrate>
            <Channels></Channels>
        </Audio>
        <Video>
            <Codec>H.264</Codec>
            <Bitrate>1000</Bitrate>
            <Width>1280</Width>
            <Height></Height>
            <Fps>30</Fps>
        </Video>
        <Container>
            <Format>mp4</Format>
        </Container>
        <AudioMixArray>
            <AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix1.mp3</AudioSource>
            <MixMode>Once</MixMode>
            <Replace>true</Replace>
            <EffectConfig>
                <EnableStartFadein>true</EnableStartFadein>
                <StartFadeinTime>3</StartFadeinTime>
                <EnableEndFadeout>false</EnableEndFadeout>
                <EndFadeoutTime>0</EndFadeoutTime>
                <EnableBgmFade>true</EnableBgmFade>
                <BgmFadeTime>1.7</BgmFadeTime>
            </EffectConfig>
        </AudioMixArray>
        <AudioMixArray>
            <AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix2.mp3</AudioSource>
            <MixMode>Once</MixMode>
            <Replace>true</Replace>
            <EffectConfig>
                <EnableStartFadein>true</EnableStartFadein>
                <StartFadeinTime>3</StartFadeinTime>
                <EnableEndFadeout>false</EnableEndFadeout>
                <EndFadeoutTime>0</EndFadeoutTime>
                <EnableBgmFade>true</EnableBgmFade>
                <BgmFadeTime>1.7</BgmFadeTime>
            </EffectConfig>
        </AudioMixArray>
    </ConcatTemplate>
</Request>
The data are described as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Request
None.
Container for saving requests
Container
Yes
Data description for Container type
Request
is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required
Tag
Request
Template type: Concat
String
Yes
Name
Request
Template name only supports Chinese, English, digits, _, -, and *, with length not exceeding 64.
String
Yes
ConcatTemplate
Request
Splicing template
Container
Yes
Data description for Container type
ConcatTemplate
is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Default Value
Required or Not
ConcatFragment
Request.ConcatTemplate
Splicing node, can splice up to 100 files.
Container Array
None.
No
Audio
Request.ConcatTemplate
audio parameters
Container
original media value
No
Video
Request.ConcatTemplate
video parameter
Container
original media value
No
Container
Request.ConcatTemplate
encapsulation format
Container
None.
Yes
AudioMix
Request.ConcatTemplate
Audio mix parameter, for details, see AudioMix
Container
None.
No
AudioMixArray
Request.ConcatTemplate
Audio mix parameter, maximum of 2 can be transmitted simultaneously
Container Array
None.
No
DirectConcat
Request.ConcatTemplate
{Create and bind a policy} {Query an instance} {Reset the access password of an instance} {Only concatenate, do not transcode, parameter value true/false}
String
false
No
SceneChangeInfo
Request.ConcatTemplate
Transition parameters
Container
None.
No
Note:
AudioMix and AudioMixArray are valid only when Audio.Remove is false.
Note: AudioMixArray is an array, and each sub-item has the same content as AudioMix. AudioMix has higher priority. When setting AudioMix, AudioMixArray becomes invalid.
Data description for Container array type
ConcatFragment
is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Default Value
Required or Not
Url
Request.ConcatTemplate.ConcatFragment
Spliced object address
String
None.
Yes
Mode
Request.ConcatTemplate.ConcatFragment
Node Type
Start
End
String
None.
Yes
StartTime
Request.ConcatTemplate.ConcatFragment
Start time, expressed in seconds, supports float format, execution accuracy accurate to milliseconds, not effective when Request.ConcatTemplate.DirectConcat is true.
String
None.
No
EndTime
Request.ConcatTemplate.ConcatFragment
End time, expressed in seconds, supports float format, execution accuracy accurate to milliseconds, not effective when Request.ConcatTemplate.DirectConcat is true.
String
None.
No
Duration
Request.ConcatTemplate.ConcatFragment
Duration, valid when Url is an image address. Unit: seconds, accuracy: millisecond. Range: (0,20]
String
2
No
Data description for Container type
Audio
is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Default Value
Required or Not
Codec
Request.ConcatTemplate.Audio
Encoding/decoding format, parameter values: aac, mp3
String
None.
Yes
Samplerate
Request.ConcatTemplate.Audio
sampling rate
unit: Hz
Option 11025, 22050, 32000, 44100, 48000, 96000
Different encapsulations. MP3 supports different sampling rates, as shown in the table below.
String
original sample rate of the file
No
Bitrate
Request.ConcatTemplate.Audio
audio bitrate
unit: Kbps
Value range: [8, 1000]
String
original audio bitrate of the file
No
Channels
Request.ConcatTemplate.Audio
number of sound channels
When Codec is set to aac, it supports 1, 2, 4, 5, 6, 8
When Codec is set to mp3, it supports 1, 2
String
Original number of sound channels in the file
No
Y indicates support for this sampling rate, N indicates no support.
Muxing Format / Audio Sample Rate
11025
22050
32000
44100
48000
96000
mp3
Y
Y
Y
Y
Y
N
Data description for Container type
Container
is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Format
Request.ConcatTemplate.Container
Muxing format: mp4, flv, hls, ts, mp3, aac
String
Yes
Data description for Container type
Video
is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Default Value
Required or Not
Codec
Request.ConcatTemplate.Video
Encoding/decoding format, parameter values: H.264, H.265
String
H.264
Yes
Width
Request.ConcatTemplate.Video
Width
Value range: [128, 4096]
unit: px
If only Width is set, calculate Height based on the original aspect ratio of the video.
Must be even
String
Original width of video
No
Height
Request.ConcatTemplate.Video
Height
Value range: [128, 4096]
unit: px
If only Height is set, calculate Width based on the original aspect ratio of the video.
Must be even
String
Original height of video
No
Fps
Request.ConcatTemplate.Video
Frame Rate
Value range: (0, 60]
unit: fps
String
Original frame rate of video
No
Bitrate
Request.ConcatTemplate.Video
Bitrate of video output file
Value range: [10, 50000]
unit: Kbps
String
Original bitrate of video
No
Crf
Request.ConcatTemplate.Video
Bitrate - Quality control factor
Value range: (0, 51]
If Crf is set, the setting of Bitrate becomes invalid.
When Bitrate is empty, it defaults to 25.
String
Original bitrate of video
No
Remove
Request.ConcatTemplate.Video
Whether to remove video stream, parameter value: true, false
String
false
No
Rotate
Request.ConcatTemplate.Video
Rotation angle
Value range: [0, 360)
unit: degree
String
None.
No
Data description for Container type
SceneChangeInfo
is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required
Default Value
Limit
Mode
Request.ConcatTemplate.SceneChangeInfo
Transition Mode
String
Yes
None.
Default: Do not add transition effect.
FADE: fade in/out
GRADIENT
XFADE: Xfade transition effect
Time
Request.ConcatTemplate.SceneChangeInfo
Transition Duration
String
No
3
unit: second (s)
Value range: (0, 5], supports decimals
TransitionType
Request.ConcatTemplate.SceneChangeInfo
XFADE transition mode, this parameter is valid only when Mode is XFADE. For specific effects, see Xfade Gallery.
String
No
None.
custom
fade
wipeleft
wiperight
wipeup
wipedown
slideleft
slideright
slideup
slidedown
circlecrop
rectcrop
distance
fadeblack
fadewhite
radial
smoothleft
smoothright
smoothup
smoothdown
circleopen
circleclose
vertopen
vertclose
horzopen
horzclose
dissolve
pixelize
diagtl
diagtr
diagbl
diagbr
hlslice
hrslice
vuslice
vdslice
hblur
fadegrays
wipetl
wipetr
wipebl
wipebr
squeezeh
squeezev
zoomin
fadefast
fadeslow
hlwind
hrwind
vuwind
vdwind
coverleft
coverright
coverup
coverdown
revealleft
revealright
revealup
revealdown

Response

Response Headers

Common Response Headers

This response uses common response headers. For details, see Common Response Headers.

Special Response Headers

There are no special response headers for this response operation.

Response Body

The response body is returned as application/xml. An example including the complete node data is shown below:
<Response>
    <RequestId>NjQ0NGNlNDZfMThhYTk0MGFfY*********</RequestId>
    <Template>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Tag>Concat</Tag>
        <Name>TemplateName</Name>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <ConcatTemplate>
            <ConcatFragment>
                <Mode>Start</Mode>
                <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/start.mp4</Url>
            </ConcatFragment>
            <ConcatFragment>
                <Mode>End</Mode>
                <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/end.mp4</Url>
            </ConcatFragment>
            <Audio>
                <Codec>mp3</Codec>
                <Samplerate></Samplerate>
                <Bitrate></Bitrate>
                <Channels></Channels>
            </Audio>
            <Video>
                <Codec>H.264</Codec>
                <Bitrate>1000</Bitrate>
                <Width>1280</Width>
                <Height></Height>
                <Fps>30</Fps>
            </Video>
            <Container>
                <Format>mp4</Format>
            </Container>
            <AudioMixArray>
                <AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix1.mp3</AudioSource>
                <MixMode>Once</MixMode>
                <Replace>true</Replace>
                <EffectConfig>
                    <EnableStartFadein>true</EnableStartFadein>
                    <StartFadeinTime>3</StartFadeinTime>
                    <EnableEndFadeout>false</EnableEndFadeout>
                    <EndFadeoutTime>0</EndFadeoutTime>
                    <EnableBgmFade>true</EnableBgmFade>
                    <BgmFadeTime>1.7</BgmFadeTime>
                </EffectConfig>
            </AudioMixArray>
            <AudioMixArray>
                <AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix2.mp3</AudioSource>
                <MixMode>Once</MixMode>
                <Replace>true</Replace>
                <EffectConfig>
                    <EnableStartFadein>true</EnableStartFadein>
                    <StartFadeinTime>3</StartFadeinTime>
                    <EnableEndFadeout>false</EnableEndFadeout>
                    <EndFadeoutTime>0</EndFadeoutTime>
                    <EnableBgmFade>true</EnableBgmFade>
                    <BgmFadeTime>1.7</BgmFadeTime>
                </EffectConfig>
            </AudioMixArray>
        </ConcatTemplate>
        <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
        <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
    </Template>
</Response>
The data are as follows:
Node Name (Keyword)
Parent Node
Description
Type
Response
None.
Container for saving results
Container
Container node
Response
content:
Node Name (Keyword)
Parent Node
Description
Type
Template
Response
Container for saving template details
Container
RequestId
Response
unique request ID
String
Container node
Template
content:
Node Name (Keyword)
Parent Node
Description
Type
TemplateId
Response.Template
template ID
String
Name
Response.Template
Template Name
String
BucketId
Response.Template
Template's bucket
String
Category
Response.Template
Template Property, Custom or Official
String
Tag
Response.Template
Template type: Concat
String
UpdateTime
Response.Template
Update time
String
CreateTime
Response.Template
Creation time
String
ConcatTemplate
Response.Template
Request.ConcatTemplate
Container

Error Codes

This request has no specific error information. For common error messages, please refer to the Error Codes document.

Examples

Request

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

<Request>
   <Tag>Concat</Tag>
   <Name>TemplateName</Name>
   <ConcatTemplate>
        <ConcatFragment>
            <Mode>Start</Mode>
            <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/start.mp4</Url>
        </ConcatFragment>
        <ConcatFragment>
            <Mode>End</Mode>
            <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/end.mp4</Url>
        </ConcatFragment>
        <Audio>
            <Codec>mp3</Codec>
            <Samplerate></Samplerate>
            <Bitrate></Bitrate>
            <Channels></Channels>
        </Audio>
        <Video>
            <Codec>H.264</Codec>
            <Bitrate>1000</Bitrate>
            <Width>1280</Width>
            <Height></Height>
            <Fps>30</Fps>
        </Video>
        <Container>
            <Format>mp4</Format>
        </Container>
        <AudioMixArray>
            <AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix1.mp3</AudioSource>
            <MixMode>Once</MixMode>
            <Replace>true</Replace>
            <EffectConfig>
                <EnableStartFadein>true</EnableStartFadein>
                <StartFadeinTime>3</StartFadeinTime>
                <EnableEndFadeout>false</EnableEndFadeout>
                <EndFadeoutTime>0</EndFadeoutTime>
                <EnableBgmFade>true</EnableBgmFade>
                <BgmFadeTime>1.7</BgmFadeTime>
            </EffectConfig>
        </AudioMixArray>
        <AudioMixArray>
            <AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix2.mp3</AudioSource>
            <MixMode>Once</MixMode>
            <Replace>true</Replace>
            <EffectConfig>
                <EnableStartFadein>true</EnableStartFadein>
                <StartFadeinTime>3</StartFadeinTime>
                <EnableEndFadeout>false</EnableEndFadeout>
                <EndFadeoutTime>0</EndFadeoutTime>
                <EnableBgmFade>true</EnableBgmFade>
                <BgmFadeTime>1.7</BgmFadeTime>
            </EffectConfig>
        </AudioMixArray>
   </ConcatTemplate>
</Request>

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 100
Connection: keep-alive
Date: Thu, 14 Jul 2022 12:37:29 GMT
Server: tencent-ci
x-ci-request-id: NjMxMDJhYTNfMThhYTk0MGFfYmU1OV8zZjc=

<Response>
    <RequestId>NjQ0NGNlNDZfMThhYTk0MGFfY*********</RequestId>
    <Template>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Tag>Concat</Tag>
        <Name>TemplateName</Name>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <ConcatTemplate>
            <ConcatFragment>
                <Mode>Start</Mode>
                <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/start.mp4</Url>
            </ConcatFragment>
            <ConcatFragment>
                <Mode>End</Mode>
                <Url>http://bucket-1250000000.cos.ap-beijing.myqcloud.com/end.mp4</Url>
            </ConcatFragment>
            <Audio>
                <Codec>mp3</Codec>
                <Samplerate></Samplerate>
                <Bitrate></Bitrate>
                <Channels></Channels>
            </Audio>
            <Video>
                <Codec>H.264</Codec>
                <Bitrate>1000</Bitrate>
                <Width>1280</Width>
                <Height></Height>
                <Fps>30</Fps>
            </Video>
            <Container>
                <Format>mp4</Format>
            </Container>
            <AudioMixArray>
                <AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix1.mp3</AudioSource>
                <MixMode>Once</MixMode>
                <Replace>true</Replace>
                <EffectConfig>
                    <EnableStartFadein>true</EnableStartFadein>
                    <StartFadeinTime>3</StartFadeinTime>
                    <EnableEndFadeout>false</EnableEndFadeout>
                    <EndFadeoutTime>0</EndFadeoutTime>
                    <EnableBgmFade>true</EnableBgmFade>
                    <BgmFadeTime>1.7</BgmFadeTime>
                </EffectConfig>
            </AudioMixArray>
            <AudioMixArray>
                <AudioSource>https://test-xxx.cos.ap-chongqing.myqcloud.com/mix2.mp3</AudioSource>
                <MixMode>Once</MixMode>
                <Replace>true</Replace>
                <EffectConfig>
                    <EnableStartFadein>true</EnableStartFadein>
                    <StartFadeinTime>3</StartFadeinTime>
                    <EnableEndFadeout>false</EnableEndFadeout>
                    <EndFadeoutTime>0</EndFadeoutTime>
                    <EnableBgmFade>true</EnableBgmFade>
                    <BgmFadeTime>1.7</BgmFadeTime>
                </EffectConfig>
            </AudioMixArray>
        </ConcatTemplate>
        <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
        <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
    </Template>
</Response>

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback