tencent cloud

Cloud Object Storage

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Use Cases
Strengths
Concepts
Regions and Access Endpoints
Specifications and Limits
Service Regions and Service Providers
Billing
Billing Overview
Billing Method
Billable Items
Free Tier
Billing Examples
Viewing and Downloading Bill
Payment Overdue
FAQs
Getting Started
Console
Getting Started with COSBrowser
User Guide
Creating Request
Bucket
Object
Data Management
Batch Operation
Global Acceleration
Monitoring and Alarms
Operations Center
Data Processing
Content Moderation
Smart Toolbox
Data Processing Workflow
Application Integration
User Tools
Tool Overview
Installation and Configuration of Environment
COSBrowser
COSCLI (Beta)
COSCMD
COS Migration
FTP Server
Hadoop
COSDistCp
HDFS TO COS
GooseFS-Lite
Online Tools
Diagnostic Tool
Use Cases
Overview
Access Control and Permission Management
Performance Optimization
Accessing COS with AWS S3 SDK
Data Disaster Recovery and Backup
Domain Name Management Practice
Image Processing
Audio/Video Practices
Workflow
Direct Data Upload
Content Moderation
Data Security
Data Verification
Big Data Practice
COS Cost Optimization Solutions
Using COS in the Third-party Applications
Migration Guide
Migrating Local Data to COS
Migrating Data from Third-Party Cloud Storage Service to COS
Migrating Data from URL to COS
Migrating Data Within COS
Migrating Data Between HDFS and COS
Data Lake Storage
Cloud Native Datalake Storage
Metadata Accelerator
GooseFS
Data Processing
Data Processing Overview
Image Processing
Media Processing
Content Moderation
File Processing Service
File Preview
Troubleshooting
Obtaining RequestId
Slow Upload over Public Network
403 Error for COS Access
Resource Access Error
POST Object Common Exceptions
API Documentation
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
SDK Documentation
SDK Overview
Preparations
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
Mini Program SDK
Error Codes
Harmony SDK
Endpoint SDK Quality Optimization
Security and Compliance
Data Disaster Recovery
Data Security
Cloud Access Management
FAQs
Popular Questions
General
Billing
Domain Name Compliance Issues
Bucket Configuration
Domain Names and CDN
Object Operations
Logging and Monitoring
Permission Management
Data Processing
Data Security
Pre-signed URL Issues
SDKs
Tools
APIs
Agreements
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary
DocumentaçãoCloud Object StorageAPI DocumentationData Processing APIsMedia ProcessingHighlight CollectionCreating Templates

Creating Templates

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2026-01-12 18:52:30

Feature Description

Create a video montage 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.
Using this feature requires enabling the media processing service in advance through Console Guide > Media Processing or the API.

Use Limits

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


Request

Request sample:

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.

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

Request body.

The implementation of this request operation requires the following request body:
<Request>
    <Tag>VideoMontage</Tag>
    <Name>TemplateName</Name>
    <Duration>10.5</Duration>
    <Container>
        <Format>mp4</Format>
    </Container>
    <Video>
        <Codec>H.264</Codec>
        <Bitrate>1000</Bitrate>
        <Width>1280</Width>
        <Fps>30</Fps>
    </Video>
    <Audio>
        <Codec>aac</Codec>
        <Samplerate>44100</Samplerate>
        <Bitrate>128</Bitrate>
        <Channels>4</Channels>
        <Remove>false</Remove>
    </Audio>
    <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>
</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
The specific data description for the
Request
Container type is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Default Value
Tag
Request
Template type: VideoMontage
String
Yes
None.
Name
Request
Template name, supports only Chinese, English, digits, _, -, and *, with length not exceeding 64.
String
Yes
None.
Duration
Request
Highlights duration
Default automatic analysis duration
Unit: seconds
Support float format, execution accuracy accurate to milliseconds
String
No
None.
Container
Request
container format
Container
Yes
None.
Video
Request
video information
Container
Yes
None.
Audio
Request
audio content
Container
No
None.
Scene
Request
highlight scenario
Video: standard video
Soccer
String
No
Video
AudioMix
Request
Audio mix parameter, for details, see AudioMix
Container
No
None.
AudioMixArray
Request
Parameter array for audio mix, up to 2 can be passed simultaneously.
Container array
No
None.
Note:
AudioMix and AudioMixArray are valid only when Audio.Remove is false.
AudioMixArray is an array, with each sub-item having the same content as AudioMix. AudioMix has higher priority; when setting AudioMix, AudioMixArray becomes invalid.
The specific data description for the
Container
type is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Required or Not
Format
Request.Container
Muxing format: mp4, flv, hls, ts, mkv
String
Yes
Set container Supported audio/video formats are listed in the table below:
Container
Audio Codecs
Video Codecs
mp4/ts/hls/mkv
AAC,MP3
H.264,H.265
flv
AAC,MP3
H.264
Data description for
Video
type Container is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Default Value
Required or Not
Codec
Request.Video
Encoding/decoding format, parameter values: H.264, H.265
String
H.264
No
Width
Request.Video
Wide
Value range: [128, 4096]
unit: px
If only Width is set, calculate Height according to the original proportion of the video.
Must be even
String
Original width of the video
No
Height
Request.Video
High
Value range: [128, 4096]
unit: px
If only Height is set, calculate Width according to the original proportion of the video.
Must be even
String
Original height of the video
No
Fps
Request.Video
Frame Rate
Value range: (0, 60]
Unit: fps
String
None.
No
Bitrate
Request.Video
Bitrate of the video output file
Value range: [10, 50000]
Unit: Kbps
String
None.
No
Crf
Request.Video
Bitrate - Quality control factor
Value range: (0, 51]
If Crf is set, the Bitrate setting becomes invalid.
When Bitrate is empty, the default is 25.
String
None.
No
Rotate
Request.Video
Rotation angle
Value range: [0, 360)
unit: degree
String
None.
No
The specific data description for the
Audio
Container type is as follows:
Node Name (Keyword)
Parent Node
Description
Type
Default Value
Required or Not
Codec
Request.Audio
Encoding/decoding format, parameter values: aac, mp3
String
aac
No
Samplerate
Request.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
44100
No
Bitrate
Request.Audio
original audio bitrate
Unit: Kbps
Value range: [8, 1000]
String
None.
No
Channels
Request.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
None.
No
Remove
Request.Audio
Whether to remove audio stream, parameter true,false
String
false.
When Audio is unconfigured, the default is true.
No
Note:
Y indicates support for this sampling rate, N indicates no support.
Muxing Format / Audio Sample Rate
11025
22050
32000
44100
48000
96000
flv
N
Y
N
Y
N
N
mp4
N
Y
Y
Y
Y
N
hls/ts/mkv
Y
Y
Y
Y
Y
N

Response

Response Headers

This API only returns the public response header. For details, see Common Response Headers documentation.

Response Body

The response body is returned as application/xml. An example including the complete node data is shown below:
<Response>
    <Template>
        <Tag>VideoMontage</Tag>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Name>TemplateName</Name>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <VideoMontage>
            <Duration>10.5</Duration>
            <Container>
                <Format>mp4</Format>
            </Container>
            <Video>
                <Codec>H.264</Codec>
                <Bitrate>1000</Bitrate>
                <Width>1280</Width>
                <Fps>30</Fps>
            </Video>
            <Audio>
                <Codec>aac</Codec>
                <Samplerate>44100</Samplerate>
                <Bitrate>128</Bitrate>
                <Channels>4</Channels>
                <Remove>false</Remove>
            </Audio>
            <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>
        </VideoMontage>
        <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
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, VideoMontage
String
UpdateTime
Response.Template
Update time
String
CreateTime
Response.Template
Creation time
String
VideoMontage
Response.Template
Detailed template parameters
Container

Container node
VideoMontage
content:
Node Name (Keyword)
Parent Node
Description
Duration
Response.Template.VideoMontage
Request.Duration in the request body
TimeInterval
Response.Template.VideoMontage
Request.TimeInterval in the request body
Container
Response.Template.VideoMontage
Request.Container in the request body
Video
Response.Template.VideoMontage
Request.Video in the request body
Audio
Response.Template.VideoMontage
Request.Audio in the request body
Scene
Response.Template.VideoMontage
Request.Scene in the request body
AudioMix
Response.Template.VideoMontage
Request.AudioMix in the request body
AudioMixArray
Response.Template.VideoMontage
Request.AudioMixArray in the request body

Error Codes

This request returns common error responses and error codes. For more information, see Error Codes.

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-beijing.myqcloud.com
Content-Length: 1666
Content-Type: application/xml

<Request>
    <Tag>VideoMontage</Tag>
    <Name>TemplateName</Name>
    <Duration>10.5</Duration>
    <Container>
        <Format>mp4</Format>
    </Container>
    <Video>
        <Codec>H.264</Codec>
        <Bitrate>1000</Bitrate>
        <Width>1280</Width>
        <Fps>30</Fps>
    </Video>
    <Audio>
        <Codec>aac</Codec>
        <Samplerate>44100</Samplerate>
        <Bitrate>128</Bitrate>
        <Channels>4</Channels>
        <Remove>false</Remove>
    </Audio>
    <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>
</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: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <Template>
        <Tag>VideoMontage</Tag>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Name>TemplateName</Name>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <VideoMontage>
            <Duration>10.5</Duration>
            <Container>
                <Format>mp4</Format>
            </Container>
            <Video>
                <Codec>H.264</Codec>
                <Bitrate>1000</Bitrate>
                <Width>1280</Width>
                <Fps>30</Fps>
            </Video>
            <Audio>
                <Codec>aac</Codec>
                <Samplerate>44100</Samplerate>
                <Bitrate>128</Bitrate>
                <Channels>4</Channels>
                <Remove>false</Remove>
            </Audio>
            <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>
        </VideoMontage>
        <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
        <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
    </Template>
</Response>

Anterior: Callback InformationPróximo: Updating a Template

Ajuda e Suporte

Esta página foi útil?

comentários