Ardour  8.7-15-gadf511264b
ARDOUR::LuaOSC::Address Class Reference

#include <lua_api.h>

Public Member Functions

 Address (std::string uri)
 
 ~Address ()
 
int send (lua_State *lua)
 

Private Attributes

lo_address _addr
 

Detailed Description

OSC transmitter

A Class to send OSC messages.

Definition at line 446 of file lua_api.h.

Constructor & Destructor Documentation

◆ Address()

ARDOUR::LuaOSC::Address::Address ( std::string  uri)
inline

Construct a new OSC transmitter object

Parameters
urithe destination uri e.g. "osc.udp://localhost:7890"

Definition at line 455 of file lua_api.h.

◆ ~Address()

ARDOUR::LuaOSC::Address::~Address ( )
inline

Definition at line 459 of file lua_api.h.

Member Function Documentation

◆ send()

int ARDOUR::LuaOSC::Address::send ( lua_State lua)

Transmit an OSC message

Path (string) and type (string) must always be given. The number of following args must match the type. Supported types are:

'i': integer (lua number)

'f': float (lua number)

'd': double (lua number)

'h': 64bit integer (lua number)

's': string (lua string)

'c': character (lua string)

'T': boolean (lua bool) – this is not implicily True, a lua true/false must be given

'F': boolean (lua bool) – this is not implicily False, a lua true/false must be given

Parameters
lualua arguments: path, types, ...
Returns
boolean true if successful, false on error.

Member Data Documentation

◆ _addr

lo_address ARDOUR::LuaOSC::Address::_addr
private

Definition at line 487 of file lua_api.h.


The documentation for this class was generated from the following file: