创建自定义转码模板
功能介绍
创建自定义转码模板。
URI
POST /v2/{project_id}/asset/template/transcodings
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token,使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
name |
是 |
String |
模板组名称 |
is_default |
否 |
Boolean |
是否设置成默认转码模板,默认false不设置为默认 |
is_auto_encrypt |
否 |
Boolean |
配置是否加密输出音视频,默认false不加密。 当前只支持加密输出HLS格式的音视频流,不会对原始上传的音视频进行加密处理。非HLS转码输出的音视频格式,此字段不可配置。开启此配置前,请参考《VOD用户指南》的“HLS加密设置”章节获取密钥URL。 |
quality_info_list |
是 |
Array of QualityInfoList objects |
画质配置信息列表 |
common |
是 |
CommonInfo object |
高清低码开关,编码格式多路共同参数 |
watermark_template_ids |
否 |
Array of strings |
绑定的水印模板组ID数组 |
description |
否 |
String |
模板介绍 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
video |
否 |
VideoInfo object |
模板视频信息。video和audio至少配置一个参数。 |
audio |
否 |
AudioInfo object |
模板音频信息 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
quality |
是 |
String |
画质
|
width |
否 |
Integer |
视频宽度 H264编码:0或[32,4096]之间2的整数倍 H265编码:0或[160,4096]之间2的整数倍 |
height |
否 |
Integer |
视频高度 H264编码:0或[32,2880]之间2的整数倍 H265编码:0或[160,2880]之间2的整数倍 |
bitrate |
是 |
Integer |
平均码率,单位:kbit/s。 参考取值范围:0或[40,30000]之间的整数。 |
frame_rate |
是 |
Integer |
帧率,单位是帧每秒。 取值范围:[0-75]之间的整数,小于5帧或大于60帧代表自适应。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
sample_rate |
是 |
String |
音频采样率(有效值范围)
|
bitrate |
否 |
Integer |
音频码率(单位:Kbps) |
channels |
是 |
String |
声道数(有效值范围)
|
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
pvc |
否 |
Boolean |
高清低码开关 |
video_codec |
否 |
String |
视频编码格式
|
audio_codec |
否 |
String |
音频编码格式
|
is_black_cut |
否 |
Boolean |
黑边剪裁类型,默认false不开启黑边剪裁 |
format |
是 |
String |
转码格式
|
hls_interval |
否 |
Integer |
分片时长,范围2-10(默认为5秒) |
upsample |
否 |
Boolean |
上采样开关,开启后可以提升视频的分辨率,增加采样点的数量,默认值:false,表示不开启上采样。 |
adaptation |
否 |
String |
转码后的片源分辨率自适应方式。 取值如下:
说明:
|
preset |
否 |
Integer |
编码质量等级,取值[0,2] 0表示默认方式,1表示转码效率优先,2表示转码质量优先。 |
max_iframes_interval |
否 |
Integer |
I帧最大间隔,取值范围:[2,10]。默认值:5,单位秒。 |
hls_audio_separate |
否 |
Boolean |
转码后音频是否独立存储。 |
hls_segment_type |
否 |
String |
HLS分片的封装格式,目前支持TS和FMP4,默认TS格式 |
响应参数
状态码: 201
参数 |
参数类型 |
描述 |
---|---|---|
group_id |
String |
模板组ID |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
请求示例
创建转码模板
POST https://{endpoint}/v2/{project_id}/asset/template/transcodings Content-Type: application/json { "name": "trans_template_test", "is_default": true, "is_auto_encrypt": false, "quality_info_list": [ { "video": { "width": 1280, "height": 720, "bitrate": 1000, "quality": "HD", "frame_rate": 0 }, "audio": { "sample_rate": "AUDIO_SAMPLE_AUTO", "channels": "AUDIO_CHANNELS_1", "bitrate": 0 } } ], "watermark_template_ids": [], "common": { "pvc": false, "video_codec": "H264", "audio_codec": "AAC", "format": "HLS", "hls_interval": 5 } }
响应示例
状态码: 201
处理成功返回。
{ "group_id" : "f9b045e0811c482f9de0d436a5927bb6" }
状态码: 400
处理失败返回。
{ "error_code" : "VOD.10053", "error_msg" : "The request parameter is illegal, illegal field: {xx}." }
状态码
状态码 |
描述 |
---|---|
201 |
处理成功返回。 |
400 |
处理失败返回。 |
错误码
请参见错误码。