No edit summary |
m grammar |
||
(3 intermediate revisions by 3 users not shown) | |||
Line 3: | Line 3: | ||
|Name=OSC Sender | |Name=OSC Sender | ||
}} | }} | ||
{{ | The '''OSC_Sender''' component will try to connect to the OSC Server at the URL provided, and send data to it. | ||
{{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 Sender finds the OSC server on this User's machine. | ||
|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 [[# | |SendMode|OSC_SendMode|The Mode in which data is sent to the OSC Server. See [[#Usage]] | ||
|AutoResendInterval|Float|Data will automatically be resent at this interval if it is set. In Seconds. See [[#Behavior]] | |AutoResendInterval|Float|Data will automatically be resent at this interval if it is set. In Seconds. See [[#Behavior]] | ||
}} | }} | ||
== | == Usage == | ||
Once <code>Handling User</code> and <code>Uri</code> 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: | Once <code>Handling User</code> and <code>Uri</code> 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: | ||
* [[Component:OSC_Value]] | * [[Component:OSC_Value]] | ||
Line 34: | Line 37: | ||
[[Category:Components:Network:OSC{{#translation:}}|OSC Sender]] | [[Category:Components:Network:OSC{{#translation:}}|OSC Sender]] | ||
[[Category:Components{{#translation:}}|OSC Sender]] | [[Category:Components{{#translation:}}|OSC Sender]] | ||
Latest revision as of 19:55, 22 December 2024
Component image
The OSC_Sender component will try to connect to the OSC Server at the URL provided, and send data to 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 | The OSC Sender finds the OSC server on this User's machine. |
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 #Usage |
AutoResendInterval
|
Float | Data will automatically be resent at this interval if it is set. In Seconds. See #Behavior |
Usage
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.