制作スタジオのコンポーネントを変更します。
使用状況ノート
このインターフェイスは現在、画像、テキスト、字幕の3種類のコンポーネントの変更をサポートしています。
QPS制限
1人のユーザーが1秒あたり最大10件のクエリ (QPS) を実行できます。 1秒あたりの呼び出し数がQPS制限を超えると、スロットリングがトリガーされます。 スロットルはビジネスに影響を与える可能性があります。 したがって、この操作のQPS制限を遵守することをお勧めします。 シングルユーザーの意味とQPSの詳細については、「ApsaraVideo LiveのAPI操作のQPS制限」をご参照ください。
デバッグ
リクエストパラメーター
パラメーター | データ型 | 必須/任意 | 例 | 説明 |
---|---|---|---|---|
操作 | 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 |
コンポーネントのタイプ。 設定可能な値は以下のとおりです。
|
Effect | String | 任意 | animateV |
コンポーネントのエフェクト。The effect for the component. 設定可能な値は以下のとおりです。
|
ComponentLayer | String | 任意 | null |
コンポーネントレイヤに関する情報 (サイズやレイアウトなど) をJSON形式で指定します。 このパラメータには、次のフィールドが含まれます。
|
TextLayerContent | String | 任意 | null |
JSON形式のテキストレイヤーに関する情報。 このパラメータには、次のフィールドが含まれます。
注 このパラメーターは、ComponentTypeパラメーターがtextに設定されている場合に必要です。
|
ImageLayerContent | String | 任意 | null |
イメージレイヤーに関する情報 (JSON形式) 。 このパラメータには、次のフィールドが含まれます。 MaterialId: メディア資産ライブラリの資産のID。 注 このパラメーターは、ComponentTypeパラメーターがimageに設定されている場合に必要です。
|
CaptionLayerContent | String | 任意 | null |
キャプションレイヤーに関する情報 (JSON形式) 。 このパラメータには、次のフィールドが含まれます。
注 このパラメーターは、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 エラーセンター」をご参照ください。