ixfx
    Preparing search index...

    Class MidiFighterEncoder

    Represents a single encoder.

    Hierarchy (View Summary)

    Index

    Accessors

    Methods

    • Set a scalar LED ring value (0..1).

      encoder.setLedRing(0.5); // Set to 50%
      

      Use setLedRingRaw to set 0..127 integer value

      Parameters

      • v: number

        Scalar (0..1)

      Returns void

    • Sets the raw (0..127) value for the LED ring feedback. Use setLedRing for scalar values (0..1)

      encoder.setLedRingRaw(50);
      

      Parameters

      • v: number

        Raw value (0..127)

      Returns void

    • Sets the switch colour based on a 0..1 standard hue degree

      const hsl = Colour.HslSpace.fromCss(`orange`);
      encoder.setSwitchColourHue(hsl.hue);

      Parameters

      • v: number

        Hue degree (0..1) range

      Returns void

    • Set the switch colour based on 0..127 Midi Fighter range (start/end in blue). Use setSwitchColourHue to set colour based on hue angle instead

      See page 4 of the MF manual.

      Parameters

      • v: number

      Returns void

    • Set the effect of the colour pip

      encoder.setSwitchEffect(`strobe`, 3);
      

      Parameters

      • kind: "none" | "strobe" | "pulse" | "rainbow"
      • value: number = 1

      Returns void

    Properties

    bank: number

    Bank (1..4) of encoder

    encoder: number

    Encoder index (1..16)

    encoderStaticNote: number = 0

    Note for this encoder.

    inputEncoderChannel: number

    Midi channel for received encoder values

    inputEncoderNoteOrCc: number

    Note/CC for received encoder values

    inputSwitchChannel: number

    Midi channel for received switch values

    inputSwitchNoteOrCc: number

    Note/CC for received switch values

    lastEncoderValue: number = -1

    The last encoder value received

    lastSwitchValue: number = -1

    The last switch value received

    ledColourChannel: number = 2

    Channel to change LED colour

    ledEffectChannel: number = 3

    Channel to change LED effect (eg strobe)

    ledRingChannel: number = 1

    Channel to change LED ring value