调用 CreateTranscodePreset
接口创建一个转码配置,在直播流传输的过程中,系统将根据您的转码配置,对直播流进行实时转码。
CreateTranscodePreset
接口支持创建多个 Vhost + App 级别的转码配置,不同的转码配置需要使用转码后缀(SuffixName
)进行区分。创建转码配置后,您可以通过在拉流地址中为流名称添加转码后缀的方式,使用转码配置。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateTranscodePreset | 接口名称。当前 API 的名称为 CreateTranscodePreset 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Vhost | String | 是 | push.example.com | 域名空间,即直播流地址的域名所属的域名空间。您可以调用 ListDomainDetail 接口或在视频直播控制台的域名管理页面,查看需要转码的直播流使用的域名所属的域名空间。 |
App | String | 是 | live | 应用名称,取值与直播流地址的 AppName 字段取值相同。支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)、短横线(-)和句点(.)组成,长度为 1 到 30 个字符。 |
SuffixName | String | 是 |
| 转码后缀,支持由大小写字母(A - Z、a - z)、数字(0 - 9)、下划线(_)和短横线(-)组成,长度为 1 到 10 个字符。 |
VideoBitrate | Integer | 否 |
| 视频码率,单位为 bps,默认值为
|
Vcodec | String | 是 |
| 视频编码格式,支持的取值及含义如下所示。
|
AudioBitrate | Integer | 否 | 50 | 音频码率,单位为 kbps,默认值为 128 ,取值范围为 [0,1000];取值为 0 时,表示与源流的音频码率相同。 |
Acodec | String | 否 |
| 音频编码格式,默认值为
|
FPS | Integer | 否 |
| 视频帧率,单位为 fps,默认值为
|
GOP | Integer | 否 | 4 | IDR 帧之间的最大间隔时间,单位为秒,默认值为 4 ,取值范围为 [1,20]。 |
Width | Integer | 否 |
| 视频宽度,单位为 px,默认值为
说明
|
Height | Integer | 否 |
| 视频高度,默认值为
说明
|
As | String | 否 |
| 视频分辨率自适应模式开关,默认值为
说明
|
ShortSide | Integer | 否 |
| 短边长度,默认值为
说明
|
LongSide | Integer | 否 |
| 长边长度,默认值为
说明
|
BFrames | Integer | 否 |
| 转码输出视频中 2 个参考帧之间的最大 B 帧数量,默认值为
|
Roi | Boolean | 否 |
| 转码类型是否为极智超清转码,默认值为
说明 视频编码格式为 H.266 ( |
AutoTransResolution | Integer | 否 |
| 是否开启转码视频分辨率不超过源流分辨率,默认值为
|
AutoTransVb | Integer | 否 |
| 是否开启转码视频码率不超过源流码率,默认值为
|
AutoTransVr | Integer | 否 |
| 是否开启转码视频帧率不超过源流帧率,默认值为
|
StopInterval | Integer | 否 | 60 | 转码停止时长,支持触发方式为拉流转码(TransType 取值为 Pull )时设置,表示断开拉流后转码停止的时长,单位为秒,取值范围为 -1 和 [0,300],-1 表示不停止转码,默认值为 60 。 |
TransType | String | 否 |
| 转码触发方式,默认值为
|
本接口无特有的返回参数。更多信息请见返回结构。
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" } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
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,支持多种编程语言,帮助您更方便的调用 API。