OSCCommands : Object
Extension
ExtensionDescription
OSCCommands implements a couple of methods that let the user collect OSC command-names (including their path/namespace - e.g. '/my, super/long/and/winding/pth/to/cmdname' - resp. the number of addressable msg-slots. E.g. from an orientation-sensor: [ '/cmdname', <x-value>, <y-value>, <z-value> ] (one command-name, 3 slots). Collected command-names can be stored to disk under a name set by the user. For convenience OSCCommands has its own GUI which shows the user which names have already been collected resp. allowing her/him to remove unwanted names from the list. Command-names will be stored to disk in a file named "OSCCommands" in the same directory as the class-file itself.
Class Methods
OSCCommands.collect(play: true)
Starts the collection-process when set to true. Stop the process by calling the same method, argument play set to false
Arguments:
| play |
a Boolean, indicating whether the process shall be started or stopped - default: |
Returns:
this (OSCCommands)
OSCCommands.collectTempIPsAndCmds(play: true)
Collect OSC command-names and the sizes of their messages (i.e. how many slots are sent within the message). Command-names will be stored in *tempIPsAndCmds, an Event, under a key thats made up of a combination of the IP-address and port: <IP-address>:<port>.
Arguments:
| play |
a Boolean, indicating whether the process shall be started or stopped - default: |
Returns:
this (OSCCommands)
OSCCommands.saveCmdSet(deviceName)
Save the current list of commands to disk.
Arguments:
| deviceName |
a String or a Symbol representing the name of the current collection. If the collection-process is still active it will be stopped. |
Returns:
this (OSCCommands)
OSCCommands.front
Open the interactive GUI that shows the user all currently collected command-names resp. remove unwanted names.
Returns:
this (OSCCommands)
OSCCommands.window
OSCCommands.deviceCmds(deviceName)
If a deviceName has been given return an Event with command-names stored to disk under the device-name deviceName. Else return an Event with all currently stored commands resp. their keys.
Arguments:
| deviceName |
a String or a Symbol representing the name under which the list of commands has been stored. |
Returns:
an Event
OSCCommands.clearCmdsAt(deviceName)
Removes all commands stored to disk under the name given in deviceName.
Arguments:
| deviceName |
Returns:
this (OSCCommands)
OSCCommands.storedDevices
OSCCommands.tempIPsAndCmds
an Event keeping command-names and IP-addresses/ports collected by *collectTempIPsAndCmds
Returns:
an Event
OSCCommands.tempCollectRunning
Indicate whether a process invoked by *collectTempIPsAndCmds is currently running or not.
Returns:
a Boolean
Inherited class methods
Undocumented class methods
OSCCommands.makeWindow
Instance Methods
Inherited instance methods
Examples
For the following example you will have to have installed an application capable of sending OSC-messages somewhere in your local network (it might be e.g. an application on your computer or some OSC-controller on a mobile phone). Very likely you will have to tell this application to send its output to the IP-address of the computer where SuperCollider is running resp. to the receiving port of SC which is by default 57120 (setting a non-standard port should work using SC >= 3.5).
link::Classes/OSCCommands::