プロダクションスタジオにコンポーネントを追加します。
操作説明
この操作を呼び出す前に、プロダクションスタジオを作成し、そのレイアウトリストを確認する必要があります。この操作では、イメージ、テキスト、字幕などのコンポーネントを追加します。API 呼び出しを使用してプロダクションスタジオを作成する方法の詳細については、「プロダクションスタジオの作成」をご参照ください。
QPS 制限
1 ユーザーあたりの 1 秒あたりのクエリ数 (QPS) 制限は 10 です。この制限を超えると、API 呼び出しはスロットリングされます。これはビジネスに影響を与える可能性があります。呼び出しを適切に計画してください。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:AddCasterComponent |
create |
*Caster
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
任意 |
リージョン ID。 |
cn-shanghai |
| CasterId |
string |
必須 |
プロダクションスタジオの ID。
説明
[クラウドプロダクションスタジオ] ページのリストにあるプロダクションスタジオの名前が、プロダクションスタジオの ID です。 |
LIVEPRODUCER_POST-cn-0pp1czt**** |
| ComponentName |
string |
任意 |
コンポーネントの名前。デフォルト値はコンポーネント ID です。 |
text01 |
| LocationId |
string |
必須 |
コンポーネントの位置を指定します。各位置には 1 つのコンポーネントしか配置できません。フォーマットは RC01 から RC99 までである必要があります。 説明
コンポーネントタイプが字幕の場合、このパラメーターは参照されるビデオソースの場所を指定します。 |
RC01 |
| ComponentType |
string |
必須 |
コンポーネントのタイプ。有効な値:
|
text |
| Effect |
string |
任意 |
コンポーネントの表示効果。有効な値:
|
animateH |
| ComponentLayer |
string |
必須 |
コンポーネントレイヤーのサイズ、レイアウト、およびその他の情報。要素は次のように記述されます:
値は JSON 形式の文字列です。パラメーター名はアッパーキャメルケースである必要があります。 |
{"HeightNormalized":"1","PositionRefer":"topRight","WidthNormalized":"0","PositionNormalized":["0.1","0.2"]} |
| LayerOrder |
string |
任意 |
コンポーネントのレイヤー順序。
|
cover |
| TextLayerContent |
string |
任意 |
レイヤー要素のプロパティ。プロパティは次のように記述されます: 重要 このパラメーターは、ComponentType が text に設定されている場合にのみ必須です。
値は 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 に設定されている場合に必須です。
値は 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 の値 |
| KaiTi | KaiTi |
| Alibaba PuHuiTi - Regular | AlibabaPuHuiTi-Regular |
| Alibaba PuHuiTi - Bold | AlibabaPuHuiTi-Bold |
| Alibaba PuHuiTi - Light | AlibabaPuHuiTi-Light |
| Source Han Sans - Regular | NotoSansHans-Regular |
| Source Han Sans - Bold | NotoSansHans-Bold |
| Source Han Sans - Light | NotoSansHans-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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。