ofxOscReceiver

class methods

Documentation from code comments


OSC message receiver which listens on a network port

ofxOscReceiver()

ofxOscReceiver::ofxOscReceiver()

ofxOscReceiver(...)

ofxOscReceiver::ofxOscReceiver(const ofxOscReceiver &mom)

~ofxOscReceiver()

ofxOscReceiver::~ofxOscReceiver()

copy(...)

ofxOscReceiver & ofxOscReceiver::copy(const ofxOscReceiver &other)

Documentation from code comments


for operator= and copy constructor

getNextMessage(...)

bool ofxOscReceiver::getNextMessage(ofxOscMessage &msg)

Documentation from code comments


remove a message from the queue and copy it's data into msg \return false if there are no waiting messages, otherwise return true

getParameter(...)

bool ofxOscReceiver::getParameter(ofAbstractParameter &parameter)

Documentation from code comments


try to get waiting message an ofParameter \return true if message was handled by the given parameter

getPort()

int ofxOscReceiver::getPort()

Documentation from code comments


\return listening port

getSettings()

const ofxOscReceiverSettings & ofxOscReceiver::getSettings()

Documentation from code comments


\return the current receiver settings

hasWaitingMessages()

bool ofxOscReceiver::hasWaitingMessages()

Documentation from code comments


\return true if there are any messages waiting for collection

isListening()

bool ofxOscReceiver::isListening()

Documentation from code comments


\return true if the receiver is listening

operator=(...)

ofxOscReceiver & ofxOscReceiver::operator=(const ofxOscReceiver &mom)

setup(...)

bool ofxOscReceiver::setup(const ofxOscReceiverSettings &settings)

Documentation from code comments


set up the receiver with the given settings

starts listening if start is true (true by default)

multiple receivers can share the same port if port reuse is enabled (true by default)

\return true if listening was started or start was not required

setup(...)

bool ofxOscReceiver::setup(int port)

Documentation from code comments


set up the receiver with the port to listen for messages on and start listening

multiple receivers can share the same port if port reuse is enabled (true by default)

\return true if listening started

start()

bool ofxOscReceiver::start()

Documentation from code comments


start listening manually using the current settings

this is not required if you called setup(port) or setup(settings) with start set to true

\return true if listening started or was already running

stop()

void ofxOscReceiver::stop()

Documentation from code comments


stop listening, does not clear port value

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