Effect Pins

TCP Server ›› API ››
Parent Previous Next

Pin


background

Sets the video source for the background. Value parameter is a text string.


cut

Executes the cut command, identical to clicking the Cut button. Value parameter is ignored.


effect

Sets the video effect. Value parameter is the name of the effect as used in the video effects drop down list. As most video effect names include a comma, make sure to either escape it or surround the name with double quotes.


source1

Sets the video source for source 1. Value parameter is a text string.


source2

Sets the video source for source 2. Value parameter is a text string.


source3

Sets the video source for source 3. Value parameter is a text string.


source4

Sets the video source for source 4. Value parameter is a text string.


trans

Executes the transition command, identical to clicking the display or the Trans button. Value parameter is ignored.


Example


The following example selects the quad split video effect.



apiwrite effect 1, effect, "Split, Quad"