index :: ui

ui.gain~

aliases: [ui.hgain~], [ui.vgain~]

UI gain control

available since version: 0.5

---

methods:

• + N increase current gain by N db
  

• - N decrease current gain by N db
  

• ++ decrease current gain by 1 db
  

• – decrease current gain by 1 db
  

• set N set current gain to N db
  

• load loads specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• store stores specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• clear clears specified preset
  parameters:
  • IDX preset index
    type: int
    required: True
    
• interp interplolates between presets
  parameters:
  • IDX preset fraction index
    type: float
    required: True
    
• pos set UI element position
  parameters:

  • X top left x-coord
    type: float
    required: True
    

  • Y top right y-coord
    type: float
    required: True
    

properties:

• @max Get/set maximum gain value
  type: int
  units: db
  range: -12..12
  default: 0
  

• @min Get/set minimal gain value
  type: int
  units: db
  range: -90..-15
  default: -60
  

• @db Get/set gain in dbfs scale
  type: float
  units: db
  default: -60
  

• @amp Get/set gain as amplitude ratio
  type: float
  default: 0
  

• @output_value Get/set flag to output @db property after each knob move
  type: bool
  default: 0
  

• @relative Get/set relative input mode. When set do not jump to value on click
  type: bool
  default: 1
  

• @presetname Get/set preset name for using with [ui.preset]
  type: symbol
  default: (null)
  

• @show_range Get/set if show slider range
  type: bool
  default: 1
  

• @mouse_events Get/set mouse events output mode. If on outputs @mouse_down, @mouse_up and @mouse_drag events
  type: bool
  default: 0
  

• @send Get/set send destination
  type: symbol
  default: (null)
  

• @receive Get/set receive source
  type: symbol
  default: (null)
  

• @size Get/set element size (width, height pair)
  type: list
  default: 15 120
  

• @pinned Get/set pin mode. if 1 - put element to the lowest level
  type: bool
  default: 0
  

• @knob_color Get/set knob color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0 0.75 1 1
  

• @background_color Get/set element background color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.93 0.93 0.93 1
  

• @border_color Get/set border color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.6 0.6 0.6 1
  

• @fontsize Get/set fontsize
  type: int
  range: 4..100
  default: 11
  

• @fontname Get/set fontname
  type: symbol
  enum: Courier, DejaVu, Helvetica, Monaco, Times
  default: Helvetica
  

• @fontweight Get/set font weight
  type: symbol
  enum: normal, bold
  default: normal
  

• @fontslant Get/set font slant
  type: symbol
  enum: roman, italic
  default: roman
  

• @midi_channel Get/set binded MIDI channel. 0 means listen to all channels
  type: int
  range: 0..16
  default: 0
  

• @midi_control Get/set binded MIDI controller number. -1 means not binded to any controller.
  type: int
  range: -1..127
  default: -1
  

• @midi_pickup Get/set pickup current value. If slider is binded to value, first time you should pass over this value to make binding. It prevents from sudden value change on first control change
  type: bool
  default: 1
  

inlets:

• input signal
  type: audio

outlets:

• output signal
  type: audio

keywords:

ui gain

Authors: Serge Poltavsky

License: GPL3 or later