文档

添加直播流自定义转码配置

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

使用说明

本接口目前支持以下自定义转码模版类型,取值:

  • h264:自定义H264标准模版。
  • h264-nbhd:自定义H264窄带高清™模版。
  • h265:自定义H265标准模版。
  • h265-nbhd:自定义H265窄带高清模版。
  • audio:纯音频模板。

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String AddCustomLiveStreamTranscode

系统规定参数。取值:AddCustomLiveStreamTranscode

Domain String example.com

主播流域名。

App String liveApp****

播流所属应用名称。

KmsKeyID String afce5722-81d2-43c3-9930-7601da11****

用户KMS主密钥ID。

KmsUID String 25346073170691****

用户KMS主账号ID。

KmsKeyExpireInterval String 3600

换Key周期。取值范围:60~3600,单位:秒。

Template String LiveCusTranscode****

转码模板自定义名称。

说明 支持数字、大小写字母或短横线(-),且字段必须以大小写字母或数字开头,不能与标准的转码模板命名重复。
TemplateType String h264

自定义转码模版类型。取值:

  • h264:自定义H264标准模版。
  • h264-nbhd:自定义H264窄带高清™模版。
  • h265:自定义H265标准模版。
  • h265-nbhd:自定义H265窄带高清模版。
  • audio:纯音频模板。
说明 TemplateType取值为视频类型时(例如h264h264-nbhdh265h265-nbhd),请求参数HeightWidthFPSVideoBitrate的值必须填写。
Height Integer 720

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

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

  • Height ≥ 100:视频的高需要不小于100像素。
  • max(Height,Width)≤ 2560:视频的宽、高中较大的一个最大不能大于2560。
  • min(Height,Width)≤ 1440:视频的宽、高中较小的一个最大不能大于1440。
说明 265窄带高清模板不得超过1280×720。
Width Integer 576

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

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

  • Width ≥ 100:视频的宽需要不小于100像素。
  • max(Height,Width)≤ 2560:视频的宽、高中较大的一个最大不能大于2560。
  • min(Height,Width)≤ 1440:视频的宽、高中较小的一个最大不能大于1440。
说明 265窄带高清模板不得超过1280×720。
FPS Integer 30

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

VideoBitrate Integer 720

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

说明 转码视频会尽量接近您所设定的比特率,但转码视频的实际比特率不能保证和您所设定的完全一致,尤其是当您设定的比特率过大或过小时。
AudioBitrate Integer 512

转码音频比特率。单位:kbps,取值:1~1000

Gop String 1

视频GOP(Group of Picture),单位可选帧或者秒。

  • 单位:帧,取值:1~3000。例如:设置GOP为2帧,则此参数传入2。
  • 单位:秒,取值:1s~20s。例如:设置GOP为1秒,则此参数传入1s。
Profile Integer 2

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

  • 1:baseline(适合移动设备)。
  • 2:main(适合标准分辨率设备)。
  • 3:high(适合高分辨率设备)。
AudioProfile String aac_low

音频编码。取值:

  • aac_low
  • aac_he
  • aac_he_v2
  • aac_ld
AudioCodec String AAC

音频编码格式。取值:

  • AAC
  • MP3
AudioRate Integer 96000

音频采样率。取值:22050~96000

重要 如果AudioProfile取值为aac_ld,则采样率不能超过44100。
AudioChannelNum Integer 2

音频声道数。取值

  • 1:单声道。
  • 2:双声道。
Lazy String yes

是否开启触发转码。取值:

  • yes:开启触发转码。
  • no:不开启触发转码。
EncryptParameters String {"EncryptType": "aliyun", "KmsKeyID":"afce5722-81d2-43c3-9930-7601da11****","KmsKeyExpireInterval":"3600"}

加密配置。JSON格式,各字段说明如下:

  • EncryptType:加密类型。固定取值aliyun。
  • KmsKeyID:用户KMS主密钥ID。
  • KmsKeyExpireInterval:换Key周期。取值范围:60~3600,单位:秒。
说明 EncryptParameters参数若配置,则KmsKeyID、KmsUID、KmsKeyExpireInterval参数不能为空
ResWithSource String {"Type":"short","Value":"1080"}

分辨率随源配置,若设置了该字段,分辨率以该字段为主。包含的字段如下:

  • Type string (必须添加):只可以传 short (短边自适应)、long(长边自适应) 、screen(横竖屏自适应) 。
  • Value string(必须添加): 取值可选240、360、480、540、720、1080、2160。
FpsWithSource String {"UpLimit":60,"LowerLimit":1}

帧率随源配置,若设置了该字段,帧率以该字段为主。包含的字段如下:

  • UpLimit int(必须添加):帧率上限,输入范围1-60的整数,且大于帧率下限。
  • LowerLimit int (必须添加):帧率下限,输入范围1-60的整数,且小于帧率上限。
BitrateWithSource String {"UpLimit":2500,"LowerLimit":800,"Factor":1}

码率随源配置,若设置了该字段,码率以该字段为主。包含的字段如下:

  • UpLimit int(必须添加):码率上限,输入范围128-10000的整数,且大于码率下限。
  • LowerLimit int (必须添加):码率下限,输入范围128-10000的整数,且小于码率上限。
  • Factor float (必须添加):按源码率输出倍率,输入范围0.1-1,精确至小数点后一位,“1”为按源流输出。
ExtWithSource String {"KeyFrameOpen":"yes","Copyts":"yes","SeiMode":1}

其他随源配置,包含的字段如下:

  • KeyFrameOpen: yes或no。
  • Copyts string :yes或no。
  • SeiMode :取值有0(不透传)、 1( 透传但不是所有)、 2( 透传并且所有)。

返回数据

名称

类型

示例值

描述

RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=AddCustomLiveStreamTranscode
&App=liveApp****
&Domain=example.com
&Template=LiveCusTranscode****
&TemplateType=h264
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<AddCustomLiveStreamTranscodeResponse>
	<RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
</AddCustomLiveStreamTranscodeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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