Pin


channel

Returns channel that is currently displayed and selected for audio. Default is 0.


channel <channel>

Set the <channel> that is displayed and selected for audio. Default is 0.


channels

Set the number of output channels (currently limited to 2), value parameter is text string with number of channels. The default setting is 1. Change this pin before writing to other pins.


clips

Returns a comma-separated list of all available clips for this module (aka camera angle).


clipspath

Returns the full path to the clips directory.


deleteclip

Deletes video clip. Value parameter holds text string with clip name.


exportclip <channel>

Saves recording/clip in <channel> from in to out point as compressed video file. All videos will be stored in the export folder. The file will be automatically named VidBlasterXSlomoClip_yymmddhhmmss_n, e.g. VidBlasterXSlomoClip_200818143000_1 for Slomo module 1 on August 18th 2020 at 2.30 PM.


guardband

A guardband is the additional time of media saved, both before and after the intended clip. Value parameter holds text string with guardband in seconds.


in <channel>

Marks current timecode for <channel> as IN point if the value parameter is true, or erases the IN point if value is false.

Reads IN timecode for <channel>.


live <channel>

Enables/disables live mode for <channel>. Value parameter is "true" or "false".

Returns live mode status ("true" or "false") for <channel>.


loadclip <channel>

Loads video clip into <channel> play buffer. Value parameter is text string with clip name.


off

Disables the module and stops internal recorder. Value parameter is ignored.


on

Enables the module and starts internal recorder. Value parameter is ignored.


osd

Output OSD text. Value parameter is text string.


out <channel>

Marks current timecode for <channel> as out point if the value parameter is true, or erases the out point if value is false.

Read out timecode for <channel>.


reset

       Resets all settings except the number of channels. recording buffer is erased if "preserve" option not set.


saveclip <name>

Saves recording from in to out point as video clip. Value parameter is text string with clip name.


speed <channel>

Sets speed of <channel> at which frames are output. Fixed frame output is set with speed 0, (delayed) real time playback with speed 100. Value parameter is text string with percentage value.


status

Read/write status text. Value parameter is text string.


tally <channel>

Sets tally status of <channel>. Value parameter is text string "program", "Preview" or empty.


timecode <channel>

Changes <channel> to <timecode>. Value parameter is text string with timecode.
Read current timecode of <channel>.


Note by default 2 channels are available: 1 (PGM) and 2 (PVW). To address both channels at the same time use 0.

Note timecode is in seconds with optional decimals.


Event


onclips, <module>, <list of clips>

Triggered when a clip is created or deleted and includes a comma-separated list of all available clips for this module.


onlive, <module>, <live status>

Triggered when a channel's live status changes. Includes a comma-separated list with the (boolean) status of each channel.


onrecording, <module>, [true|false]

Triggered when a channel's recording status changes. Includes (boolean) recording status.


onspeed, <module>, <speed>

Triggered when a channel's speed changes. Includes a comma-separated list with the (integer) speed percentage of each channel.



Example


The following example sets program playback to half speed.



apiwrite slomo 1, speed 1, 50