reaper-osc
    Preparing search index...

    Class FxAbstract

    A Reaper FX.

    // Open an FX UI window
    fx.openUi();
    // Bypass the FX
    fx.bypass();

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    _isBypassed _isUiOpen _name _preset _send

    Accessors

    isBypassed isUiOpen name preset

    Methods

    bypass closeUi handleEvent nextPreset onPropertyChanged openUi previousPreset unbypass

    Constructors

    • Parameters

      • name: string
      • send: SendCommand

      Returns Fx

    Properties

    Protected_isBypassed

    _isBypassed: boolean = false

    Protected_isUiOpen

    _isUiOpen: boolean = false

    Protected_name

    _name: string

    Protected_preset

    _preset: string = 'No preset'

    Protected Readonly_send

    _send: SendCommand

    Accessors

    • get isBypassed(): boolean

      Indicates whether the FX is bypassed

      Returns boolean

    • get isUiOpen(): boolean

      Indicates whether the FX's UI is open

      Returns boolean

    • get name(): string

      The name of the FX

      Returns string

    • get preset(): string

      The name of the current preset.

      Update behaviour varies by subclass:

      • DeviceSelectedFx — updated in real time whenever the preset changes, because Reaper sends /fx/preset in response to every preset navigation command.
      • SelectedTrackFxSlot and TrackFx — only updated during a sync burst (refreshControlSurfaces()), because Reaper only sends /fx/{n}/preset and /track/{n}/fx/{m}/preset as part of the full state refresh, not in response to individual preset commands.

      If you need live preset feedback, use DeviceSelectedFx (via selectedTrack.selectedFx after calling device.selectFx(n) to point it at the desired slot).

      Returns string

    Methods

    • Bypass the FX

      Returns void

    • Close the UI of the FX

      Returns void

    • Load the next FX preset

      Returns void

    • 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

    • Open the UI of the FX

      Returns void

    • Load the previous FX preset

      Returns void

    • Unbypass the FX

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods