创建模板

最近更新时间:2024-04-03 16:01:44

我的收藏

功能描述

创建画质增强模板。


授权说明

授权策略中 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>VideoEnhance</Tag>
<Name>TemplateName</Name>
<VideoEnhance>
<Transcode>
<Container>
<Format>mp4</Format>
</Container>
<Video>
<Codec>H.264</Codec>
<Width>1280</Width>
<Fps>30</Fps>
</Video>
<Audio>
<Codec>aac</Codec>
<Samplerate>44100</Samplerate>
<Bitrate>128</Bitrate>
<Channels>4</Channels>
</Audio>
</Transcode>
<SuperResolution>
<Resolution>sdtohd</Resolution>
<EnableScaleUp>true</EnableScaleUp>
<Version>Enhance</Version>
</SuperResolution>
<ColorEnhance>
<Contrast>50</Contrast>
<Correction>100</Correction>
<Saturation>100</Saturation>
</ColorEnhance>
<MsSharpen>
<SharpenLevel>5</SharpenLevel>
</MsSharpen>
<SDRtoHDR>
<HdrMode>HDR10</HdrMode>
</SDRtoHDR>
<FrameEnhance>
<FrameDoubling>true</FrameDoubling>
</FrameEnhance>
</VideoEnhance>
</Request>
具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
Request
保存请求的容器
Container
Container 类型
Request
的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
默认值
是否必选
Tag
Request
模板类型: VideoEnhance
String
Name
Request
模板名称:仅支持中文、英文、数字、_、-和*,长度不超过 64
String
VideoEnhance
Request
画质增强参数
Container
Container 类型
VideoEnhance
的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
默认值
是否必选
Transcode
Request.VideoEnhance
转码参数
Container
SuperResolution
Request.VideoEnhance
超分辨率参数
Container
SDRtoHDR
Request.VideoEnhance
SDR to HDR 参数
Container
ColorEnhance
Request.VideoEnhance
色彩增强参数
Container
MsSharpen
Request.VideoEnhance
细节增强参数
Container
FrameEnhance
Request.FrameEnhance
帧率增强参数
Container
说明
SuperResolution、 SDRtoHDR、 ColorEnhance、 MsSharpen、FrameEnhance 不能同时为空。
Container 类型
Transcode
的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
默认值
是否必选
Container
Request.VideoEnhance.Transcode
容器格式
Container
Video
Request.VideoEnhance.Transcode
视频信息
Container
Audio
Request.VideoEnhance.Transcode
音频信息,不传 Audio,相当于删除音频信息
Container
Container 类型
Container
的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
是否必选
Format
Request.Container
封装格式: mp4/webm
String
Container 类型
Video
的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
默认值
是否必选
Codec
Request.VideoEnhance.Transcode.Video
编解码格式
H.264
H.265
VP8
VP9
String
H.264,当 Format 为 WebM 时,为 VP8
Width
Request.VideoEnhance.Transcode.Video
值范围:[128, 4096]
单位:px
若只设置 Width 时,按照视频原始比例计算 Height
必须为偶数
String
当 Request.VideoEnhance.SuperResolution 参数为空时,默认值为视频原始宽度
当 Request.VideoEnhance.SuperResolution 参数不为空时,默认值为视频原始宽度两倍
Height
Request.VideoEnhance.Transcode.Video
值范围:[128, 4096]
单位:px
若只设置 Height 时,按照视频原始比例计算 Width
必须为偶数
String
当Request.VideoEnhance.SuperResolution 参数为空时,默认值为视频原始高度
当Request.VideoEnhance.SuperResolution 参数不为空时,默认值为视频原始高度两倍
Fps
Request.VideoEnhance.Transcode.Video
帧率
值范围:(0, 60]
单位:fps
String
Container 类型
Audio
的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
默认值
是否必选
Codec
Request.VideoEnhance.Transcode.Audio
编解码格式,取值 aac、mp3、Vorbis、opus
String
aac,当 format 为 WebM 时,为 Vorbis
Samplerate
Request.VideoEnhance.Transcode.Audio
采样率
单位:Hz
可选 8000、11025、12000、16000、22050、24000、32000、44100、48000、88200、96000
不同的封装,mp3 支持不同的采样率,如下表所示
当 Codec 设置为 amr 时,只支持8000
当 Codec 设置为 opus 时,仅支持8000,16000,24000,48000
String
44100,当 Codec 为 opus 时,默认值为48000
Bitrate
Request.VideoEnhance.Transcode.Audio
原始音频码率
单位:Kbps
值范围:[8,1000]
String
Channels
Request.VideoEnhance.Transcode.Audio
声道数
String
设定 container,音频视频支持的格式如下表所示:
Container
Audio Codecs
Video Codecs
mp4
aac、mp3
H.264、H.265
WebM
Vorbis、opus
VP8、VP9
Container 类型
ColorEnhance
的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
默认值
是否必选
Contrast
Request.VideoEnhance.ColorEnhance
对比度
值范围:[0, 100]
auto(表示自动分析)
String
Correction
Request.VideoEnhance.ColorEnhance
色彩校正
值范围:[0, 1000]
auto(表示自动分析)
String
Saturation
Request.VideoEnhance.ColorEnhance
饱和度
值范围:[0, 300]
auto(表示自动分析)
String
Container 类型
MsSharpen
的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
默认值
是否必选
SharpenLevel
Request.VideoEnhance.MsSharpen
增强等级
值范围:[0, 10]
auto(表示自动分析)
String
Container 类型
SuperResolution
的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
默认值
是否必选
Resolution
Request.VideoEnhance.SuperResolution
分辨率选项
sdtohd:标清到超清
hdto4k:高清到4K
String
EnableScaleUp
Request.VideoEnhance.SuperResolution
自动缩放开关,取值 true、false
String
false
Version
Request.VideoEnhance.SuperResolution
版本
Base:基础版
Enhance:增强版
String
Base
Container 类型
SDRtoHDR
的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
默认值
是否必选
HdrMode
Request.VideoEnhance.SDRtoHDR
HDR 标准
HLG
HDR10
String
HLG
HDR10
Container 类型
FrameEnhance
的具体数据描述如下:
节点名称(关键字)
父节点
描述
类型
默认值
是否必选
FrameDoubling
Request.VideoEnhance.FrameEnhance
是否开启插帧,取值 true、false
String
false

