ModifyCasterLayout - - Alibaba Cloud ドキュメントセンター

レイアウト構成を変更します。変更したいパラメーターのみを渡す必要があります。

操作説明

まず、CreateCaster 操作を呼び出してプロダクションスタジオを作成します。その後、この操作を呼び出してレイアウト構成を変更できます。変更したいパラメーターのみを渡す必要があります。この操作は、要素に対して `none` (デフォルト) と `fit` の塗りつぶしモードをサポートしています。

QPS 制限

この操作の 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:ModifyCasterLayout

update

*Caster

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-shanghai
VideoLayer	array<object>	必須	ビデオ情報。
	object	任意	ビデオ情報。
FillMode	string	任意	要素の塗りつぶしモード。 none (デフォルト)：元のビデオフレームサイズがスケーリングなしで使用されます。 fit：元の縦横比を維持したまま、ビデオを塗りつぶしエリアに合わせてスケーリングします。ビデオは塗りつぶしエリアの中央に配置されます。ビデオフレームの長辺が塗りつぶしエリアの対応する辺に揃えられます。縦横比が一致しない場合、短辺に沿った空白スペースには下のレイヤーが表示されます。下にレイヤーがない場合、空白スペースは黒になります。	fit
FixedDelayDuration	integer	任意	ビデオの固定遅延。字幕を同期するために使用します。単位：ミリ秒。デフォルト値：0。有効な値：0～5000。	5000
HeightNormalized	number	任意	レイヤー要素の正規化された高さ。 none 塗りつぶしモードでは、この高さに基づいて幅が比例的にスケーリングされます。デフォルト値は 0 で、元のフレームサイズを表示します。 fit モードでは、このパラメーターは必須であり、その値は 0 より大きくなければなりません。塗りつぶしエリアの正規化された高さを指定します。	1
PositionNormalized	array	任意	レイヤー要素の正規化された座標。フォーマットは `[x,y]` です。デフォルト値は `[0,0]` です。説明 x と y の値は正規化する必要があります。	0.3
	number	任意	レイヤー要素の正規化された座標。フォーマットは `[x,y]` です。デフォルト値は `[0,0]` です。説明 x と y の値は正規化する必要があります。	[0,3]
PositionRefer	string	任意	要素の位置の基準点。有効な値： topLeft (デフォルト)：左上隅。 topRight：右上隅。 bottomLeft：左下隅。 bottomRight：右下隅。 center：中央。 topCenter：上部中央。 bottomCenter：下部中央。 leftCenter：左中央。 rightCenter：右中央。	topLeft
WidthNormalized	number	任意	レイヤー要素の正規化された幅。 none 塗りつぶしモードでは、この幅に基づいて高さが比例的にスケーリングされます。デフォルト値は 0 で、元のフレームサイズを表示します。 fit モードでは、このパラメーターは必須であり、その値は 0 より大きくなければなりません。塗りつぶしエリアの正規化された幅を指定します。	1
AudioLayer	array<object>	必須	オーディオ情報。
	object	任意	オーディオ情報。
FixedDelayDuration	integer	任意	オーディオの固定遅延。字幕を同期するために使用します。単位：ミリ秒。デフォルト値：0。有効な値：0～5000。	5000
ValidChannel	string	任意	ボリューム入力に使用されるオーディオチャンネル。有効な値： leftChannel：左チャンネル。 rightChannel：右チャンネル。 all (デフォルト)：両方のチャンネル。	all
VolumeRate	number	任意	レイヤー要素の正規化された高さの比率です。縦横比を維持するため、幅は比例して拡大・縮小されます。デフォルト値は 0 です。この値は、要素が元のサイズで表示されることを意味します。	1
BlendList	array	必須	ビデオソースのロケーション ID。これは LocationId パラメーターに対応します。詳細については、AddCasterVideoResource をご参照ください。このリスト内の ID の順序は、VideoLayer リスト内の要素の順序と一致する必要があります。	RV02
	string	任意	ビデオソースのロケーション ID。これは LocationId パラメーターに対応します。詳細については、AddCasterVideoResource をご参照ください。このリスト内の ID の順序は、VideoLayer リスト内の要素の順序と一致する必要があります。	RV02
MixList	array	必須	オーディオソースのロケーション ID。これは LocationId パラメーターに対応します。詳細については、AddCasterVideoResource をご参照ください。このリスト内の ID の順序は、AudioLayer リスト内の要素の順序と一致する必要があります。	RV02
	string	任意	オーディオソースのロケーション ID。これは LocationId パラメーターに対応します。詳細については、AddCasterVideoResource をご参照ください。このリスト内の ID の順序は、AudioLayer リスト内の要素の順序と一致する必要があります。	RV02
CasterId	string	必須	プロダクションスタジオの ID。 CreateCaster 操作を使用してプロダクションスタジオを作成した場合、返された CasterId の値を使用します。 ApsaraVideo Live コンソールでプロダクションスタジオを作成した場合、[プロダクションスタジオ] > [クラウドプロダクションスタジオ] ページで ID を見つけます。説明クラウドプロダクションスタジオページのリストにあるプロダクションスタジオ名は、プロダクションスタジオ ID です。	LIVEPRODUCER_POST-cn-0pp1czt****
LayoutId	string	必須	レイアウト ID。AddCasterLayout 操作を使用してレイアウトを追加した場合、返された LayoutId の値を使用します。	21926b36-7dd2-4fde-ae25-51b5bc8e****

説明

リクエストパラメーターにおいて、N は要素のシーケンス番号を示します。たとえば、VideoLayer.1.FillMode は最初の要素の塗りつぶしモードを指定し、VideoLayer.2.FillMode は 2 番目の要素の塗りつぶしモードを指定します。

レスポンスフィールド

フィールド	型	説明	例
	object
LayoutId	string	レイアウト ID。この ID を使用して、プロダクションスタジオのレイアウトのリストをクエリします。	21926b36-7dd2-4fde-ae25-51b5bc8e****
RequestId	string	リクエスト ID。	16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

例

成功レスポンス

JSONJSON

{
  "LayoutId": "21926b36-7dd2-4fde-ae25-51b5bc8e****",
  "RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidCasterId.Malformed	%s, please check and try again later.
400	InvalidUserId.Malformed	%s, please check userId.
400	InvalidLayoutId.Malformed	%s, please check and try again later.
400	InvalidParameter.Malformed	There are invalid parameters: %s.
400	InvalidVideoLayersAndBlendListSize.Mismatch	%s, please check and try again later.
400	InvalidAudioLayersAndMixListSize.Mismatch	%s, please check and try again later.
400	InvalidPositionNormalized.Malformed	%s, please check and try again later.
400	InvalidBlendList.ExceedNorm	%s, please check and try again later.
400	InvalidMixList.ExceedNorm	%s, please check and try again later.
400	InvalidHeightOrWidthNormalized	%s, please check and try again later.
400	InvalidVideoLayersConfig	%s, please check and try again later.
400	InvalidAudioLayersConfig	%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.
404	InvalidLayout.NotFound	%s, please check and try again later.

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

変更履歴

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