Replay Controller Pins

TCP Server ›› API ››
Parent Previous Next

Pin


clear

Executes the clear command, identical to clicking Clear in the popup menu. Value parameter is ignored.


frameindex

Read: returns current frame index.

Write: cancels live mode and sets all sources to specified index. Value parameter is a text string of the desired frame number.

Use a source module's pins to directly read or write the index of a single source.


in

Mark in point, identical to pressing In button.


live

Read: returns status of live mode (true/false).

Write: enables live mode (no delay).


out

Mark out point and create entry in playlist, identical to pressing Out button.


play

Executes play command, identical to clicking Play button. Value parameter is ignored.


playlist

Set name of playlist. Value parameter is a text string.


run

Read: returns running status (true/false).

Write: plays replay (with set delay). Value parameter is ignored.


source

Reads or writes the name of the replay source. When writing the value parameter is a text string.


sourcenext

Set source for the next clip. Value parameter is text string.


speed

Set replay speed. Value parameter is text string with percentage (0..100).


stop

Executes stop command, identical to clicking Stop button. Value parameter is ignored.


Example


The following example starts playback from the current frame for the Replay Controller module.



apiwrite replay controller, run, true