1. module node-osc
   1. function node-osc.Client (host, port)
   2. function node-osc.Message (address)
   3. function node-osc.Server (port, host)
   4. object node-osc.Client.prototype
   5. object node-osc.Message.prototype
   6. object node-osc.types
2. module node-osc.Client
   1. function node-osc.Client (host, port)
3. module node-osc.Client.prototype
   1. function node-osc.Client.prototype.send (message)
4. module node-osc.Message
   1. function node-osc.Message (address)
5. module node-osc.Message.prototype
   1. function node-osc.Message.prototype.append (arg)
6. module node-osc.Server
   1. function node-osc.Server (port, host)
   2. function node-osc.Server.super_ ()
7. module node-osc.types
   1. function node-osc.types.TBlob (value)
   2. function node-osc.types.TDouble (value)
   3. function node-osc.types.TFalse (value)
   4. function node-osc.types.TFloat (value)
   5. function node-osc.types.TInt (value)
   6. function node-osc.types.TString (value)
   7. function node-osc.types.TTime (value)
   8. function node-osc.types.TTrue (value)

module node-osc

function node-osc.Client (host, port)

• description and source-code

  Client = function (host, port) {
      this.host = host;
      this.port = port;
      this._sock = dgram();
      this.kill = function() {
          this._sock.close();
      };
  }

• example usage

  ...
  
  Sending OSC messages:
  
  ::
  
    var osc = require('node-osc');
  
    var client = new osc.Client('127.0.0.1', 3333);
    client.send('/oscAddress', 200, function () {
      client.kill();
    });
  
  Listening for OSC messages:
  
  ::
  ...

function node-osc.Message (address)

• description and source-code

  function Message(address) {
      this.oscType = 'message';
      this.address = address;
      this.args = [];
  
      for (var i = 1; i < arguments.length; i++) {
          this.append(arguments[i]);
      }
  }

• example usage

  n/a

function node-osc.Server (port, host)

• description and source-code

  Server = function (port, host) {
      var server;
      events.EventEmitter.call(this);
      this.port = port;
      this.host = host;
      this._sock = dgram();
      this._sock.bind(port);
      server = this;
      this._sock.on('message', function (msg, rinfo) {
          try {
              var decoded = decode(msg);
              // [<address>, <typetags>, <values>*]
          }
          catch (e) {
              console.log('can\'t decode incoming message: ' + e.message);
          }
  
          if (decoded) {
              server.emit('message', decoded, rinfo);
              server.emit(decoded[0], decoded, rinfo);
          }
      });
      this.kill = function() {
          this._sock.close();
      };
  }

• example usage

  ...
  
  Listening for OSC messages:
  
  ::
  
    var osc = require('node-osc');
  
    var oscServer = new osc.Server(3333, '0.0.0.0');
    oscServer.on("message", function (msg, rinfo) {
    	console.log("TUIO message:");
    	console.log(msg);
    });
  
  Example of received TUIO (based on OSC) messages:
  ...

module node-osc.Client

function node-osc.Client (host, port)

• description and source-code

  Client = function (host, port) {
      this.host = host;
      this.port = port;
      this._sock = dgram();
      this.kill = function() {
          this._sock.close();
      };
  }

• example usage

  ...
  
  Sending OSC messages:
  
  ::
  
    var osc = require('node-osc');
  
    var client = new osc.Client('127.0.0.1', 3333);
    client.send('/oscAddress', 200, function () {
      client.kill();
    });
  
  Listening for OSC messages:
  
  ::
  ...

module node-osc.Client.prototype

function node-osc.Client.prototype.send (message)

• description and source-code

  send = function (message) {
      var mes;
      var buf;
      var callback;
      var args = Array.prototype.slice.call(arguments);
      var last = args[args.length - 1];
      if (typeof last === 'function') {
        callback = args.pop();
      }
      else {
        callback = function () {};
      }
      if (message instanceof Array) {
        message = {
          address: message[0],
          args: message.splice(1)
        }
      }
  
      switch (typeof message) {
          case 'object':
              buf = min.toBuffer(message);
              this._sock.send(buf, 0, buf.length, this.port, this.host, callback);
              break;
          case 'string':
              mes = new Message(args[0]);
              for (var i = 1; i < args.length; i++) {
                  mes.append(args[i]);
              }
              buf = min.toBuffer(mes);
              this._sock.send(buf, 0, buf.length, this.port, this.host, callback);
              break;
          default:
              throw new Error('That Message Just Doesn\'t Seem Right');
      }
  }

