创建转码模板
请求参数
字段 | 类型 | 是否必填 | 示例 | 描述 |
Action | String | 是 | CreateTranscodeTemplate | 公共参数，本接口取值：CreateTranscodeTemplate |
TranscodeTemplate | TranscodeTemplate | 是 | 通用转码模板参数配置。 | |
SpaceName | String | 否 | other_space1 | 应用空间 默认为：default_space |
TranscodeTemplate
字段 | 类型 | 是否必填（创建） | 示例 | 描述 |
TemplateId | String | 否 | xxx | 模板ID |
Name | String | 否 | transcode_template | 转码模板名称，长度限制：64 个字符。只可设置字母、数字、中划线、下划线。 |
Description | String | 否 | test xxx | 模板描述信息，长度限制：256 个字符。 |
Container | String | 否 | mp4 | 封装格式，可选值：
默认mp4 |
RemoveAudio | String | 否 | true | 是否去除音频数据，可选值：
默认值：false，保留音频。 |
VideoTemplate | VideoTemplate | 是 | 视频流配置参数，当保留视频时，该字段必填。 | |
AudioTemplate | AudioTemplate | 否 | 音频流配置参数，当保留音频时，该字段必填。 | |
WatermarkTemplateIds | Array of String | 否 | 水印模板Id数组。 |
VideoTemplate
字段 | 类型 | 是否必填（创建） | 示例 | 描述 |
Codec | String | 否 | libx265 | 视频流的编码格式，可选值：
默认libx264 |
Fps | Integer | 是 | 30 | 视频帧率，取值范围：[0, 240]，单位：Hz。 |
MaxBitrate | Integer | 是 | 视频流的最大码率，取值范围：[10, 60000]，单位：Kbps。 | |
LongShortMode | String | 否 | true | 是否开启长短边模式。可选值：
默认值：true。 |
Width | Integer | 否 | 1080 | 视频流宽度（或长边）的最大值，取值范围：[0, 4096]，单位：px。
默认值：0。 |
Height | Integer | 否 | 1920 | 视频流高度，同上，不再赘述 |
Crf | Integer | 否 | 视频恒定码率控制因子，取值范围为[0, 58]。 如果指定该参数，将使用 CRF 的码率控制方式做转码（视频码率将不再生效）。 建议设置到[10,32]内 | |
Gop | Integer | 否 | 250 | 关键帧间最大帧数。
|
AudioTemplate
字段 | 类型 | 是否必填（创建） | 示例 | 描述 |
Codec | String | 否 | 音频流的编码格式。 可选值为：
默认值aac | |
Bitrate | Integer | 是 | 音频流的码率，取值范围：[16, 256]，单位：kbps。 | |
SampleRate | Integer | 是 | 音频流的采样率，可选值：
单位：Hz。 |
返回参数
参数名称 | 类型 | 描述 |
TranscodeTemplateId | String | 转码模板Id |
API示例
请求示例
curl -X POST 'https://vod.streamlakeapi.com/?Action=CreateTranscodeTemplate' \
-H 'Content-Type: application/json' \
-d '{"TranscodeTemplate": {"Name": "test", "Container": "mp4"}}'
-H <公共请求参数>
返回示例
HTTP/1.1 200 OK
Content-Type: application/json
{
"ResponseMeta": {
"RequestId":"CixgpmAFOYcAAAAAAAAAAw",
"ErrorCode":"",
"ErrorMessage":""
},
"ResponseData": {
"TranscodeTemplateId": "12rqdaFar2"
}
}
错误码
ErrorCode | ErrorMessage | 说明 | 状态码 |
InvalidArgument | failed to create template because of duplication | 已经存在重复的模板 | 400 |
InvalidArgument | invalid transcode template format, failed to parse json | 传入的格式不正确 | 400 |
InvalidArgument | %s invalid, should be between %s and %s | 取值范围不正确 | 400 |
InvalidArgument | %s invalid, length should below %s | 参数长度不符合要求 | 400 |
InvalidArgument | AudioTemplate shouldn't be empty if RemoveAudio is false | RemoveAudio为false时AudioTemplate为空 | 400 |
InvalidArgument | invalid width or height for transcode | 长和宽设置不合理 | 400 |
InvalidArgument | customer not exist | 客户不存在或者没有没有开通点播服务 | 400 |
InvalidArgument | failed to create template | 转码参数不合理，没有创建成功。具体原因请联系相关研发进行排查 | 400 |
InvalidArgument | VideoTemplate can't be empty | 视频模板不能为空 | 400 |
InvalidArgument | %s required arguments are missing | 必填参数为空 | 400 |
InvalidArgument | Invalid name format | 模板名称格式不正确 | 400 |