すべてのプロダクト
Search
ドキュメントセンター

:AddCasterComponent

最終更新日:Jan 16, 2026

プロダクションスタジオにコンポーネントを追加します。

操作説明

この操作を呼び出す前に、プロダクションスタジオを作成し、そのレイアウトリストを確認する必要があります。この操作では、イメージ、テキスト、字幕などのコンポーネントを追加します。API 呼び出しを使用してプロダクションスタジオを作成する方法の詳細については、「プロダクションスタジオの作成」をご参照ください。

QPS 制限

1 ユーザーあたりの 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:AddCasterComponent

create

*Caster

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

任意

リージョン ID。

cn-shanghai

CasterId

string

必須

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

  • CreateCaster 操作を呼び出してプロダクションスタジオを作成した場合、応答の CasterId パラメーターで ID を確認します。

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

説明

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

LIVEPRODUCER_POST-cn-0pp1czt****

ComponentName

string

任意

コンポーネントの名前。デフォルト値はコンポーネント ID です。

text01

LocationId

string

必須

コンポーネントの位置を指定します。各位置には 1 つのコンポーネントしか配置できません。フォーマットは RC01 から RC99 までである必要があります。

説明

コンポーネントタイプが字幕の場合、このパラメーターは参照されるビデオソースの場所を指定します。

RC01

ComponentType

string

必須

コンポーネントのタイプ。有効な値:

  • text:テキストコンポーネント。このパラメーターを text に設定した場合、TextLayerContent パラメーターも設定する必要があります。

  • image:イメージコンポーネント。このパラメーターを image に設定した場合、ImageLayerContent パラメーターも設定する必要があります。

  • caption:字幕コンポーネント。このパラメーターを caption に設定した場合、CaptionLayerContent パラメーターも設定する必要があります。

text

Effect

string

任意

コンポーネントの表示効果。有効な値:

  • none (デフォルト):効果なし。

  • animateH:水平方向にスクロールします。

  • animateV:垂直方向にスクロールします。

animateH

ComponentLayer

string

必須

コンポーネントレイヤーのサイズ、レイアウト、およびその他の情報。要素は次のように記述されます:

  • HeightNormalized:正規化された高さ。

  • WidthNormalized:正規化された幅。

  • PositionNormalized:レイヤー要素の正規化された位置。

  • PositionRefer:要素の位置の参照座標。

値は JSON 形式の文字列です。パラメーター名はアッパーキャメルケースである必要があります。

