You need to enable JavaScript to run this app.
导航
查询转码配置列表
最近更新时间:2023.10.12 17:39:58首次发布时间:2022.04.19 20:40:35

查询指定域名空间下的全部应用以及与其相关联的转码配置。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询转码配置列表接口。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=ListVhostTransCodePreset&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringListVhostTransCodePreset接口名称。当前 API 的名称为 ListVhostTransCodePreset
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

参数类型是否必选示例值描述
VhostStringpush.example.com域名空间

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构

参数类型示例值描述
CommonPresetListArray of TranscodePresetVhostAPP-使用内置参数的转码配置列表
CustomizePresetListArray of TranscodePresetVhostAPP-使用自定义配置的转码配置列表
AllPresetListArray of AllPresetList-全部转码配置列表

TranscodePresetVhostAPP

参数类型示例值描述
AppStringlive应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成
TranscodePresetObject of TranscodePreset-转码配置具体信息
VhostStringpush.example.com域名空间

AllPresetList

参数类型示例值描述
AppStringlive应用名称
TranscodePresetObject of TranscodePreset-转码配置具体信息
VhostStringpush.example.com域名空间

TranscodePreset

参数类型示例值描述

Acodec

String

acc

音频编码格式。包括以下 3 种类型。

  • aac:使用 aac 编码格式;
  • copy:不进行转码,所有音频编码参数不生效;
  • opus:使用 opus 编码格式。

As

String

0

宽高自适应模式开关。

  • 0:关闭宽高自适应,按照 Width 和 Height 的取值进行拉伸;
  • 1:开启宽高自适应,按照 ShortSide 或 LongSide 等比缩放。
AudioBitrateInteger30音频码率,单位为 kbps。
BFramesInteger32 个参考帧之间的最大 B 帧数。BFrames 取 0 时,表示去 B 帧。
FPSInteger60帧率,单位为 fps。帧率越大,画面越流畅
GOPInteger0IDR 帧之间的最大间隔,单位为 s

Height

Integer

100

视频高度。

说明

当 As 的取值为 0 时,如果 Width 和 Height 任意取值为 0,表示保持源流尺寸。

LongSide

Integer

200

长边长度。

说明

当 As 的取值为 1 时,如果 LongSide 和 ShortSide 都取 0,表示保持源流尺寸。

PresetStringpreset1转码配置名称

Roi

Boolean

true

是否极智超清转码。

  • true:极智超清;
  • false:标准转码。

ShortSide

Integer

100

短边长度。

说明

当 As 的取值为 1 时,如果 LongSide 和 ShortSide 都取 0,表示保持源流尺寸。

SuffixNameStringhd转码流后缀名

Vcodec

String

h265

视频编码格式。

  • h264:使用 H.264 编码格式;
  • h265:使用 H.265 编码格式;
  • copy:不进行转码,所有视频编码参数不生效。
VideoBitrateInteger30视频码率,单位为 kbps

Width

Integer

200

视频宽度。

说明

当 As 的取值为 0 时,如果 Width 和 Height 任意取值为 0,表示保持源流尺寸。

示例

请求示例

POST https://live.volcengineapi.com?Action=ListVhostTransCodePreset&Version=2020-08-01
{
  "Vhost": "push.example.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestID": "2021072818053901022706413520787",
    "Action": "ListVhostTransCodePreset",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "CommonPresetList": [],
    "CustomizePresetList": []
  }
}

错误码

访问公共错误码获取详细信息。