HTTP API Reference

Shunkei VTXは、設定を変更するためにHTTP APIが用意されています。

形式と認証

エンドポイントは http://<Shunkei VTXのIP>/api/ になります。

リクエスト・レスポンスのデータ形式は、JSONを利用します。

認証はWebUIと共通で、Basic認証を利用します。

例えばPythonの requests モジュールを利用する場合、以下のようなコードが利用できます。

# update gain
res = requests.post(
    "http://" + host + "/api/tx/manual-gain",
    json={"gain": 150},
    auth=HTTPBasicAuth('shunkei', 'shunkei'),
)

エンドポイント

Camera gain set auto

カメラのゲインをオートゲインに設定します。

項目	値
パス	/api/tx/auto-gain
メソッド	POST
ボディ	なし
バージョン	>=0.3.0

Camera gain manual set

カメラのゲインを手動で設定します。

項目	値
パス	/api/tx/manual-gain
メソッド	POST
ボディ	gain: int
バージョン	>=0.3.0