Component:OSC Field

From Resonite Wiki
Revision as of 19:50, 22 December 2024 by 989onan (talk | contribs) (add last info needed to not be a stub)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Component image 
OSC Field`1 component as seen in the Scene Inspector

The OSC_Field`1 Component is used to send and recieve OSC data.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
Handler OSC_Handler The Component:OSC_Receiver or Component:OSC_Sender to be used with this field.
Path String The OSC Path for this value.
ArgumentIndex Int For Multi-Dimensional OSC Values, this specifies which value to retrieve or send.
Field direct RelayRef`1<IField`1<T>> The Field to store the value in.

Usage

Receiving

When Handler, is set to a valid and IsListening, OSC Reciever, if OSC Data is found at the specified Path. The value from OSC will be set on the Field specified.

Sending

When Handler, is set to a valid, OSC Sender.

If the SendMode of the OSC_Receiver, is set to SendAsBundles, then it will bundle up all other OSC Value component's values and send them all as a bundle.

If the SendMode of the OSC_Receiver, is set to SendIndividually, then Resonite will send the value within the specified Field, as an OSC message on the OSC Path in Path.

Resonite will send data each time it changes or again every AutoResendInterval on the OSC_Sender.

Examples

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:OSC_Field&oldid=93767"