Pin


abmode

Enables (value = true) or disables (value = false) A/B mode.


auto

Executes current transition. Note this command is only supported by A buses that are set in A/B mode.


deselect

Resets active sources in bus. Value parameter is a comma-separated list with source names.


onselected <module>

Adds <module> to events list. Event is triggered when bus source is (de)selected. Sends onselected event followed by the title of the switcher bus and selected pin contents.


optiontally [true|false]

Enables or disables (default) the tally option.


ready

Returns true if switcher ready, i.e. fully constructed and all source buttons present.


select

Sets active sources in bus. Value parameter is a comma-separated list with source names.


selected

Returns comma-separated list with names of active sources, their alias and their 0-based bus index, e.g. camera 1, CAM01, 0.


sources

When reading this returns a comma-separated list with names of all sources. When writing the bus is (re)built with sources supplied as a comma-separated list in the value parameter.


take

Executes take. Note this command is only supported by A buses that are set in A/B mode.


time

Reads or sets transition time in ms. Note this command is only supported by A buses that are set in A/B mode.


toggle

Toggles source's active status. Value parameter is a source name.


Example


The following example sets the transition time of the program bus to 1 s.



apiwrite PGM 1, time, 1000



The following example selects Camera 1 and Player 1 in FX 1.



apiwrite FX 1, select, "Camera 1,Player 1"