查询转码配置列表--视频直播-火山引擎

文档中心

立即注册

导航

查询转码配置列表

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

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

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Vhost	String	是	`push.example.com`	域名空间，即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面，查看需要录制的直播流使用的域名所属的域名空间。

返回参数

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

参数	类型	示例值	描述
CommonPresetList	Array of TranscodePresetVhostAPP	`-`	使用内置参数的转码配置列表。
CustomizePresetList	Array of TranscodePresetVhostAPP	`-`	使用自定义配置的转码配置列表。
AllPresetList	Array of TranscodePresetVhostAPP	`-`	全部转码配置列表。

TranscodePresetVhostAPP

参数	类型	示例值	描述
App	String	`live`	应用名称。
TranscodePreset	Object of TranscodePreset	`-`	转码配置具体信息。
Vhost	String	`push.example.com`	域名空间。

TranscodePreset

参数	类型	示例值	描述
Acodec	String	`acc`	音频编码格式，默认值为 `aac`，支持的取值及含义如下所示。 `aac`：使用 AAC 音频编码格式； `opus`：使用 Opus 音频编码格式。 `copy`：不进行音频转码，所有音频编码参数不生效，音频编码参数包括音频码率（`AudioBitrate`）等。
As	String	`0`	视频分辨率自适应模式开关，默认值为 `0`。支持的取值及含义如下。 `0`：关闭视频分辨率自适应； `1`：开启视频分辨率自适应。说明关闭视频分辨率自适应模式（`As` 取值为 `0`）时，转码配置的视频分辨率取视频宽度（`Width`）和视频高度（`Height`）的值对转码视频进行拉伸；开启视频分辨率自适应模式（`As` 取值为 `1`）时，转码配置的视频分辨率按照短边长度（`ShortSide`）、长边长度（`LongSide`）、视频宽度（`Width`）、视频高度（`Height`）的优先级取值，另一边等比缩放。
AudioBitrate	Integer	`30`	音频码率，单位为 kbps。
AutoTransResolution	Integer	`1`	是否开启转码视频分辨率不超过源流分辨率，默认值为 `1` 表示开启。开启后，当源流分辨率低于转码配置分辨率时（即源流宽低于转码配置宽且源流高低于转码配置高时），将按源流视频分辨率进行转码。 `0`：关闭； `1`：开启。
AutoTransVb	Integer	`1`	是否开启转码视频码率不超过源流码率，默认值为 `1` 表示开启。开启后，当源流码率低于转码配置码率时，将按照源流视频码率进行转码。 `0`：关闭； `1`：开启。
AutoTransVr	Integer	`1`	是否开启转码视频帧率不超过源流帧率，默认值为 `1` 表示开启。开启后，当源流帧率低于转码配置帧率时，将按照源流视频帧率进行转码。 `0`：关闭； `1`：开启。
BFrames	Integer	`3`	转码输出视频中 2 个参考帧之间的最大 B 帧数量，取值为 `0` 时表示去除 B 帧。
FPS	Integer	`60`	视频帧率，单位为 fps，帧率越大，画面越流畅。
GOP	Integer	`4`	IDR 帧之间的最大间隔，单位为秒。
Height	Integer	`100`	视频高度。说明当关闭视频分辨率自适应（`As` 取值为 `0`）时，转码分辨率将取 `Width` 和 `Height` 的值对转码视频进行拉伸；当关闭视频分辨率自适应（`As` 取值为 `0`）时，`Width` 和 `Height` 任一取值为 `0` 时，转码视频将保持源流尺寸。
LongSide	Integer	`200`	长边长度。说明当开启视频分辨率自适应模式时（`As` 取值为 `1`）时，参数生效，反之则不生效。当开启视频分辨率自适应模式时（`As` 取值为 `1`）时，如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 `0`，表示保持源流尺寸。
Preset	String	`preset1`	转码配置名称。
Roi	Boolean	`true`	转码类型是否为极智超清转码，默认值为 `false`，取值及含义如下。 `true`：极智超清转码； `false`：标准转码。说明视频编码格式为 H.266 （`Vcodec` 取值为 `h266`）时，转码类型不支持极智超清转码。
ShortSide	Integer	`100`	短边长度。说明当 `As` 的取值为 1 即开启宽高自适应时，参数生效，反之则不生效。当 `As` 的取值为 1 时，如果 `LongSide` 、 `ShortSide` 、`Width` 、`Height` 同时取 0，表示保持源流尺寸。
StopInterval	Integer	`60`	转码停止时长，支持触发方式为拉流转码（`TransType` 取值为 `Pull`）时设置，表示断开拉流后转码停止的时长，单位为秒，取值范围为 `-1` 和 [0,300]，`-1` 表示不停止转码，默认值为 `60`。
SuffixName	String	`hd`	转码流后缀名。
Vcodec	String	`h265`	视频编码格式，支持的取值及含义如下所示。 `h264`：使用 H.264 视频编码格式； `h265`：使用 H.265 视频编码格式； `h266`：使用 H.266 视频编码格式； `copy`：不进行视频转码，所有视频编码参数不生效，视频编码参数包括视频帧率（`FPS`）、视频码率（`VideoBitrate`）、分辨率设置（`As`、`Width`、`Height`、`ShortSide`、`LongSide`）、`GOP` 和 `BFrames` 等。
VideoBitrate	Integer	`30`	视频码率，单位为 kbps。
Width	Integer	`200`	视频宽度。说明当关闭视频分辨率自适应（`As` 取值为 `0`）时，转码分辨率将取 `Width` 和 `Height` 的值对转码视频进行拉伸；当关闭视频分辨率自适应（`As` 取值为 `0`）时，`Width` 和 `Height` 任一取值为 `0` 时，转码视频将保持源流尺寸。
TransType	String	`Pull`	转码触发方式，支持的取值及含义如下。 `Push`：推流转码，直播推流后会自动启动转码任务，生成转码流； `Pull`：拉流转码，直播推流后，需要主动播放转码流才会启动转码任务，生成转码流。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240529174633D899A58F84B28B78E183",
        "Action": "ListVhostTransCodePreset",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "AllPresetList": [
            {
                "App": "live",
                "TranscodePreset": {
                    "Acodec": "aac",
                    "As": "1",
                    "AudioBitrate": 128,
                    "AutoTransResolution": 1,
                    "AutoTransVb": 1,
                    "AutoTransVr": 1,
                    "BFrames": 3,
                    "FPS": 0,
                    "GOP": 2,
                    "Height": 0,
                    "LongSide": 0,
                    "Preset": "bukkhowjbx",
                    "Roi": false,
                    "ShortSide": 1000,
                    "StopInterval": 60,
                    "SuffixName": "_hd",
                    "TransType": "Pull",
                    "Vcodec": "h264",
                    "VideoBitrate": 0,
                    "Width": 0
                },
                "Vhost": "push.example.com"
            }
        ],
        "CommonPresetList": [],
        "CustomizePresetList": [
            {
                "App": "live",
                "TranscodePreset": {
                    "Acodec": "aac",
                    "As": "1",
                    "AudioBitrate": 128,
                    "AutoTransResolution": 1,
                    "AutoTransVb": 1,
                    "AutoTransVr": 1,
                    "BFrames": 3,
                    "FPS": 0,
                    "GOP": 2,
                    "Height": 0,
                    "LongSide": 0,
                    "ParamType": "",
                    "Preset": "bukkhowjbx",
                    "Roi": false,
                    "SceneType": "",
                    "ShortSide": 1000,
                    "StopInterval": 60,
                    "SuffixName": "_hd",
                    "TransType": "Pull",
                    "Vcodec": "h264",
                    "VideoBitrate": 0,
                    "Width": 0
                },
                "Vhost": "push.example.com"
            }
        ]
    }
}

错误码

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

状态码	错误码	错误信息	说明
200	CommonErr	-	未分类错误。建议重试，如果仍返回该错误码，请联系技术支持。
400	InvalidParam	-	输入的参数无效或不符合要求，请参照请求参数说明进行检查。
400	InvalidParam.BindError	Request parameter error, please check input data	参数未通过校验，请检查参数类型是否正确。
400	InvalidParam.Empty	%s is required	参数缺失，请检查错误消息中指定的参数是否传入。
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。