Function Reference
vMix互換API
Section titled “vMix互換API”vMix互換HTTP APIおよびTCP APIで使用できる主なFunction(Shortcut)の一覧です。
Input: Sceneの通し番号、名前、またはGUIDを指定します。CutやFadeなどのバス操作では通常のInputを直接割り当てられないため、Sceneのみ指定可能です(未定義の番号も拒否されます)。0で現在のPreview、-1で現在のProgramを指定できます。Mix: 操作対象のMixing Unit番号を指定します(省略時または0は現在選択中のユニット、1以降はセッション内の順序に対応)。Value: 保存先のファイルパスを指定します(拡張子が.jpg/.jpegならJPEG、それ以外や省略時はPNG)。省略時はピクチャフォルダまたは一時ディレクトリに日時付きで保存されます。
| Function | 引数 | 動作 |
|---|---|---|
Cut |
Input, Mix |
PreviewとProgramをCutで切り替えます。Input指定時は該当Sceneを直接Programへ送り、Previewは維持します。 |
CutDirect |
Input(必須), Mix |
指定したInputを直接Programへ送ります(Previewは維持)。 |
Fade |
Input, Mix, Duration |
Fadeトランジションを実行します。Durationはミリ秒単位(省略時は該当ユニットのプリセット値、未設定時は1000ms)。 |
PreviewInput |
Input(必須), Mix |
指定したInputをPreviewに設定します。 |
ActiveInput |
Input(必須), Mix |
指定したInputをProgramに設定します。 |
Snapshot |
Value, Mix |
指定したMixing UnitのProgram映像をスクリーンショットとして保存します(Inputは使用しません)。 |
SnapshotInput |
Input(必須), Value, Mix |
指定したInputの映像をスクリーンショットとして保存します(通し番号はSceneが先、続いて通常のInputとなり、0/-1は対象Mixing UnitのPreview/Programを表します)。 |
# HTTP APIhttp://127.0.0.1:8088/api?Function=Fade&Duration=500http://127.0.0.1:8088/api?Function=Cut&Input=3http://127.0.0.1:8088/api?Function=Snapshot&Mix=1&Value=C:/Temp/eiviz.png
# TCP APIFUNCTION Fade Duration=500FUNCTION Cut Input=3
