制作スタジオの指定されたレイアウトまたはすべてのレイアウトを照会します。

使用状況ノート

レイアウトIDがリクエストに提供されている場合、サーバーは特定のレイアウトの情報を返します。 レイアウトIDが指定されていない場合、サーバーはすべてのレイアウトを返します。

QPS limit

1人のユーザーが1秒あたり最大10件のクエリ (QPS) を実行できます。 1秒あたりの呼び出し数がQPS制限を超えると、スロットリングがトリガーされます。 スロットルはビジネスに影響を与える可能性があります。 したがって、この操作のQPS制限を遵守することをお勧めします。 シングルユーザーの意味とQPSの詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 DescribeCasterLayouts

実行したい操作。 この値をDescribeCasterLayoutsに設定します。

CasterId String 必須 9ff2d96b-37ef-40a3-8cb0-4c7b1e2e ****

制作スタジオのID。

CreateCaster インターフェイスを使用して制作スタジオを作成する場合は、レスポンスのCasterIdパラメーターの値を確認します。

ApsaraVideo Live Consoleを使用して制作スタジオを作成する場合は、コンソールにログインし、次のパスを使用して制作スタジオのIDを確認します。

制作スタジオ > 制作スタジオ管理

CasterIdは、Production Studio Managementページの [名前] 列に反映されます。
LayoutId String 任意 72d2ec7a-4cd7-4a01-974b-7cd53947 ****

レイアウトのID。

このパラメーターを設定しないと、制作スタジオのすべてのレイアウトが照会されます。

レスポンスパラメーター

パラメーター データ型 説明
RequestId String 3be7ade8-d907-483c-b24a-0dad4595beaf

リクエストの ID です。

レイアウト レイアウトの配列

レイアウトのリスト。

レイアウト
LayoutId String 72d2ec7a-4cd7-4a01-974b-7cd53947 ****

レイアウトのID。

VideoLayers VideoLayerの配列

既定の配列シーケンスを使用した、ビデオレイヤーの構成リスト。

VideoLayer
HeightNormalized Float 0.5

ビデオレイヤー画像の高さの正規化された値。

  • ビデオレイヤーのFillModeパラメーターがnoneの場合、ビデオ画像の幅はこのパラメーターに基づいてスケーリングされます。 デフォルト値はで、これはビデオ画像が元のサイズで表示されることを示します。
  • ビデオレイヤーのFillModeパラメーターが適合する場合、このパラメーターをより大きい値に設定する必要があります。これは、セクションの高さの正規化された値を示します。
WidthNormalized Float 0.5

ビデオレイヤー画像の幅の正規化された値。

  • ビデオレイヤーのFillModeパラメーターがnoneの場合、ビデオ画像の高さはこのパラメーターに基づいてスケーリングされます。 デフォルト値はで、これはビデオ画像が元のサイズで表示されることを示します。
  • ビデオレイヤーのFillModeパラメーターが適合する場合、このパラメーターをより大きい値に設定する必要があります。これは、セクションの幅の正規化された値を示します。
PositionNormalizeds List [0,3]

プロダクションスタジオのビデオレイヤーの [x,y] 座標の正規化された値。 デフォルトの座標は [0,0] です。

PositionRefer String topLeft

The reference coordinates of the video layer. Default value: topLeft. 設定可能な値は以下のとおりです。

  • topLeft: 左上隅
  • topRight: the upper-right corner.
  • bottomLeft: 左下隅。
  • bottomRight: 右下隅。
  • center: the center position.
  • topCenter: the upper center position.
  • bottomCenter: the lower center position.
  • leftCenter: the left center position.
  • rightCenter: the right center position.
FillMode String fit

ビデオレイヤーのスケーリングモード。 デフォルト値 : none。 設定可能な値は以下のとおりです。

  • none: 指定されたレイアウトセクションを塗りつぶすようにイメージがスケーリングされません。 ビデオレイヤは、ビデオリソースの画像サイズに基づいて設定される。
  • フィット感: 指定したレイアウトセクションを埋めるために、イメージが元のアスペクト比でスケーリングされます。 ビデオレイヤーは、セクションサイズに基づいて設定されます。 画像はレイアウトセクションの中央に配置され、画像の長辺はセクションの同じ辺の長さに合わせてスケーリングされます。 画像のアスペクト比が断面のアスペクト比と同じでない場合、画像の短辺が断面の短辺よりも短くなる可能性がある。 画像の外側の領域は、次のビデオレイヤまたは次のビデオレイヤが存在しない場合は背景を表示します。 By default, the background color is black.
