TouchOSC

In this reference we list the names and types of the properties and values for each control type, for access from control scripts.

For a description of the meaning and effects of each property and value, please see the Properties, Values and Control Reference sections.

---

• Common
• BOX
• BUTTON
• LABEL
• TEXT
• FADER
• XY
• RADIAL
• ENCODER
• RADAR
• RADIO
• PAGER

---

Common

Properties and values that are common to all controls, independent of their type. Not all control types will utilize the value of these properties.

Properties

Name	Description	Since
name	A user-editable string.
tag	A user-editable string.	1.0.2.98
frame	A Rectangle object.
color	A Color object.
visible	A boolean value.
interactive	A boolean value.
background	A boolean value.
outline	A boolean value.
outlineStyle	One of the possible values of the OutlineStyle enumeration.
grabFocus	A boolean value.
pointerPriority	One of the possible values of the PointerPriority enumeration.
cornerRadius	An integer number value ranging from 0 to 10
orientation	One of the possible values of the Orientation enumeration.
script	A string value. The control's script source code.

Values

Name	Description
touch	A boolean value. true if any pointers are associated with the control in the current frame, false otherwise. For a control to be able to be associated with a pointer, its visible and interactive properties have to both be true

 

---

BOX

Properties

Name	Description
shape	One of the possible values of the Shape enumeration

 

---

BUTTON

Properties

Name	Type
shape	One of the possible values of the Shape enumeration.
buttonType	One of the possible values of the ButtonType enumeration.
press	A boolean value.
release	A boolean value.
valuePosition	A boolean value.

Values

Name	Description
x	A floating point value ranging from 0.0 to 1.0.

 

---

LABEL

Properties

Name	Type	Since
font	One of the possible values of the Font enumeration.	1.0.4.106
textSize	An integer value.
textLength	An integer value.
textAlignH	One of the possible values of the AlignH enumeration.
textAlignV	One of the possible values of the AlignV enumeration.
textColor	A Color object.
textClip	A boolean value.

Values

Name	Description
text	A string value.

 

---

TEXT

Properties

Name	Type	Since
font	One of the possible values of the Font enumeration.	1.0.4.106
textSize	An integer value.
textAlignH	One of the possible values of the AlignH enumeration.	1.0.4.106
textAlignV	One of the possible values of the AlignV enumeration.	1.2.1.171
textColor	A Color object.
textClip	A boolean value.	1.2.1.171
textWrap	A boolean value.	1.2.1.171

Values

Name	Description
text	A string value.

 

---

FADER

Properties

Name	Type	Since
cursor	A boolean value.
cursorDisplay	One of the possible values of the CursorDisplay enumeration.
bar	A boolean value.
barDisplay	One of the possible values of the CursorDisplay enumeration.
centered	A boolean value.
response	One of the possible values of the Response enumeration.
responseFactor	An integer value ranging from 1 to 100.
grid	A boolean value.
gridSteps	An integer value.
gridColor	A Color object.	1.2.0.166

Values

Name	Description
x	A floating point value ranging from 0.0 to 1.0.

 

---

XY

Properties

Name	Type	Since
cursor	A boolean value.
cursorDisplay	One of the possible values of the CursorDisplay enumeration.
lines	A boolean value.
linesDisplay	One of the possible values of the CursorDisplay enumeration.
lockX	A boolean value.
lockY	A boolean value.
response	One of the possible values of the Response enumeration.
responseFactor	An integer value ranging from 1 to 100.
gridX	A boolean value.
gridY	A boolean value.
gridStepsX	An integer value.
gridStepsY	An integer value.
gridColor	A Color object.	1.2.0.166

Values

Name	Description
x	A floating point value ranging from 0.0 to 1.0.
y	A floating point value ranging from 0.0 to 1.0.

 

---

RADIAL

Properties

Name	Type	Since
inverted	A boolean value.
centered	A boolean value.
response	One of the possible values of the Response enumeration.
responseFactor	An integer value ranging from 1 to 100.
grid	A boolean value.
gridSteps	An integer value.
gridColor	A Color object.	1.2.0.166

Values

Name	Description
x	A floating point value ranging from 0.0 to 1.0.

 

---

ENCODER

Properties

Name	Type	Since
cursor	A boolean value.
cursorDisplay	One of the possible values of the CursorDisplay enumeration.
response	One of the possible values of the Response enumeration.
responseFactor	An integer value ranging from 1 to 100.
grid	A boolean value.
gridSteps	An integer value.
gridColor	A Color object.	1.2.0.166

Values

Name	Description
x	A floating point value ranging from 0.0 to 1.0.
y	A floating point value ranging from 0.0 to 1.0.

 

---

RADAR

Properties

Name	Type	Since
cursor	A boolean value.
cursorDisplay	One of the possible values of the CursorDisplay enumeration.
lines	A boolean value.
linesDisplay	One of the possible values of the CursorDisplay enumeration.
lockX	A boolean value.
lockY	A boolean value.
gridX	A boolean value.
gridY	A boolean value.
gridStepsX	An integer value.
gridStepsY	An integer value.
gridColor	A Color object.	1.2.0.166

Values

Name	Description
x	A floating point value ranging from 0.0 to 1.0.
y	A floating point value ranging from 0.0 to 1.0.

 

---

RADIO

Properties

Name	Type
steps	An integer value.
radioType	One of the possible values of the RadioType enumeration.

Values

Name	Description
x	An integer value ranging from 0 to the value of the steps property minus one.

 

---

PAGER

Properties

Name	Type
tabbar	A boolean value.
tabbarSize	An integer value ranging from 10 to 300.
tabbarDoubleTap	A boolean value.
tabLabels	A boolean value.
textSizeOff	An integer value.
textSizeOn	An integer value.

Page Properties

Name	Type
tabLabel	A string value.
tabColorOff	A Color object.
tabColorOn	A Color object.
textColorOff	A Color object.
textColorOn	A Color object.

Values

Name	Description
page	An integer value ranging from 0 to the number of pages minus one.