コンテンツにスキップ

互換API(vMix HTTP & TCP/OBS WebSocket)

eivizでは、従来のソフトウェアスイッチャー向けに開発された資産を活用するため、一部ソフトウェアスイッチャーと互換のAPIを備えています。

Mixerがプロセス内でHTTPサーバーを公開します。既定はすべてのインターフェイスのポート8088です。SettingsのWeb APIから有効化、ポート、BasicAuthを変えられます。ユーザー名とパスワードを空にすると認証は使いません。

項目
エンドポイント GET /api または GET /API
状態取得 クエリなし。application/xmlでvMix形のXMLを返す
Function ?Function=Fade&Duration=500 のようにクエリで実行し、成功時は同じXMLを返す

Sceneを先に、そのあとInputをフラットなInputsとして並べます。SceneはBlank Input+レイヤーです。preview/activeは選択中のMixing Unitのフラット番号です。追加のMixing Unitは<mix>です。

対応FunctionはFunction Referenceです。未知のFunctionは404、引数不正は400を返します。vMixのように「存在するFunctionなら失敗しても成功」にはしません。

HTTPのアクセスログはMixerログとは別にeiviz-mixer-http.logへ出します。ポーリング用の素のGET /apiは書きません。

未実装です。組み込み向けのTCPは#107で検討しています。

未実装です。#79を参照してください。

最新リリース(v0.2.1-alpha.1)