Function Reference
vMix-compatible API
Section titled “vMix-compatible API”Shortcuts available on the vMix-compatible HTTP API (GET /api?Function=...) and the TCP API (port 8099, FUNCTION Cut Input=3). Input is a Scene’s flat number, name, or GUID. Cut/Fade and other bus Functions reject a raw Input because a Mixing Unit cannot take it. Unknown numbers are also rejected. 0 is the current Preview, -1 is the current Program. Omit Mix or use 0 for the selected Mixing Unit; 1 and up index Mixing Units in session order.
Value is the destination path. .jpg / .jpeg saves JPEG; anything else (including an omitted path) saves PNG. If Value is omitted, a timestamped file is written under Pictures, or the temp directory.
| Function | Parameters | Action |
|---|---|---|
Cut |
Input, Mix |
Cuts Preview to Program. If Input is set, that Scene goes onto Program and Preview is left as-is |
CutDirect |
Input (required), Mix |
Puts the input on Program. Preview does not change |
Fade |
Input, Mix, Duration |
Same target as Cut, then Fade. If Input is set, Preview is left as-is. Duration is milliseconds. If omitted, the Mixing Unit Fade preset is used, else 1000 |
PreviewInput |
Input (required), Mix |
Sets Preview to the input |
ActiveInput |
Input (required), Mix |
Sets Program to the input. Preview does not change |
Snapshot |
Value, Mix |
Saves Program of the Mixing Unit. Input is not used |
SnapshotInput |
Input (required), Value, Mix |
Saves that Input. Flat numbers are Scenes first, then raw Inputs. 0 / -1 are Preview / Program of the Mixing Unit |
Examples:
http://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=CutDirect&Input=3http://127.0.0.1:8088/api?Function=Snapshot&Mix=1&Value=C:/Temp/eiviz.pnghttp://127.0.0.1:8088/api?Function=SnapshotInput&Input=3&Value=C:/Temp/scene.jpg- TCP:
FUNCTION Fade Duration=500 - TCP:
FUNCTION Cut Input=3
Replay
Section titled “Replay”Replay functions need a Replay input in the project, a Professional license, and the Pro module. Channel selects the replay channel, written as a letter (A, B, …) or a number from 0. Omitted or empty means channel A; a channel that does not exist is rejected instead of playing another one.
| Function | Parameters | Action |
|---|---|---|
ReplayStartRecording |
Starts recording on every angle | |
ReplayStopRecording |
Stops recording | |
ReplayMarkIn |
Marks the in point at the recording edge | |
ReplayMarkOut |
Channel, Value |
Marks the out point. Value is the event name. The event is filed, and added to the playlist when the session asks for it |
ReplayCue |
Channel, Value |
Cues a clip onto the channel. Value is a clip uid; omitted or empty cues the newest clip on the channel’s playlist |
ReplayPlay |
Channel, Value |
Plays the cued clip. Value is a multiple of normal speed (default 1, so 0.5 is half speed) |
ReplayPause |
Channel |
Pauses, keeping the current speed |
ReplayChangeSpeed |
Channel, Value |
Plays at a new speed without reloading the clip. This differs from vMix: vMix adds Value to the current speed, eiviz sets the speed to Value directly. Panels that press a speed for an absolute rate need no change; a panel that nudges in steps should use SetRateSlowMotion with the step computed on its side |
SetRateSlowMotion |
Channel, Value |
vMix’s absolute slow-motion rate (Value 0–1). Same action as ReplayPlay, so 0.5 is half speed |
ReplaySetSpeed |
Channel, Value |
Alias of SetRateSlowMotion |
ReplayJumpToNow |
Channel |
Returns the channel to the recording edge |
The XML document puts a <replay> node on every Replay input, the way vMix does: recording, live, channelMode, events, cameraA/cameraB, speedA/speedB and timecodeA/timecodeB. The document’s first Replay input is channel A, the second is B — the numbers each channel’s transport is really at, not a copy of the panel’s state. Bitfocus Companion and the vMix Stream Deck plugin read these attributes as feedback.
Replay examples:
# 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=ALatest: v0.5.0-kagaribi16.1

