ofxOscMessage

class methods

Documentation from code comments


an OSC message with address and arguments

ofxOscMessage()

ofxOscMessage::ofxOscMessage()

ofxOscMessage(...)

ofxOscMessage::ofxOscMessage(const ofxOscMessage &other)

~ofxOscMessage()

ofxOscMessage::~ofxOscMessage()

addBlobArg(...)

void ofxOscMessage::addBlobArg(const ofBuffer &argument)

Documentation from code comments


add a binary blog

addBoolArg(...)

void ofxOscMessage::addBoolArg(bool argument)

Documentation from code comments


add a bool true sends a OFXOSC_TYPE_TRUE & false sends a OFXOSC_TYPE_FALSE

addCharArg(...)

void ofxOscMessage::addCharArg(char argument)

Documentation from code comments


add a char

addDoubleArg(...)

void ofxOscMessage::addDoubleArg(double argument)

Documentation from code comments


add a 64-bit double

addFloatArg(...)

void ofxOscMessage::addFloatArg(float argument)

Documentation from code comments


add a 32-bit float

addImpulseArg()

void ofxOscMessage::addImpulseArg()

Documentation from code comments


add a trigger impulse (has no value) alias for addTriggerArg()

addInfinitumArg()

void ofxOscMessage::addInfinitumArg()

Documentation from code comments


add a trigger impulse (has no value) alias for addTriggerArg()

addInt32Arg(...)

void ofxOscMessage::addInt32Arg(int32_t argument)

Documentation from code comments


add a 32-bit integer

addInt64Arg(...)

void ofxOscMessage::addInt64Arg(int64_t argument)

Documentation from code comments


add a 64-bit integer

addIntArg(...)

void ofxOscMessage::addIntArg(int32_t argument)

Documentation from code comments


add a 32-bit integer

addMidiMessageArg(...)

void ofxOscMessage::addMidiMessageArg(uint32_t argument)

Documentation from code comments


add a 4-byte MIDI message

addNoneArg()

void ofxOscMessage::addNoneArg()

Documentation from code comments


add a none/nil (has no value)

addRgbaColorArg(...)

void ofxOscMessage::addRgbaColorArg(uint32_t argument)

Documentation from code comments


add a 32-bit color

addStringArg(...)

void ofxOscMessage::addStringArg(const string &argument)

Documentation from code comments


add a string

addSymbolArg(...)

void ofxOscMessage::addSymbolArg(const string &argument)

Documentation from code comments


add a symbol (string)

addTimetagArg(...)

void ofxOscMessage::addTimetagArg(uint64_t argument)

Documentation from code comments


add a 64-bit NTP time tag

addTriggerArg()

void ofxOscMessage::addTriggerArg()

Documentation from code comments


add a trigger impulse (has no value)

clear()

void ofxOscMessage::clear()

Documentation from code comments


clear this message

copy(...)

ofxOscMessage & ofxOscMessage::copy(const ofxOscMessage &other)

Documentation from code comments


for operator= and copy constructor

getAddress()

string ofxOscMessage::getAddress()

Documentation from code comments


\return the OSC address

getArgAsBlob(...)

ofBuffer ofxOscMessage::getArgAsBlob(size_t index)

Documentation from code comments


Parameters:

index The index of the queried item. \return given argument as a binary blob

getArgAsBool(...)

bool ofxOscMessage::getArgAsBool(size_t index)

Documentation from code comments


get argument as a bool, converts numeric types automatically this argument type matches both OFXOSC_TYPE_TRUE & OFXOSC_TYPE_FALSE

Parameters:

index The index of the queried item. \return given argument value as a bool

getArgAsChar(...)

char ofxOscMessage::getArgAsChar(size_t index)

Documentation from code comments


get argument as a string, converts numeric types with a warning

Parameters:

index The index of the queried item. \return given argument value as a string

getArgAsDouble(...)

double ofxOscMessage::getArgAsDouble(size_t index)

Documentation from code comments


get argument as a double, converts numeric types automatically

Parameters:

index The index of the queried item. \return given argument value as a double

getArgAsFloat(...)

float ofxOscMessage::getArgAsFloat(size_t index)

Documentation from code comments


get argument as a float, converts numeric types automatically prints a warning when converting higher precision types

Parameters:

index The index of the queried item. \return given argument value as a float

getArgAsImpulse(...)

bool ofxOscMessage::getArgAsImpulse(size_t index)

