You need to enable JavaScript to run this app.
导航
视频直播
  • 文档首页
    • /
  • 视频直播

查询内置转码档位的详细配置

最近更新时间：2023.10.12 17:39:59

首次发布时间：2022.06.17 18:05:39

我的收藏

调用该接口查询直播系统内置转码档位的详细配置。

说明

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

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
PresetListArray of String否["preser1","preset2"]模板名称列表，缺省情况下，表示查询所有系统内置转码档位

返回参数

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

参数类型示例值描述
NarrowBandHDPresetDetailArray of PresetDetail-极智超清模板信息
StandardPresetDetailArray of PresetDetail-标准模板信息

PresetDetail

参数类型示例值描述
SuffixNameStringhd转码流后缀名
VideoBitrateInteger1000000视频码率，单位为 kbps

Vcodec

String

h265

视频编码格式。

  • h264：使用 H.264 编码格式；
  • h265：使用 H.265 编码格式；
  • copy：不进行转码，所有视频编码参数不生效。
AudioBitrateInteger30音频码率，单位为 kbps

Acodec

String

acc

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

  • aac：使用 aac 编码格式；
  • copy：不进行转码，所有音频编码参数不生效；
  • opus：使用 opus 编码格式。
FPSInteger60帧率，单位为 fps。帧率越大，画面越流畅
GOPInteger0IDR 帧之间的最大间隔，单位为。

Width

Integer

100

视频宽度。

说明

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

Height

Integer

50

视频高度。

说明

当 As 的取值为 0 时，Width 和 Height 中任意参数取 0，表示保持源流尺寸。

As

String

1

宽高自适应模式开关。

  • 0：关闭宽高自适应，按照 Width 和 Height 的取值进行拉伸；
  • 1：开启宽高自适应，按照 ShortSide 或 LongSide 等比缩放。

ShortSide

Integer

100

短边长度。

说明

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

LongSide

Integer

200

长边长度。

说明

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

BFramesInteger32 个参考帧之间的最大 B 帧数。BFrames 取 0 时，表示去 B 帧。

Roi

Boolean

true

是否极智超清转码。

  • true：极智超清；
  • false：标准转码。

示例

请求示例

POST https://live.volcengineapi.com?Action=ListCommonTransPresetDetail&Version=2020-08-01
{
  "PresetList": [
    "preset1",
    "preset2"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestID": "20220426203705010211197144119377C1",
    "Action": "ListCommonTransPresetDetail",
    "Version": "2020-08-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "StandardPresetDetail": [],
    "NarrowBandHDPresetDetail": []
  }
}

错误码

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