响应

响应头

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

响应体

该响应体返回为 application/xml 数据, 包含完整节点数据的内容展示如下:
<Response>
<RequestId>NjJmMWQxYjNfOTBmYTUwNjRfNWYyY18x</RequestId>
<Template>
<Tag>VideoEnhance</Tag>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Name>TemplateName</Name>
<BucketId>test-1234567890</BucketId>
<Category>Custom</Category>
<VideoEnhance>
<transcode>
<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>
</Audio>
</Transcode>
<SuperResolution>
<Resolution>sdtohd</Resolution>
<EnableScaleUp>true</EnableScaleUp>
<Version>Enhance</Version>
</SuperResolution>
<ColorEnhance>
<Contrast>50</Contrast>
<Correction>100</Correction>
<Saturation>100</Saturation>
</ColorEnhance>
<MsSharpen>
<SharpenLevel>5</SharpenLevel>
</MsSharpen>
<SDRtoHDR>
<HdrMode>HDR10</HdrMode>
</SDRtoHDR>
<FrameEnhance>
<FrameDoubling>true</FrameDoubling>
</FrameEnhance>
</VideoEnhance>
<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
模板类型,SuperResolution
String
UpdateTime
Response.Template
更新时间
String
CreateTime
Response.Template
创建时间
String
VideoEnhance
Response.Template
详细的模板参数
Container
Container 节点 VideoEnhance 的内容:
节点名称(关键字)
父节点
描述
类型
Transcode
Response.Template.VideoEnhance
同请求体中的 Request.Transcode
Container
SuperResolution
Response.Template.VideoEnhance
同请求体中的 Request.SuperResolution
Container
SDRtoHDR
Response.Template.VideoEnhance
同请求体中的 Request.SDRtoHDR
Container
ColorEnhance
Response.Template.VideoEnhance
同请求体中的 Request.ColorEnhance
Container
MsSharpen
Response.Template.VideoEnhance
同请求体中的 Request.MsSharpen
Container
FrameEnhance
Response.Template.VideoEnhance
同请求体中的 Request.FrameEnhance
Container

错误码

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

实际案例

请求

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=28e9a4986df11bed0255e97ff90500557e0e****
Host: test-1234567890.ci.ap-chongqing.myqcloud.com
Content-Length: 1666
Content-Type: application/xml

<Request>
<Tag>VideoEnhance</Tag>
<Name>TemplateName</Name>
<VideoEnhance>
<Transcode>
<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>
</Audio>
</Transcode>
<SuperResolution>
<Resolution>sdtohd</Resolution>
<EnableScaleUp>true</EnableScaleUp>
<Version>Enhance</Version>
</SuperResolution>
<ColorEnhance>
<Contrast>50</Contrast>
<Correction>100</Correction>
<Saturation>100</Saturation>
</ColorEnhance>
<MsSharpen>
<SharpenLevel>5</SharpenLevel>
</MsSharpen>
<SDRtoHDR>
<HdrMode>HDR10</HdrMode>
</SDRtoHDR>
<FrameEnhance>
<FrameDoubling>true</FrameDoubling>
</FrameEnhance>
</VideoEnhance>
</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: NjJmMWQxYjNfOTBmYTUwNjRfNWYyY18x

<Response>
<RequestId>NjJmMWQxYjNfOTBmYTUwNjRfNWYyY18x</RequestId>
<Template>
<Tag>VideoEnhance</Tag>
<TemplateId>t1460606b9752148c4ab182f55163ba7cd</TemplateId>
<Name>TemplateName</Name>
<BucketId>test-1234567890</BucketId>
<Category>Custom</Category>
<VideoEnhance>
<transcode>
<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>
</Audio>
</Transcode>
<SuperResolution>
<Resolution>sdtohd</Resolution>
<EnableScaleUp>true</EnableScaleUp>
<Version>Enhance</Version>
</SuperResolution>
<ColorEnhance>
<Contrast>50</Contrast>
<Correction>100</Correction>
<Saturation>100</Saturation>
</ColorEnhance>
<MsSharpen>
<SharpenLevel>5</SharpenLevel>
</MsSharpen>
<SDRtoHDR>
<HdrMode>HDR10</HdrMode>
</SDRtoHDR>
<FrameEnhance>
<FrameDoubling>true</FrameDoubling>
</FrameEnhance>
</VideoEnhance>
<CreateTime>2020-08-05T11:35:24+0800</CreateTime>
<UpdateTime>2020-08-31T16:15:20+0800</UpdateTime>
</Template>
</Response>