Pin


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.


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.


onclips <module>

Adds <module> to events list. Event is triggered when clip is created or deleted and includes a comma-separated list of all available clips for this module.


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>.


saveclip

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.


Example


The following example sets program playback to half speed.



apiwrite slomo 1, speed 1, 50