调用CreateCustomTemplate创建合流自定义模板_视频直播(LIVE)-阿里云帮助中心

使用说明

调用本接口创建好自定义模板后，请记录模板名。通过CreateMixStream接口创建合流任务时，MixStreamTemplate传入模板名来使用自定义模板。

QPS限制

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

调试

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

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	CreateCustomTemplate	系统规定参数。取值：CreateCustomTemplate。
CustomTemplate	String	是	{"height":"1060","scale":"[16:9]","gop":"60","bframes":"30","cdesc":"h264"}	JSON格式{height:xxx,scale:xxx,gop:xxx,bframes:xxx,cdesc:xxx}，所有字段均必填，缺少其中任意字段会调用失败。说明具体参数请参考下表CustomTemplate说明。
Template	String	是	TestTemplate	需要添加的模板名。说明请在创建时记录模板名，用于使用、查询和删除操作。

CustomTemplate说明

名称	类型	必选	描述
height	String	必选	输出分辨率的高。 scale为16:9时最大支持1920x1080。 scale为4:3时最大支持1440x1080 。
scale	String	必选	输出分辨率高宽比。只能接受 String 取值如下： [3:4] [4:3] [16:9] [9:16]
bframes	String	必选	输出流b帧数。取值需要大于0小于9。
cdesc	String	必选	编码格式。只能取值 h264。
gop	String	必选	关键帧间隔。取值大于25小于250。

返回数据

名称	类型	示例值	描述
RequestId	String	0D715397-2E66-4AE1-694h-C546628AD145	请求ID。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=CreateCustomTemplate
&CustomTemplate={height:1080,scale:[16:9],gop:60,bframes:30,cdesc:h264}
&Template=TestTemplate
&<公共请求参数>

正常返回示例

XML格式

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

<CreateCustomTemplateResponse>
    <RequestId>0D715397-2E66-4AE1-694h-C546628AD145</RequestId>
</CreateCustomTemplateResponse>

JSON格式

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

{
  "RequestId" : "0D715397-2E66-4AE1-694h-C546628AD145"
}

错误码

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