No edit summary |
add last info needed to not be a stub |
||
(One intermediate revision by one other user not shown) | |||
Line 3: | Line 3: | ||
|Name=OSC Field`1 | |Name=OSC Field`1 | ||
}} | }} | ||
The '''OSC_Field`1''' Component is used to send and recieve [[OSC|OSC data]]. | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Handler|OSC_Handler|The [[Component:OSC_Receiver]] or [[Component:OSC_Sender]] to be used with this | |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. | |Path|String|The OSC Path for this value. | ||
|ArgumentIndex|Int|For Multi-Dimensional OSC Values, this specifies which value to retrieve or send. | |ArgumentIndex|Int|For [[OSC#Multi-Dimensional Values|Multi-Dimensional OSC Values]], this specifies which value to retrieve or send. | ||
|Field|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<T>}}|TypeAdv3=true|The Field to store the value in. | |Field|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<T>}}|TypeAdv3=true|The Field to store the value in. | ||
}} | }} | ||
== | == Usage == | ||
=== Receiving === | === Receiving === | ||
When <code>Handler</code>, is set to a valid and <code>IsListening</code>, [[Component:OSC_Receiver|OSC Reciever]], if [[OSC]] Data is found at the specified <code>Path</code>. The value from OSC will be set on the Field specified. | When <code>Handler</code>, is set to a valid and <code>IsListening</code>, [[Component:OSC_Receiver|OSC Reciever]], if [[OSC]] Data is found at the specified <code>Path</code>. The value from OSC will be set on the Field specified. | ||
Line 30: | Line 30: | ||
== See Also == | == See Also == | ||
* [[OSC]] | |||
[[Category:Components:Network:OSC{{#translation:}}|OSC Field`1]] | [[Category:Components:Network:OSC{{#translation:}}|OSC Field`1]] | ||
[[Category:Components{{#translation:}}|OSC Field`1]] | [[Category:Components{{#translation:}}|OSC Field`1]] | ||
[[Category:Generic Components{{#translation:}}|OSC Field`1]] | [[Category:Generic Components{{#translation:}}|OSC Field`1]] | ||
Latest revision as of 19:50, 22 December 2024
Component image
The OSC_Field`1 Component is used to send and recieve OSC data.
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 OSC