AddStudioLayout API による仮想スタジオレイアウト設定 - LIVE

操作説明

この操作を呼び出して、仮想プロダクションスタジオのレイアウト設定を追加できます。この操作は、コモンレイアウトとスタジオレイアウトの両方をサポートしています。

QPS 制限

この操作の 1 ユーザーあたりの QPS (クエリ/秒) 制限は 10 です。この制限を超えると、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:AddStudioLayout

create

*Caster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
CasterId	string	必須	プロダクションスタジオの ID。重要事前に仮想プロダクションスタジオを作成してください。プロダクションスタジオは、コンソールで作成するか、CreateCaster API 操作を呼び出して作成できます。プロダクションスタジオは仮想プロダクションスタジオである必要があります。 CreateCaster API 操作を呼び出してプロダクションスタジオを作成する場合、返された CasterId 値を使用します。 ApsaraVideo Live コンソールでプロダクションスタジオを作成する場合、[ApsaraVideo Live コンソール] > [プロダクションスタジオ] > [クラウドプロダクションスタジオ] ページに移動します。リスト内のプロダクションスタジオの名前がその ID です。説明 [クラウドプロダクションスタジオ] ページのリストにあるプロダクションスタジオ名は、プロダクションスタジオ ID です。	a2b8e671-2fe5-4642-a2ec-bf93880e****
LayoutName	string	必須	スタジオレイアウトの名前。	测试布局
LayoutType	string	必須	スタジオレイアウトのタイプ。有効値： common：コモンレイアウト。LayoutType を common に設定する場合は、CommonConfig も指定する必要があります。 studio：スタジオレイアウト。LayoutType を studio に設定する場合は、BgImageConfig と ScreenInputConfigList も指定する必要があります。MediaInputConfigList パラメーターはオプションです。	studio
CommonConfig	string	任意	コモンレイアウトの構成。値は JSON 文字列です。詳細については、「CommonConfig」をご参照ください。重要このパラメーターは、LayoutType を common に設定した場合にのみ必須です。	{"ChannelId":"RV01" }
BgImageConfig	string	任意	背景リソースの構成。値は JSON 文字列です。詳細については、「BgImageConfig」をご参照ください。重要このパラメーターは、LayoutType を studio に設定した場合にのみ必須です。	{ "Id":"k12kj31**", "MaterialId":"f080575eb5f4427684fc0715159a**" }
ScreenInputConfigList	string	任意	クロマキー入力の設定。値は JSON 文字列です。詳細については、「ScreenInputConfig」をご参照ください。重要このパラメーターは、LayoutType を studio に設定した場合にのみ必須です。	[ { "Index":"1", "ChannelId":"RV01", "Color":"green", "PositionX":"0.1", "PositionY":"0.2", "HeightNormalized":"0.4" } ]
MediaInputConfigList	string	任意	マルチメディア入力リソースの設定。値は JSON 文字列です。詳細については、「MediaInputConfig」をご参照ください。重要このパラメーターは、LayoutType を studio に設定した場合にのみ有効かつオプションです。	[ { "Id":"k12kj31**", "Index":"1", "ChannelId":"RV01", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.4", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" }, { "Id":"k12kj31", "Index":"2", "ImageMaterialId":"lkajsdfsa8fd89asd8**", "FillMode":"none", "PositionRefer":"topLeft", "WidthNormalized":"0.6", "HeightNormalized":"0.4", "PositionNormalized":"[0.1, 0.2]" } ]
LayerOrderConfigList	string	任意	レイヤー順序の設定。値は JSON 文字列です。詳細については、「LayerOrderConfig」をご参照ください。背景素材とマルチメディア素材をソートできます。クロマキーレイヤーはサポートされていません。リスト内で素材が先に表示されるほど、そのレイヤーは下になります。	[ { "Type":"media", "Id":"k12kj31**" }, { "Type":"media", "Id":"k12kj31**" } ]

CommonConfig

名前	タイプ	例	説明
ChannelId	String	RV01	ビデオリソースがアタッチされているチャンネルの ID。

BgImageConfig

説明

