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リプレイのFunctionは、プロジェクトにリプレイ入力があり、ProfessionalライセンスとProモジュールが有効な場合に使用できます。Channelはリプレイチャンネルを英字(A, B…)または0からの番号で指定します。省略または空はチャンネルA、存在しないチャンネルは別のチャンネルを再生せず拒否されます。
| Function | 引数 | 動作 |
|---|---|---|
ReplayStartRecording |
全アングルの録画を開始します。 | |
ReplayStopRecording |
録画を停止します。 | |
ReplayMarkIn |
録画位置にIN点をマークします。 | |
ReplayMarkOut |
Channel, Value |
OUT点をマークします。Valueはイベント名です。イベントを登録し、セッションの設定に従ってプレイリストにも追加します。 |
ReplayCue |
Channel, Value |
チャンネルにクリップをキューします。ValueはクリップのUIDで、省略または空ならそのチャンネルのプレイリストの最新クリップをキューします。 |
ReplayPlay |
Channel, Value |
キュー中のクリップを再生します。Valueは等速を1とした倍率です(既定1、0.5で半速)。 |
ReplayPause |
Channel |
現在の速度を保ったまま一時停止します。 |
ReplayChangeSpeed |
Channel, Value |
クリップを読み直さずに速度を変更して再生します。vMixと挙動が異なります: vMixは現在の速度にValueを加減算しますが、eivizはValueを速度として直接設定します。絶対値として速度を指定するパネルはそのままで動きます。段階的に速度を変えるパネルは、パネル側で差分を計算してSetRateSlowMotionを使ってください。 |
SetRateSlowMotion |
Channel, Value |
vMix準拠の絶対スロー速度指定(Value 0〜1)。ReplayPlayと同じ動作で、0.5が半速です。 |
ReplaySetSpeed |
Channel, Value |
SetRateSlowMotionの別名です。 |
ReplayJumpToNow |
Channel |
チャンネルを録画位置(最新)に戻します。 |
XMLドキュメントでは、Replay入力にvMixと同じ<replay>ノードを出力します(recording、live、channelMode、events、cameraA/cameraB、speedA/speedB、timecodeA/timecodeB)。セッションの1つ目のReplay入力がチャンネルA、2つ目がBで、各チャンネルのトランスポートの実測値です。Bitfocus Companion や vMix Stream Deck プラグインは、この属性をフィードバックとして読み取ります。
リプレイの実行例
Section titled “リプレイの実行例”# HTTP APIhttp://127.0.0.1:8088/api?Function=ReplayStartRecordinghttp://127.0.0.1:8088/api?Function=ReplayMarkInhttp://127.0.0.1:8088/api?Function=ReplayMarkOut&Channel=Ahttp://127.0.0.1:8088/api?Function=ReplayCue&Channel=Ahttp://127.0.0.1:8088/api?Function=ReplayPlay&Channel=A&Value=0.5
# TCP APIFUNCTION ReplayMarkOut Channel=A
