調用DescribeMPULayoutInfoList獲取旁路直播任務布局參數。

使用說明

調用本接口前，您必須已經調用CreateMPULayout創建旁路直播布局。

QPS限制

本接口的單用戶QPS限制為10次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見QPS限制。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeMPULayoutInfoList

系統規定參數。取值：DescribeMPULayoutInfoList。

AppId String 是 yourAppId

應用ID。僅支持傳單個ID，您可以在控制臺創建和查詢。
LayoutId Long 否 2

布局ID。獲取布局ID，請參見CreateMPULayout.

Name String 否 LayoutName

布局名稱。
PageNum Long 否 1

頁碼，默認為1。

PageSize Long 否 10

每頁顯示數量，默認為10。

返回數據

名稱 類型 示例值 描述
TotalPage Long 1

總頁數。
RequestId String 760bad53276431c499e30dc36f6b26be

請求ID。
TotalNum Long 1

總記錄數。
Layouts Array of Layout

布局列表。
Layout
LayoutId Long 2

布局ID。
Name String LayoutName

布局名稱。
AudioMixCount Integer 3

最大混音個數。
Panes Array of Panes

布局的窗格參數。
Panes
MajorPane Integer 0

指定主窗格，每個布局只能有一個主窗格。

  • 0：副窗格。
  • 1：主窗格。
Width Float 0.5

窗格寬，歸一化百分比。
Height Float 0.5

窗格高，歸一化百分比。
Y Float 0.5

坐標Y，歸一化百分比。
PaneId Integer 0

窗格ID，從左上到右下排序，從0開始。
ZOrder Integer 0

疊放順序，0為最底層，1層在0層之上，以此類推。
X Float 0.5

坐標X，歸一化百分比。

示例

請求示例

https://rtc.aliyuncs.com/?Action=DescribeMPULayoutInfoList
&AppId=yourAppId
&<公共請求參數>

正常返回示例

XML格式 

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

<DescribeMPULayoutInfoListResponse>
<TotalNum>1</TotalNum>
<TotalPage>1</TotalPage>
<RequestId>760bad53276431c499e30dc36f6b26be</RequestId>
<Layouts>
    <AudioMixCount>3</AudioMixCount>
    <LayoutId>2</LayoutId>
    <Name>LayoutName</Name>
    <Panes>
        <MajorPane>0</MajorPane>
        <ZOrder>0</ZOrder>
        <X>0.5</X>
        <Y>0.5</Y>
        <Height>0.5</Height>
        <Width>0.5</Width>
        <PaneId>0</PaneId>
    </Panes>
</Layouts>
</DescribeMPULayoutInfoListResponse>

JSON格式 

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

{
  "TotalNum" : "1",
  "TotalPage" : "1",
  "RequestId" : "760bad53276431c499e30dc36f6b26be",
  "Layouts" : [ {
    "AudioMixCount" : "3",
    "LayoutId" : "2",
    "Name" : "LayoutName",
    "Panes" : [ {
      "MajorPane" : "0",
      "ZOrder" : "0",
      "X" : "0.5",
      "Y" : "0.5",
      "Height" : "0.5",
      "Width" : "0.5",
      "PaneId" : "0"
    } ]
  } ]
}