OSSIA_Node
Extension
ExtensionDescription
The nodes in the device are simply called code in the API. Nodes are identified with the OSC parameter syntax: '/foo/bar'.
Nodes per se don't carry any value; they have to be extended with parameters to be able to send and receive messages.
Class Methods
.new
Instantiates a new node in the Ossia application.
Arguments:
| parent |
required - an |
| name |
required - the node's identifier on the network |
Returns:
an OSSIA_Node
Instance Methods
.name
gets the node's identifier on the network.
.snapshot
Returns:
an array with children parameters' name as symbols and their values, convenient for Synth creation.
.description
An optional textual description.
.tags
An optional array of tags for nodes.
Arguments:
| aSymbolList |
e.g. : |
.disable
This attribute will disable a node: it will stop sending messages to the network.
.enable
This attribute will re-enable a disabled node
.is_disabled
Returns:
true if node is disabled, false otherwise.
.muted
This attribute will disable a node: it will stop sending messages to the network. Unlike the "enabled/disabled" attribute, it won't propagate to other computers.
.hidden
This attribute is to use for nodes that are not to be exposed to the network.
.load_preset
applies a saved node preset to the receiver. If path is empty, a dialog will open.
Arguments:
| path |
the path to the .json preset file. |
.save_preset
saves the state of the receiver as a .json file. If path is empty, a dialog will open.
Arguments:
| path |
the path to the .json preset file. |
.fullpath
gets the node full path on the network.
Returns:
aString containing the node's osc path.
.children
Returns:
a stringlist of the node's direct children nodes.
.zombie
This is a read-only attribute: it informs of whether a node is in a zombie state. A zombie node is an node in a remote device, whose source has been removed. It is kept in the mirrors but marked as such.
Returns:
true if node is in a zombie state, false otherwise.