• example usage

  ...
  Sending OSC messages:
  
  ::
  
    var osc = require('node-osc');
  
    var client = new osc.Client('127.0.0.1', 3333);
    client.send('/oscAddress', 200, function () {
      client.kill();
    });
  
  Listening for OSC messages:
  
  ::
  ...

module node-osc.Message

function node-osc.Message (address)

• description and source-code

  function Message(address) {
      this.oscType = 'message';
      this.address = address;
      this.args = [];
  
      for (var i = 1; i < arguments.length; i++) {
          this.append(arguments[i]);
      }
  }

• example usage

  n/a

module node-osc.Message.prototype

function node-osc.Message.prototype.append (arg)

• description and source-code

  append = function (arg) {
      var argOut;
      switch (typeof arg) {
      case 'object':
          if (arg instanceof Array) {
              for (var i = 0; i < arg.length; i++) {
                  this.append(arg[i]);
              }
          } else if (arg.type) {
              this.args.push(arg);
          } else {
              throw new Error('don\'t know how to encode object ' + arg);
          }
          break;
      case 'number':
          if (Math.floor(arg) === arg) {
              argOut = new Argument('integer', arg);
              this.args.push(argOut);
          } else {
              argOut = new Argument('float', arg);
              this.args.push(argOut);
          }
          break;
      case 'string':
          argOut = new Argument('string', arg);
          this.args.push(argOut);
          break;
      default:
          throw new Error('don\'t know how to encode ' + arg);
      }
  }

• example usage

  n/a

module node-osc.Server

function node-osc.Server (port, host)

• description and source-code

  Server = function (port, host) {
      var server;
      events.EventEmitter.call(this);
      this.port = port;
      this.host = host;
      this._sock = dgram();
      this._sock.bind(port);
      server = this;
      this._sock.on('message', function (msg, rinfo) {
          try {
              var decoded = decode(msg);
              // [<address>, <typetags>, <values>*]
          }
          catch (e) {
              console.log('can\'t decode incoming message: ' + e.message);
          }
  
          if (decoded) {
              server.emit('message', decoded, rinfo);
              server.emit(decoded[0], decoded, rinfo);
          }
      });
      this.kill = function() {
          this._sock.close();
      };
  }

• example usage

  ...
  
  Listening for OSC messages:
  
  ::
  
    var osc = require('node-osc');
  
    var oscServer = new osc.Server(3333, '0.0.0.0');
    oscServer.on("message", function (msg, rinfo) {
    	console.log("TUIO message:");
    	console.log(msg);
    });
  
  Example of received TUIO (based on OSC) messages:
  ...

function node-osc.Server.super_ ()

• description and source-code

  function EventEmitter() {
    EventEmitter.init.call(this);
  }

• example usage

  n/a

module node-osc.types

function node-osc.types.TBlob (value)

• description and source-code

  function TBlob(value) { this.value = value; }

• example usage

  n/a

function node-osc.types.TDouble (value)

• description and source-code

  function TDouble(value) { this.value = value; }

• example usage

  n/a

function node-osc.types.TFalse (value)

• description and source-code

  function TFalse(value) { this.value = value; }

• example usage

  n/a

function node-osc.types.TFloat (value)

• description and source-code

  function TFloat(value) { this.value = value; }

• example usage

  n/a

function node-osc.types.TInt (value)

• description and source-code

  function TInt(value) { this.value = value; }

• example usage

  n/a

function node-osc.types.TString (value)

• description and source-code

  function TString(value) { this.value = value; }

• example usage

  n/a

function node-osc.types.TTime (value)

• description and source-code

  function TTime(value) { this.value = value; }

• example usage

  n/a

function node-osc.types.TTrue (value)

• description and source-code

  function TTrue(value) { this.value = value; }

• example usage

  n/a