多媒体处理
有奖捉虫：行业应用 & 管理与支持文档专题 HOT
文档中心 > 多媒体处理 > API 文档 > 模板接口 > 转码模板 > 搜索转码模板

搜索转码模板

最近更新时间：2021-12-14 11:06:02

我的收藏

本页目录：

功能描述

DescribeMediaTemplates 用于搜索转码模板。

请求

请求示例

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

说明
Authorization: Auth String （详情请参见 请求签名 文档）。

请求头

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

请求体

该请求的请求体为空。

请求参数

参数的具体内容如下：
节点名称（关键字）
父节点
描述
类型
必选
tag
无
模板Tag：Transcode
String
是
category
无
Official，Custom，默认值: Custom
String
是
ids
无
模板 ID，以,符号分割字符串
String
否
name
无
模板名称前缀
String
否
pageNumber
无
第几页
Integer
否
pageSize
无
每页个数
Integer
否

响应

响应头

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

响应体

该响应体返回为 application/xml 数据，包含完整节点数据的内容展示如下：
<Response>
    <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhfMjc=</RequestId>
    <TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TemplateList>
        <TemplateId>A</TemplateId>
        <Name>TemplateName</Name>
        <Tag>Transcode</Tag>
        <TransTpl>
            <Container>
                <Format>mp4</Format>
            </Container>
            <Video>
                <Codec>H.264</Codec>
                <Profile>high</Profile>
                <Bitrate>1000</Bitrate>
                <Crf></Crf>
                <Width>1280</Width>
                <Height></Height>
                <Fps>30</Fps>
                <Gop></Gop>
                <Preset>medium</Preset>
                <ScanMode></ScanMode>
                <Bufsize>0</Bufsize>
                <Maxrate>0</Maxrate>

            </Video>
            <Audio>
                <Codec>aac</Codec>
                <Samplerate>44100</Samplerate>
                <Bitrate>128</Bitrate>
                <Channels>4</Channels>
            </Audio>
            <TransConfig>
                <AdjDarMethod>scale</AdjDarMethod>
                <IsCheckReso>false</IsCheckReso>
                <ResoAdjMethod>1</ResoAdjMethod>
            </TransConfig>
            <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>
    </TemplateList>
