API でキャスターレイアウト設定を更新 - LIVE - Alibaba Cloud - ApsaraVideo Live

レイアウト構成を変更します。変更済みの項目のみを渡す必要があります。変更が不要な項目は含める必要はありません。

操作説明

まず CreateCaster 操作を呼び出してプロダクションスタジオを作成し、その後この操作を呼び出してレイアウト構成を変更します。変更済みの項目のみを渡す必要があります。変更が不要な項目は含める必要はありません。この操作は現在、デフォルトとアダプティブの要素塗りつぶしモードをサポートしています。

QPS 制限

この操作のシングルユーザー QPS 制限は 1 秒あたり 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	任意	レイヤー要素の正規化された高さ比率。塗りつぶしなしモードを使用する場合、要素の幅はこの高さに基づいて比例的にスケーリングされます。デフォルト値: 0。イメージが元のサイズで表示されることを示します。アダプティブモードを使用する場合、このフィールドは必須であり、0 より大きい値を指定する必要があります。塗りつぶしエリア (ボックス) の正規化された高さ比率を指定します。	1
PositionNormalized	array	任意	レイヤー要素の正規化された位置の値 `[x,y]`。デフォルト値: `[0,0]`。説明注: x と y の値は正規化する必要があります。	0.3
	number	任意	レイヤー要素の正規化された位置の値 `[x,y]`。デフォルト値: `[0,0]`。説明注: x と y の値は正規化する必要があります。	0.5
PositionRefer	string	任意	要素の位置のリファレンス座標。有効な値: topLeft (デフォルト): 左上。 topRight: 右上。 bottomLeft: 左下。 bottomRight: 右下。 center: センター。 topCenter: 上部センター。 bottomCenter: 下部センター。 leftCenter: 左センター。 rightCenter: 右センター。	topLeft
WidthNormalized	number	任意	レイヤー要素の正規化された幅比率。塗りつぶしなしモードを使用する場合、要素の高さはこの幅に基づいて比例的にスケーリングされます。デフォルト値: 0。イメージが元のサイズで表示されることを示します。アダプティブモードを使用する場合、このフィールドは必須であり、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)。 LocationId については、ビデオソースの追加を参照してください。要素は VideoLayers 要素に注文どおりに対応します。	RV02
	string	任意	ビデオリソース要素のロケーション ID (LocationId)。 LocationId については、ビデオソースの追加を参照してください。要素は VideoLayers 要素に注文どおりに対応します。	RV02
MixList	array	必須	オーディオリソース要素のロケーション ID (LocationId)。 LocationId については、ビデオソースの追加を参照してください。要素は AudioLayers 要素に注文どおりに対応します。	RV02
	string	任意	オーディオリソース要素のロケーション ID (LocationId)。 LocationId については、ビデオソースの追加を参照してください。要素は AudioLayers 要素に注文どおりに対応します。	RV02
CasterId	string	必須	プロダクションスタジオ ID。 CreateCaster 操作を呼び出してプロダクションスタジオを作成した場合、CreateCaster 操作から返された CasterId パラメーターを確認してください。 ApsaraVideo Live コンソールでプロダクションスタジオを作成した場合、ApsaraVideo Live コンソール > プロダクションスタジオ > クラウドプロダクションスタジオで ID をビューしてください。説明 ApsaraVideo Live コンソールのクラウドプロダクションスタジオページのプロダクションスタジオリストに表示されるプロダクションスタジオ名がプロダクションスタジオ ID です。	LIVEPRODUCER_POST-cn-0pp1czt****
LayoutId	string	必須	レイアウト ID。AddCasterLayout 操作を呼び出してプロダクションスタジオのレイアウトを追加した場合、AddCasterLayout 操作から返された LayoutId パラメーターを確認してください。	21926b36-7dd2-4fde-ae25-51b5bc8e****

説明

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

レスポンスフィールド

フィールド	型	説明	例
	object
LayoutId	string	レイアウト 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.

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

変更履歴

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