API > OSC

OSC⚓︎

OSC (open sound control) Lua Interface which allows to bind Lua functions to be executed when OSC messages received.

Name	Description
`OSC`.`IsClientRunning`	Is OSC client running?
`OSC`.`IsServerRunning`	Is the OSC server running?

Name	Description
`OSC`.`HasAddress(address)`	Returns true if the address is registered.
`OSC`.`SendMessage(address, parameters)`	Sends an OSC message to the specified address with basic parameters. Maximum of four (4) parameters allowed. Allowed parameter types are boolean, string and number (double). To have more control over parameter types, use type tag string.
`OSC`.`SendMessageTypeTag(address, TypeTag, params)`	Send OSC message to the specified address with type tag defined parameters. Maximum of four (4) parameters allowed. Use the Type Tag string to define the types of the variables. Follow the OSC specification on type characters here
`OSC`.`TryBindAddressPattern(address, function)`	Binds an address to a provided Lua function. Returns true if the operation was successful. Note that the provided functions parameters must match message received by OSC both in order and type.
`OSC`.`TryUnBindAddressPattern(address)`	Unbind a previously bound address. Returns true if the operation was successful.