</Response>
具体的数据内容如下：
节点名称（关键字）
父节点
描述
类型
Response
无
保存结果的容器
Container
Container 节点 Response 的内容：
节点名称（关键字）
父节点
描述
类型
RequestId
Response
请求的唯一 ID
String
TotalCount
Response
模板总数
Int
PageNumber
Response
当前页数，同请求中的 pageNumber
Int
PageSize
Response
每页个数，同请求中的 pageSize
Int
TemplateList
Response
模板数组
Container
Container节点 TemplateList 的内容：
节点名称（关键字）
父节点
描述
类型
TemplateId
Response.TemplateList
模板 ID
String
Name
Response.TemplateList
模板名字
String
BucketId
Response.TemplateList
模板所属存储桶
String
Category
Response.TemplateList
模板属性，Custom 或者 Official
String
Tag
Response.TemplateList
模板类型，Transcode
String
UpdateTime
Response.TemplateList
更新时间
String
CreateTime
Response.TemplateList
创建时间
String
TransTpl
Response.TemplateList
详细的模板参数
Container
Container节点 TransTpl 的内容：
节点名称（关键字）
父节点
描述
类型
TimeInterval
Response.TemplateList.TransTpl
时间区间
Container
Container
Response.TemplateList.TransTpl
容器格式
Container
Video
Response.TemplateList.TransTpl
视频信息
Container
Audio
Response.TemplateList.TransTpl
音频信息
Container
TransConfig
Response.TemplateList.TransTpl
转码配置
Container
TransTpl 节点 Container 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
必选
Format
Request.Container
容器格式：mp4，flv，hls，ts
String
是
TransTpl 节点 Video 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
默认值
限制
Codec
Response.TemplateList.
TransTpl.Video
编解码格式
String
否
H.264，当format为WebM时，为VP8
1. H.264
2. H.265
3. VP8
Width
Response.TemplateList.
TransTpl.Video
宽
String
否
视频原始宽度
1. 值范围：[128, 4096]
2. 单位：px
3. 若只设置Width时, 按照视频原始比例计算Height
4. 必须为偶数
Height
Response.TemplateList.
TransTpl.Video
高
String
否
视频原始高度
1. 值范围：[128, 4096]
2. 单位：px
3. 若只设置Height时, 按照视频原始比例计算Width
4. 必须为偶数
Fps
Response.TemplateList.
TransTpl.Video
帧率
String
否
无
1. 值范围：(0, 60]
2. 单位：fps
Remove
Response.TemplateList.
TransTpl.Video
是否删除视频流
String
否
false
true、false
Profile
Response.TemplateList.
TransTpl.Video
编码级别
String
否
high
1. 支持baseline、main、high
2. baseline：适合移动设备；
3. main：适合标准分辨率设备；
4. high：适合高分辨率设备;
5. 仅H.264支持此参数。
6. Codec为VP8不支持此参数
Bitrate
Response.TemplateList.
TransTpl.Video
视频输出文件的码率
String
否
无
1. 值范围：[10, 50000]
2. 单位：Kbps
Crf
Response.TemplateList.
TransTpl.Video
码率-质量控制因子
String
否
无
1. 值范围：(0, 51]
2. 如果设置了Crf, 则Bitrate的设置失效
3. 当Bitrate为空时,默认为25
Gop
Response.TemplateList.
TransTpl.Video
关键帧间最大帧数
String
否
无
1. 值范围：[0, 100000]
2. Codec为VP8不支持此参数
Preset
Response.TemplateList.
TransTpl.Video
视频算法器预置
String
否
medium
1. 仅H.264支持该参数
2. 取值veryfast、fast、medium、slow、slower
3. Codec为VP8不支持此参数
Bufsize
Response.TemplateList.
TransTpl.Video
缓冲区大小
String
否
无
1. 值范围：[1000, 128000]
2. 单位：Kb
3. Codec为VP8不支持此参数
Maxrate
Response.TemplateList.
TransTpl.Video
视频码率峰值
String
否
无
1. 值范围：[10, 50000]
2. 单位：Kbps
3. Codec为VP8不支持此参数
HlsTsTime
Response.TemplateList.
TransTpl.Video
hls分片时间
String
否
5
1. (0 视频时长]
2. 单位为秒
3. Codec为VP8不支持此参数
Pixfmt
Response.TemplateList.
TransTpl.Video
视频颜色格式
String
否
无
1. H.264支持:yuv420p、yuv422p、yuv444p、yuvj420p、yuvj422p、yuvj444p
2. H.265支持:yuv420p
3. Codec为VP8不支持此参数
LongShortMode
Response.TemplateList.
TransTpl.Video
长短边自适应
String
否
false
1. true、false
2. Codec为VP8不支持此参数
TransTpl 节点 TimeInterval 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
必选
默认值
限制
Start
Response.TemplateList.
TransTpl.TimeInterval
开始时间
String
否
0
[0 视频时长]
单位为秒
支持 float 格式，执行精度精确到毫秒
Duration
Response.TemplateList.
TransTpl.TimeInterval
持续时间
String
否
视频时长
[0 视频时长]
单位为秒
支持 float 格式，执行精度精确到毫秒
TransTpl 节点 Audio 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
默认值
限制
Codec
Response.TemplateList.
TransTpl.Audio
编解码格式
String
否
aac，当format为WebM时，为Vorbis
取值 aac、mp3、flac、amr、Vorbis
Samplerate
Response.TemplateList.
TransTpl.Audio
采样率
String
否
44100,当Codec为opus时，默认值为48000
单位：Hz
可选 8000、11025、12000、16000、22050、24000、32000、44100、48000、88200、96000
不同的封装，mp3 支持不同的采样率，如下表所示
当Codec设置为amr时，只支持8000
当Codec设置为opus时，仅支持8000，16000，24000，48000
Bitrate
Response.TemplateList.
TransTpl.Audio
原始音频码率
String
否
无
单位：Kbps
值范围：[8，1000]
Channels
Response.TemplateList.
TransTpl.Audio
声道数
String
否
无
当Codec设置为aac/flac，支持1、2、4、5、6、8
当Codec设置为mp3/Vorbis/opus时，支持1、2
当Codec设置为amr，只支持1
Remove
Response.TemplateList.
TransTpl.Audio
是否删除音频流
String
否
false
取值 true、false。当Video.Codec为H.265时，此参数无效。
KeepTwoTracks
Response.TemplateList.
TransTpl.Audio
保持双音轨
String
否
false
取值 true、false。 当Video.Codec为H.265时，此参数无效。
SwitchTrack
Response.TemplateList.
TransTpl.Audio
转换轨道
String
否
false
取值 true、false。 当Video.Codec为H.265时，此参数无效。
SampleFormat
Response.TemplateList.
TransTpl.Audio
采样位宽
String
否
无
当 Codec 设置为 aac，支持 fltp
当 Codec 设置为 mp3，支持 fltp、s16p、s32p
当 Codec 设置为 flac，支持 s16、s32
当 Codec 设置为 amr，支持 s16
当 Video.Codec 为 H.265 时，此参数无效。
TransTpl 节点 TransConfig 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
必选
默认值
限制
AdjDarMethod
Response.TemplateList.
TransTpl.TransConfig
分辨率调整方式
String
否
none
取值 scale、crop、pad、none。
当输出视频的宽高比与原视频不等时，根据此参数做分辨率的相应调整
IsCheckReso
Response.TemplateList.
TransTpl.TransConfig
是否检查分辨率
String
否
false
true、false
当为 false 时，按照配置参数转码
ResoAdjMethod
Response.TemplateList.
TransTpl.TransConfig
分辨率调整方式
String
否
0
取值0、1；0 表示使用原视频分辨率；1表示返回转码失败
当 IsCheckReso 为 true 时生效
IsCheckVideoBitrate
Response.TemplateList.
TransTpl.TransConfig
是否检查视频码率
String
否
false
true、false
当为 false 时，按照配置参数转码
VideoBitrateAdjMethod
Response.TemplateList.
TransTpl.TransConfig
视频码率调整方式
String
否
0
取值0、1；0 表示使用原视频码率；1表示返回转码失败
当 IsCheckVideoBitrate 为 true 时生效
IsCheckAudioBitrate
Response.TemplateList.
TransTpl.TransConfig
是否检查音频码率
String
否
false
true、false
当为 false 时，按照配置参数转码
AudioBitrateAdjMethod
Response.TemplateList.
TransTpl.TransConfig
音频码率调整方式
String
否
0
取值0、1；0 表示使用原音频码率；1表示返回转码失败
当 IsCheckAudioBitrate 为 true 时生效
DeleteMetadata
Response.TemplateList.
TransTpl.TransConfig
是否删除文件中的MetaData信息
String
否
false
true、false
当为false时, 保留源文件信息
当Video.Codec为H.265时，此参数无效。
IsHdr2Sdr
Response.TemplateList.
TransTpl.TransConfig
是否开启HDR转SDR
String
否
false
true/false
HlsEncrypt
Response.TemplateList.
TransTpl.TransConfig
hls加密配置
Container
否
无
无
AdjDarMethod 参数图示：



