Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Fx

A Reaper FX.

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

Hierarchy

Implements

  • INotifyPropertyChanged

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • name: string

      The FX name

    • oscAddress: string

      The OSC address of the FX

    • sendOscMessage: ISendOscMessage

      A callback used to send OSC messages to Reaper

    Returns Fx

Properties

Protected Readonly _handlers

_handlers: IMessageHandler[] = ...

Protected Readonly _sendOscMessage

_sendOscMessage: ISendOscMessage

Readonly oscAddress

oscAddress: string

Accessors

isBypassed

  • get isBypassed(): boolean

  • Indicates whether the FX is bypassed

    Returns boolean

isUiOpen

  • get isUiOpen(): boolean

  • Indicates whether the FX's UI is open

    Returns boolean

name

  • get name(): string

  • The name of the FX

    Returns string

preset

  • get preset(): string

  • The name of the current preset, if any

    Returns string

Methods

bypass

  • bypass(): void

closeUi

  • closeUi(): void

  • Close the UI of the FX

    Returns void

nextPreset

  • nextPreset(): void

  • Load the next FX preset

    Returns void

onPropertyChanged

  • onPropertyChanged(property: string, callback: function): void

  • Parameters

    • property: string
    • callback: function
        • (): void

        • Returns void

    Returns void

openUi

  • openUi(): void

  • Open the UI of the FX

    Returns void

previousPreset

  • previousPreset(): void

  • Load the previous FX preset

    Returns void

receive

  • Receive and handle an OSC message

    Parameters

    Returns boolean

unbypass

  • unbypass(): void

Generated using TypeDoc