{"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]}

LayerOrder

string

任意

コンポーネントのレイヤー順序。

  • cover:コンポーネントは前景にあります。

  • background:コンポーネントはバックグラウンドにあります。

cover

TextLayerContent

string

任意

レイヤー要素のプロパティ。プロパティは次のように記述されます:

重要 このパラメーターは、ComponentType が text に設定されている場合にのみ必須です。

  • SizeNormalized:正規化されたフォントサイズ。この値は、フォントサイズ / 出力高さとして計算されます。値は [0,1] の範囲内である必要があります。正規化された値から計算されたフォントサイズが 1024 を超える場合、フォントサイズは 1024 に設定されます。

  • BorderWidthNormalized:テキストの罫線の正規化された幅。この値はフォントサイズに基づいて計算されます:BorderWidth / FontSize。値は [0,1] の範囲内である必要があります。正規化された値から計算された幅が 16 を超える場合、幅は 16 に設定されます。デフォルト値は 0 です。

  • FontName:フォント名。有効な値については、「プロダクションスタジオのフォント」をご参照ください。デフォルトのフォントは KaiTi です。

  • BorderColor:テキストの罫線の色。値は 0x000000 から 0xffffff までの 16 進数カラーコードである必要があります。デフォルト値は空の文字列 ("") で、罫線の色が設定されていないことを示します。

  • Text:テキストコンテンツ。デフォルト値は空の文字列 ("") です。

  • Color:テキストの色。デフォルト値は 0xff0000 で、赤を表します。

値は JSON 形式の文字列です。パラメーター名はアッパーキャメルケースである必要があります。

{"BorderWidthNormalized":"1","SizeNormalized":"0.2","Color":"0x000000","FontName":"KaiTi","BorderColor":"0x000000","Text":"hello world!"}

ImageLayerContent

string

任意

レイヤー要素のプロパティ。プロパティは次のように記述されます:

重要 このパラメーターは、ComponentType が image に設定されている場合に必須です。

MaterialId:メディアアセットの ID。メディアアセットをアップロードする際に指定した名前が、メディアアセットの ID として使用されます。

値は JSON 形式の文字列です。パラメーター名はアッパーキャメルケースである必要があります。

{"MaterialId":"6cf724c6ebfd4a59b5b3cec6f10d****"}

CaptionLayerContent

string

任意

レイヤー要素のプロパティ。プロパティは次のように記述されます:

重要 このパラメーターは、ComponentType が caption に設定されている場合に必須です。

  • SizeNormalized:正規化されたフォントサイズ。この値は、フォントサイズ / 出力高さとして計算されます。値は [0,1] の範囲内で、小数点以下 2 桁まで有効です。正規化された値から計算されたフォントサイズが 1024 を超える場合、フォントサイズは 1024 に設定されます。

  • BorderWidthNormalized:テキストの罫線の正規化された幅。この値はフォントサイズに基づいて計算されます:BorderWidth / FontSize。値は [0,1] の範囲内で、小数点以下 2 桁まで有効です。正規化された値から計算された幅が 16 を超える場合、幅は 16 に設定されます。デフォルト値は 0 です。

  • FontName:フォント名。有効な値については、「プロダクションスタジオのフォント」をご参照ください。デフォルトのフォントは KaiTi です。

  • BorderColor:テキストの罫線の色。値は 0x000000 から 0xffffff までの 16 進数カラーコードである必要があります。デフォルト値は空の文字列 ("") で、罫線の色が設定されていないことを示します。

  • LocationId:翻訳ソースのチャネル ID。

  • SourceLan:ビデオソースの元の音声言語。有効な値:en (英語)、cn (中国語)、es (スペイン語)、ru (ロシア語)。デフォルト値は cn です。

  • TargetLan:ビデオソースのターゲット音声言語。このパラメーターを設定しない場合、音声認識のみが実行されます。このパラメーターを設定すると、音声が翻訳されます。有効な値:en (英語)、cn (中国語)、es (スペイン語)、ru (ロシア語)。

  • ShowSourceLan:ソース言語を表示するかどうかを指定します。有効な値:true と false。デフォルト値は false です。

  • Truncation:字幕を切り捨てることができるかどうかを指定します。有効な値:true と false。デフォルト値は false です。

  • SourceLanPerLineWordCount:ソース言語の字幕の 1 行あたりの最大単語数。デフォルト値は 20 です。

  • TargetLanPerLineWordCount:ターゲット言語の字幕の 1 行あたりの最大単語数。デフォルト値は 20 です。

  • SourceLanReservePages:ソース言語の字幕用に予約する行数。このパラメーターは、Truncation が true に設定されている場合にのみ有効です。デフォルト値は 2 です。

  • TargetLanReservePages:ターゲット言語の字幕用に予約する行数。このパラメーターは、Truncation が true に設定されている場合にのみ有効です。デフォルト値は 2 です。

値は JSON 形式の文字列です。パラメーター名はアッパーキャメルケースである必要があります。

{"BorderWidthNormalized":0.01,"SizeNormalized":0.05,"Color":"0x000000","LocationId":"RV01","SourceLan":"cn","FontName":"KaiTi","BorderColor":"0xffffff"}

HtmlLayerContent

string

任意

H5 コンポーネントの構成。

{"htmlUrl":http://caster.example.com}

プロダクションスタジオのフォント

フォントFontName の値
KaiTiKaiTi
Alibaba PuHuiTi - RegularAlibabaPuHuiTi-Regular
Alibaba PuHuiTi - BoldAlibabaPuHuiTi-Bold
Alibaba PuHuiTi - LightAlibabaPuHuiTi-Light
Source Han Sans - RegularNotoSansHans-Regular
Source Han Sans - BoldNotoSansHans-Bold
Source Han Sans - LightNotoSansHans-Light

レスポンスフィールド

フィールド

説明

object

ComponentId

string

コンポーネント ID。この ID を使用して、コンポーネントのクエリ、変更、または削除を行います。

21926b36-7dd2-4fde-ae25-51b5bc8e****

RequestId

string

リクエスト ID。

16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidUserId.Malformed %s, please check userId.
400 InvalidCasterId.Malformed %s, please check and try again later.
400 MissingParameter %s.
400 InvalidParameter.Malformed There are invalid parameters: %s.
400 InvalidPositionNormalized.Malformed %s, please check and try again later.
400 DuplicateLocationID %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 CanvasNotExist %s, please check and try again later.

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

変更履歴

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