ListCommonTransPresetDetail - 查询内置转码档位的详细配置--视频直播-火山引擎

文档中心

立即注册

导航

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

最近更新时间：2024.12.24 18:21:20首次发布时间：2023.09.25 14:34:04

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

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

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

返回参数

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

参数	类型	示例值	描述
NarrowBandHDPresetDetail	Array of PresetDetail	`-`	极智超清转码配置。
StandardPresetDetail	Array of PresetDetail	`-`	标准转码配置。

PresetDetail

参数	类型	示例值	描述
SuffixName	String	`hd`	转码后缀，支持由大小写字母（A - Z、a - z）、数字（0 - 9）、下划线（_）和短横线（-）组成，长度为 1 到 10 个字符。转码后缀通常以流名称后缀的形式来使用，常见的标识有 `_sd`、`_hd`、`_uhd`，例如，当转码配置的标识为 `_hd` 时，拉取转码流时转码流的流名名称为 `源流的流名称_hd`。
VideoBitrate	Integer	`1000000`	视频码率，单位为 kbps。
Vcodec	String	`h265`	视频编码格式。 `h264`：使用 H.264 编码格式； `h265`：使用 H.265 编码格式； `copy`：不进行转码，所有视频编码参数不生效。
AudioBitrate	Integer	`30`	音频码率，单位为 kbps。
Acodec	String	`aac`	音频编码格式，支持的取值及含义如下。 `aac`：使用 AAC 编码格式； `opus`：使用 Opus 编码格式； `copy`：不进行转码，所有音频编码参数不生效。
FPS	Integer	`60`	帧率，单位为 fps。帧率越大，画面越流畅。
GOP	Integer	`2`	IDR 帧之间的最大间隔，单位为秒。
Width	Integer	`100`	视频宽度，单位为 px。说明当关闭视频分辨率自适应（`As` 取值为 `0`）时，转码分辨率将取 `Width` 和 `Height` 的值对转码视频进行拉伸；当关闭视频分辨率自适应（`As` 取值为 `0`）时，`Width` 和 `Height` 任一取值为 `0` 时，转码视频将保持源流尺寸；编码格式为 H.266 时，不支持设置 `Width` 和 `Height`，请使用自适应配置。
Height	Integer	`50`	视频高度，单位为 px。说明当关闭视频分辨率自适应（`As` 取值为 `0`）时，转码分辨率将取 `Width` 和 `Height` 的值对转码视频进行拉伸；当关闭视频分辨率自适应（`As` 取值为 `0`）时，`Width` 和 `Height` 任一取值为 `0` 时，转码视频将保持源流尺寸；编码格式为 H.266 时，不支持设置 `Width` 和 `Height`，请使用自适应配置。
As	String	`1`	视频分辨率自适应模式开关。支持的取值及含义如下。 `0`：关闭视频分辨率自适应； `1`：开启视频分辨率自适应。说明关闭视频分辨率自适应模式（`As` 取值为 `0`）时，转码配置的视频分辨率取视频宽度（`Width`）和视频高度（`Height`）的值对转码视频进行拉伸；开启视频分辨率自适应模式（`As` 取值为 `1`）时，转码配置的视频分辨率按照短边长度（`ShortSide`）、长边长度（`LongSide`）、视频宽度（`Width`）、视频高度（`Height`）的优先级取值，另一边等比缩放。
ShortSide	Integer	`100`	短边长度，单位为 px。说明当 `As` 的取值为 1 即开启宽高自适应时，参数生效，反之则不生效。当 `As` 的取值为 1 时，如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 0，表示保持源流尺寸。
LongSide	Integer	`200`	长边长度，单位为 px。说明当 `As` 的取值为 1 即开启宽高自适应时，参数生效，反之则不生效。当 `As` 的取值为 1 时，如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 0，表示保持源流尺寸。
BFrames	Integer	`3`	转码输出视频中 2 个参考帧之间的最大 B 帧数量，默认值为 `3`，取值为 `0` 时表示去除 B 帧。最大 B 帧数量的取值范围根据视频编码格式（Vcodec）的不同有所差异，取值范围如下所示。视频编码格式为 H.264 （`Vcodec` 取值为 `h264`）时取值范围为 [0,7]；视频编码格式为 H.265 或 H.266 （`Vcodec` 取值为 `h265` 或 `h266`）时取值范围为 [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": {
        "Action": "ListCommonTransPresetDetail",
        "Region": "cn-north-1",
        "Service": "live",
        "Version": "2023-01-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "NarrowBandHDPresetDetail": [
            {
                "Acodec": "aac",
                "As": "1",
                "AudioBitrate": 30,
                "BFrames": 3,
                "FPS": 60,
                "GOP": 2,
                "Height": 50,
                "LongSide": 200,
                "Roi": true,
                "ShortSide": 100,
                "SuffixName": "hd",
                "Vcodec": "h265",
                "VideoBitrate": 1000000,
                "Width": 100
            }
        ],
        "StandardPresetDetail": [
            {
                "Acodec": "aac",
                "As": "1",
                "AudioBitrate": 30,
                "BFrames": 3,
                "FPS": 60,
                "GOP": 2,
                "Height": 50,
                "LongSide": 200,
                "Roi": true,
                "ShortSide": 100,
                "SuffixName": "hd",
                "Vcodec": "h265",
                "VideoBitrate": 1000000,
                "Width": 100
            }
        ]
    }
}

错误码

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

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

服务端 SDK

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