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

:AddCasterComponent

最終更新日:Dec 13, 2025

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

操作説明

この操作を呼び出してプロダクションスタジオにコンポーネントを追加する前に、まずプロダクションスタジオを作成し、プロダクションスタジオのレイアウトについて理解しておく必要があります。 この操作を呼び出して、イメージ、テキスト、字幕の 3 種類のコンポーネントを追加できます。 プロダクションスタジオの作成方法の詳細については、「CreateCaster」をご参照ください。

QPS 制限

この操作は、アカウントごとに毎秒 10 回まで呼び出すことができます。 この制限を超えたリクエストは破棄され、サービスが中断されます。 この操作を呼び出す際は、この制限に注意することを推奨します。

今すぐお試しください

この 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}

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

CasterId

string

必須

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

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

  • ApsaraVideo Live コンソールを使用してプロダクションスタジオを作成した場合、[プロダクションスタジオ管理] ページで ID を取得します。 このページに移動するには、ApsaraVideo Live コンソールにログインし、左側のナビゲーションウィンドウで [プロダクションスタジオ] をクリックします。

説明

プロダクションスタジオの ID は、[インスタンス ID/名前] 列で確認できます。

LIVEPRODUCER_POST-cn-0pp1czt****

ComponentName

string

任意

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

text01

LocationId

string

必須

コンポーネントのロケーション ID。 各ロケーション ID は 1 つのコンポーネントにのみ割り当てることができ、RC[Number] 形式である必要があります。 このパラメーターで指定する値は、RC01 から RC99 のように昇順である必要があります。

説明

ComponentType パラメーターが caption に設定されている場合、LocationId パラメーターはコンポーネントが参照するビデオソースのロケーション ID を指定します。

RC01

ComponentType

string

必須

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

  • text:テキストコンポーネント。 ComponentType を text に設定する場合は、TextLayerContent も指定する必要があります。

  • image:イメージコンポーネント。 ComponentType を image に設定する場合は、ImageLayerContent も指定する必要があります。

  • caption:字幕コンポーネント。 ComponentType を 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:正規化されたフォントサイズ。 フォントサイズは font_size/output_height に設定されます。 値の範囲は [0,1] です。 正規化メソッドに基づいてシステムが計算したフォントサイズが 1024 を超える場合は、1024 が使用されます。

  • BorderWidthNormalized:テキストの罫線の幅の正規化された値。 正規化された値は、テキストのサイズ、つまり「BorderWidth/FontSize」に基づいて計算されます。 値の範囲は [0,1] です。 正規化メソッドに基づいて計算された値が 16 を超える場合は、16 が使用されます。 デフォルト値は 0 です。

  • FontName:フォント名。 値の詳細については、フォントの説明をご参照ください。 デフォルト値は KaiTi です。

  • BorderColor:テキストの罫線の色。 有効な値:0x000000 から 0xffffff。 デフォルトでは、このパラメーターは設定されていません。 この場合、テキストの罫線の色は透明です。

  • 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:正規化されたフォントサイズ。 フォントサイズは font_size/output_height に設定されます。 値の範囲は [0,1] で、小数点以下 2 桁まで正確です。 正規化メソッドに基づいてシステムが計算したフォントサイズが 1024 を超える場合は、1024 が使用されます。

  • BorderWidthNormalized:テキストの罫線の幅の正規化された値。テキストのサイズ、つまり「BorderWidth/FontSize」に基づいて計算されます。 値の範囲は [0,1] で、小数点以下 2 桁まで正確です。 正規化メソッドに従って計算された値が 16 を超える場合は、16 が使用されます。 デフォルト値は 0 です。

  • FontName:フォント名。 値の詳細については、フォントの説明をご参照ください。 デフォルトのフォント名は KaiTi です。

  • BorderColor:テキストの罫線の色。 有効な値:0x000000 から 0xffffff。 デフォルトでは、このパラメーターは設定されていません。 この場合、テキストの罫線の色は透明です。

  • LocationId:ソース字幕のチャネル ID。

  • SourceLan:ソースビデオの音声のソース言語。 有効な値:en、cn、es、ru。それぞれ英語、中国語、スペイン語、ロシア語を示します。 デフォルト値:cn。

  • TargetLan:ソースビデオのターゲット音声言語。 このフィールドを指定しない場合は、音声認識が使用されます。 このフィールドを指定すると、翻訳が使用されます。 有効な値:en、cn、es、ru。それぞれ英語、中国語、スペイン語、ロシア語を示します。 デフォルト値:cn。

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

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

  • SourceLanPerLineWordCount:字幕がソース言語の場合に各行に表示される単語数。 デフォルト値:20。

  • TargetLanPerLineWordCount:字幕が宛先言語の場合に各行に表示される単語数。 デフォルト値: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

任意

HTML5 レイヤーに関する情報。

{"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。 この値は、プロダクションスタジオのクエリ、変更、または削除を行うリクエストパラメーターの値として使用できます。

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
400 InvalidCasterId.Malformed %s
400 MissingParameter %s
400 InvalidParameter.Malformed %s
400 InvalidPositionNormalized.Malformed %s
400 DuplicateLocationID %s
401 IllegalOperation %s
500 InternalError %s
404 InvalidCaster.NotFound %s
404 CanvasNotExist %s

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

変更履歴

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