最近更新时间:2023.10.23 16:14:00
首次发布时间:2023.09.25 14:34:04
调用该接口查询直播系统内置转码档位的详细配置。
请求频率:单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListCommonTransPresetDetail | 接口名称。当前 API 的名称为 ListCommonTransPresetDetail 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
PresetList | Array of String | 否 | ["preser1","preset2"] | 模板名称列表,缺省情况下,表示查询所有系统内置转码档位。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
NarrowBandHDPresetDetail | Array of PresetDetail | - | 极智超清模板信息。 |
StandardPresetDetail | Array of PresetDetail | - | 标准模板信息。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
SuffixName | String | hd | 转码流后缀名。 |
VideoBitrate | Integer | 1000000 | 视频码率,单位为 kbps |
Vcodec | String |
| 视频编码格式。
|
AudioBitrate | Integer | 30 | 音频码率,单位为 kbps。 |
Acodec | String |
| 音频编码格式。包括以下 3 种类型。
|
FPS | Integer | 60 | 帧率,单位为 fps。帧率越大,画面越流畅。 |
GOP | Integer | 0 | IDR 帧之间的最大间隔,单位为 s。 |
Width | Integer |
| 视频宽度。 说明 当 |
Height | Integer |
| 视频高度。 说明 当 |
As | String |
| 宽高自适应模式开关。
|
ShortSide | Integer |
| 短边长度。 说明 当 |
LongSide | Integer |
| 长边长度。 说明 当 |
BFrames | Integer | 3 | 2 个参考帧之间的最大 B 帧数。BFrames 取 0 时,表示去 B 帧。 |
Roi | Boolean |
| 是否极智超清转码。
|
POST https://live.volcengineapi.com?Action=ListCommonTransPresetDetail&Version=2023-01-01 { "PresetList": [ "preset1", "preset2" ] }
{ "ResponseMetadata": { "RequestID": "20220426203705010211197144119377C1", "Action": "ListCommonTransPresetDetail", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "StandardPresetDetail": [], "NarrowBandHDPresetDetail": [] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
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. | 内部服务超时,请联系技术支持。 |