logologo
售前咨询
点播云
文档中心服务端API媒体处理创建转码模板

创建转码模板


请求参数

字段

类型

是否必填

示例

描述

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
  • hls

默认mp4

RemoveAudio

String

true

是否去除音频数据,可选值:

  • true:去除
  • false:保留

默认值:false,保留音频。

VideoTemplate

VideoTemplate


视频流配置参数,当保留视频时,该字段必填。

AudioTemplate

AudioTemplate


音频流配置参数,当保留音频时,该字段必填。

WatermarkTemplateIds

Array of String


水印模板Id数组。

VideoTemplate

字段

类型

是否必填(创建)

示例

描述

Codec

String

libx265

视频流的编码格式,可选值:

  • libx264:H.264 编码
  • libx265:H.265 编码

默认libx264

Fps

Integer

30

视频帧率,取值范围:[0, 240],单位:Hz。

MaxBitrate

Integer


视频流的最大码率,取值范围:[10, 60000],单位:Kbps。

LongShortMode

String

true

是否开启长短边模式。可选值:

  • true:开启长短边模式,此时,Width 代表视频的长边,Height 表示视频的短边;
  • false:关闭长短边模式,此时,Width 代表视频的宽度,Height 表示视频的高度。

默认值:true。

Width

Integer

1080

视频流宽度(或长边)的最大值,取值范围:[0, 4096],单位:px。

  • 当 Width、Height 均为 0,则分辨率同源;
  • 当 Width 为 0,Height 非 0,则 Width 按比例缩放;
  • 当 Width 非 0,Height 为 0,则 Height 按比例缩放;
  • 当 Width、Height 均非 0,则将视频尺寸缩小到指定尺寸范围内,支持横竖屏自适应。

默认值:0。

Height

Integer

1920

视频流高度,同上,不再赘述

Crf

Integer


视频恒定码率控制因子,取值范围为[0, 58]。

如果指定该参数,将使用 CRF 的码率控制方式做转码(视频码率将不再生效)。

建议设置到[10,32]内

Gop

Integer

250

关键帧间最大帧数。

  • 默认值:10
  • 最大帧数时,无单位
  • 值范围:[1,100000]

AudioTemplate

字段

类型

是否必填(创建)

示例

描述

Codec

String


音频流的编码格式。

可选值为:

  • aac
  • mp3

默认值aac

Bitrate

Integer


音频流的码率,取值范围:[16, 256],单位:kbps。

SampleRate

Integer


音频流的采样率,可选值:

  • 32000,
  • 44100,
  • 48000

单位: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

上一篇:获取媒资信息下一篇:创建水印模板
该篇文档内容是否对您有帮助?
有帮助没帮助