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

获取转码模板列表


请求参数

字段

类型

是否必填

示例

描述

Action

String

ListTranscodeTemplate

公共参数,拉取上传,取值:ListTranscodeTemplate

Offset

Integer

0

分页偏移量,默认值:0。不能小于0

Limit

Integer

20

分页返回条数,最大不超过50。不能小于0

默认值:20

SpaceName

String

other_space1

应用空间

默认为:default_space

返回参数

字段

类型

示例

描述

TranscodeTemplates

Array of TranscodeTemplate


对应的转码模板对象列表

Limit

Integer

10

返回的模板个数

Offset

Integer

0

下次分页起始坐标

Total

Integer

10

满足查询条件的模板总数


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。


API示例

请求示例

curl -X POST 'https://vod.streamlakeapi.com/?Action=ListTranscodeTemplate' \
-H 'Content-Type: application/json' \
-d '{"Offset": 0, "Limit": 10}' \
-H <公共参数>


返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
"ResponseMeta": {
"RequestId":"CixgpmAFOYcAAAAAAAAAAw",
"ErrorCode":"",
"ErrorMessage":""
},
"ResponseData": {
"Limit": 10,
"Offset": 0,
"Total": 10,
"TranscodeTemplates": [
{
"TemplateId": "xxx",
"Name": "xxx",
...
}, {
"TemplateId": "xxx",
"Name": "xxx",
...
}
]
}
}


错误码

ErrorCode

ErrorMessage

说明

状态码

InvalidArgument

Limit is over 50

limit超过限制

400

InvalidArgument

Limit is below 0

limit小于0

400

InvalidArgument

Offset is below 0

offset小于0

400

上一篇:查询任务流模板详情下一篇:获取截图模板列表
该篇文档内容是否对您有帮助?
有帮助没帮助