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

查询转码配置列表

最近更新时间：2024.04.07 10:28:24

首次发布时间：2023.09.25 14:34:04

我的收藏

调用 ListVhostTransCodePreset 接口，查询转码配置列表。

注意事项

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

请求说明

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

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

Query

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

Body

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

返回参数

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

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

TranscodePresetVhostAPP

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

TranscodePreset

参数类型示例值描述

Acodec

String

acc

音频编码格式，取值含义如下。

  • aac：使用 AAC 编码格式；
  • copy：不进行转码，所有音频编码参数不生效；
  • opus：使用 Opus 编码格式。

As

String

0

宽高自适应模式开关。

  • 0：关闭宽高自适应；
  • 1：开启宽高自适应。

说明

  • 关闭宽高自适应时，转码配置分辨率取 Width 和 Height 的值对转码视频进行拉伸；
  • 开启宽高自适应时，转码配置分辨率按照 ShortSide 、 LongSide 、Width 、Height 的优先级取值，另一边等比缩放。
AudioBitrateInteger30音频码率，单位为 kbps。

AutoTransResolution

Integer

1

是否开启转码不超过源流分辨率。开启后，当源流分辨率低于转码配置分辨率时(即源流宽低于转码配置宽且源流高低于转码配置高时)，将按源流视频分辨率进行转码，默认开启。

  • 0：关闭
  • 1：开启

AutoTransVb

Integer

1

是否开启不超过源流码率。开启后，当源流码率低于转码配置码率时，将按照源流视频码率进行转码，默认开启。

  • 0：关闭
  • 1：开启

AutoTransVr

Integer

1

是否开启不超过源流帧率。开启后，当源流帧率低于转码配置帧率时，将按照源流视频帧率进行转码，默认开启。

  • 0：关闭
  • 1：开启
BFramesInteger32 个参考帧之间的最大 B 帧数。取值为 0 时，表示去除 B 帧。
FPSInteger60视频帧率，单位为 fps，帧率越大，画面越流畅。
GOPInteger4IDR 帧之间的最大间隔，单位为秒。
HeightInteger100视频高度。

LongSide

Integer

200

长边长度。

说明

  • 当 As 的取值为 1 即开启宽高自适应时，参数生效，反之则不生效。
  • 当 As 的取值为 1 时，如果 LongSide 、 ShortSide 、Width 、Height 同时取 0，表示保持源流尺寸。
PresetStringpreset1转码配置名称。

Roi

Boolean

true

是否极智超清转码，取值及含义如下。

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

ShortSide

Integer

100

短边长度。

说明

  • 当 As 的取值为 1 即开启宽高自适应时，参数生效，反之则不生效。
  • 当 As 的取值为 1 时，如果 LongSide 、 ShortSide 、Width 、Height 同时取 0，表示保持源流尺寸。
StopIntervalInteger60转码停止时长，支持触发方式为拉流转码时设置，表示断开拉流后转码停止的时长，单位为 s，取值范围为 -1 和 [0,300]，-1 表示不停止转码，默认值为 60。
SuffixNameStringhd转码流后缀名。

Vcodec

String

h265

视频编码格式。

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

TransType

String

Pull

转码触发方式，取值及含义如下。

  • Push：推流转码，直播推流后会自动启动转码任务，生成转码流；
  • Pull：拉流转码，直播推流后，需要主动播放转码流才会启动转码任务，生成转码流。

请求示例

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

返回示例

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

错误码

下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400InvalidParam-输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验，请检查参数类型是否正确。
400InvalidParam.Empty%s is required参数缺失，请检查错误消息中指定的参数是否传入。
403RequestForbidden-请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.AccountIDNotAllowthis AccountID does not have permission to access the corresponding resource, please check the request parameters请求被拒绝，当前账号下无请求的资源（域名空间、域名、应用、配置模版、证书）。
403RequestForbidden.BillingStatusBilling status is not available for the AccountID, please activate the service or recharge.未开通视频直播服务或账号欠费，造成账单不可用，请检查服务开通情况和账号欠费情况。
404ResourceNotFound-未找到资源（域名空间、域名、应用、配置模版、证书）。建议重试，如果仍返回该错误码，请联系技术支持。
500InternalErroran internal error occurred, please contact the administrator.出现内部错误，请联系技术支持。
500InternalError.Presetan internal error related to preset occurred, please contact the administrator.出现与功能配置相关的内部错误，请联系技术支持。
502InternalServiceErroran internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
502InternalServiceError.BadResponsean internal error occurred, please contact the administrator.服务间出现错误，请联系技术支持。
504InternalServiceTimeoutInternal Service is timeout. please contact the administrator.内部服务超时，请联系技术支持。

服务端 SDK

视频直播提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。