Component:OSC Receiver: Difference between revisions

From Resonite Wiki
m Add note about using OSC receiver on a headless server
add last info needed to not be a stub
 
Line 3: Line 3:
|Name=OSC Receiver
|Name=OSC Receiver
}}
}}
{{stub}}
The '''OSC_Reciever''' component creates an OSC Server within Resonite to receive OSC messages.


{{Note|If this component does not work as expected, try disabling and re-enabling the <code>Enabled</code> field.|warning}}
{{Note|If this component does not work as expected, try disabling and re-enabling the <code>Enabled</code> field.|warning}}


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|HandlingUser|{{RootFieldType|UserRef}}|TypeAdv0=true|The OSC Reciever creates the OSC server on this User's machine.
|HandlingUser|{{RootFieldType|UserRef}}|TypeAdv0=true|The OSC Reciever creates the OSC server on this User's machine.
Line 15: Line 15:
}}
}}


== Behavior ==
== Usage ==
Once <code>Handling User</code> and <code>Port</code> are set, this component will create an OSC Server within Resonite to receive OSC messages. To actually receive data, you should use the Value components:
Once <code>Handling User</code> and <code>Port</code> are set, To actually receive data, you should use the Value components:
* [[Component:OSC_Value]]
* [[Component:OSC_Value]]
* [[Component:OSC_Field]]
* [[Component:OSC_Field]]
Line 29: Line 29:


== See Also ==
== See Also ==
* [[OSC]]


[[Category:Components:Network:OSC{{#translation:}}|OSC Receiver]]
[[Category:Components:Network:OSC{{#translation:}}|OSC Receiver]]
[[Category:Components{{#translation:}}|OSC Receiver]]
[[Category:Components{{#translation:}}|OSC Receiver]]
[[Category:ComponentStubs]]

Latest revision as of 19:53, 22 December 2024

Component image 
OSC Receiver component as seen in the Scene Inspector

The OSC_Reciever component creates an OSC Server within Resonite to receive OSC messages.

If this component does not work as expected, try disabling and re-enabling the Enabled field.

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.
HandlingUser direct UserRef The OSC Reciever creates the OSC server on this User's machine.
AccessReason String Displayed in the Host Access Dialog when a connection is trying to be established.
Port Int Network port to listen on for OSC connections
IsListening Bool This value is set to true when Resonite is successful in opening a network connection to receive data on.

Usage

Once Handling User and Port are set, To actually receive data, you should use the Value components:

Examples

Limits

There are no limits to the number of OSC Paths that can be used to receive data.

When using a Headless Server the OSC address must be set to "localhost", using 127.0.0.1 will not work.

See Also