对象存储
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 对象存储 > API 文档 > 数据处理接口 > 媒体处理 > 极速高清转码 > 创建模板

创建模板

最近更新时间：2023-11-06 19:15:32

我的收藏

本页目录：

功能描述

创建极速高清转码模板。


授权说明

授权策略中 action 设置为 ci:CreateMediaTemplate 。查看所有 action。

服务开通

使用该功能需提前开通数据万象，并绑定存储桶。详情请参见 绑定存储桶。

使用限制

使用该接口时，请先确认相关限制条件。详情请参见 使用限制。

请求

请求示例

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>
说明
Authorization: Auth String（详情请参见 请求签名 文档）。
通过子账号使用时，需要授予相关的权限，详情请参见 授权粒度详情 文档。

请求头

此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。

请求体

该请求操作的实现需要有如下请求体：
<Request>
    <Tag>HighSpeedHd</Tag>
    <Name>TemplateName</Name>
    <Container>
        <Format>mp4</Format>
    </Container>
    <Video>
        <Codec>H.264</Codec>
        <Bitrate>1000</Bitrate>
        <Width>1280</Width>
        <Fps>30</Fps>
        <Bufsize>1000</Bufsize>
        <Maxrate>10</Maxrate>
    </Video>
    <Audio>
        <Codec>aac</Codec>
        <Samplerate>44100</Samplerate>
        <Bitrate>128</Bitrate>
        <Channels>4</Channels>
    </Audio>
    <TransConfig>
        <IsCheckReso>false</IsCheckReso>
        <ResoAdjMethod>1</ResoAdjMethod>
    </TransConfig>
    <TimeInterval>
        <Start>0</Start>
        <Duration>60</Duration>
    </TimeInterval>
</Request>

