外部からコントロールする

概要

  • HTTPリクエストをつかって、外からコントロールをおこなうことができます。

有効化の設定

  • 通信ポートを設定し、チェックボックスをいれてください。
  • 有効化されると、http://localhost:ポート番号/ でアクセスできます。
  • プラグインを入れる場合は、マイドキュメント配下にある\TelopAssistants\Plugin においてください。

サンプル

  • インストールフォルダにサンプルプログラムがはいっています。
    (Plugin_Sampleフォルダ)
    ファイルを上記のプラグインフォルダにコピーすると動きます。

APIの仕様

  • 現段階の仕様です。
  • 仕様は予告なく変更することがあります。

■データセットの移動と反映

機能次に進みます
URLhttp://127.0.01:(port)/move_dataset_forward
パラメータ[v0.7~]
・send:OBSに送るか?(yes/no) (default:yes)
戻りApplication/JSON
・Length データセットの総数
・Position 今のデータセット位置
機能1つ前に戻ります
URLhttp://127.0.01:(port)/move_dataset_reverse
メソッドGET
パラメータ[v0.7~]
・send:OBSに送るか?(yes/no) (default:yes)
戻りApplication/JSON
・Length データセットの総数
・Position 今のデータセット位置

■データセットの取得

機能データセットを取得
URLhttp://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が返ります

■データセットの設定

機能データセットを設定
URLhttp://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への転送指示
URLhttp://127.0.01:(port)/send
メソッドGET
パラメータposition データセット番号
[v0.7~]
・positionを指定しない場合:
 name  設定名
・position も name もない(もしくは無効)な場合
 現在カーソルがあるデータセットを採用
戻りApplication/JSON
・なし

パラメータミスがあるとステータス 400が返ります。

■データセット名⇒IDへの変換

機能データセットのIDを名前を指定して取得
URLhttp://127.0.01:(port)/check_id
メソッドGET
パラメータname 設定名
戻りApplication/JSON
id  データセット番号
name 設定名

名前が存在しない場合 -1 が返ります。
適用v0.6~

■ソース名リストの取得

機能ソース名リストを取得
URLhttp://127.0.01:(port)/check_source
メソッドGET
パラメータなし
戻りApplication/JSON
Item配列:
・sourceName ソース名
・sourceType  ソースの属性(OBS内部名)
適用v0.6~

■ツールバージョンの取得

機能バージョン番号を取得
URLhttp://127.0.01:(port)/check_version
メソッドGET
パラメータなし
戻りApplication/JSON
・Version バージョンラベル
     例: 「Version 0.6」
適用v0.6~

■ダイレクトセット

機能データの指定セット
URLhttp://127.0.01:(port)/set_direct
メソッドGET
パラメータenable  有効・無効
sourceName ソース名
visible 表示するかしないか
text  ソースに設定するデータ 
戻りApplication/JSON
・なし

パラメータミスがあるとステータス 400が返ります。
適用v0.9~

■シーケンスを開始

機能シーケンスを実行する
URLhttp://127.0.01:(port)/run_sequence
メソッドGET
パラメータ[v1.52~]
position データセット番号

positionを指定しない場合:
 name  設定名
戻りApplication/JSON
・なし

パラメータミスがあるとステータス 400が返ります。