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

添加转码配置

最近更新时间：2023.10.23 16:14:00

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

我的收藏

调用接口添加转码模版。新增转码模版会先加入模版库，再绑定到对应的 App。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
VhostString是push.example.com域名空间名称。
AppString是live应用名称，由 1 到 30 位数字、字母、下划线及"-"和"."组成。

SuffixName

String

是

hd

转码流后缀名。支持 10 个字符以内的大小写字母、下划线与中划线，常见后缀包括：_sd、_hd、_uhd
例如，配置的转码流后缀名为 _hd，则拉转码流时转码的流名为 stream-123456789_hd。

VideoBitrateInteger否1000000视频码率，单位为 bps，取值范围为 [0,30000000]；默认值为 1000000；取 0 时，表示使用源流码率。

Vcodec

String

是

h265

视频编码格式。

  • h264：使用 H.264 编码格式；
  • h265：使用 H.265 编码格式；
  • copy：不进行转码，所有视频编码参数不生效。
AudioBitrateInteger否50音频码率，单位为 kbps。

Acodec

String

否

acc

音频编码格式。默认格式为 acc，支持以下 3 种类型。

  • aac：使用 aac 编码格式；
  • copy：不进行转码，所有音频编码参数不生效；
  • opus：使用 opus 编码格式。
FPSInteger否25视频帧率，单位为 fps，取值范围为 [0,60]，默认为 25fps。帧率越大，画面越流畅。
GOPInteger否0IDR 帧之间的最大间隔，单位为 s，默认值为 0，取值范围为 [0,1000]

Width

Integer

否

0

视频宽度。默认值为 0，取值范围为 [0,8192]。

说明

  • 当 As 的取值为 0 时，参数生效；反之则不生效；
  • 当 As 的取值为 0 时，如果 Width 和 Height 任意取值为 0，表示保持源流尺寸。

Height

Integer

否

200

视频高度。默认值为 0，取值范围为 [0,8192]。

说明

  • 当 As 的取值为 0 时，参数生效；反之则不生效；
  • 当 As 的取值为 0 时，如果 Width 和 Height 任意取值为 0，表示保持源流尺寸。

As

String

否

1

宽高自适应模式开关。默认值为 0。支持的取值包括。

  • 0：关闭宽高自适应，按照 Width 和 Height 的取值进行拉伸；
  • 1：开启宽高自适应，按照 ShortSide 或 LongSide 等比缩放。

ShortSide

Integer

否

768

短边长度。默认值为 0。

  • Roi 取 false 时，取值范围为 [0,4096]；
  • Roi 取 true 时，取值范围为 [0,1080]。

说明

  • 当 As 的取值为 1 时，参数生效，反之则不生效。
  • 当 As 的取值为 1 时，如果 LongSide 和 ShortSide 同时取 0，表示保持源流尺寸。
  • 当 As 的取值为 1 时，如果同时配置 LongSide 和 ShortSide 的值，则按照 ShortSide 进行等比缩放。

LongSide

Integer

否

500

长边长度。默认值为 0。

  • Roi 取 false 时，取值范围为 [0,8192]；
  • Roi 取 true 时，取值范围为 [0,1920]。

说明

  • 当 As 的取值为 1 时，参数生效，反之则不生效。
  • 当 As 的取值为 1 时，如果 LongSide 和 ShortSide 同时取 0，表示保持源流尺寸。
  • 当 As 的取值为 1 时，如果同时配置 LongSide 和 ShortSide 的值，则按照 ShortSide 进行等比缩放。

BFrames

Integer

否

3

2 个参考帧之间的最大 B 帧数。不同编码格式的取值存在差异。

  • H.264：取值范围为 [0,7]，默认值为 3；
  • H.265：取值范围为 [0,1,2,3,7,15]，默认值为 3；
    BFrames 取 0 时，表示去 B 帧。

Roi

Boolean

否

true

是否极智超清转码。默认值为 false。

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

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

示例

请求示例

POST https://live.volcengineapi.com?Action=CreateTranscodePreset&Version=2023-01-01
{
    "Vhost":"push.example.com",
    "App":"live",
    "SuffixName":"hd",
    "Vcodec"："h264"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "201806041104200100100232280022D30",
    "Action": "CreateTranscodePreset",
    "Version": "2023-01-01",
    "Service": "live",
    "Region": "cn-north-1"
  }
}

错误码

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

状态码错误码错误信息说明
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.内部服务超时，请联系技术支持。