Component:OSC Receiver: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
Added a warning note for this component.
 
(5 intermediate revisions by 2 users not shown)
Line 4: Line 4:
}}
}}
{{stub}}
{{stub}}
{{Note|If this component does not work as expected, try disabling and re-enabling the <code>Enabled</code> field.|warning}}


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|HandlingUser|{{RootFieldType|UserRef}}|TypeAdv0=true|
|HandlingUser|{{RootFieldType|UserRef}}|TypeAdv0=true|The OSC Reciever creates the OSC server on this User's machine.
|AccessReason|String|
|AccessReason|String|Displayed in the Host Access Dialog when a connection is trying to be established.
|Port|Int|
|Port|Int|Network port to listen on for OSC connections
|IsListening|Bool|
|IsListening|Bool|This value is set to true when Resonite is successful in opening a network connection to receive data on.
}}
}}


== Behavior ==
== Behavior ==
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:
* [[Component:OSC_Value]]
* [[Component:OSC_Field]]


== Examples ==
== Examples ==
* See [[OSC]].
== Limits ==
There are no limits to the number of OSC Paths that can be used to receive data.


== See Also ==
== See Also ==

Latest revision as of 03:44, 28 September 2024

Component image 
OSC Receiver component as seen in the Scene Inspector


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


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

Usage

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.

Behavior

Once Handling User and Port 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:

Examples

Limits

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

See Also