ImageUrl または MaterialId のいずれか 1 つのみを指定してください。

名前	タイプ	例	説明
Id	String	k12kj31****	背景素材の一意の ID。
ImageUrl	String	http://aliyundoc.com	素材の URL。
MaterialId	String	f080575eb5f4427684fc0715159a****	ビデオ・オン・デマンド (VOD) 素材の ID。

ScreenInputConfig

名前	タイプ	例	説明
Index	Integer	1	クロマキーソースの番号。このパラメーターはフロントエンドでの表示用であり、論理的な機能はありません。0 より大きい正の整数である必要があります。
ChannelId	String	RV01	ビデオリソースがアタッチされているチャンネルの ID。
Color	String	green	クロマキーの色。有効値：blue：ブルースクリーンの背景。green：グリーンスクリーンの背景。auto：自動検出。complex：リアルシーンクロマキー。
PositionX	Float	0.1	x 座標。値は [0, 1] の範囲内である必要があります。左上隅が素材の位置の基準点です。
PositionY	Float	0.2	y 座標。値は [0, 1] の範囲内である必要があります。左上隅が素材の位置の基準点です。
HeightNormalized	Float	0.4	正規化された高さ。これは、キーアウトされた人物像の高さと背景の高さの比率です。値は [0, 1] の範囲内である必要があります。

MediaInputConfig

マルチメディア素材がビデオソースの場合は ChannelId を指定します。
マルチメディア素材がイメージの場合は ImageMaterialId を指定します。
ChannelId と ImageMaterialId は相互排他的です。いずれか 1 つのみを指定してください。

名前	タイプ	例	説明
Id	String	k12kj31****	マルチメディア素材の一意の ID。
Index	Integer	1	マルチメディア素材の番号。このパラメーターはフロントエンドでの表示用であり、論理的な機能はありません。0 より大きい正の整数である必要があります。
ChannelId	String	RV01	ビデオリソースがアタッチされているチャンネルの ID。
ImageMaterialId	String	lkajsdfsa8fd89asd8****	VOD イメージ素材の ID。
FillMode	String	none	塗りつぶしタイプ。これを none に設定します。
PositionRefer	String	topLeft	素材の位置の基準点。これを topLeft に設定します。これは、左上隅が基準点であることを示します。
WidthNormalized	Float	0.4	素材の正規化された幅。これは、素材の幅と背景の幅の比率です。値は [0, 1] の範囲内である必要があります。
HeightNormalized	Float	0.4	素材の正規化された高さ。これは、素材の高さと背景の高さの比率です。値は [0, 1] の範囲内である必要があります。
PositionNormalized	Float	[0.1, 0.2]	素材の塗りつぶしエリアの正規化された位置 [x, y]。x と y の値は [0, 1] の範囲内である必要があります。例えば、[0.1, 0.2] は、左上隅から水平方向に 10%、垂直方向に 20% のオフセットを示します。

LayerOrderConfig

名前	タイプ	例	説明
Type	String	media	リソース構成のタイプ。background：背景素材。media：マルチメディア素材。
Id	String	k12kj31****	リソースの一意の ID。

レスポンスフィールド

フィールド	型	説明	例
	object
LayoutId	string	レイアウト ID。この ID を使用して、仮想プロダクションスタジオのレイアウトを削除、変更、またはクエリします。	445409ec-7eaa-461d-8f29-4bec2eb9****
RequestId	string	リクエスト ID。	5c6a2a0d-f228-4a64-af62-20e91b96****

例

成功レスポンス

JSONJSON

{
  "LayoutId": "445409ec-7eaa-461d-8f29-4bec2eb9****",
  "RequestId": "5c6a2a0d-f228-4a64-af62-20e91b96****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	MissingParameter	%s.
400	InvalidParameter.Malformed	There are invalid parameters: %s.
400	InvalidCasterId.Malformed	%s, please check and try again later.
400	InvalidUserId.Malformed	%s, please check userId.
400	InvalidPositionNormalized.Malformed	%s, please check and try again later.
400	InvalidHeightOrWidthNormalized	%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.

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

変更履歴

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