Skip to main content

Toggle Button

Toggle Buttons have two states which send commands. Each state of the Toggle Button requires a positive action.

Toggle Buttons will display a highlighted background when in the On State.

Group State

The group state option under Properties allows a toggle button to be made part of a Group. Only one toggle button in a group can be in the ON state at a time. If the button is set to ON and another Control in the group is set to ON, the current active toggle button will be transitioned to its OFF state (triggering the commands in the OFF state in the process).

Action Map

The action map below details the point at which commands are sent.

Touch ReadyTouch BeginTouch HoldTouch ReleaseTouch End
XXXOn ModeX
XXXOff ModeX

Control Methods

TypeOn ModeOff Mode
MIDIMIDI Channel, Note, VelocityMIDI Channel, Note, Velocity
OSCOSC Message, PatchOSC Message, Patch
HTTPHTTP Address, PatchHTTP Address, Patch
TCPTCP String, PatchTCP String, Patch
UDPUDP String, PatchUDP String, Patch
sACNsACN Patch, Channel, ValuesACN Patch, Channel, Value
AudioAudio ID, VolumeAudio ID, Volume
VideoVideo, Layer, Volume, Scale X, Scale Y, Position X, Position Y, OpacityVideo, Layer, Volume, Scale X, Scale Y, Position X, Position Y, Opacity

API Methods

Use external applications to operate this control with the API via OSC.

Send the string /ctrl/control/[uid]/[command] with the control's UID and selected command.

The default port for Ctrl for iPads OSC API is 53000. This can be modified by navigating to the settings menu and modifying the global OSC input port.

OSC Commands

Command
/enabled [Int]Enable or disable the control (0 - Disabled, 1 - Enabled)
/theme [Int]Change the theme of the control (Int 1 to 14)
/theme [Int] [String]Change the theme of the control using custom palette
/label [String]Change the label of the control for the session name (Int 1 to 14)
/flash [Int]Set the control to flash to indicate attention is required (0 - Off, 1 - On)

Alternatively, you can create a Custom OSC Binding for this control for any of the attributes listed above.