概要
- HTTPリクエストをつかって、外からコントロールをおこなうことができます。
姉妹ツールの「ゆかりねっとコネクター」、「心拍モニター」に設定すると、簡単に連動ができます。
有効化の設定
- 通信ポートを設定し、チェックボックスをいれてください。
- 有効化されると、http://localhost:ポート番号/ でアクセスできます。
- プラグインを入れる場合は、マイドキュメント配下にある\TelopAssistants\Plugin においてください。
サンプル
- インストールフォルダにサンプルプログラムがはいっています。
（Plugin_Sampleフォルダ）
ファイルを上記のプラグインフォルダにコピーすると動きます。
APIの仕様
- 現段階の仕様です。
- 仕様は予告なく変更することがあります。
■データセットの移動と反映
| 機能 | 次に進みます |
| URL | http://127.0.01:(port)/move_dataset_forward |
| パラメータ | [v0.7～] ・send：OBSに送るか？(yes/no) (default:yes) |
| 戻り | Application/JSON ・Length データセットの総数 ・Position 今のデータセット位置 |
| 機能 | １つ前に戻ります |
| URL | http://127.0.01:(port)/move_dataset_reverse |
| メソッド | GET |
| パラメータ | [v0.7～] ・send：OBSに送るか？(yes/no) (default:yes) |
| 戻り | Application/JSON ・Length データセットの総数 ・Position 今のデータセット位置 |
■データセットの取得
| 機能 | データセットを取得 |
| URL | http://127.0.01:(port)/get_dataset |
| メソッド | GET |
| パラメータ | position データセット番号 |
| 戻り | Application/JSON ・Scene シーン名 ・DatasetLength データセットの総数 ・TotalLength データセットアイテムの総数 ・Name データセット名 ・position データのインデックス(v0.9～) ・Item （データセット配列） ＜Itemの中身＞ ・id データNo ・enable 設定の有効・無効 ・sourceName ソース名 ・visible 表示するかしないか ・text ソースに設定するデータ パラメータミスがあるとステータス 400が返ります |
■データセットの設定
| 機能 | データセットを設定 |
| URL | http://127.0.01:(port)/set_dataset |
| メソッド | GET |
| パラメータ | position データセット番号 send 更新後OBSに送るか？(‘yes’ | ‘no’) id データNo enable 有効・無効 id データNo sourceName ソース名 visible 表示するかしないか text ソースに設定するデータ Scene シーン名 Name 設定名 |
| 戻り | Application/JSON ・なし パラメータミスがあるとステータス 400が返ります。 |
■OBSに送る
| 機能 | OBSへの転送指示 |
| URL | http://127.0.01:(port)/send |
| メソッド | GET |
| パラメータ | position データセット番号 [v0.7～] ・positionを指定しない場合： name 設定名 ・position も name もない(もしくは無効)な場合 現在カーソルがあるデータセットを採用 |
| 戻り | Application/JSON ・なし パラメータミスがあるとステータス 400が返ります。 |
■データセット名⇒IDへの変換
| 機能 | データセットのIDを名前を指定して取得 |
| URL | http://127.0.01:(port)/check_id |
| メソッド | GET |
| パラメータ | name 設定名 |
| 戻り | Application/JSON id データセット番号 name 設定名 名前が存在しない場合 -1 が返ります。 |
| 適用 | v0.6～ |
■ソース名リストの取得
| 機能 | ソース名リストを取得 |
| URL | http://127.0.01:(port)/check_source |
| メソッド | GET |
| パラメータ | なし |
| 戻り | Application/JSON Item配列： ・sourceName ソース名 ・sourceType ソースの属性(OBS内部名) |
| 適用 | v0.6～ |
■ツールバージョンの取得
| 機能 | バージョン番号を取得 |
| URL | http://127.0.01:(port)/check_version |
| メソッド | GET |
| パラメータ | なし |
| 戻り | Application/JSON ・Version バージョンラベル 例： 「Version 0.6」 |
| 適用 | v0.6～ |
■ダイレクトセット
| 機能 | データの指定セット |
| URL | http://127.0.01:(port)/set_direct |
| メソッド | GET |
| パラメータ | enable 有効・無効 sourceName ソース名 visible 表示するかしないか text ソースに設定するデータ |
| 戻り | Application/JSON ・なし パラメータミスがあるとステータス 400が返ります。 |
| 適用 | v0.9～ |
■シーケンスを開始
| 機能 | シーケンスを実行する |
| URL | http://127.0.01:(port)/run_sequence |
| メソッド | GET |
| パラメータ | [v1.52～] position データセット番号 positionを指定しない場合： name 設定名 |
| 戻り | Application/JSON ・なし パラメータミスがあるとステータス 400が返ります。 |