Documentation from code comments


get argument as a trigger impulse this is an alias for getArgAsTrigger()

Parameters:

index The index of the queried item. \return true if argument was a trigger

getArgAsInfinitum(...)

bool ofxOscMessage::getArgAsInfinitum(size_t index)

Documentation from code comments


get argument as a trigger impulse this is an alias for getArgAsTrigger()

Parameters:

index The index of the queried item. \return true if argument was a trigger

getArgAsInt(...)

int32_t ofxOscMessage::getArgAsInt(size_t index)

Documentation from code comments


get argument as an integer, converts numeric types automatically prints a warning when converting higher precision types

Parameters:

index The index of the queried item. \return given argument value as a 32-bit int

getArgAsInt32(...)

int32_t ofxOscMessage::getArgAsInt32(size_t index)

Documentation from code comments


get argument as an integer, converts numeric types automatically prints a warning when converting higher precision types

Parameters:

index The index of the queried item. \return given argument value as a 32-bit int

getArgAsInt64(...)

int64_t ofxOscMessage::getArgAsInt64(size_t index)

Documentation from code comments


get argument as a 64-bit integer, converts numeric types automatically \return given argument value as a 64-bit int

Parameters:

index The index of the queried item.

getArgAsMidiMessage(...)

uint32_t ofxOscMessage::getArgAsMidiMessage(size_t index)

Documentation from code comments


Parameters:

index The index of the queried item. \return given argument value as a 4-byte midi message

getArgAsNone(...)

bool ofxOscMessage::getArgAsNone(size_t index)

Documentation from code comments


get argument as a none/nil

Parameters:

index The index of the queried item. \return true if argument was a none/nil

getArgAsRgbaColor(...)

uint32_t ofxOscMessage::getArgAsRgbaColor(size_t index)

Documentation from code comments


get an argument as an RGBA color, converts int32 automatically

Parameters:

index The index of the queried item. \return given argument as a 32-bit color value

getArgAsString(...)

string ofxOscMessage::getArgAsString(size_t index)

Documentation from code comments


get argument as a string, converts numeric types with a warning

Parameters:

index The index of the queried item. \return given argument value as a string

getArgAsSymbol(...)

string ofxOscMessage::getArgAsSymbol(size_t index)

Documentation from code comments


get argument as a symbol (string), converts numeric types with a warning

Parameters:

index The index of the queried item. \return given argument value as a symbol (string)

getArgAsTimetag(...)

uint64_t ofxOscMessage::getArgAsTimetag(size_t index)

Documentation from code comments


Parameters:

index The index of the queried item. \return given argument as a 64-bit NTP time tag

getArgAsTrigger(...)

bool ofxOscMessage::getArgAsTrigger(size_t index)

Documentation from code comments


get argument as a trigger impulse

Parameters:

index The index of the queried item. \return true if argument was a trigger

getArgType(...)

ofxOscArgType ofxOscMessage::getArgType(size_t index)

Documentation from code comments


Parameters:

index The index of the queried item. \return argument type code for a given index

getArgTypeName(...)

string ofxOscMessage::getArgTypeName(size_t index)

Documentation from code comments


Parameters:

index The index of the queried item. \return argument type tag char as a string

getNumArgs()

size_t ofxOscMessage::getNumArgs()

Documentation from code comments


\return number of arguments

getRemoteHost()

string ofxOscMessage::getRemoteHost()

Documentation from code comments


\return the remote host name/ip or "" if not set

getRemotePort()

int ofxOscMessage::getRemotePort()

Documentation from code comments


\return the remote port or 0 if not set

getTypeString()

string ofxOscMessage::getTypeString()

Documentation from code comments


Parameters:

index The index of the queried item. \return type tags for all arguments as a string, 1 char for each argument

operator=(...)

ofxOscMessage & ofxOscMessage::operator=(const ofxOscMessage &other)

setAddress(...)

void ofxOscMessage::setAddress(const string &address)

Documentation from code comments


set the message address, must start with a /

setRemoteEndpoint(...)

void ofxOscMessage::setRemoteEndpoint(const string &host, int port)

Documentation from code comments


set host and port of the remote endpoint, this is mainly used by ofxOscReceiver

If you have any doubt about the usage of this module you can ask in the forum.

If you want to contribute better documentation or start documenting this section you can do so here

If you find anything wrong with this docs you can report any error by opening an issue