OSC

OSC

Windows
MacOS
Linux
On this page

Actions

Add Blob to OSC Message

Adds blob value to end of OSCMessage

Target is OSCManager

Add Bool to OSC Message

Adds boolean value to end of OSCMessage

Target is OSCManager

Add Float to OSC Message

Adds float value to end of OSCMessage

Target is OSCManager

Add Integer (64-bit) to OSC Message

Adds Int64 value to end of OSCMessage

Target is OSCManager

Add Integer to OSC Message

Adds Int32 value to end of OSCMessage

Target is OSCManager

Add OSC Address (As String) to OSC Message

Adds address (packed as string) value to end of OSCMessage

Target is OSCManager

Add OSC Bundle to Bundle

Adds bundle packet to bundle.

Target is OSCManager

Add OSC Message to Bundle

Adds provided message packet to bundle.

Target is OSCManager

Add String to OSC Message

Adds string value to end of OSCMessage

Target is OSCManager

Add Whitelisted Client

Adds client to whitelist of clients to listen for.

Target is OSCServer

Bind Event to on OSCAddress Pattern Matches Path

Adds event to dispatch when OSCAddressPattern is matched.

Target is OSCServer

Clear OSC Address Containers

Clears containers of OSC Address provided

Target is OSCManager

Clear OSC Bundle

Clears provided bundle of all internal messages/bundle packets.

Target is OSCManager

Clear OSC Message

Clears provided message of all arguments.

Target is OSCManager

Clear Whitelisted Clients

Clears client whitelist to listen for.

Target is OSCServer

Convert Object Path (String) to OSC Address

Converts object path string to OSC Address, converting folders to address containers and the object's name to the address method. Only supports parent objects (See UObjectBaseUtility::GetPathName and UObjectBaseUtility::GetFullName).

Target is OSCManager

Convert Object Path to OSC Address

Converts object path to OSC Address, converting folders to address containers and the object's name to the address method. Only supports parent objects (See UObjectBaseUtility::GetPathName and UObjectBaseUtility::GetFullName).

Target is OSCManager

Convert OSC Address to Object Path

Converts OSC Address to an object path.

Target is OSCManager

Convert OSC Address To String

Returns full path of OSC address in the form '/Container1/Container2'

Target is OSCManager

Convert String to OSCAddress

Converts string to OSC Address

Target is OSCManager

Create OSCClient

Creates an OSC Client. If SendIPAddress left empty (or '0'), attempts to use attempts to use LocalHost IP address.

Target is OSCManager

Create OSCServer

Creates an OSC Server. If ReceiveIPAddress left empty (or '0'), attempts to use LocalHost IP address. If StartListening set, immediately begins listening on creation.

Target is OSCManager

Find Object at OSC Address

Finds an object with the given OSC Address in path form, where containers correspond to path folders and the the address method to the object's name. Only supports parent objects.

Target is OSCManager

Get Blob

Sets Value to blob at provided Index from OSCMessage if in bounds and type matches

Target is OSCManager

Get Bound OSCAddress Patterns

Returns set of OSCAddressPatterns currently listening for matches to dispatch.

Target is OSCServer

Get Ip Address

Returns the IP for the server if connected as a string.

Target is OSCServer

Get Multicast Loopback

Gets whether or not to loopback if ReceiveIPAddress provided is multicast.

Target is OSCServer

Get OSC Address Container At Index

Returns the OSC Address container at the provided 'Index.' Returns empty string if index is out-of-bounds.

Target is OSCManager

Get OSC Address Containers

Builds referenced array of address of containers in order

Target is OSCManager

Get OSC Address Method

Returns method name of OSC Address provided

Target is OSCManager

Get OSC Bundles From Bundle

Fills array with child bundles found in bundle.

Target is OSCManager

Get OSC Message Address

Returns copy of message's OSC Address

Target is OSCManager

Get OSC Message Address At Index

Sets Value to address at provided Index in OSCMessage if in bounds and OSC type matches 'String' (Does NOT return address of message, rather string packed in message and casts to OSC address). Returns if string found at index and is valid OSC address path.

Target is OSCManager

Get OSC Message Addresses

Returns all strings that are valid address paths in order received from OSCMessage (Does NOT include address of message, just strings packed in message that are valid paths).

Target is OSCManager

Get OSC Message Bool At Index