具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Request
无
保存请求的容器
Container
是
Container 类型
Request
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Tag
Request
模板类型: HighSpeedHd
String
是
Name
Request
模板名称。仅支持中文、英文、数字、_、-和*，长度不超过 64
String
是
Container
Request
容器格式
Container
是
Video
Request
视频信息
Container
是
TimeInterval
Request
时间区间
Container
否
Audio
Request
音频信息
Container
否
TransConfig
Request
转码配置
Container
否
说明：
不传 Audio，相当于删除音频信息。
Container 类型
Container
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Format
Request.Container
封装格式: mp4，flv，hls，mkv
String
是
ClipConfig
Request.Container
分片配置, 当Format为hls时有效
Container
否
Container 类型 ClipConfig 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
Duration
Request.Container.ClipConfig
分片时长, 默认5s
String
否
设定 container，音频视频支持的格式如下表：
Container
Audio Codecs
Video Codecs
mp4/hls/mkv
AAC、MP3
H.264、H.265
flv
AAC、MP3
H.264
Container 类型
Video
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
默认值
是否必选
Codec
Request.Video
编解码格式
H.264
H.265
String
H.264
否
Width
Request.Video
宽
值范围：[128，4096]
单位：px
若只设置 Width 时，按照视频原始比例计算 Height
必须为偶数
String
视频原始宽度
否
Height
Request.Video
高
值范围：[128，4096]
单位：px
若只设置 Height 时，按照视频原始比例计算
Width 必须为偶数
String
视频原始高度
否
Fps
Request.Video
帧率
值范围：(0，60]
单位：fps
String
无
否
Profile
Request.Video
编码级别
支持 baseline、main、high
baseline：适合移动设备；
main：适合标准分辨率设备；
high：适合高分辨率设备;
仅H.264支持此参数。
String
high
否
Bitrate
Request.Video
视频输出文件的码率
值范围：[10，50000],单位：Kbps
auto 表示自适应码率
String
无
否
Crf
Request.Video
码率-质量控制因子
值范围：(0，51]
如果设置了 Crf，则 Bitrate 的设置失效
当 Bitrate 为空时，默认为25
String
无
否
Gop
Request.Video
关键帧间最大帧数，值范围：[0, 100000]
String
无
否
Preset
Request.Video
视频算法器预置
仅H.264支持该参数
取值 veryfast、fast、medium、slow、slower
String
medium
否
Bufsize
Request.Video
缓冲区大小
值范围：[1000，128000]
单位：Kb
String
无
否
Maxrate
Request.Video
视频码率峰值
值范围：[10，50000]
单位：Kbps
String
无
否
Pixfmt
Request.Video
视频颜色格式
H.264支持：yuv420p、auto
H.265支持：yuv420p、yuv420p10le、auto
String
无
否
Rotate
Request.Video
旋转角度
值范围：[0, 360)
单位：度
String
无
否
Roi
Request.Video
Roi 强度，取值 none、low、medium、high
String
none
否
Container 类型
TimeInterval
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
默认值
是否必选
Start
Request.TimeInterval
开始时间
[0 视频时长]
单位为秒
支持 float 格式，执行精度精确到毫秒
String
无
否
Duration
Request.TimeInterval
持续时间
[0 视频时长]
单位为秒
支持 float 格式，执行精度精确到毫秒
String
无
否
Container 类型
Audio
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
默认值
是否必选
Codec
Request.Audio
编解码格式，取值 aac、mp3
String
aac
否
Samplerate
Request.Audio
采样率
单位：Hz
可选 11025、22050、32000、44100、48000、96000
不同的封装，mp3 支持不同的采样率，如下表所示
String
44100
否
Bitrate
Request.Audio
原始音频码率
单位：Kbps
值范围：[8，1000]
String
无
否
Channels
Request.Audio
声道数
当 Codec 设置为 aac，支持1、2、4、5、6、8
当 Codec 设置为 mp3，支持1、2
String
无
否
Remove
Request.Audio
是否删除源音频流，取值 true、false
String
false
否
说明
Y 表示支持这种采样率，N 表示不支持。
封装格式/音频采样率
11025
22050
32000
44100
48000
96000
flv
N
Y
N
Y
N
N
mp4
N
Y
Y
Y
Y
N
hls/mkv
Y
Y
Y
Y
Y
N
Container 类型
TransConfig
的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
默认值
是否必选
AdjDarMethod
Request.TransConfig
分辨率调整方式
取值 scale、crop、pad、none
当输出视频的宽高比与原视频不等时，根据此参数做分辨率的相应调整
String
none
否
IsCheckReso
Request.TransConfig
是否检查分辨率，取值 true、false
当为 false 时，按照配置参数转码
String
false
否
ResoAdjMethod
Request.TransConfig
分辨率调整方式
当 IsCheckReso 为 true 时生效，取值0、1；
0 表示使用原视频分辨率；
1 表示返回转码失败
String
0
否
IsCheckVideoBitrate
Request.TransConfig
是否检查视频码率，取值 true、false
当为 false 时，按照配置参数转码
String
false
否
VideoBitrateAdjMethod
Request.TransConfig
视频码率调整方式
IsCheckVideoBitrate 为 true 时生效，取值0、1；
当输出视频码率大于原视频码率时，0表示使用原视频码率；1表示返回转码失败
String
0
否
IsCheckAudioBitrate
Request.TransConfig
是否检查音频码率，取值 true、false
当为 false 时，按照配置参数转码
String
false
否
AudioBitrateAdjMethod
Request.TransConfig
音频码率调整方式
IsCheckAudioBitrate 为 true 时生效，取值0、1；
当输出音频码率大于原音频码率时，0表示使用原音频码率；1表示返回转码失败
String
0
否
IsCheckVideoFps
Request.TransConfig
是否检查视频帧率，取值 true、false
当为 false 时，按照配置参数转码
String
false
否
VideoFpsAdjMethod
Request.TransConfig
视频帧率调整方式
IsCheckVideoFps 为 true 时生效，取值0、1；
当输出视频帧率大于原视频帧率时，0表示使用原视频帧率；1表示返回转码失败
String
0
否
DeleteMetadata
Request.TransConfig
是否删除文件中的 MetaData 信息，取值 true、false
String
false
否
IsHdr2Sdr
Request.TransConfig
是否开启 HDR 转 SDR，取值 true、false
String
false
否
HlsEncrypt
Request.TransConfig
hls 加密配置
Container
无
无

AdjDarMethod 参数图示：



Container 类型 HlsEncrypt 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
默认值
IsHlsEncrypt
Request.TransConfig.HlsEncrypt
是否开启HLS加密，取值 true/false
String
否
false
UriKey
Request.TransConfig.HlsEncrypt
HLS加密的key，当IsHlsEncrypt为true时, 该参数才有意义
String
否
无

响应

响应头

此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。

响应体