Container 类型 HlsEncrypt 的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
必选
默认值
限制
IsHlsEncrypt
Response.TemplateList.
TransTpl.TransConfig.HlsEncrypt
是否开启HLS加密
String
否
false
1. true/false
2. 当 Video.Codec 为 H264 或 H265 并且 Container.Format 为 hls 时支持加密
UriKey
Response.TemplateList.
TransTpl.TransConfig.HlsEncrypt
HLS加密的key
String
否
无
当 IsHlsEncrypt 为 true 时，该参数才有意义

错误码

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

实际案例

案例一：按照模板 ID 维度查询

请求

GET /template?ids=A,B,C 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=28e9a4986df11bed0255e97ff90500557e0e****
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
Content-Length: 0
Content-Type: application/xml

响应

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: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
    <TemplateList>
        <TemplateId>A</TemplateId>
        <Name>TemplateName</Name>
        <Tag>Transcode</Tag>
        <TransTpl>
            <Container>
                <Format>mp4</Format>
            </Container>
            <Video>
                <Codec>H.264</Codec>
                <Profile>high</Profile>
                <Bitrate>1000</Bitrate>
                <Crf></Crf>
                <Width>1280</Width>
                <Height></Height>
                <Fps>30</Fps>
                <Gop></Gop>
                <Preset>medium</Preset>
                <ScanMode></ScanMode>
                <Bufsize>0</Bufsize>
                <Maxrate>0</Maxrate>

            </Video>
            <Audio>
                <Codec>aac</Codec>
                <Samplerate>44100</Samplerate>
                <Bitrate>128</Bitrate>
                <Channels>4</Channels>
            </Audio>
            <TransConfig>
                <AdjDarMethod>scale</AdjDarMethod>
                <IsCheckReso>false</IsCheckReso>
                <ResoAdjMethod>1</ResoAdjMethod>
            </TransConfig>
            <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>
    </TemplateList>
    <NonExistTIDs>
        <TemplateId>B</TemplateId>
        <TemplateId>C</TemplateId>
    </NonExistTIDs>
</Response>
案例二：按照分页列表维度查询

请求

GET /template?pageSize=10&pageNumber=1 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=28e9a4986df11bed0255e97ff90500557e0e****
Host: examplebucket-1250000000.ci.ap-beijing.myqcloud.com
Content-Length: 0
Content-Type: application/xml

响应

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: NTk0MjdmODlfMjQ4OGY3XzYzYzhf****

<Response>
    <RequestId>NTk0MjdmODlfMjQ4OGY3XzYzYzhf****</RequestId>
    <TotalCount>1</TotalCount>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TemplateList>
        <TemplateId>A</TemplateId>
        <Name>TemplateName</Name>
        <Tag>Transcode</Tag>
        <TransTpl>
            <Container>
                <Format>mp4</Format>
            </Container>
            <Video>
                <Codec>H.264</Codec>
                <Profile>high</Profile>
                <Bitrate>1000</Bitrate>
                <Crf></Crf>
                <Width>1280</Width>
                <Height></Height>
                <Fps>30</Fps>
                <Gop></Gop>
                <Preset>medium</Preset>
                <ScanMode></ScanMode>
                <Bufsize>0</Bufsize>
                <Maxrate>0</Maxrate>
            </Video>
            <Audio>
                <Codec>aac</Codec>
                <Samplerate>44100</Samplerate>
                <Bitrate>128</Bitrate>
                <Channels>4</Channels>
            </Audio>
            <TransConfig>
                <AdjDarMethod>scale</AdjDarMethod>
                <IsCheckReso>false</IsCheckReso>
                <ResoAdjMethod>1</ResoAdjMethod>
            </TransConfig>
            <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>
    </TemplateList>
</Response>

中国站