index :: proto

proto.whammy

Control for Digitech Whammy pedal

available since version: 0.9.5

---

arguments:

• MODE pedal mode (should correspond to hardware switch on pedal)
  type: symbol
  

• ACTIVE pedal initial state
  type: bool
  

methods:

• next select next preset
  parameters:
  • [N] positive step or 'random'
    type: atom
    
• prev select previous preset
  parameters:
  • [N] positive step or 'random'
    type: atom
    
• random choose random preset
  parameters:

  • MODE if 'whammy' - select random preset from 'whammy' modes (right pedal side), if 'harm' - select random preset from harmonizer modes (left pedal side), if 'detune' - select random detune mode. If not specified - select random mode from all categories.
    type: symbol
    required: True
    

  • [STATE] pedal state (on/off)
    type: int
    

• reset turn off pedal and select default preset
  

• set IDX set preset by index
  parameters:

  • IDX preset index
    type: int
    required: True
    

  • [STATE] pedal state (on/off)
    type: int
    

• set NAME set preset by name
  parameters:

  • NAME preset name
    type: symbol
    required: True
    

  • [STATE] pedal state (on/off)
    type: int
    

• set UP DOWN set preset by transpose range.
  parameters:

  • UP up range
    type: int
    required: True
    

  • DOWN down range
    type: int
    required: True
    

  • [STATE] pedal state (on/off)
    type: int
    

• toggle toggle pedal on/off
  

properties:

• @active Get/set pedal state
  type: bool
  default: 1
  

• @mode Get/set pedal mode (should correspond to hardware switch on pedal)
  type: symbol
  enum: chords, classic
  default: classic
  

• @chan Get/set output Midi channel
  type: int
  range: 0..15
  default: 0
  

• @seed Get/set random seed
  type: int
  min value: 0
  default: 0
  

• @chords Get/set alias for @mode chords
  type: alias
  

• @classic Get/set alias for @mode classic
  type: alias
  

inlets:

• 1: turn on, 0: turn off pedal
  type: control

outlets:

• float stream: raw midi output
  type: control

keywords:

parser midi whammy

Authors: Serge Poltavsky

License: GPL3 or later