该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
<Response>
    <RequestId>NjQ0NGNlNDZfMThhYTk0MGFfY*********</RequestId>
    <Template>
        <Tag>HighSpeedHd</Tag>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Name>TemplateName</Name>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <HighSpeedHd>
            <Container>
                <Format>mp4</Format>
            </Container>
            <Video>
                <Codec>H.264</Codec>
                <Bitrate>1000</Bitrate>
                <Width>1280</Width>
                <Fps>30</Fps>
                <Bufsize>1000</Bufsize>
                <Maxrate>10</Maxrate>
            </Video>
            <Audio>
                <Codec>aac</Codec>
                <Samplerate>44100</Samplerate>
                <Bitrate>128</Bitrate>
                <Channels>4</Channels>
            </Audio>
            <TransConfig>
                <IsCheckReso>false</IsCheckReso>
                <ResoAdjMethod>1</ResoAdjMethod>
            </TransConfig>
            <TimeInterval>
                <Start>0</Start>
                <Duration>60</Duration>
            </TimeInterval>
        </HighSpeedHd>
        <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
        <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
    </Template>
</Response>
具体的数据内容如下：
节点名称（关键字）
父节点
描述
类型
Response
无
保存结果的容器
Container
Container 节点
Response
的内容：
节点名称（关键字）
父节点
描述
类型
Template
Response
保存模板详情的容器
Container
RequestId
Response
请求的唯一 ID
String
Container 节点
Template
的内容：
节点名称（关键字）
父节点
描述
类型
TemplateId
Response.Template
模板 ID
String
Name
Response.Template
模板名称
String
BucketId
Response.Template
模板所属存储桶
String
Category
Response.Template
模板属性，Custom 或者 Official
String
Tag
Response.Template
模板类型，HighSpeedHd
String
UpdateTime
Response.Template
更新时间
String
CreateTime
Response.Template
创建时间
String
HighSpeedHd
Response.Template
详细的模板参数
Container
Container 节点 HighSpeedHd 的内容：
节点名称（关键字）
父节点
描述
类型
TimeInterval
Response.Template.HighSpeedHd
同请求体中的 Request.TimeInterval
Container
Container
Response.Template.HighSpeedHd
同请求体中的 Request.Container
Container
Video
Response.Template.HighSpeedHd
同请求体中的 Request.Video
Container
Audio
Response.Template.HighSpeedHd
同请求体中的 Request.Audio
Container
TransConfig
Response.Template.HighSpeedHd
同请求体中的 Request.TransConfig
Container

错误码

该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。

实际案例

请求

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

<Request>
    <Tag>HighSpeedHd</Tag>
    <Name>TemplateName</Name>
    <Container>
        <Format>mp4</Format>
    </Container>
    <Video>
        <Codec>H.264</Codec>
        <Bitrate>1000</Bitrate>
        <Width>1280</Width>
        <Fps>30</Fps>
        <Bufsize>1000</Bufsize>
        <Maxrate>10</Maxrate>
    </Video>
    <Audio>
        <Codec>aac</Codec>
        <Samplerate>44100</Samplerate>
        <Bitrate>128</Bitrate>
        <Channels>4</Channels>
    </Audio>
    <TransConfig>
        <IsCheckReso>false</IsCheckReso>
        <ResoAdjMethod>1</ResoAdjMethod>
    </TransConfig>
    <TimeInterval>
        <Start>0</Start>
        <Duration>60</Duration>
    </TimeInterval>
</Request>

响应

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>
    <RequestId>NjQ0NGNlNDZfMThhYTk0MGFfY*********</RequestId>
    <Template>
        <Tag>HighSpeedHd</Tag>
        <TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
        <Name>TemplateName</Name>
        <BucketId>test-1234567890</BucketId>
        <Category>Custom</Category>
        <HighSpeedHd>
            <Container>
                <Format>mp4</Format>
            </Container>
            <Video>
                <Codec>H.264</Codec>
                <Bitrate>1000</Bitrate>
                <Width>1280</Width>
                <Fps>30</Fps>
                <Bufsize>1000</Bufsize>
                <Maxrate>10</Maxrate>
            </Video>
            <Audio>
                <Codec>aac</Codec>
                <Samplerate>44100</Samplerate>
                <Bitrate>128</Bitrate>
                <Channels>4</Channels>
            </Audio>
            <TransConfig>
                <IsCheckReso>false</IsCheckReso>
                <ResoAdjMethod>1</ResoAdjMethod>
            </TransConfig>
            <TimeInterval>
                <Start>0</Start>
                <Duration>60</Duration>
            </TimeInterval>
        </HighSpeedHd>
        <CreateTime>2020-08-05T11:35:24+0800</CreateTime>
        <UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
    </Template>
</Response>

中国站