制作スタジオのコンポーネントを変更します。

使用状況ノート

このインターフェイスは現在、画像、テキスト、字幕の3種類のコンポーネントの変更をサポートしています。

QPS制限

1人のユーザーが1秒あたり最大10件のクエリ (QPS) を実行できます。 1秒あたりの呼び出し数がQPS制限を超えると、スロットリングがトリガーされます。 スロットルはビジネスに影響を与える可能性があります。 したがって、この操作のQPS制限を遵守することをお勧めします。 シングルユーザーの意味とQPSの詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 ModifyCasterComponent

実行したい操作。 値をModifyCasterComponentに設定します。

CasterId String 必須 9ff2d96b-37ef-40a3-8cb0-4c7b1e2e ****

制作スタジオのID。

CreateCaster インターフェイスを使用して制作スタジオを作成する場合は、レスポンスのCasterIdパラメーターの値を確認します。

ApsaraVideo Live Consoleを使用して制作スタジオを作成する場合は、コンソールにログインし、次のパスを使用して制作スタジオのIDを確認します。

制作スタジオ > 制作スタジオ管理

CasterIdは、Production Studio Managementページの [名前] 列に反映されます。
ComponentId String 必須 05ab713c-676e-49c0-96ce-cc408da1 ****

コンポーネントのID。 AddCasterComponent 操作を呼び出したときの応答に含まれます。

ComponentName String 任意 text01

コンポーネントの名前を示します。 デフォルトでは、名前はコンポーネントのIDです。

ComponentType String 任意 text

コンポーネントのタイプ。 設定可能な値は以下のとおりです。

  • text: テキストコンポーネント。
  • image: イメージコンポーネント。
  • caption: captionコンポーネント。
Effect String 任意 animateV

コンポーネントのエフェクト。The effect for the component. 設定可能な値は以下のとおりです。

  • none: コンポーネントのエフェクトを指定しません。 これはデフォルト値です。
  • animateH: コンポーネントの水平スクロールを指定します。
  • animateV: コンポーネントの垂直スクロールを指定します。
ComponentLayer String 任意 null

コンポーネントレイヤに関する情報 (サイズやレイアウトなど) をJSON形式で指定します。 このパラメータには、次のフィールドが含まれます。

  • HeightNormalized: コンポーネントレイヤーの要素の高さの正規化値。
  • WidthNormalized: コンポーネントレイヤーの要素の幅の正規化された値。
  • PositionNormalized: コンポーネントレイヤーの座標の正規化された値。
  • PositionRefer: コンポーネントレイヤーの参照座標。
TextLayerContent String 任意 null

JSON形式のテキストレイヤーに関する情報。 このパラメータには、次のフィールドが含まれます。

  • SizeNormalized: フォントサイズの正規化された値。 このフィールドの値は、フォントサイズを出力の高さで割った値になります。 有効な値: 0〜1。 このフィールドに基づいて計算されたフォントサイズが1,024より大きい場合でも、テキストの最大フォントサイズは1,024です。
  • BorderWidthNormalized: ボーダー幅の正規化された値。 このフィールドの値は、境界線の幅をフォントサイズで割った値になります。 有効な値: 0〜1。 デフォルト値は 0 です。 このフィールドに基づいて計算された境界幅が16より大きい場合でも、最大境界幅は16です。
  • FontName: フォントの名前。 デフォルト値: KaiTi。 有効な値の詳細については、「プロダクションスタジオで利用可能なフォントの説明」をご参照ください。
  • BorderColor: the color of the text border. 有効値: 0x000000から0xffffff。 デフォルトでは、このパラメーターは設定されていません。 この場合、テキストの境界線の色は透明です。
  • テキスト: テキストの内容。 デフォルトでは、このパラメーターは設定されていません。 この場合、テキストにはコンテンツが含まれていません。
  • : テキストの色。 デフォルト値は0xff0000で、テキストが赤で表示されていることを示します。
このパラメーターは、ComponentTypeパラメーターがtextに設定されている場合に必要です。
ImageLayerContent String 任意 null

