Element Enumerations

class tosclib.elements.ControlElements

Valid xml tags for a Control

CHILDREN = 'children'

<children>

GAMEPAD = 'gamepad'

<gamepad>

LOCAL = 'local'

<local>

MESSAGES = 'messages'

<messages>

MIDI = 'midi'

<midi>

NODE = 'node'

<node type =>

OSC = 'osc'

<osc>

PROPERTIES = 'properties'

<properties>

PROPERTY = 'property'

<property type=>

VALUE = 'value'

<value>

VALUES = 'values'

<values>

class tosclib.elements.ControlType

Valid xml attrib = {“type”:ControlType} for <node>

BOX = 'BOX'

<node type = “BOX”>

BUTTON = 'BUTTON'

<node type = “BUTTON”>

ENCODER = 'ENCODER'

<node type = “ENCODER”>

FADER = 'FADER'

<node type = “FADER”>

GRID = 'GRID'

<node type = “GRID”>

GROUP = 'GROUP'

<node type = “GROUP”>

LABEL = 'LABEL'

<node type = “LABEL”>

PAGER = 'PAGER'

<node type = “PAGER”>

RADAR = 'RADAR'

<node type = “RADAR”>

RADIAL = 'RADIAL'

<node type = “RADIAL”>

RADIO = 'RADIO'

<node type = “RADIO”>

TEXT = 'TEXT'

<node type = “TEXT”>

XY = 'XY'

<node type = “XY”>

class tosclib.elements.PropertyType

Valid xml attrib = {“type”:PropertyType} for <property>

BOOLEAN = 'b'

<property type=”b”>

COLOR = 'c'

<property type=”c”>

FLOAT = 'f'

<property type=”f”>

FRAME = 'r'

<property type=”r”>

INTEGER = 'i'

<property type=”i”>

STRING = 's'

<property type=”s”>

class tosclib.elements.Property

Struct like object to carry the property values

__init__(type, key, value=None, params=None)

Parameters

• type (str) –

• key (str) –

• value (Optional[str]) –

• params (Optional[dict[str, str]]) –

class tosclib.elements.Value

Default Elements for <value>.

Parameters

• key (str, optional) – “x” or “touch”. Defaults to “touch”.

• locked (str, optional) – boolean. Defaults to “0”.

• lockedDefaultCurrent (str, optional) – boolean. Defaults to “0”.

• default (str, optional) – float or boolean. Defaults to “false”.

• defaultPull (str, optional) – 0 to 100. Defaults to “0”.

__init__(key='touch', locked='0', lockedDefaultCurrent='0', default='false', defaultPull='0')

Parameters

• key (str) –

• locked (str) –

• lockedDefaultCurrent (str) –

• default (str) –

• defaultPull (str) –

class tosclib.elements.OSC

Default Elements and Sub Elements for <osc>

Parameters

• enabled (str, optional) – Boolean. Defaults to “1”.

• send (str, optional) – Boolean. Defaults to “1”.

• receive (str, optional) – Boolean. Defaults to “1”.

• feedback (str, optional) – Boolean. Defaults to “0”.

• connections (str, optional) – Binary.

• "00001" (Defaults to) –

• triggers (List[Trigger], optional) – [Trigger].

• [Trigger()]. (Defaults to) –

• path (List[Partial], optional) – [Partial].

• [Partial (Defaults to) –

• arguments (List[Partial], optional) – [Partial].

• [Partial –

__init__(enabled='1', send='1', receive='1', feedback='0', connections='00001', triggers=[<tosclib.elements.Trigger object>], path=[<tosclib.elements.Partial object>, <tosclib.elements.Partial object>], arguments=[<tosclib.elements.Partial object>])

Parameters

• enabled (str) –

• send (str) –

• receive (str) –

• feedback (str) –

• connections (str) –

• triggers (list[tosclib.elements.Trigger]) –

• path (list[tosclib.elements.Partial]) –

• arguments (list[tosclib.elements.Partial]) –

class tosclib.elements.MIDI

__init__(enabled='1', send='1', receive='1', feedback='0', connections='00001', triggers=[<tosclib.elements.Trigger object>], message=<tosclib.elements.MidiMessage object>, values=[<tosclib.elements.MidiValue object>, <tosclib.elements.MidiValue object>, <tosclib.elements.MidiValue object>])

Parameters

• enabled (str) –

• send (str) –

• receive (str) –

• feedback (str) –

• connections (str) –

• triggers (list[tosclib.elements.Trigger]) –

• message (tosclib.elements.MidiMessage) –

• values (list[tosclib.elements.MidiValue]) –

class tosclib.elements.LOCAL

Default elements for <midi> :param enabled: bool :param triggers: Trigger x or touch. :param type: BOOL, INT, FLOAT, STRING. The Type of Trigger.x :param conversion: BOOL, INT, FLOAT, STRING. :param value: The value sent to the other local Control. :param scaleMin: 0 :param scaleMax: 1 :param dstType: BOOL, INT, FLOAT, STRING of the target. :param dstVar: The value you want to change in the target. :param dstID: The node {ID} of the target.

__init__(enabled='1', triggers=[<tosclib.elements.Trigger object>], type='VALUE', conversion='FLOAT', value='x', scaleMin='0', scaleMax='1', dstType='', dstVar='', dstID='')

Parameters

• enabled (str) –

• triggers (list[tosclib.elements.Trigger]) –

• type (str) –

• conversion (str) –

• value (str) –

• scaleMin (str) –

• scaleMax (str) –

• dstType (str) –

• dstVar (str) –

• dstID (str) –