reaper-osc 0.2.0 → 0.3.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Ben Simpson
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Ben Simpson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,36 +1,32 @@
-# reaper-osc
-
-A Node.js library for controlling Cockos Reaper using Open Sound Control (OSC).
-
-## API Reference
-
-You can find the API documentation [here](https://lykaiosnz.github.io/reaper-osc.js/)
-
-## Installation
-
-Yarn: `yarn add reaper-osc`
-npm: `npm i reaper-osc`
-
-## Basic usage
-
-```javascript
-import {Reaper} from 'reaper-osc';
-
-var reaper = new Reaper();
-
-// Start listening for messages
-reaper.startOsc();
-
-// Subscribe to state changes
-reaper.tracks[0].onPropertyChanged('isMuted', () => {
-  console.log(`Track 1 was ${reaper.tracks[0].isMuted ? 'muted' : 'unmuted'}`);
-});
-
-// Wait for the port to open, then start sending commands
-reaper.onReady(() => {
-  reaper.transport.play();
-
-  reaper.tracks[0].mute();
-  reaper.tracks[0].unmute();
-});
+# reaper-osc
+
+A Node.js library for controlling Cockos Reaper using Open Sound Control (OSC).
+
+## API Reference
+
+You can find the API documentation [here](https://lykaiosnz.github.io/reaper-osc.js/)
+
+## Installation
+
+Yarn: `yarn add reaper-osc`
+npm: `npm i reaper-osc`
+
+## Basic usage
+
+```javascript
+import {Reaper} from 'reaper-osc';
+
+var reaper = new Reaper();
+
+// Start listening for messages
+await reaper.start()
+
+// Subscribe to state changes
+reaper.tracks[0].onPropertyChanged('isMuted', () => {
+  console.log(`Track 1 was ${reaper.tracks[0].isMuted ? 'muted' : 'unmuted'}`);
+});
+
+reaper.transport.play();
+reaper.tracks[0].mute();
+reaper.tracks[0].unmute();
 ```

package/dist/Fx.d.ts

@@ -1,72 +1,72 @@
-/**
- * Contains classes for controlling FX in Reaper
- * @module
- */
-import { INotifyPropertyChanged } from './Notify';
-import { IMessageHandler } from './Handlers';
-import { ISendOscMessage, OscMessage } from './Messages';
-/**
- * A Reaper FX.
- *
- * @example
- * ```typescript
- * // Open an FX UI window
- * fx.openUi();
- * // Bypass the FX
- * fx.bypass();
- * ```
- */
-export declare class Fx implements INotifyPropertyChanged {
-    readonly oscAddress: string;
-    private _isBypassed;
-    private _isUiOpen;
-    private _name;
-    private _preset;
-    protected readonly _handlers: IMessageHandler[];
-    protected readonly _sendOscMessage: ISendOscMessage;
-    /**
-     * @param name The FX name
-     * @param oscAddress The OSC address of the FX
-     * @param sendOscMessage A callback used to send OSC messages to Reaper
-     */
-    constructor(name: string, oscAddress: string, sendOscMessage: ISendOscMessage);
-    /** Bypass the FX */
-    bypass(): void;
-    /** Close the UI of the FX */
-    closeUi(): void;
-    /** Indicates whether the FX is bypassed */
-    get isBypassed(): boolean;
-    /** Indicates whether the FX's UI is open */
-    get isUiOpen(): boolean;
-    /** The name of the FX */
-    get name(): string;
-    /** Load the next FX preset */
-    nextPreset(): void;
-    onPropertyChanged(property: string, callback: () => void): void;
-    /** Open the UI of the FX */
-    openUi(): void;
-    /** The name of the current preset, if any */
-    get preset(): string;
-    /** Load the previous FX preset */
-    previousPreset(): void;
-    /**
-     *  Receive and handle an OSC message
-     * @param message The message to be handled
-     */
-    receive(message: OscMessage): boolean;
-    /** Unbypass the FX */
-    unbypass(): void;
-}
-/**
- * An FX on a {@link Track}
- */
-export declare class TrackFx extends Fx {
-    readonly trackNumber: number;
-    readonly fxNumber: number;
-    /**
-     * @param trackNumber The number of the track the FX is on
-     * @param fxNumber The FX number in the current bank
-     * @param sendOscMessage A callback used to send OSC messages to Reaper
-     */
-    constructor(trackNumber: number, fxNumber: number, sendOscMessage: ISendOscMessage);
-}
+/**
+ * Contains classes for controlling FX in Reaper
+ * @module
+ */
+import { INotifyPropertyChanged } from './Notify';
+import { IMessageHandler } from './Handlers';
+import { ISendOscMessage, OscMessage } from './Messages';
+/**
+ * A Reaper FX.
+ *
+ * @example
+ * ```typescript
+ * // Open an FX UI window
+ * fx.openUi();
+ * // Bypass the FX
+ * fx.bypass();
+ * ```
+ */
+export declare class Fx implements INotifyPropertyChanged {
+    readonly oscAddress: string;
+    private _isBypassed;
+    private _isUiOpen;
+    private _name;
+    private _preset;
+    protected readonly _handlers: IMessageHandler[];
+    protected readonly _sendOscMessage: ISendOscMessage;
+    /**
+     * @param name The FX name
+     * @param oscAddress The OSC address of the FX
+     * @param sendOscMessage A callback used to send OSC messages to Reaper
+     */
+    constructor(name: string, oscAddress: string, sendOscMessage: ISendOscMessage);
+    /** Bypass the FX */
+    bypass(): void;
+    /** Close the UI of the FX */
+    closeUi(): void;
+    /** Indicates whether the FX is bypassed */
+    get isBypassed(): boolean;
+    /** Indicates whether the FX's UI is open */
+    get isUiOpen(): boolean;
+    /** The name of the FX */
+    get name(): string;
+    /** Load the next FX preset */
+    nextPreset(): void;
+    onPropertyChanged(property: string, callback: () => void): () => void;
+    /** Open the UI of the FX */
+    openUi(): void;
+    /** The name of the current preset, if any */
+    get preset(): string;
+    /** Load the previous FX preset */
+    previousPreset(): void;
+    /**
+     *  Receive and handle an OSC message
+     * @param message The message to be handled
+     */
+    receive(message: OscMessage): boolean;
+    /** Unbypass the FX */
+    unbypass(): void;
+}
+/**
+ * An FX on a {@link Track}
+ */
+export declare class TrackFx extends Fx {
+    readonly trackNumber: number;
+    readonly fxNumber: number;
+    /**
+     * @param trackNumber The number of the track the FX is on
+     * @param fxNumber The FX number in the current bank
+     * @param sendOscMessage A callback used to send OSC messages to Reaper
+     */
+    constructor(trackNumber: number, fxNumber: number, sendOscMessage: ISendOscMessage);
+}

package/dist/Fx.js

@@ -1,137 +1,137 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TrackFx = exports.Fx = void 0;
-/**
- * Contains classes for controlling FX in Reaper
- * @module
- */
-const Notify_1 = require("./Notify");
-const Handlers_1 = require("./Handlers");
-const Messages_1 = require("./Messages");
-/**
- * A Reaper FX.
- *
- * @example
- * ```typescript
- * // Open an FX UI window
- * fx.openUi();
- * // Bypass the FX
- * fx.bypass();
- * ```
- */
-let Fx = class Fx {
-    /**
-     * @param name The FX name
-     * @param oscAddress The OSC address of the FX
-     * @param sendOscMessage A callback used to send OSC messages to Reaper
-     */
-    constructor(name, oscAddress, sendOscMessage) {
-        this.oscAddress = oscAddress;
-        this._isBypassed = false;
-        this._isUiOpen = false;
-        this._preset = 'No preset';
-        this._handlers = [
-            new Handlers_1.StringMessageHandler(this.oscAddress + '/name', value => (this._name = value)),
-            new Handlers_1.BooleanMessageHandler(this.oscAddress + '/bypass', value => (this._isBypassed = !value)),
-            new Handlers_1.BooleanMessageHandler(this.oscAddress + '/openui', value => (this._isUiOpen = value)),
-            new Handlers_1.StringMessageHandler(this.oscAddress + '/preset', value => (this._preset = value)),
-        ];
-        this._sendOscMessage = sendOscMessage;
-        this._name = name;
-    }
-    /** Bypass the FX */
-    bypass() {
-        this._sendOscMessage(new Messages_1.BooleanMessage(this.oscAddress + '/bypass', false)); // false to bypass
-    }
-    /** Close the UI of the FX */
-    closeUi() {
-        this._sendOscMessage(new Messages_1.BooleanMessage(this.oscAddress + '/openui', false));
-    }
-    /** Indicates whether the FX is bypassed */
-    get isBypassed() {
-        return this._isBypassed;
-    }
-    /** Indicates whether the FX's UI is open */
-    get isUiOpen() {
-        return this._isUiOpen;
-    }
-    /** The name of the FX */
-    get name() {
-        return this._name;
-    }
-    /** Load the next FX preset */
-    nextPreset() {
-        this._sendOscMessage(new Messages_1.OscMessage(this.oscAddress + '/preset+'));
-    }
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    onPropertyChanged(property, callback) {
-        throw new Error('not implemented');
-    }
-    /** Open the UI of the FX */
-    openUi() {
-        this._sendOscMessage(new Messages_1.BooleanMessage(this.oscAddress + '/openui', true));
-    }
-    /** The name of the current preset, if any */
-    get preset() {
-        return this._preset;
-    }
-    /** Load the previous FX preset */
-    previousPreset() {
-        this._sendOscMessage(new Messages_1.OscMessage(this.oscAddress + '/preset-'));
-    }
-    /**
-     *  Receive and handle an OSC message
-     * @param message The message to be handled
-     */
-    receive(message) {
-        for (const handler of this._handlers) {
-            if (handler.handle(message)) {
-                return true;
-            }
-        }
-        return false;
-    }
-    /** Unbypass the FX */
-    unbypass() {
-        this._sendOscMessage(new Messages_1.BooleanMessage(this.oscAddress + '/bypass', true)); // true to unbypass
-    }
-};
-__decorate([
-    Notify_1.notify('isBypassed')
-], Fx.prototype, "_isBypassed", void 0);
-__decorate([
-    Notify_1.notify('isUiOpen')
-], Fx.prototype, "_isUiOpen", void 0);
-__decorate([
-    Notify_1.notify('name')
-], Fx.prototype, "_name", void 0);
-__decorate([
-    Notify_1.notify('preset')
-], Fx.prototype, "_preset", void 0);
-Fx = __decorate([
-    Notify_1.notifyOnPropertyChanged
-], Fx);
-exports.Fx = Fx;
-/**
- * An FX on a {@link Track}
- */
-class TrackFx extends Fx {
-    /**
-     * @param trackNumber The number of the track the FX is on
-     * @param fxNumber The FX number in the current bank
-     * @param sendOscMessage A callback used to send OSC messages to Reaper
-     */
-    constructor(trackNumber, fxNumber, sendOscMessage) {
-        super(`Fx ${fxNumber}`, `/track/${trackNumber}/fx/${fxNumber}`, sendOscMessage);
-        this.trackNumber = trackNumber;
-        this.fxNumber = fxNumber;
-    }
-}
-exports.TrackFx = TrackFx;
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrackFx = exports.Fx = void 0;
+/**
+ * Contains classes for controlling FX in Reaper
+ * @module
+ */
+const Notify_1 = require("./Notify");
+const Handlers_1 = require("./Handlers");
+const Messages_1 = require("./Messages");
+/**
+ * A Reaper FX.
+ *
+ * @example
+ * ```typescript
+ * // Open an FX UI window
+ * fx.openUi();
+ * // Bypass the FX
+ * fx.bypass();
+ * ```
+ */
+let Fx = class Fx {
+    /**
+     * @param name The FX name
+     * @param oscAddress The OSC address of the FX
+     * @param sendOscMessage A callback used to send OSC messages to Reaper
+     */
+    constructor(name, oscAddress, sendOscMessage) {
+        this.oscAddress = oscAddress;
+        this._isBypassed = false;
+        this._isUiOpen = false;
+        this._preset = 'No preset';
+        this._handlers = [
+            new Handlers_1.StringMessageHandler(this.oscAddress + '/name', value => (this._name = value)),
+            new Handlers_1.BooleanMessageHandler(this.oscAddress + '/bypass', value => (this._isBypassed = !value)),
+            new Handlers_1.BooleanMessageHandler(this.oscAddress + '/openui', value => (this._isUiOpen = value)),
+            new Handlers_1.StringMessageHandler(this.oscAddress + '/preset', value => (this._preset = value)),
+        ];
+        this._sendOscMessage = sendOscMessage;
+        this._name = name;
+    }
+    /** Bypass the FX */
+    bypass() {
+        this._sendOscMessage(new Messages_1.BooleanMessage(this.oscAddress + '/bypass', false)); // false to bypass
+    }
+    /** Close the UI of the FX */
+    closeUi() {
+        this._sendOscMessage(new Messages_1.BooleanMessage(this.oscAddress + '/openui', false));
+    }
+    /** Indicates whether the FX is bypassed */
+    get isBypassed() {
+        return this._isBypassed;
+    }
+    /** Indicates whether the FX's UI is open */
+    get isUiOpen() {
+        return this._isUiOpen;
+    }
+    /** The name of the FX */
+    get name() {
+        return this._name;
+    }
+    /** Load the next FX preset */
+    nextPreset() {
+        this._sendOscMessage(new Messages_1.OscMessage(this.oscAddress + '/preset+'));
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    onPropertyChanged(property, callback) {
+        throw new Error('not implemented');
+    }
+    /** Open the UI of the FX */
+    openUi() {
+        this._sendOscMessage(new Messages_1.BooleanMessage(this.oscAddress + '/openui', true));
+    }
+    /** The name of the current preset, if any */
+    get preset() {
+        return this._preset;
+    }
+    /** Load the previous FX preset */
+    previousPreset() {
+        this._sendOscMessage(new Messages_1.OscMessage(this.oscAddress + '/preset-'));
+    }
+    /**
+     *  Receive and handle an OSC message
+     * @param message The message to be handled
+     */
+    receive(message) {
+        for (const handler of this._handlers) {
+            if (handler.handle(message)) {
+                return true;
+            }
+        }
+        return false;
+    }
+    /** Unbypass the FX */
+    unbypass() {
+        this._sendOscMessage(new Messages_1.BooleanMessage(this.oscAddress + '/bypass', true)); // true to unbypass
+    }
+};
+__decorate([
+    Notify_1.notify('isBypassed')
+], Fx.prototype, "_isBypassed", void 0);
+__decorate([
+    Notify_1.notify('isUiOpen')
+], Fx.prototype, "_isUiOpen", void 0);
+__decorate([
+    Notify_1.notify('name')
+], Fx.prototype, "_name", void 0);
+__decorate([
+    Notify_1.notify('preset')
+], Fx.prototype, "_preset", void 0);
+Fx = __decorate([
+    Notify_1.notifyOnPropertyChanged
+], Fx);
+exports.Fx = Fx;
+/**
+ * An FX on a {@link Track}
+ */
+class TrackFx extends Fx {
+    /**
+     * @param trackNumber The number of the track the FX is on
+     * @param fxNumber The FX number in the current bank
+     * @param sendOscMessage A callback used to send OSC messages to Reaper
+     */
+    constructor(trackNumber, fxNumber, sendOscMessage) {
+        super(`Fx ${fxNumber}`, `/track/${trackNumber}/fx/${fxNumber}`, sendOscMessage);
+        this.trackNumber = trackNumber;
+        this.fxNumber = fxNumber;
+    }
+}
+exports.TrackFx = TrackFx;
 //# sourceMappingURL=Fx.js.map

package/dist/Handlers.d.ts

@@ -1,62 +1,62 @@
-import { OscMessage } from './Messages';
-import { Track } from './Tracks';
-import { Transport } from './Transport';
-import { TrackFx } from './Fx';
-/** An OSC message handler */
-export interface IMessageHandler {
-    /**
-     *  Handle an OSC message
-     * @param message The message to handle
-     */
-    handle(message: OscMessage): boolean;
-}
-/**
- * Routes messages to the appropriate track
- * @param trackSelector A function that can be used to get a track
- * */
-export declare class TrackMessageHandler implements IMessageHandler {
-    private readonly trackSelector;
-    constructor(trackSelector: (trackNumber: number) => Track | null);
-    handle(message: OscMessage): boolean;
-}
-/** Routes messages to the transport */
-export declare class TransportMessageHandler implements IMessageHandler {
-    private readonly transport;
-    constructor(transport: Transport);
-    handle(message: OscMessage): boolean;
-}
-/** Routes messages to the appropriate track fx */
-export declare class TrackFxMessageHandler implements IMessageHandler {
-    private readonly fxSelector;
-    constructor(fxSelector: (fxNumber: number) => TrackFx | null);
-    handle(message: OscMessage): boolean;
-}
-/**
- * Handles an OSC message containing a single boolean value (0 or 1)
- * @param address The address of the message to handle
- * @param callback The callback to be called when a message with the specified OSC address is received
- */
-export declare class BooleanMessageHandler implements IMessageHandler {
-    readonly address: string;
-    private readonly _callback;
-    constructor(address: string, callback: (value: boolean) => void);
-    handle(message: OscMessage): boolean;
-}
-export declare class IntegerMessageHandler implements IMessageHandler {
-    readonly address: string;
-    private readonly _callback;
-    constructor(address: string, callback: (value: number) => void);
-    handle(message: OscMessage): boolean;
-}
-export declare class StringMessageHandler implements IMessageHandler {
-    readonly address: string;
-    private readonly _callback;
-    constructor(address: string, callback: (value: string) => void);
-    handle(message: OscMessage): boolean;
-}
-export declare class FloatMessageHandler implements IMessageHandler {
-    readonly address: string;
-    private readonly _callback;
-    constructor(address: string, callback: (value: number) => void);
-    handle(message: OscMessage): boolean;
-}
+import { OscMessage } from './Messages';
+import { Track } from './Tracks';
+import { Transport } from './Transport';
+import { TrackFx } from './Fx';
+/** An OSC message handler */
+export interface IMessageHandler {
+    /**
+     *  Handle an OSC message
+     * @param message The message to handle
+     */
+    handle(message: OscMessage): boolean;
+}
+/**
+ * Routes messages to the appropriate track
+ * @param trackSelector A function that can be used to get a track
+ * */
+export declare class TrackMessageHandler implements IMessageHandler {
+    private readonly trackSelector;
+    constructor(trackSelector: (trackNumber: number) => Track | null);
+    handle(message: OscMessage): boolean;
+}
+/** Routes messages to the transport */
+export declare class TransportMessageHandler implements IMessageHandler {
+    private readonly transport;
+    constructor(transport: Transport);
+    handle(message: OscMessage): boolean;
+}
+/** Routes messages to the appropriate track fx */
+export declare class TrackFxMessageHandler implements IMessageHandler {
+    private readonly fxSelector;
+    constructor(fxSelector: (fxNumber: number) => TrackFx | null);
+    handle(message: OscMessage): boolean;
+}
+/**
+ * Handles an OSC message containing a single boolean value (0 or 1)
+ * @param address The address of the message to handle
+ * @param callback The callback to be called when a message with the specified OSC address is received
+ */
+export declare class BooleanMessageHandler implements IMessageHandler {
+    readonly address: string;
+    private readonly _callback;
+    constructor(address: string, callback: (value: boolean) => void);
+    handle(message: OscMessage): boolean;
+}
+export declare class IntegerMessageHandler implements IMessageHandler {
+    readonly address: string;
+    private readonly _callback;
+    constructor(address: string, callback: (value: number) => void);
+    handle(message: OscMessage): boolean;
+}
+export declare class StringMessageHandler implements IMessageHandler {
+    readonly address: string;
+    private readonly _callback;
+    constructor(address: string, callback: (value: string) => void);
+    handle(message: OscMessage): boolean;
+}
+export declare class FloatMessageHandler implements IMessageHandler {
+    readonly address: string;
+    private readonly _callback;
+    constructor(address: string, callback: (value: number) => void);
+    handle(message: OscMessage): boolean;
+}