Home Reference Source Test


osc-js is an Open Sound Control library for JavaScript applications (UMD module for Node, Browser etc.) with address pattern matching and timetag handling. Sends messages via UDP, WebSocket or both (bridge mode) and offers a customizable Plugin API for network protocols.

Wiki | Basic Usage | ESDoc Documentation | Plugin API



Read more about osc-js and how to use it in the Wiki.


const osc = new OSC()

osc.on('/param/density', message => {

osc.on('*', message => {

osc.on('/{foo,bar}/*/param', message => {

osc.on('open', () => {
  const message = new OSC.Message('/test', 12.221, 'hello')

osc.open({ port: 9000 })

Installation and Usage

Recommended installation via npm: npm install osc-js --save or yarn add osc-js.

Import the library const OSC = require('osc-js') or add the script lib/osc.js or lib/osc.min.js (minified version) for usage in a browser.


osc-js offers a plugin architecture for extending it's networking capabilities. The library comes with four built-in plugins. This is propably all you need for an OSC application:

Configuration and examples of every plugin can be read here: Wiki.

Example: WebSocket Server

Register the plugin when creating the OSC instance:

const osc = new OSC({ plugin: new OSC.WebsocketServerPlugin() })
osc.open() // listening on 'ws://localhost:8080'

Example: OSC between MaxMSP/PD/SC etc. and your browser

  1. Write a simple webpage. The library will use a WebSocket client by default.

    <button id="send">Send Message</button>
    <script type="text/javascript" src="lib/osc.browser.min.js"></script>
    <script type="text/javascript">
     var osc = new OSC();
     osc.open(); // connect by default to ws://localhost:8080
     document.getElementById('send').addEventListener('click', () => {
       var message = new OSC.Message('/test/random', Math.random());
  2. Write a Node app (the "bridge" between your UDP and WebSocket clients).

    const OSC = require('osc-js')
    const config = { udpClient: { port: 9129 } }
    const osc = new OSC({ plugin: new OSC.BridgePlugin(config) })
    osc.open() // start a WebSocket server on port 8080
  3. Create your Max/MSP patch (or PD, or SuperCollider or whatever you need).

    [udpreceive 9129] // incoming '/test/random' messages with random number

Custom solutions with Plugin API

It is possible to write more sophisticated solutions for OSC applications without loosing the osc-js interface (including it's message handling etc.). Read the Plugin API documentation for further information.

class MyCustomPlugin {
  // ... read docs for implementation details

const osc = new OSC({ plugin: MyCustomPlugin() })

osc.on('/test', message => {
  // use event listener with your plugin

Usage without plugins

The library can be used without the mentioned features in case you need to write and read binary OSC data. See this example below for using the Low-Level API (even though the library already has a solution for handling UDP like in this example):

const dgram = require('dgram')
const OSC = require('osc-js')

const socket = dgram.createSocket('udp4')

// send a messsage via udp
const message = new OSC.Message('/some/path', 21)
const binary = message.pack()
socket.send(new Buffer(binary), 0, binary.byteLength, 41234, 'localhost')

// receive a message via UDP
socket.on('message', data => {
  const msg = new OSC.Message()


osc-js uses Babel for ES6 support, ESDoc for documentation, Mocha + Chai for testing and Rollup for generating the UMD module.

Clone the repository and install all dependencies:

git clone [email protected]:adzialocha/osc-js.git
cd osc-js
npm install


npm run test for running the test suites. npm run test:watch for running specs during development. Check your style guide violations with npm run lint.


npm run build for creating all UMD modules in lib folder.


npm run docs for generating a docs folder with HTML files documenting the library. Read them online here: https://doc.esdoc.org/github.com/adzialocha/osc-js/