Sets Value to boolean at provided Index from OSCMessage if in bounds and type matches

Target is OSCManager

Get OSC Message Bools

Returns all boolean values in order of received from OSCMessage

Target is OSCManager

Get OSC Message Float At Index

Set Value to float at provided Index in OSCMessage if in bounds and type matches

Target is OSCManager

Get OSC Message Floats

Returns all float values in order of received from OSCMessage

Target is OSCManager

Get OSC Message From Bundle At Index

Returns message found in bundle at ordered index.

Target is OSCManager

Get OSC Message Integer (64-bit) at Index

Set Value to Int64 at provided Index in OSCMessage if in bounds and type matches

Target is OSCManager

Get OSC Message Integer at Index

Set Value to integer at provided Index in OSCMessage if in bounds and type matches

Target is OSCManager

Get OSC Message Integers

Returns all integer values in order of received from OSCMessage

Target is OSCManager

Get OSC Message Integers (64-bit)

Returns all Int64 values in order of received from OSCMessage

Target is OSCManager

Get OSC Message String at Index

Set Value to string at provided Index in OSCMessage if in bounds and type matches

Target is OSCManager

Get OSC Message Strings

Returns all string values in order of received from OSCMessage

Target is OSCManager

Get OSC Messages From Bundle

Fills array with messages found in bundle.

Target is OSCManager

Get OSCAddress Container Path

Returns full path of OSC address in the form '/Container1/Container2/Method'

Target is OSCManager

Get Port

Returns the port for the server if connected.

Target is OSCServer

Get Send IPAddress

Gets the OSC Client IP address and port.

Target is OSCClient

Get Whitelisted Clients

Returns set of whitelisted clients.

Target is OSCServer

Is Active

Returns whether server is actively listening to incoming messages.

Target is OSCServer

Is OSC Address Valid Path

Returns whether OSC Address is valid path

Target is OSCManager

Is OSC Address Valid Pattern

Returns whether OSC Address is valid pattern to match against

Target is OSCManager

Listen

Sets the IP address and port to listen for OSC data.

Target is OSCServer

On Osc Bundle Received

Event that gets called when an OSC bundle is received.

On Osc Message Received

Event that gets called when an OSC message is received.

OSC Address Path Matches Pattern

Returns if address pattern matches the provided address path. If passed address is not a valid path, returns false.

Target is OSCManager

Pop Container from OSC Address

Pops container from ordered array of containers. If no containers, returns empty string

Target is OSCManager

Pop Containers from OSC Address

Pops container from ordered array of containers. If NumContainers is greater than or equal to the number of containers in address, returns all containers.

Target is OSCManager

Push Container Array to OSC Address

Pushes container onto address' ordered array of containers

Target is OSCManager

Push Container to OSC Address

Pushes container onto address' ordered array of containers

Target is OSCManager

Remove Containers from OSC Address

Remove containers from ordered array of containers at index up to count of containers.

Target is OSCManager

Remove Whitelisted Client

Removes whitelisted client to listen for.

Target is OSCServer

Send OSCBundle

Send OSC Bundle over the network.

Target is OSCClient

Send OSCMessage

Send OSC message to a specific address.

Target is OSCClient

Set Address

Set the address and port of server. Fails if server is currently active.

Target is OSCServer

Set Multicast Loopback

Set whether or not to loopback if ReceiveIPAddress provided is multicast.

Target is OSCServer

Set OSC Address Method

Sets the method name of the OSC Address provided

Target is OSCManager

Set OSCMessage Address

Sets the OSC Address of the provided message

Target is OSCManager

Set Send IPAddress

Sets the OSC Client IP address and port. Returns whether address and port was successfully set.

Target is OSCClient

Set Whitelist Clients Enabled

When set to true, server will only process received messages from whitelisted clients.

Target is OSCServer

Stop

Stop and tidy up network socket.

Target is OSCServer

Unbind All Events from on OSCAddress Pattern Matches Path

Removes OSCAddressPattern from sending dispatch events.

Target is OSCServer

Unbind All Events from on OSCAddress Pattern Matching

Removes all events from OSCAddressPatterns to dispatch.

Target is OSCServer

Unbind Event from on OSCAddress Pattern Matches Path

Unbinds specific event from OSCAddress pattern.

Target is OSCServer

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss