プロダクションスタジオにコンポーネントを追加します。
操作説明
この操作を呼び出してプロダクションスタジオにコンポーネントを追加する前に、まずプロダクションスタジオを作成し、プロダクションスタジオのレイアウトについて理解しておく必要があります。 この操作を呼び出して、イメージ、テキスト、字幕の 3 種類のコンポーネントを追加できます。 プロダクションスタジオの作成方法の詳細については、「CreateCaster」をご参照ください。
QPS 制限
この操作は、アカウントごとに毎秒 10 回まで呼び出すことができます。 この制限を超えたリクエストは破棄され、サービスが中断されます。 この操作を呼び出す際は、この制限に注意することを推奨します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
live:AddCasterComponent |
create |
*Caster
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| CasterId |
string |
必須 |
プロダクションスタジオの ID。
説明
プロダクションスタジオの 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 |
| 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 |
任意 |
HTML5 レイヤーに関する情報。 |
{"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。 この値は、プロダクションスタジオのクエリ、変更、または削除を行うリクエストパラメーターの値として使用できます。 |
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 |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。