index :: ui

ui.meter~

aliases: [ui.m~], [ui.hm~], [ui.vm~]

Shows peak and rms signal level

available since version: 0.1

---

information

Each cell has 3db range. Full meter range is 39 db. Values > -3db are red, range [-12, -3) db is hot, [-21, -12) db is warm, [-30, -21) is tepid, values < 30 are cold. [ui.hm~] - alias for horizontal meter

methods:

• 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:

• @interval Get/set refresh interval
  type: int
  units: ms
  min value: 20
  default: 50
  

• @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
  

• @cold_color Get/set extra low-level signal color <-31db (list of red, green, blue values in 0-1 range)
  type: list
  default: 0 0.6 0 1
  

• @tepid_color Get/set low-level signal color <-21db (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.6 0.73 0 1
  

• @warm_color Get/set normal level signal color <-9db (list of red, green, blue values in 0-1 range)
  type: list
  default: 0.85 0.85 0 1
  

• @hot_color Get/set loud level signal color <-3db (list of red, green, blue values in 0-1 range)
  type: list
  default: 1 0.6 0 1
  

• @over_color Get/set extra-loud level signal color >-3db (list of red, green, blue values in 0-1 range)
  type: list
  default: 1 0 0 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
  

inlets:

• input signal
  type: audio

outlets:

• output pair of values: rms and peak in decibels (dbfs)
  type: control

keywords:

ui meter

Authors: Pierre Guillot, Serge Poltavsky

License: GPL3 or later