No edit summary |
Added a warning note on this component. |
||
| (2 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 == | ||
| Line 10: | Line 12: | ||
|AccessReason|String|Displayed in the Host Access Dialog when a connection is trying to be established. | |AccessReason|String|Displayed in the Host Access Dialog when a connection is trying to be established. | ||
|URL|Uri|Uri of the OSC Server to connect to, must be in the format <code>osc://<ip>:<port><code>. E.g. <code>osc://127.0.0.1:3001</code> | |URL|Uri|Uri of the OSC Server to connect to, must be in the format <code>osc://<ip>:<port><code>. E.g. <code>osc://127.0.0.1:3001</code> | ||
|LocalPort|Int|Sets the local port. Defaults on 0 which is random. | |||
|IsSending|Bool|Set to true if this OSC Sender is sending data. | |IsSending|Bool|Set to true if this OSC Sender is sending data. | ||
|SendMode|OSC_SendMode|The Mode in which data is sent to the OSC Server. See [[#Behavior]] | |SendMode|OSC_SendMode|The Mode in which data is sent to the OSC Server. See [[#Behavior]] | ||
| Line 22: | Line 25: | ||
== Examples == | == Examples == | ||
* See [[OSC]] | * See [[OSC]] | ||
== Limits == | |||
When sending Multi-Dimensional OSC Values, there is a limit of 256 values on a single OSC Path. | |||
There are no limits to the number of OSC Paths that can be used. | |||
== See Also == | == See Also == | ||
Latest revision as of 03:46, 28 September 2024
Component image 
OSC Sender component as seen in the Scene Inspector
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Usage
| 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 | |
AccessReason
|
String | Displayed in the Host Access Dialog when a connection is trying to be established. |
URL
|
Uri | Uri of the OSC Server to connect to, must be in the format osc://<ip>:<port> |
LocalPort
|
Int | Sets the local port. Defaults on 0 which is random. |
IsSending
|
Bool | Set to true if this OSC Sender is sending data. |
SendMode
|
OSC_SendMode | The Mode in which data is sent to the OSC Server. See #Behavior |
AutoResendInterval
|
Float | Data will automatically be resent at this interval if it is set. In Seconds. See #Behavior |
Behavior
Once Handling User and Uri are set, this component will try to connect to the OSC Server at the URL provided. To actually receive data, you should use the Value components:
Examples
- See OSC
Limits
When sending Multi-Dimensional OSC Values, there is a limit of 256 values on a single OSC Path.
There are no limits to the number of OSC Paths that can be used.