文档首页/ 视频点播 VOD/ API参考/ 历史API/ 转码模板组管理接口/ 创建自定义转码模板组
更新时间：2024-10-08 GMT+08:00
查看PDF
分享

创建自定义转码模板组

功能介绍

当前页面接口为历史版本API，未来可能停止维护，建议您使用新转码模板管理API。您也可以通过视频点播控制台使用转码功能，具体请参见转码设置。

创建自定义转码模板组。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1.0/{project_id}/asset/template_group/transcodings

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token，使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

模板组名称。

status

否

String

是否设置默认。

type

是

String

模板组类型。

auto_encrypt

否

Integer

是否自动加密。

取值如下：

  • 0：表示不加密。
  • 1：表示需要加密。

默认值：0。

加密与转码必须要一起进行，当需要加密时，转码参数不能为空，且转码输出格式必须要为HLS。

quality_info_list

否

Array of QualityInfo objects

画质配置信息列表。

common

否

Common object

模板信息。

watermark_template_ids

否

Array of strings

绑定的水印模板组ID数组。

description

否

String

模板介绍。
表4 QualityInfo

参数

是否必选

参数类型

描述

video

否

VideoTemplateInfo object

模板视频信息

audio

否

AudioTemplateInfo object

模板音频信息

format

是

String

格式。
表5 VideoTemplateInfo

参数

是否必选

参数类型

描述

quality

是

String

画质。

width

否

Integer

视频宽度。

height

否

Integer

视频高度。

bitrate

否

Integer

码率。

frame_rate

否

Integer

帧率（默认为1，1代表自适应，单位是帧每秒）。
表6 AudioTemplateInfo

参数

是否必选

参数类型

描述

sample_rate

是

Integer

音频采样率（有效值范围）

  • 1：AUDIO_SAMPLE_AUTO
  • 2：AUDIO_SAMPLE_22050
  • 3：AUDIO_SAMPLE_32000
  • 4：AUDIO_SAMPLE_44100
  • 5：AUDIO_SAMPLE_48000
  • 6：AUDIO_SAMPLE_96000

默认值为1。

bitrate

否

Integer

音频码率（单位：Kbps）。

channels

是

Integer

声道数（有效值范围）

  • 1：AUDIO_CHANNELS_1
  • 2：AUDIO_CHANNELS_2
表7 Common

参数

是否必选

参数类型

描述

pvc

是

String

pvc开关。

pvc_version

否

String

pvc版本。

video_codec

否

String

视频编码格式。

audio_codec

否

String

音频编码格式（有效值范围）

  • 1：AUDIO_CODECTYPE_AAC
  • 2：AUDIO_CODECTYPE_HEAAC1
  • 3：AUDIO_CODECTYPE_HEAAC2
  • 4：AUDIO_CODECTYPE_MP3

默认值为1。

hls_interval

否

Integer

分片时长（默认为5秒）。

响应参数

状态码： 204

表8 响应Body参数

参数

参数类型

描述

group_id

String

模板组ID

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

POST https://{endpoint}/v1.0/{project_id}/asset/template_group/transcodings

{
  "name" : "template_group_test",
  "type" : "custom_template_group",
  "auto_encrypt" : 0,
  "quality_info_list" : [ {
    "video" : {
      "width" : 1280,
      "height" : 720,
      "bitrate" : 1000,
      "quality" : "HD",
      "frame_rate" : 1
    },
    "audio" : {
      "sample_rate" : 1,
      "channels" : 2,
      "bitrate" : 0
    },
    "format" : "HLS"
  } ],
  "status" : "0",
  "watermark_template_ids" : [ ],
  "common" : {
    "pvc" : "0",
    "video_codec" : "H264",
    "audio_codec" : "AAC",
    "hls_interval" : 5
  }
}

响应示例

状态码： 204

处理成功返回。

{
  "group_id" : "f9b045e0811c482f9de0d436a5927bb6"
}

状态码： 400

处理失败返回。

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

状态码

状态码

描述

204

处理成功返回。

400

处理失败返回。

错误码

请参见错误码。

相关文档