イメージレイヤーに関する情報 (JSON形式) 。 このパラメータには、次のフィールドが含まれます。

MaterialId: メディア資産ライブラリの資産のID。

このパラメーターは、ComponentTypeパラメーターがimageに設定されている場合に必要です。
CaptionLayerContent String 任意 null

キャプションレイヤーに関する情報 (JSON形式) 。 このパラメータには、次のフィールドが含まれます。

  • SizeNormalized: フォントサイズの正規化された値。 このフィールドの値は、フォントサイズを出力の高さで割った値になります。 有効な値: 0〜1。 このフィールドに基づいて計算されたフォントサイズが1,024より大きい場合でも、キャプションの最大フォントサイズは1,024です。
  • BorderWidthNormalized: ボーダー幅の正規化された値。 このフィールドの値は、境界線の幅をフォントサイズで割った値になります。 有効な値: 0〜1。 デフォルト値は 0 です。 このフィールドに基づいて計算された境界幅が16より大きい場合でも、最大境界幅は16です。
  • FontName: フォントの名前。 デフォルト値: KaiTi。 有効な値の詳細については、「プロダクションスタジオで利用可能なフォントの説明」をご参照ください。
  • BorderColor: テキストの境界線の色。 有効値: 0x000000から0xffffff。 デフォルトでは、このパラメーターは設定されていません。 この場合、テキストの境界線の色は透明です。
  • LocationId: ビデオソースのチャンネルID。
  • SourceLan: ビデオソースのソースオーディオ言語。 有効な値: en、cn、es、およびru。それぞれ英語、中国語、スペイン語、およびロシア語を示します。 デフォルト値: cn。
  • TargetLan: ビデオソースのターゲットオーディオ言語。 有効な値: en、cn、es、およびru。それぞれ英語、中国語、スペイン語、およびロシア語を示します。 デフォルト値: cn。
  • ShowSourceLan: ソース言語を表示するかどうかを指定します。 true: ソース言語を表示します。 false: ソース言語を非表示にします。 デフォルト値: false。
  • 切り捨て: キャプションを切り捨てるかどうかを指定します。 true: キャプションを切り捨てることができることを指定します。 false: キャプションを切り捨てることができないことを指定します。 デフォルト値: false。
  • SourceLanPerLineWordCount: ソース言語の各行に表示される単語の数。 このフィールドは、Truncationフィールドがtrueに設定されている場合にのみ有効です。 デフォルト値: 20。
  • TargetLanPerLineWordCount: ターゲット言語の各行に表示される単語の数。 このフィールドは、Truncationフィールドがtrueに設定されている場合にのみ有効です。 デフォルト値: 20。
このパラメーターは、ComponentTypeパラメーターがcaptionに設定されている場合に必要です。

制作スタジオで利用可能なフォントの説明

フォント

FontNameの値

カイティ

カイティ

Alibaba PuHuiTi-レギュラー

Alibaba PuHuiTi-レギュラー

アリババPuHuiTi-太字

Alibaba PuHuiTi-ボールド

アリババPuHuiTi-ライト

Alibaba PuHuiTi-ライト

ソースハンサンズ-レギュラー

NotoSansHans-レギュラー

ソースHan Sans-Bold

NotoSansHans-ボールド

ソースハンサンズ-ライト

NotoSansHans-ライト

レスポンスパラメーター

パラメーター データ型 説明
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

リクエストの ID です。

ComponentId String 05ab713c-676e-49c0-96ce-cc408da1 ****

コンポーネントのID。

リクエストの例

http(s):// live.aliyuncs.com/?Action=ModifyCasterComponent
&CasterId=9ff2d96b-37ef-40a3-8cb0-4c7b1e2e ****
&ComponentId=05ab713c-676e-49c0-96ce-cc408da1 ****
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

<ModifyCasterComponentResponse>
      <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
      <ComponentId>21926b36-7dd2-4fde-ae25-51b5bc8e5****</ComponentId>
</ModifyCasterComponentResponse>

JSON 形式

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

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。