FixedDelayDuration Integer 20

ビデオレイヤーの固定遅延。 このパラメータは、ビデオと字幕を同期するために使用されます。

単位: ミリ秒。 デフォルト値: 0 Valid values: 0 to 5000.

AudioLayers AudioLayerの配列

オーディオレイヤの設定リスト。

AudioLayer
VolumeRate Float 1

The normalized value of heights for the elements in the audio layer. 要素の幅は、このパラメータに基づいてスケーリングされます。

デフォルト値は0です。これは、オーディオレイヤーの要素がスケーリングされないことを示します。
ValidChannel String all

オーディオレイヤの有効な音声チャネル。 Default value: all. 設定可能な値は以下のとおりです。

  • leftChannel: the left channel.
  • rightChannel: 右チャンネル。
  • all: both the left and right channels.
FixedDelayDuration Integer 20

ビデオレイヤーの固定遅延。 このパラメータは、ビデオと字幕を同期するために使用されます。

単位: ミリ秒。 デフォルト値: 0 有効値: 0〜5000

BlendList List "RV01" 、"RV02"

The location ID of the video layer in the production studio. このパラメーターで指定されたビデオレイヤーは、VideoLayersパラメーターで指定されたものと同じ順序です。

MixList List RV01

プロダクションスタジオのオーディオレイヤーの位置ID。 このパラメーターで指定されたオーディオレイヤーは、AudioLayersパラメーターで指定されたものと同じ順序です。

Total Integer 3

返されたレコードの総数。

リクエストの例

http(s):// live.aliyuncs.com/?Action=DescribeCasterLayouts
&CasterId=9ff2d96b-37ef-40a3-8cb0-4c7b1e2e ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

<DescribeCasterLayoutsResponse>
  <RequestId>3be7ade8-d907-483c-b24a-0dad4595beaf</RequestId>
  <レイアウト>
        <レイアウト>
              <LayoutId>72d2ec7a-4cd7-4a01-974b-7cd53947 ****</LayoutId>
              <AudioLayers>
                    <AudioLayer>
                          <ValidChannel> すべて </ValidChannel>
                          <VolumeRate>1</VolumeRate>
                          <FixedDelayDuration>20</FixedDelayDuration>
                    </AudioLayer>
              </AudioLayers>
              <VideoLayers>
                    <VideoLayer>
                          <FillMode> フィット </FillMode>
                          <HeightNormalized>0.5</HeightNormalized>
                          <PositionRefer>topLeft</PositionRefer>
                          <FixedDelayDuration>20</FixedDelayDuration>
                          <WidthNormalized>0.5</WidthNormalized>
                          <PositionNormalizeds>
                                <位置>[0,3]</位置>
                          </PositionNormalizeds>
                    </VideoLayer>
              </VideoLayers>
              <BlendList>
                    <LocationId>"RV01",  "RV02"</LocationId>
              </BlendList>
              <MixList>
                    <LocationId>RV01</LocationId>
              </MixList>
        </レイアウト>
  </レイアウト>
  <合計> 3</合計>
</DescribeCasterLayoutsResponse>

JSON 形式

{
    "RequestId": "3be7ade8-d907-483c-b24a-0dad4595beaf" 、
    "レイアウト": {
        "レイアウト": [
            {
                "LayoutId": "72d2ec7a-4cd7-4a01-974b-7cd53947 ****" 、
                "AudioLayers": {
                    "AudioLayer": [
                        {
                            "ValidChannel": "すべて" 、
                            "VolumeRate": "1" 、
                            "FixedDelayDuration": "20"
                        }
                    ]
                },
                "VideoLayers": {
                    "VideoLayer": [
                        {
                            "FillMode": "フィット" 、
                            "HeightNormalized": "0.5" 、
                            "PositionRefer": "topLeft" 、
                            "FixedDelayDuration": "20" 、
                            "WidthNormalized": "0.5" 、
                            "PositionNormalizeds": {
                                "ポジション": "[0,3]"
                            }
                        }
                    ]
                },
                "BlendList": {
                    "LocationId": "\" RV01\", \" RV02\"""
                },
                "MixList": {
                    "LocationId": "RV01"
                }
            }
        ]
    },
    "合計": "3"
}

エラー

エラーコードリストについては、「API エラーセンター」をご参照ください。