Component:OSC Value: Difference between revisions

Latest revision as of 19:56, 22 December 2024

Component image

The OSC_Value`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. Some components stop their functionality when this field is disabled, but some don't.
`Handler`	OSC_Handler	The Component:OSC_Receiver or Component:OSC_Sender to be used with this component.
`Path`	String	The OSC Path for this value.
`ArgumentIndex`	Int	For Multi-Dimensional OSC Values, this specifies which value to retrieve or send.
`Value`	T	The recieved OSC Value or the default value of the Type if there is no OSC data.

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 shown in the Value field.

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 Value, 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 OSC

@@ Line 3: / Line 3: @@
 |Name=OSC Value`1
 }}
-{{stub}}
+The '''OSC_Value`1''' Component is used to send and recieve [[OSC|OSC data]].
-== Usage ==
+== Fields ==
 {{Table ComponentFields
 |Handler|OSC_Handler|The [[Component:OSC_Receiver]] or [[Component:OSC_Sender]] to be used with this component.
-|Path|String|The OSC Path for this value
+|Path|String|The OSC Path for this value.
-|ArgumentIndex|Int|For Multi-Dimensional OSC Values, this specifies which value to retrieve
+|ArgumentIndex|Int|For [[OSC#Multi-Dimensional Values|Multi-Dimensional OSC Values]], this specifies which value to retrieve or send.
 |Value|'''T'''|TypeAdv3=true|The recieved OSC Value or the default value of the Type if there is no OSC data.
 }}
-== Behavior ==
+== Usage ==
 === Receiving ===
@@ Line 23: / Line 23: @@
 If the <code>SendMode</code> of the [[Component:OSC_Receiver|OSC_Receiver]], is set to <code>SendAsBundles</code>, then it will bundle up all other OSC Value component's values and send them all as a bundle.
-If the <code>SendMode</code> of the [[Component:OSC_Receiver|OSC_Receiver]], is set to <code>SendIndividuall</code>, then Resonite will send <code>Value</code>, as an OSC message on the OSC Path in <code>Path</code>.
+If the <code>SendMode</code> of the [[Component:OSC_Receiver|OSC_Receiver]], is set to <code>SendIndividually</code>, then Resonite will send <code>Value</code>, as an OSC message on the OSC Path in <code>Path</code>.
 Resonite will send data each time it changes or again every <code>AutoResendInterval</code> on the [[Component:OSC_Sender|OSC_Sender]].
@@ Line 31: / Line 31: @@
 == See Also ==
+* [[OSC]]
 [[Category:Components:Network:OSC{{#translation:}}|OSC Value`1]]
 [[Category:Components{{#translation:}}|OSC Value`1]]
 [[Category:Generic Components{{#translation:}}|OSC Value`1]]
-[[Category:ComponentStubs]]