接口功能介绍
通过本接口可添加转码配置信息，创建新的转码模板。
接口约束
本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。
URI
POST /template/transcode/create
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 模板名称，必填，支持大小写字母数字以及汉字以及下划线及折线，长度最长为20个字符，并且同一个用户名称唯一。 | transcodeTemplate | |
| favorite | 否 | Boolean | 是否为选定模板，默认为否。 | true | |
| format | 是 | String | 转码目标文件格式，可选为 MP4/FLV/HLS。 | MP4 | |
| encrytion | 否 | Boolean | 表示是否加密目标视频，仅当 transcode.format == "HLS" 时有效。 | true | |
| video | 否 | Object | 视频的转码参数，video不传且audio有值表示新建音频转码模板，video和audio至少一个有值。 | -- | video |
| audio | 否 | Object | 音频的转码参数，不传时表示去除音频。 | -- | audio |
| remark | 否 | String | 转码模板备注 | 模板备注 |
表 video
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| codec | 是 | String | 视频编码，支持 H264 和 H265。如果目标文件格式为 FLV，这一项只能为 H264。 | H264 | |
| bitRate | 否 | String | 可选参数，但建议填写，视频的码率，默认为自动。请注意，该值需要自带单位，例如 512K。 | 512K | |
| frameRate | 否 | Integer | 视频的帧率，默认为 24。 | 24 | |
| height | 否 | Integer | 目标视频的高度，如果高度和宽度都不指定，则为原视频的高宽。如果指定了其中一个，另一个不指定，不指定的会按比例缩放。 | 1024 | |
| width | 否 | Integer | 目标视频的宽度，如果高度和宽度都不指定，则为原视频的高宽。如果指定了其中一个，另一个不指定，不指定的会按比例缩放。 | 768 | |
| autoRotate | 否 | Boolean | 表示当前模板支持自动旋转，即如当前模板的分辨率为 1024x768，但如果用户传入了 高 > 宽的情况，则该模板将自动适配为 768x1024 | true |
表 audio
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| codec | 是 | String | 音频的编码，可选为 AAC 和 MP3。 | AAC | |
| bitRate | 否 | String | 音频的码率，建议从以下值选择输入 64K/96K/128K/192K/256K/320K，不填入为自动 | 128k | |
| sampleRate | 是 | Integer | 音频的频率，可选为 44100/48000，默认为 44100 | 44100 |
响应参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| code | 是 | Integer | 本次请求的结果码。 | 0 | |
| message | 是 | String | 错误文本信息，创建成功时，为空字符串。 | "" | |
| data | 是 | Object | 返回数据。 | data |
表 data
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| templateId | 是 | Long | 模板id。 | 100000000003 |
请求示例
请求体body
{
"name": "",
"favorite": "true",
"format": "MP4",
"encrytion": "true",
"remark": "模板备注",
"video": {
"codec": "H264",
"bitRate": "512K",
"frameRate": 24,
"height": 1024,
"width": 768,
"autoRotate": "true"
},
"audio": {
"codec": "AAC",
"bitRate": "128k",
"sampleRate": 44100
}
}
响应示例
{
"code": 0,
"message": "",
"data" : {
"templateId" : "100000000003"
}
}
状态码
| Http 状态码 | 状态码信息 | 状态码描述 |
|---|---|---|
| 0 | 表示业务成功 | 表示业务成功 |
| 400 | 请求参数有误 | 请求参数有误 |
| 403 | 用户鉴权失败，用户无操作权限 | 用户鉴权失败，用户无操作权限 |
| 404 | 请求的资源不存在，输入错误的URL | 请求的资源不存在，输入错误的URL |
| 500 | 业务执行异常 | 业务执行异常 |
错误码
OpenAPI错误码请参考 错误码说明。
