index :: proto

proto.xtouch_ext

Behringer XTouch Extender XMidi protocol

available since version: 0.9.1

---

information

Behringer XTouch Extender XMidi

arguments:

• PROTO connection protocol
  type: symbol
  

methods:

• fader set fader value
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • X fader value(s)
    type: list
    required: True
    

• fader? get fader value, output to second outlet in format [fader? IDX VALUE(
  parameters:
  • CHAN channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    
• knob set knob value
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • X fader value(s)
    type: list
    required: True
    

• knob? get knob value, output to second outlet in format [knob? IDX VALUE(
  parameters:
  • CHAN channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    
• lcd set LCD text
  parameters:

  • CHAN channel index, max value is NUM_SCENES * 8
    type: int
    required: True
    

  • UPPER upper display text
    type: atom
    required: True
    

  • LOWER lower display text
    type: atom
    required: True
    

• lcd0 set upper LCD text
  parameters:

  • CHAN channel index, max value is NUM_SCENES * 8
    type: int
    required: True
    

  • STR upper display text
    type: list
    required: True
    

• lcd1 set lower LCD text
  parameters:

  • CHAN channel index, max value is NUM_SCENES * 8
    type: int
    required: True
    

  • STR lower display text
    type: list
    required: True
    

• lcd_align set all texts alignment. Note: you should set this before setting upper display text
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • ALIGN align name. Valid names are: left, right, center, justify and auto
    type: list
    required: True
    

• lcd_align0 set upper text alignment. Note: you should set this before setting upper display text
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • ALIGN align name. Valid names are: left, right, center, justify and auto
    type: list
    required: True
    

• lcd_align1 set lower text alignment. Note: you should set this before setting lower display text
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • ALIGN align name. Valid names are: left, right, center, justify and auto
    type: list
    required: True
    

• lcd_color set display color
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • COLOR list of color name or color indexes. Valid color names are: black, red, green, blue, yellow, magenta, cyan, white and random. Valid color indexes are in 0..7 range
    type: list
    required: True
    

• lcd_enum0 set all upper display text with incremental enumeration
  parameters:
  • [PREFIX] name prefix
    type: atom
    
• lcd_enum1 set all lower display text with incremental enumeration
  parameters:
  • [PREFIX] name prefix
    type: atom
    
• lcd_mode set lcd background/highlight mode.
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • MODE mod values. 0: display is inverted, 1: upper is inverted, 2: lower is inverted, 3: none in inverted
    type: list
    required: True
    

• llcd set several lower LCD text
  parameters:

  • CHAN channel index, max value is NUM_SCENES * 8
    type: int
    required: True
    

  • ATOMS lower display texts, each atom per display
    type: list
    required: True
    

• mute set mute buttons
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • X button value(s)
    type: list
    required: True
    

• mute? get mute button, output to second outlet in format [mute? IDX VALUE(
  parameters:
  • CHAN channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    
• mute_mode set mute buttons toggle mode
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • X values list: -1, 0 or 1
    type: list
    required: True
    

• rec set rec buttons
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • X button value(s)
    type: list
    required: True
    

• rec? get rec button, output to second outlet in format [rec? IDX VALUE(
  parameters:
  • CHAN channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    
• rec_mode set rec buttons toggle mode
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • X values list: -1, 0 or 1
    type: list
    required: True
    

• reset reset all knobs, faders and buttons to 0, vu to lowest values. Do not change display texts
  

• select set select buttons
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • X button value(s)
    type: list
    required: True
    

• select? get select button, output to second outlet in format [select? IDX VALUE(
  parameters:
  • CHAN channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    
• select_mode set select buttons toggle mode
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • X values list: -1, 0 or 1
    type: list
    required: True
    

• solo set solo buttons
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • X button value(s)
    type: list
    required: True
    

• solo? get solo button, output to second outlet in format [solo? IDX VALUE(
  parameters:
  • CHAN channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    
• solo_mode set solo buttons toggle mode
  parameters:

  • CHAN 'all', 'scene' or channel index, max value is NUM_SCENES * 8
    type: atom
    required: True
    

  • X values list: -1, 0 or 1
    type: list
    required: True
    

• ulcd set several upper LCD text
  parameters:

  • CHAN channel index, max value is NUM_SCENES * 8
    type: int
    required: True
    

  • ATOMS upper display texts, each atom per display
    type: list
    required: True
    

• vu set VU meter indicator
  parameters:

  • CHAN channel index, max value is NUM_SCENES * 8
    type: int
    required: True
    

  • DB level in decibels, in -144..0 range
    type: float
    required: True
    

properties:

• @n (initonly) Get/set number of scenes
  type: int
  range: 1..32
  default: 2
  

• @scene Get/set current scene
  type: int
  min value: 0
  default: 0
  

• @proto Get/set connection protocol
  type: symbol
  enum: hui, mcu, xmidi
  default: xmidi
  

inlets:

• raw midi input
  type: control

outlets:

• raw midi output to behringer device
  type: control
• control messages from device
  type: control

keywords:

xtouch behringer

Authors: Serge Poltavsky

License: GPL3 or later