live.meter~
Max for Live Reference
Open Help

live.meter~

Live-style visual peak level indicator

Description

live.meter~ is a simple mono Live-style signal level meter that can be attached to any signal whose level is between -1 and 1 (other signals should be scaled first).

Examples

Discussion

The visual output of the live.meter~ shows the current signal level, the recent peak level, and provides a red "over" indicator if the signal is greater than or equal to 1. You can change the redrawing interval with the Interval attribute, and the orientation of the meter is set using the Orientation attribute.

Arguments

None.

Attributes

active [int] (default: 1)

Enables (1) or disables (0) the meter display.

bgcolor [4 floats]

Sets the background color in RGBA format.

clip_size [int] (default: 0)

Sets the clipping range for the display. The options are Normal or Extended.

Possible values:

0 = 'Normal'
1 = 'Extended'

coldcolor [4 floats]

Sets the Cold signal color in RGBA format.

display_range [2 floats] (default: -70. 6.)

Sets the display range of the meter in dB.

hotcolor [4 floats]

Sets the Warning signal color in RGBA format.

inactivecoldcolor [4 floats]

Sets the Cold signal (inactive) color in RGBA format.

inactivewarmcolor [4 floats]

Sets the Warm signal (inactive) color in RGBA format.

interval [int] (default: 20)

Sets the maximum update-time interval, in milliseconds, of the live.meter~ display. The minimum update-interval is 10 milliseconds, the maximum is 2 seconds, and the default is 50 milliseconds. This message also sets the rate at which meter~ sends out the peak value received in that time interval. The threshold_db or threshold_linear attributes are used to limit the refresh and the output, depending on the setting of the mode attribute.

mode [int] (default: 0)

Sets the display and output mode of the live.meter~ object.

Possible values:

0 = 'deciBel'
1 = 'Linear'

orientation [int] (default: 0)

Sets the orientation of the meter display. The options are Horizontal or Vertical

Possible values:

0 = 'Vertical'
1 = 'Horizontal'

overloadcolor [4 floats]

Sets the Overload signal color in RGBA format.

threshold_db [float] (default: 1.)

When the live.meter~ object's mode attribute is set to 0, this attribute sets the refresh threshold in deciBels. If the signal peak delta is greater than the threshold value, the object will be redrawn and the value sent out the outlet.

threshold_linear [float] (default: 0.01)

When the live.meter~ object's mode attribute is set to 1, this attribute sets the refresh threshold in deciBels. If the signal peak delta is greater than the threshold value, the object will be redrawn and the value sent out the outlet.

warmcolor [4 floats]

Sets the Warm signal color in RGBA format.

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic

Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points).

Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [float]

Sets the color for the object's text in RGBA format.

textjustification [int]

Text Justification

Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

int

Arguments

signal-value [int]
Converted to float .

float

Arguments

signal-value [float]
When no signal is connected to the live.meter~ object's inlet, a float number will set the meter to react as though a signal with equal amplitude peak-value has been passed to its input. Corresponding LEDs will light up and the peak-level value will be passed out the outlet (0.0 will show silence, 0.0 through 1.0 will light up to any but the overload LED, and anything above 1.0 will light all LEDs including overload).

db

Arguments

db-value [float]
The word db , followed by a floating point number that specficies a deciBel value, will set the live.meter~ object to react as though a signal with that dB peak-value has been passed to its input. Corresponding LEDs will light up and the value will be passed out the outlet.

signal

The peak amplitude of the incoming signal is displayed by the on-screen level meter.

See Also

Name Description
average~ Multi-mode signal average
meter~ Visual peak level indicator
scope~ Visualize an audio signal