すべてのプロダクト
Search

このプロダクト

    ApsaraVideo Live:DescribeStudioLayouts

    ドキュメントセンター

    ApsaraVideo Live:DescribeStudioLayouts

    最終更新日:Jun 09, 2026

    仮想スタジオの 1 つ以上のレイアウトを照会します。

    操作説明

    仮想プロダクションスタジオにレイアウトを追加するには、まず AddStudioLayout オペレーションを呼び出す必要があります。その後、このオペレーションを呼び出して、レイアウト設定を照会できます。

    QPS 制限

    このオペレーションの 1 秒あたりのクエリ数 (QPS) は、ユーザーあたり最大 15 です。この制限を超える呼び出しはスロットリングされ、ビジネスに影響を及ぼす可能性があります。この点を考慮し、計画的に呼び出しを行ってください。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    live:DescribeStudioLayouts

    get

    *Caster

    acs:live:*:{#accountId}:caster/{#CasterId}

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    任意

    リージョン ID。

    cn-shanghai
    CasterId

    string

    必須

    プロダクションスタジオの ID。

    • CreateCaster API を呼び出してプロダクションスタジオを作成した場合、返された CasterId を使用します。

    • ApsaraVideo Live コンソールでプロダクションスタジオを作成した場合、[ApsaraVideo Live コンソール] > [プロダクションスタジオ] > [クラウドプロダクションスタジオ] ページに移動して ID を確認します。

    説明

    [クラウドプロダクションスタジオ] ページのリストにあるプロダクションスタジオ名は、プロダクションスタジオの ID です。

    5c6a2a0d-f228-4a64-af62-20e91b96****
    LayoutId

    string

    任意

    レイアウト ID。複数のレイアウト ID を指定するには、コンマ (,) で区切ります。このパラメーターを空のままにすると、プロダクションスタジオのすべてのレイアウトが返されます。

    AddStudioLayout API を呼び出してレイアウトを追加した場合、返された LayoutId を使用します。

    445409ec-7eaa-461d-8f29-4bec2eb9****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レイアウトの詳細。

    RequestId

    string

    リクエスト ID。

    5c6a2a0d-f228-4a64-af62-20e91b9676b3
    StudioLayouts

    array<object>

    レイアウトの詳細。

    array<object>

    レイアウトの詳細。

    BgImageConfig

    object

    背景リソースの設定。

    Id

    string

    背景素材の一意の ID。

    k12kj31****
    ImageUrl

    string

    素材の URL。

    http://example.org
    LocationId

    string

    ポジション ID。

    RV01
    MaterialId

    string

    ビデオオンデマンド (VOD) 素材の ID。

    asdfas9df89asd8f9****
    CommonConfig

    object

    共通レイアウトに関する情報。レイアウトが共通レイアウトの場合、このパラメーターが返されます。

    ChannelId

    string

    ビデオソースがアタッチされているチャネルの ID。

    RV01
    VideoResourceId

    string

    ビデオソースの ID。

    asdfasdfasdfasdfa****
    LayerOrderConfigList

    array<object>

    レイヤー順序の設定。

    object

    レイヤー順序の設定。

    Id

    string

    リソースの一意の ID。

    k12kj31****
    Type

    string

    リソース設定のタイプ。有効な値：

    • background： 背景素材。

    • media： マルチメディア素材。

    media
    LayoutId

    string

    プロダクションスタジオレイアウトの ID。

    445409ec-7eaa-461d-8f29-4bec2eb9****
    LayoutName

    string

    プロダクションスタジオレイアウトの名前。

    Test layout
    LayoutType

    string

    プロダクションスタジオレイアウトのタイプ。有効な値：

    • common： 共通レイアウト。

    • studio： プロダクションスタジオレイアウト。

    studio
    MediaInputConfigList

    array<object>

    マルチメディア入力リソースの設定。

    object

    マルチメディア入力ソースの設定。

    ChannelId

    string

    ビデオソースがアタッチされているチャネルの ID。

    RV01
    FillMode

    string

    フィルモード。デフォルト値は none です。

    none
    HeightNormalized

    number

    素材の正規化された高さ。これは、素材の高さと背景の高さの比率です。有効な値： 0～1。

    0.4
    Id

    string

    マルチメディア素材の一意の ID。

    k12kj31****
    ImageMaterialId

    string

    VOD 画像素材の ID。

    lkajsdfsa8fd89asd8****
    Index

    integer

    マルチメディア素材のインデックス。このパラメーターはフロントエンドでの表示用であり、論理的な機能はありません。

    1
    PositionNormalized

    array

    素材の塗りつぶし領域の正規化された座標。 [x,y] 形式です。x と y の値の範囲は 0～1 です。たとえば、[0.1,0.2] は、左上隅から水平方向に 10%、垂直方向に 20% のオフセットを示します。

    number

    素材の塗りつぶし領域の正規化された座標。[x,y] 形式です。x と y の値の範囲は 0～1 です。たとえば、[0.1,0.2] は、左上隅から水平方向に 10%、垂直方向に 20% のオフセットを示します。

    0.1
    PositionRefer

    string

    素材の位置の基準点。デフォルト値は topLeft で、左上隅が基準点であることを示します。

    topLeft
    VideoResourceId

    string

    ビデオソースの ID。

    asdfasdfasdfasdfa****
    WidthNormalized

    number

    素材の正規化された幅。これは、素材の幅と背景の幅の比率です。有効な値： 0～1。

    0.4
    ScreenInputConfigList

    array<object>

    クロマキー入力の設定。

    array<object>

    クロマキー入力の設定。

    AudioConfig

    object

    音声設定。

    ValidChannel

    string

    対応するチャネル。

    1
    VolumeRate

    number

    音量。

    1.0
    ChannelId

    string

    ビデオソースがアタッチされているチャネルの ID。

    RV01
    Color

    string

    クロマキーの色。有効な値：

    • blue： ブルーバック。

    • green： グリーンバック。

    • auto： 自動検出。

    • complex： リアルシーンマッティング。

    green
    HeightNormalized

    number

    正規化された高さ。これは、キーイングされたポートレートの高さと背景の高さの比率です。有効な値： 0～1。

    0.4
    Id

    string

    クロマキーソース素材の一意の ID。

    k12kj31****
    Index

    integer

    クロマキーソースのインデックス。このパラメーターはフロントエンドでの表示用であり、論理的な機能はありません。

    1
    OnlyAudio

    boolean

    音声のみ。

    true
    PortraitType

    integer

    ポートレートタイプ。有効な値：

    • 0： 半身。

    • 1： 全身。

    0
    PositionX

    string

    x 座標。有効な値： 0～1。素材の位置の基準点は左上隅です。

    0.1
    PositionY

    string

    y 座標。有効な値： 0～1。素材の位置の基準点は左上隅です。

    0.2
    VideoResourceId

    string

    ビデオソースの ID。

    asdfasdfasdfasdfa****
    Total

    integer

    レイアウトの総数。

    1

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b9676b3",
  "StudioLayouts": [
    {
      "BgImageConfig": {
        "Id": "k12kj31****",
        "ImageUrl": " http://example.org",
        "LocationId": "RV01",
        "MaterialId": "asdfas9df89asd8f9****"
      },
      "CommonConfig": {
        "ChannelId": "RV01",
        "VideoResourceId": "asdfasdfasdfasdfa****"
      },
      "LayerOrderConfigList": [
        {
          "Id": "k12kj31****",
          "Type": "media"
        }
      ],
      "LayoutId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
      "LayoutName": "Test layout",
      "LayoutType": "studio",
      "MediaInputConfigList": [
        {
          "ChannelId": "RV01",
          "FillMode": "none",
          "HeightNormalized": 0.4,
          "Id": "k12kj31****",
          "ImageMaterialId": "lkajsdfsa8fd89asd8****",
          "Index": 1,
          "PositionNormalized": [
            0.1
          ],
          "PositionRefer": "topLeft",
          "VideoResourceId": "asdfasdfasdfasdfa****",
          "WidthNormalized": 0.4
        }
      ],
      "ScreenInputConfigList": [
        {
          "AudioConfig": {
            "ValidChannel": "1",
            "VolumeRate": 1
          },
          "ChannelId": "RV01",
          "Color": "green",
          "HeightNormalized": 0.4,
          "Id": "k12kj31****",
          "Index": 1,
          "OnlyAudio": true,
          "PortraitType": 0,
          "PositionX": "0.1",
          "PositionY": "0.2",
          "VideoResourceId": "asdfasdfasdfasdfa****"
        }
      ]
    }
  ],
  "Total": 1
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidUserId.Malformed %s, please check userId.
    400 InvalidCasterId.Malformed %s, please check and try again later.
    401 IllegalOperation %s, please check and try again later.
    500 InternalError %s, please try again later.
    404 InvalidCaster.NotFound %s, please check and try again later.

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。