调用CreateMPULayout创建旁路直播布局。
使用说明
本接口用于创建旁路直播布局。例如:您可以配置混音个数、主窗格等参数。
QPS限制
本接口的单用户QPS限制为10次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | CreateMPULayout |
系统规定参数。取值:CreateMPULayout。 |
AppId | String | 是 | yourAppId |
应用ID,仅支持传单个ID。 您可以在控制台创建和查询。 |
Name | String | 否 | LayoutName |
布局名称。 |
AudioMixCount | Integer | 是 | 3 |
最大混音个数。取值范围:0~6。 |
Panes.N.MajorPane | Integer | 否 | 1 |
指定主窗格,每个布局只能有一个主窗格。
|
Panes.N.Width | Float | 否 | 0.25 |
窗格宽,归一化百分比。Width取值范围:0.0<Width≤1.0。 |
Panes.N.Height | Float | 否 | 0.25 |
窗格高,归一化百分比。Height取值范围:0.0<Height≤1.0。 |
Panes.N.Y | Float | 否 | 0.25 |
坐标Y,归一化百分比。坐标Y取值范围:0.0≤Y≤1.0。 |
Panes.N.PaneId | Integer | 否 | 0 |
布局ID,从左上到右下排序,从0开始。 |
Panes.N.ZOrder | Integer | 否 | 0 |
叠放顺序,0为最底层,1层在0层之上,以此类推。 |
Panes.N.X | Float | 否 | 0.25 |
坐标X,归一化百分比。坐标X取值范围:0.0≤X≤1.0。 |
说明 N从1开始取值。
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
LayoutId | Long | 2 |
布局ID。 |
RequestId | String | 760bad53276431c499e30dc36f6b26be |
请求ID。 |
示例
请求示例
https://rtc.aliyuncs.com/?Action=CreateMPULayout
&AppId=yourAppId
&AudioMixCount=3
&Panes.1.PaneId=0
&Panes.1.MajorPane=1
&Panes.1.X=0.25
&Panes.1.Y=0.25
&Panes.1.Width=0.25
&Panes.1.Height=0.25
&Panes.1.ZOrder=0
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateMPULayoutResponse>
<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>
<LayoutId>2</LayoutId>
</CreateMPULayoutResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "760bad53276431c499e30dc36f6b26be",
"LayoutId" : 2
}