reaper-osc
    Preparing search index...

    Class Reaper

    Allows control of an instance of Reaper via OSC.

    // Create an instance of Reaper using default settings
    const reaper = new Reaper();
    // Start OSC
    reaper.startOsc();
    // Give the port a chance to open, then tell Reaper to start playback
    setTimeout(() => {reaper.transport.play();}, 100);

    Implements

    Index

    Constructors

    constructor

    Accessors

    client device isAnySoloed isAutoRecordArmEnabled isMetronomeEnabled isReady markers master regions selectedTrack tracks transport viewport

    Methods

    onPropertyChanged refreshControlSurfaces sendOscMessage soloReset start stop toggleAutoRecordArm toggleMetronome triggerAction

    Constructors

    Accessors

    • get isAnySoloed(): boolean

      Indicates whether any track is soloed

      Returns boolean

    • get isAutoRecordArmEnabled(): boolean

      Indicates whether auto-record-arm is enabled

      Returns boolean

    • get isMetronomeEnabled(): boolean

      Indicates whether the metronome is enabled

      Returns boolean

    • get isReady(): boolean

      Indicates whether OSC is ready to send and receive messages

      Returns boolean

    Methods

    • An event that can be subscribed to for property change notifications

      Parameters

      • property: string

        The name of the property to subscribe to

      • callback: () => void

        A callback to be called when the state of the specified property changes

      Returns () => void

      A function that unsubscribes the event handler

    • Triggers the action Control surface: Refresh all surfaces (Command ID: 41743)

      Returns void

    • Reset all solos

      Returns void

    • Open the OSC port and start listening for messages

      Returns Promise<void>

    • Stop listening for OSC messages

      Returns Promise<void>

    • Toggle auto-record-arm on or off

      Returns void

    • Toggle the metronome on or off

      Returns void

    • Trigger a Reaper action

      Parameters

      • commandId: string | number

        The Command ID of the action to be triggered.

      • value: number | null = null

        The value to send for the action. Note that some actions expect the CC value (0-127) while others expect a decimal value between 0 and 1.

      Returns void

      // Trigger action 'Track: Toggle mute for master track'
      reaper.triggerAction(14);
      // Trigger SWS Extension action 'SWS/S&M: Live Config #1 - Apply config (MIDI/OSC only)' with a CC value of 3, selects config #3
      reaper.triggerAction('_S&M_LIVECFG_APPLY1', 3);
      // Trigger action 'Track: Set volume for track 01 (MIDI CC/OSC only)' with a value of 0.75, sets volume of track 1 to +0.0dB
      reaper.triggerAction(20, 0.7156)

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods