Global Array DATA OSC

Module to automatically receive or send global arrays with OSC messages. See global-array-tutorial to learn how to use global arrays.

Typology of OSC messages

If you define an OSC address /usine/ this module will catch all messages /usine/1..N/ ,f with 1..N the index of the global array value. For example /usine/1/ ,f for the first index (value 0), /usine/2/ ,f for the second index (value 1), etc.

But the module will also catch all messages with the typology /usine/ ,fffff, each value of the message corresponding to its respective index in the global array. A particular case is the message /usine/ ,f which affects the first value of the global array.

On emission (sending OSC), the module will send all values as separated OSC messages /usine/1/ ,f for the first value, /usine/2/ ,f for the second, etc.

Settings

name

Name of the global array.

Only one global-array module should be created with a given name, so each name has to be unique.

name suffix

Defines if a suffix is added automatically at the end of the name to produce names like MYARRAY-1, MYARRAY-2,etc.

  • no suffix
  • poly voice num - 1: number of the voice in a polyphonic sub-patch.
  • rack num - 1: number of the current rack.
  • patch num - 1: number of the current patch.
  • user: user defined suffix.

user suffix

User defined suffix string appended to the global array name. Only visible when name suffix is set to user.

address

Osc address string of the message.

Be careful, the OSC address string is key sensitive. It mean that /USINE/ is not equal to /usine/.

type

Type tag of the OSC messages.

  • f : float values
  • i : integer values
  • i trigger : the incoming integer value is considered as a trigger. It means that when a 1 value is received, it will be reset to 0 at the next calculation cycle of Usine.

    osc tag size

    Size (number of values) expected to fill the global array. For example if the global array is an X-Y-Z array the expected tag is ,fff so the osc-tag-size is 3.

host

IP address of the remote computer (to send data).

Active only if the broadcast option is OFF.

host port

Remote Port destination number of the message.

broadcast

  • If this option is activated, the OSC message is sent to all the computers connected to the local network.
  • If not activated the message is sent at the address specified in the ip name field.
broadcast or not ?

In OSC when you want to send a data to another computer you normally have to know the network (IP) address of the destination. Something like 192.168.1.5.

The problem is that, by default, routers are configured to allocate IP addresses dynamically. In other word their IP aren't fixed and can change if, for example, you have to reboot one of your computer or your router. When broadcast is ON data's are sent to all the computers of the network at the same time whatever their IP address. So you don't have to deal with IP addresses and you're sure that all the computers will receive the message.

The main drawback is that if you have 20 computers connected you'll probably overload the network.

So if we resume broadcast ON is cool for small networks, let say, less than 10 computers. For larger networks, disable this option (OFF) and use the IP address field to set the destination of the message.

receive OSC active

Enables the reception of OSC messages for the global array.

this inlet can be an array for multiple input values.

base index

Global array start index which receives the OSC values.

is a pair

Determines if the value received at the index is considered as a "pair", and so automatically fill the index+1 with the same value.

this inlet can be an array for multiple input values.

data received

Sends 1 when a valid OSC message is received for the global array.

index received

List of received values indexes as an array of integers.

values received

List of received values as an array.

send OSC active

Enables the sending of OSC messages for the global array.

this inlet can be an array for multiple input values.

resend all

Forces resending all OSC messages (for all values) even if the send OSC active is OFF.

resend all active

Forces resending OSC messages (for each values) only if the send OSC active is ON or if send OSC active is equal to 1 for the nth index.

Remember that the send OSC active can be an array.

inverse value (1-value)

The value is inverted on receive and send by a 1-VALUE operation. For example, if the value received is 0.3 the final value of the global array will be 1 - 0.3 = 0.7

Common Settings

info

show manual

Button. Opens the manual page of the selected object (or of its parent module for a control) in the web browser. If no page exists for this object, an error is traced in the trace panel.

For more details about information/help creation, see create-help-file.

description

Free multi-line text attached to the module, saved with the patch. It is only meant as an internal note for the patch designer: it is not displayed in the interface.

ID's

visible only in god mode, see setup-panel-tab-expert.

unique ID

Read-only, not saved. Current private numeric ID of the object, used internally to identify it (for example as the target of a bind ID).

preset ID

Read-only, not saved. Private ID used to store and recall the values of this control in presets.

recreate ID

Button. Generates a new unique ID, original ID and preset ID for the object. Use it if you experience difficulties in Polyphonic mode or if two objects share the same ID. Preset values and binds referring to the old IDs are lost.

Object Remote Address

absolute

Read-only, not saved. Absolute address of the object in the Usine objects tree, built from the workspace root. This is the address to use to reach the object from scripts, the objects panel or remote messages. Only shown for objects that are registered in the objects list. See objects-address.

local

Read-only, not saved. Address of the object relative to the current patch, valid inside that patch only. See objects-address.

user addr

Free user-defined address for the object (empty by default). When set, the object is also registered in the objects tree under this name, so it can be reached independently of its position in the workspace (the value is also reported in the mouse-over and mouse-down chunks). Changing it rebuilds the objects list. Only available on objects that support a user address. See objects-address.

See also

version 7.0.250121

Edit All Pages