DescribeCasterLayouts でライブスタジオレイアウト設定を取得 - LIVE

プロダクションスタジオのレイアウトを照会します。

操作説明

この API 操作を呼び出して、プロダクションスタジオのレイアウトを照会できます。レイアウト ID を指定しない場合、スタジオのすべてのレイアウトが返されます。

QPS 制限

この API 操作の 1 秒あたりのクエリ数 (QPS) 制限は、ユーザーごとに 1 秒あたり 15 回の呼び出しです。この制限を超えると、API 呼び出しがスロットルされます。これはビジネスに影響を与える可能性があるため、この API 操作は適切なレートで呼び出す必要があります。

今すぐお試しください

この 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:DescribeCasterLayouts

get

*Caster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
CasterId	string	必須	プロダクションスタジオの ID。 CreateCaster 操作を呼び出してプロダクションスタジオを作成した場合は、レスポンスで返された CasterId 値を使用します。 LIVE コンソールでプロダクションスタジオを作成した場合は、[プロダクションスタジオ] > [クラウドプロダクションスタジオ] ページで ID を確認します。説明クラウドプロダクションスタジオページのリストにあるプロダクションスタジオの名前は、プロダクションスタジオ ID です。	LIVEPRODUCER_POST-cn-0pp1czt****
LayoutId	string	任意	レイアウト ID。 LayoutId の値を指定しない場合、プロダクションスタジオのすべてのレイアウトが返されます。	72d2ec7a-4cd7-4a01-974b-7cd53947****

レスポンスフィールド

フィールド	型	説明	例
	object
Layouts	object
Layout	array<object>	レイアウトリスト。
	array<object>	レイアウトリスト。
AudioLayers	object
AudioLayer	array<object>	AudioLayer 設定のリスト。
	object	AudioLayer 設定のリスト。
FixedDelayDuration	integer	音声の固定レイテンシ。キャプションの同期に使用できます。単位：ミリ秒 (ms)。デフォルト値：0。有効な値：0 から 5000。	20
ValidChannel	string	音声入力に使用できるサウンドチャンネル。有効な値： leftChannel：左サウンドチャンネル。 rightChannel：右サウンドチャンネル。 all (デフォルト)：両方のサウンドチャンネル。	all
VolumeRate	number	音量率。値 1 は元の音量を示します。説明デフォルト値は 0 です。これは、要素を元のサイズで表示します。	1
BlendList	object
LocationId	array	関連付けられたポジションのリスト。順序は VideoLayers と同じです。
	string	ポジション ID。	RV01
LayoutId	string	レイアウト ID。	72d2ec7a-4cd7-4a01-974b-7cd53947****
MixList	object
LocationId	array	関連付けられたポジションのリスト。順序は AudioLayers と同じです。
	string	ポジション ID。	RV01
VideoLayers	object
VideoLayer	array<object>	VideoLayer 設定のリスト。デフォルトの配列シーケンスが使用されます。
	array<object>	VideoLayer 設定のリスト。デフォルトの配列シーケンスが使用されます。
FillMode	string	要素の塗りつぶしモード。有効な値： none (デフォルト)：塗りつぶしなし。レイヤーはビデオフレームに基づいて構成されます。 fit：フィット。レイヤーは塗りつぶし領域に基づいて構成されます。ビデオフレームは元の縦横比でスケーリングされ、塗りつぶし領域の長い方の辺に収まり、中央に配置されます。塗りつぶし領域の縦横比がビデオフレームの縦横比と異なる場合、下のレイヤーが塗りつぶされていない領域に表示されます。下にレイヤーが構成されていない場合、背景は黒になります。	fit
FixedDelayDuration	integer	ビデオに設定された固定レイテンシ。キャプションの同期に使用できます。単位：ミリ秒 (ms)。デフォルト値：0。有効な値：0 から 5000。	20
HeightNormalized	number	レイヤー要素の正規化された高さ。塗りつぶしモードが none の場合、要素の幅はこの高さに基づいて比例的にスケーリングされます。デフォルト値は 0 で、ビデオが元のサイズで表示されることを意味します。塗りつぶしモードが fit の場合、このパラメーターは必須であり、0 より大きい必要があります。塗りつぶし領域の正規化された高さを表します。	0.5
PositionNormalizeds	object
Position	array	`[x,y]` 形式のレイヤー要素の正規化された位置。デフォルト値は `[0,0]` です。説明 x 座標と y 座標は正規化する必要があります。
	number	値。	0
PositionRefer	string	要素の位置の基準点。有効な値： topLeft (デフォルト)：左上。 topRight：右上。 bottomLeft：左下。 bottomRight：右下。 center：中央。 topCenter：中央上。 bottomCenter：中央下。 leftCenter：中央左。 rightCenter：中央右。	topLeft
WidthNormalized	number	レイヤー要素の正規化された幅。塗りつぶしモードが none の場合、要素の高さはこの幅に基づいて比例的にスケーリングされます。デフォルト値は 0 で、ビデオが元のサイズで表示されることを意味します。塗りつぶしモードが fit の場合、このパラメーターは必須であり、0 より大きい必要があります。塗りつぶし領域の正規化された幅を表します。	0.5
RequestId	string	リクエスト ID。	3be7ade8-d907-483c-b24a-0dad45****
Total	integer	レコードの総数。	3

例

成功レスポンス

JSONJSON

{
  "Layouts": {
    "Layout": [
      {
        "AudioLayers": {
          "AudioLayer": [
            {
              "FixedDelayDuration": 20,
              "ValidChannel": "all",
              "VolumeRate": 1
            }
          ]
        },
        "BlendList": {
          "LocationId": [
            "RV01"
          ]
        },
        "LayoutId": "72d2ec7a-4cd7-4a01-974b-7cd53947****",
        "MixList": {
          "LocationId": [
            "RV01"
          ]
        },
        "VideoLayers": {
          "VideoLayer": [
            {
              "FillMode": "fit",
              "FixedDelayDuration": 20,
              "HeightNormalized": 0.5,
              "PositionNormalizeds": {
                "Position": [
                  0
                ]
              },
              "PositionRefer": "topLeft",
              "WidthNormalized": 0.5
            }
          ]
        }
      }
    ]
  },
  "RequestId": "3be7ade8-d907-483c-b24a-0dad45****",
  "Total": 3
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
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.

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

変更履歴

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