You need to enable JavaScript to run this app.
导航
查询内置转码档位的详细配置
最近更新时间:2024.05.14 10:43:17首次发布时间:2023.09.25 14:34:04

调用 ListCommonTransPresetDetail 接口,查询内置转码档位的详细配置。

注意事项

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

请求说明

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

调试

请求参数

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

Query

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

Body

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

返回参数

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

参数类型示例值描述
NarrowBandHDPresetDetailArray of PresetDetail-极智超清转码配置。
StandardPresetDetailArray of PresetDetail-标准转码配置。

PresetDetail

参数类型示例值描述

SuffixName

String

hd

转码后缀,支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)和短横线(-)组成,长度为 1 到 10 个字符。
转码后缀通常以流名称后缀的形式来使用,常见的标识有 _sd_hd_uhd,例如,当转码配置的标识为 _hd 时,拉取转码流时转码流的流名名称为 源流的流名称_hd

VideoBitrateInteger1000000视频码率,单位为 kbps。

Vcodec

String

h265

视频编码格式。

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

Acodec

String

acc

音频编码格式,支持的取值及含义如下。

  • aac:使用 AAC 编码格式;
  • opus:使用 Opus 编码格式;
  • copy:不进行转码,所有音频编码参数不生效。
FPSInteger60帧率,单位为 fps。帧率越大,画面越流畅。
GOPInteger4IDR 帧之间的最大间隔,单位为秒。

Width

Integer

100

视频宽度。

说明

  • 当关闭视频分辨率自适应(As 取值为 0)时,转码分辨率将取 WidthHeight 的值对转码视频进行拉伸;
  • 当关闭视频分辨率自适应(As 取值为 0)时,WidthHeight 任一取值为 0 时,转码视频将保持源流尺寸;
  • 编码格式为 H.266 时,不支持设置 WidthHeight,请使用自适应配置。

Height

Integer

50

视频高度。

说明

  • 当关闭视频分辨率自适应(As 取值为 0)时,转码分辨率将取 WidthHeight 的值对转码视频进行拉伸;
  • 当关闭视频分辨率自适应(As 取值为 0)时,WidthHeight 任一取值为 0 时,转码视频将保持源流尺寸;
  • 编码格式为 H.266 时,不支持设置 WidthHeight,请使用自适应配置。

As

String

1

视频分辨率自适应模式开关。支持的取值及含义如下。

  • 0:关闭视频分辨率自适应;
  • 1:开启视频分辨率自适应。

说明

  • 关闭视频分辨率自适应模式(As 取值为 0)时,转码配置的视频分辨率取视频宽度(Width)和视频高度(Height)的值对转码视频进行拉伸;
  • 开启视频分辨率自适应模式(As 取值为 1)时,转码配置的视频分辨率按照短边长度(ShortSide)、长边长度(LongSide)、视频宽度(Width)、视频高度(Height)的优先级取值,另一边等比缩放。

ShortSide

Integer

100

短边长度。

说明

  • As 的取值为 1 即开启宽高自适应时,参数生效,反之则不生效。
  • As 的取值为 1 时,如果 LongSideShortSideWidthHeight 同时取 0,表示保持源流尺寸。

LongSide

Integer

200

长边长度。

说明

  • As 的取值为 1 即开启宽高自适应时,参数生效,反之则不生效。
  • As 的取值为 1 时,如果 LongSideShortSideWidthHeight 同时取 0,表示保持源流尺寸。

BFrames

Integer

3

转码输出视频中 2 个参考帧之间的最大 B 帧数量,默认值为 3,取值为 0 时表示去除 B 帧。
最大 B 帧数量的取值范围根据视频编码格式(Vcodec)的不同有所差异,取值范围如下所示。

  • 视频编码格式为 H.264 (Vcodec 取值为 h264)时取值范围为 [0,7];
  • 视频编码格式为 H.265 或 H.266 (Vcodec 取值为 h265h266)时取值范围为 [0,3]、7、15。

Roi

Boolean

true

转码类型是否为极智超清转码,默认值为 false,取值及含义如下。

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

说明

视频编码格式为 H.266 (Vcodec 取值为 h266)时,转码类型不支持极智超清转码。

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2024051318115741EFB25EF1B532A4EC52",
    "Action": "ListCommonTransPresetDetail",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  },
  "Result": {
    "NarrowBandHDPresetDetail": [
      {
        "Acodec": "copy",
        "Roi": true,
        "SuffixName": "_zor5",
        "Vcodec": "h265"
      }
    ],
    "StandardPresetDetail": [
      {
        "Acodec": "aac",
        "As": "1",
        "AudioBitrate": 128,
        "FPS": 20,
        "Roi": false,
        "ShortSide": 360,
        "SuffixName": "_ld",
        "Vcodec": "h264",
        "VideoBitrate": 500000,
      },
      {
        "Acodec": "aac",
        "As": "1",
        "AudioBitrate": 128,
        "FPS": 20,
        "Roi": false,
        "ShortSide": 360,
        "Status": 1,
        "SuffixName": "_ld5",
        "Vcodec": "h265"
      },
      {
        "Acodec": "copy",
        "Roi": false,
        "SuffixName": "_or5",
        "Vcodec": "h265"
      },
      {
        "Acodec": "copy",
        "Roi": false,
        "SuffixName": "_or",
        "Vcodec": "h264"
      }
    ]
  }
}

错误码

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

状态码错误码错误信息说明
200CommonErr-未分类错误。建议重试,如果仍返回该错误码,请联系技术支持
400InvalidParam-输入的参数无效或不符合要求,请参照请求参数说明进行检查。
400InvalidParam.BindErrorRequest parameter error, please check input data参数未通过校验,请检查参数类型是否正确。
400InvalidParam.OutOfRange%s should be one of {[%s]}%s should be between %d and %d参数超出允许范围,请检查错误消息中指定参数的取值是否超出取值范围。
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。