新建转码模板组 - CreateTemplateGroup
功能介绍
新建转码模板组,最多支持一进六出。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
mpc:templateGroup:create
Write
-
-
-
-
URI
POST /v1/{project_id}/template_group/transcodings
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID。获取方法请参考获取项目ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
| Authorization | 否 | String | 使用AK/SK方式认证时必选,携带的鉴权信息。 |
| X-Project_Id | 否 | String | 使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。 |
| X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选,请求的发生时间。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 模板组名称 |
| videos | 否 | Array of VideoObj objects | 视频信息列表 |
| audio | 否 | Audio object | 音频信息 |
| video_common | 否 | VideoCommon object | 视频通用信息 |
| common | 否 | Common object | 通用信息 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| width | 是 | Integer | 视频宽度(单位:像素) |
| height | 是 | Integer | 视频高度(单位:像素) |
| bitrate | 是 | Integer | 输出平均码率。 参考取值范围:0或[40,30000]之间的整数。 单位:kbit/s 若设置为0,则输出平均码率为自适应值。 |
| stream_name | 否 | String | 流名称 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| PVC | 否 | Boolean | 是否开启高清低码功能。 取值如下: (数字0表示关闭,其余正整数,负数都表示true) |
| hls_interval | 否 | Integer | HLS分片间隔,仅封装格式“pack_type”取值为1或3时,该参数生效。 取值范围:[2,10]。 单位:秒。 |
| dash_interval | 否 | Integer | DASH间隔,仅封装格式“pack_type”取值为2或3时,该参数生效。 取值范围:[2,10]。 单位:秒。 |
| pack_type | 是 | Integer | 封装格式。 取值如下: 说明: pack_type设置为5和6时不能设置视频参数,设置为9时不支持多音频,设置为10时不支持H265编码。 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| template_group | TemplateGroup object | 模板组信息。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| group_id | String | 模板组id |
| name | String | 模板组名称 |
| template_ids | Array of integers | 模板组模板ID |
| videos | Array of VideoAndTemplate objects | 视频信息列表 |
| audio | Audio object | 音频信息 |
| video_common | VideoCommon object | 视频通用信息 |
| common | Common object | 通用信息 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| template_id | Integer | 模板ID |
| width | Integer | 视频宽度(单位:像素) |
| height | Integer | 视频高度(单位:像素) |
| bitrate | Integer | 输出平均码率。 取值范围:0或[40,30000]之间的整数。 单位:kbit/s 若设置为0,则输出平均码率为自适应值。 |
| stream_name | String | 流名称 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| PVC | Boolean | 是否开启高清低码功能。 取值如下: (数字0表示关闭,其余正整数,负数都表示true) |
| hls_interval | Integer | HLS分片间隔,仅封装格式“pack_type”取值为1或3时,该参数生效。 取值范围:[2,10]。 单位:秒。 |
| dash_interval | Integer | DASH间隔,仅封装格式“pack_type”取值为2或3时,该参数生效。 取值范围:[2,10]。 单位:秒。 |
| pack_type | Integer | 封装格式。 取值如下: 说明: pack_type设置为5和6时不能设置视频参数,设置为9时不支持多音频,设置为10时不支持H265编码。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
新建转码模板组,最多支持一进六出。
POST https://{endpoint}/v1/{project_id}/template_group/transcodings
{
"name" : "my_templateGroup",
"videos" : [ {
"width" : "480",
"height" : "270",
"bitrate" : "200"
} ],
"audio" : {
"codec" : 1,
"sample_rate" : 1,
"channels" : 2,
"bitrate" : 0
},
"video_common" : {
"codec" : 1,
"black_cut" : 0,
"profile" : 3,
"level" : 15,
"preset" : 3,
"max_iframes_interval" : 5,
"bframes_count" : 4,
"frame_rate" : 0
},
"common" : {
"PVC" : false,
"pack_type" : 1,
"hls_interval" : 5,
"dash_interval" : 5
}
} 响应示例
状态码:201
新建转码模板组成功。
{
"template_group" : {
"group_id" : "f7fc420b17db414fb11652671581bb6d",
"name" : "my_templateGroup",
"template_ids" : [ 286548 ],
"videos" : [ {
"template_id" : 286548,
"width" : 480,
"height" : 270,
"bitrate" : 200
} ],
"audio" : {
"output_policy" : "transcode",
"codec" : 1,
"bitrate" : 0,
"sample_rate" : 1,
"channels" : 2
},
"video_common" : {
"output_policy" : "transcode",
"codec" : 1,
"profile" : 3,
"level" : 15,
"preset" : 1,
"max_iframes_interval" : 5,
"bframes_count" : 4,
"frame_rate" : 0,
"black_cut" : 0
},
"common" : {
"PVC" : false,
"hls_interval" : 5,
"dash_interval" : 5,
"pack_type" : 1
}
}
} 状态码:400
新建转码模板组失败。
{
"error_code" : "MPC.10202",
"error_msg" : "Invalid request parameter."
} 状态码
| 状态码 | 描述 |
|---|---|
| 201 | 新建转码模板组成功。 |
| 400 | 新建转码模板组失败。 |
错误码
请参见错误码。