调用AddRtsLiveStreamTranscode添加RTS自定义转码配置信息。

使用说明

调用本接口添加RTS自定义转码配置信息，本接口目前只支持h264、h264-nbhd、h264-origin、audio四种自定义转码模版类型。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 AddRtsLiveStreamTranscode

系统规定参数。取值：AddRtsLiveStreamTranscode。

Domain String 是 example.com

主播流域名。
App String 是 aliyun-test

播流所属应用名称。取值要求：

  • 该字段必须由大小写字母、数字、下划线（_）或短横线（-）组成。
  • 这些字符不必全含，建议取值大于3个字符，且字段的开头必须是字母（大小写）或数字。
Template String 是 ld

转码模板自定义名称。取值要求：

  • 该字段必须由大小写字母、数字、下划线（_）或短横线（-）组成。
  • 这些字符不必全含，建议取值大于3个字符，且字段的开头必须是字母（大小写）或数字。
说明 不能与标准的转码模板命名重复。
TemplateType String 是 h264

自定义转码模版类型。目前支持：

如果选择h264或h264-nbhd或h264-origin类型，必须同时设置请求参数Height，Width，FPS，VideoBitrate和DeleteBframes。

  • h264：自定义H264标准模版。
  • h264-nbhd：自定义H264窄带高清™模版。
  • h264-origin：原画H264标准模版，转码参数尽量保持和片源相同。
  • audio：纯音频转码模板，转码出来文件只有声音没有图像。如果选择audio类型，必须同时设置请求参数AudioBitrate。
Height Integer 否 1280

转码视频高度。单位：像素。取值：

注意 当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。

需要同时满足如下三个条件：

  • Height ≥ 100：视频的高需要不小于100像素。
  • max（Height,Width）≤ 2560：视频的宽、高中较大的一个最大不能大于2560。
  • min（Height,Width）≤ 1440：视频的宽、高中较小的一个最大不能大于1440。

例如：1560×1560（正方形视频）是不合法的。

说明 原画模板由于需要保持片源的信息，分辨率最高支持到4K。
Width Integer 否 720

转码视频宽度。单位：像素。取值：

注意 当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。

需要同时满足如下三个条件：

  • Width≥ 100：视频的宽需要不小于100像素。
  • max（Height,Width）≤ 2560：视频的宽、高中较大的一个最大不能大于2560。
  • min（Height,Width）≤ 1440：视频的宽、高中较小的一个最大不能大于1440。

例如：1560×1560（正方形视频）是不合法的。

说明 原画模板由于需要保持片源的信息，分辨率最高支持到4K。
FPS Integer 否 30

转码视频帧率。单位：FPS。取值：1~60。

注意 当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。
VideoBitrate Integer 否 2000

转码视频比特率。单位：kbps。取值：1~6000。

注意 当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。
说明 转码视频会尽量接近您所设定的比特率，但转码视频的实际比特率不能保证和您所设定的完全一致，尤其是当您设定的比特率过大或过小时。
AudioBitrate Integer 否 128

转码音频比特率。

单位：kbps。取值：1~1000。

注意 当TemplateType（自定义转码模版类型）设为audio时，本参数必填。
Gop String 否 2

视频GOP（Group of Picture）。主要用于控制关键帧间隔。单位：秒。取值：1~3。

Profile Integer 否 2

编码级别。视频支持的一组特定的编码功能，一般值越大得到的画面质量越好，同时编解码消耗的资源也越高。取值：

  • 1：baseline（适合移动设备）。
  • 2：main（适合标准分辨率设备）。
  • 3：high（适合高分辨率设备）。
DeleteBframes Boolean 否 false

是否使用B帧进行转码。取值：

注意 当TemplateType（自定义转码模版类型）设为h264或h264-nbhd或h264-origin时，本参数必填。
  • true：转码后的视频无B帧。
  • false：包含B帧，默认包含B帧。
说明 不传参数时默认为false。
Opus Boolean 否 true

音频转码是否使用opus进行转码（主要用户兼容原生webrtc问题）。取值：

  • true：音频转码为opus格式。
  • false：不使用opus格式转码。
说明 不传参数时默认为false。
AudioCodec String 否 aac

音频编码器。取值：

  • aac。
  • mp3。
说明 如果要使用opus编码，把Opus选项参数置为true即可。
AudioProfile String 否 aac_low

音频编码级别。取值：

  • aac_low。
  • aac_he。
  • aac_he_v2。
  • aac_ld。
AudioRate Integer 否 44100

音频采样率。取值：22050~96000，其中44100比较常用。

说明 如果音频编码AudioProfile是aac_ld，则采样率不能超过44100。
AudioChannelNum Integer 否 2

音频声道数。取值：

  • 1 ：单声道。
  • 2：立体声。
Lazy String 否 no

是否开启强制转码。取值：

  • yes：延迟转码。
  • no：强制转码。

返回数据

名称 类型 示例值 描述
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

请求ID。

示例

请求示例

https://live.aliyuncs.com/?Action=AddRtsLiveStreamTranscode
&Domain=example.com
&App=aliyun-test
&Template=ld
&TemplateType=h264
&Height=1280
&Width=720
&FPS=25
&VideoBitrate=2400
&DeleteBframes=false
&<公共请求参数>

正常返回示例

XML格式 

<AddLiveStreamTranscodeResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</AddLiveStreamTranscodeResponse>

JSON格式 

{"RequestId":"16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"}

错误码

访问错误中心查看更多错误码。

特殊错误码

错误代码

描述

HTTP 状态码

语义

InvalidDomain.NotFound

The domain provided does not exist in our records.

404

域名不存在或不属于当前用户。

IllegalOperation

Illegal domain operate is not permitted.

403

不支持当前操作，如：非直播类域名。

InvalidParameters

Invalid parameters.

400

参数不合法，如高度过大、比特率过大等。

ConfigAlreadyExists

Config has already exist.

400

配置已添加。

InternalError

The request processing has failed due to some unknown error.

500

后台发生未知错误。