ofxPubSubOsc

easy utility for publish/subscribe OSC message.

Dependencies

ofxOsc

Notice

this addon is tested with oF0.9.8~
if you use oF0.9.0~, then you can use std::function<void(ofxOscMessage &)>! detail: API Reference
if you use oF~0.8.4, then you can use branch:v0_1_x_oF084
if you have challange spirit, please use dev/vX.Y.Z branch.
if you want to join development ofxPubSubOsc, open the issue and post the PR for dev/vX.Y.Z.

How to use

class ofApp : public ofBaseApp {
	int foo;
	ofColor c;
	ofPoint p;
public:
	void setup() {
		ofxSubscribeOsc(9005, "/foo", foo);
		ofxSubscribeOsc(9005, "/color", c);
		ofxSubscribeOsc(9005, "/p", p);
		
		ofxPublishOsc("localhost", 9006, "/fps", &ofGetFrameRate);
		
		ofxSubscribeOsc(9005, "/lambda", [](const std::string &str){
			ofLogNotice() << "receive " << str;
		});
		ofxSubscribeOsc(9005, "/trigger_event", [](){
			ofLogNotice() << "receive trigger_event";
		});
	}
	
	void update() {
		// do NOTHING about OSC on update!!!
	}
	
	void draw() {
		ofSetColor(c);
		ofDrawCircle(p, 5);
	}
};

Simple API Reference

API Reference is imperfect now.

If you want to use advanced features, see Advanced

ofxSubscribeOsc

void ofxSubscribeOsc(int port, const string &address, SupportedType &value);

bind a value to the argument(s) of OSC messages with an address pattern address incoming to port.

See more ofxSubscribeOsc

ofxUnsubscribeOsc(int port, const string &address);

unbind from OSC messages with an address pattern address incoming to port.

ofxUnsubscribeOsc(int port);

unbind from OSC messages with any address patterns incoming to port.

if you want to pick up OSCs which do not match the subscribed addresses, see ofxSetLeadkedOscPicker

See class ofxOscSubscriberManager, class ofxOscSubscriber

ofxPublishOsc

void ofxPublishOsc(const string &ip, int port, const string &address, SupportedType &value, bool whenValueIsChanged = true);

publish value as an OSC message with an address pattern address to ip:port every time the value has changed. If whenValueIsChanged is set to false, then the binded value is sent every frame after App::update.

See more ofxPublishOsc, ofxPublishOscIf

void ofxUnpublishOsc(const string &ip, int port, const string &address);

unbind a publisher sending OSC message with an address pattern address to ip:port.

void ofxUnpublishOsc(const string &ip, int port);

unbind all the publishers sending to ip:port.

See class ofxOscPublisherManager, class ofxOscPublisher

ofxRegisterPublishingOsc

void ofxRegisterPublishingOsc(const string &ip, int port, const string &address, SupportedType &value)
void ofxPublishRegisteredOsc(const string &ip, int port, const string &address)

register value as an OSC message with an address pattern address to ip:port. and publish when call ofxPublishRegisteredOsc(ip, port, address).

void ofxUnregisterPublishingOsc(const string &ip, int port, const string &address)

unregister OSC message with an address pattern address to ip:port.

void ofxUnregisterPublishingOsc(const string &ip, int port)

unregister all the messages sending to ip:port.

NOTE: registable type is same to ofxPublishOsc. see more ofxPublishOsc.

ofxSendOsc

void ofxSendOsc(const string &ip, int port, const string &address, Arguments && ... arguments)

Supported types

Arithmetic is any type of Int32, Int64 or Float

Arithmetic (Int32, Int64, Float)

bool (published as Int32)
unsigned char, char (published as Int32)
unsigned short, short (published as Int32)
unsigned int, int (published as Int32 or Int64 (if sizeof(int) == 8 then Int64))
unsigned long, long (published as Int64 or Int64 (if sizeof(int) == 8 then Int64))
unsigned long long, long long (published as Int64)
float (published as Float)
double (published as Float)