reaper-osc
    Preparing search index...

    Class ReaperOscClient

    A stateless OSC client for communicating with Reaper.

    Translates incoming OSC messages into strongly typed events, and accepts strongly typed commands for sending to Reaper. Does not maintain any state about track properties, transport, or FX — use Reaper for that.

    const client = new ReaperOscClient();
    await client.start();

    // Receive typed events
    client.on('message', event => {
    switch (event.type) {
    case 'track:mute':
    console.log(`Track ${event.trackNumber} muted: ${event.muted}`);
    break;
    case 'transport:play':
    console.log(`Playing: ${event.playing}`);
    break;
    }
    });

    // Send typed commands
    client.send({ type: 'transport:play' });
    client.send({ type: 'track:mute', trackNumber: 3, muted: true });

    Hierarchy

    • EventEmitter
      • ReaperOscClient
    Index

    Constructors

    Accessors

    Methods

    Constructors

    Accessors

    • get isReady(): boolean

      Indicates whether OSC is ready to send and receive messages

      Returns boolean

    Methods

    • Open the OSC port and start listening for messages

      Returns Promise<void>

    • Stop listening for OSC messages

      Returns Promise<void>