live.gain~
Max for Live Reference
Open Help

live.gain~

Decibel volume slider and monitor

Description

live.gain~ is a slider that scales input audio signals and provides a visual indication of the current sound level on a deciBel scale.

Examples

Arguments

None.

Attributes

active [int] (default: 1)

Toggles the object's active mode. When the active attribute is set to 0, mouse action does not cause output and the inactive colors are used.

channels [int] (default: 2)

Channels

clip_size [int] (default: 0)

Sets the clipping zone size.

Possible values:

0 = 'Normal' ( Normal )
Normal (the default)

1 = 'Extended' ( Extended )
Extended

coldcolor [4 floats]

Sets the Cold signal color in RGBA format.

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

Sets the range, in deciBels, displayed by the live.gain~ object. By default, the the display range is set to the same values as the range of the object itself (-70dB - +6dB).

focusbordercolor [4 floats]

Sets the display color for the live.gain~ object's border in RGBA format.

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.

interp [float] (default: 10.)

Sets the ramp time in milliseconds. The default is 10 milliseconds.

interval [int] (default: 20)

Sets the update time interval of the meter display, in milliseconds. The minimum update interval is 10 milliseconds, the maximum is 2 seconds. This message also sets the rate at which the live.gain~ object sends out the list of peak values (in dB) for each channel received in that time interval.

livemode [int]

Live Mode

metering [int] (default: 1)

Specifies whether the live.gain~ object displays and outputs the signal level pre-fader (0) or post-fader (1).

Possible values:

0 = 'Pre Fader'
1 = 'Post Fader'

mode [int] (default: 0)

The mode attribute allows you to specify metering to be displayed.

Possible values:

0 = 'deciBel' ( DeciBel display )
Set deciBel metering display.

1 = 'Linear' ( Linear display )
Set linear metering display.

modulationcolor [4 floats]

Sets the modulation color of live.gain~ object in RGBA format.

orientation [int] (default: 0)

Sets the slider object to a horizontal or vertical data display.

Possible values:

0 = 'Vertical' ( Vertical display )
Set the object for vertical display.

1 = 'Horizontal' ( Horizontal display )
Set the object for horizontal display.

overloadcolor [4 floats]

Sets the Overload signal color in RGBA format.

relative [int] (default: 0)

Sets the mode for mouse behavior.

Possible values:

0 = 'Absolute' ( Absolute mode )
The live.gain~ will automatically jump directly to the clicked location.

1 = 'Relative' ( Relative mode )
The live.gain~ keeps its relative position when you click on it. Moving the mouse outputs higher or lower values in relation to that relative position (the default).

showname [int] (default: 1)

Toggles the display of the parameter name. The default is 1 (on).

shownumber [int] (default: 1)

Toggles the display of the gain parameter value. The default is 1 (on).

slidercolor [4 floats]

Sets the slider background color in RGBA format.

textcolor [4 floats]

Sets the display color for the live.gain~ object's text in RGBA format.

threshold_db [float] (default: 1.)

Sets the redraw threshold for dB display. This allows you to balance the redrawing / efficiency. The maximum refresh rate is set by the interval attribute.

threshold_linear [float] (default: 0.01)

Sets the redraw threshold for linear display. This allows you to balance the redrawing / efficiency. The maximum refresh rate is set by the interval attribute.

tribordercolor [4 floats]

Sets the triangle border color in RGBA format. This is only used when the live.gain~ object does not have the focus.

tricolor [4 floats]

Sets the triangle color in RGBA format. This is only used when the live.gain~ object does not have the focus.

trioncolor [4 floats]

Sets the triangle color in RGBA format. This is only used when the live.gain~ object does have the focus.

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.

Parameter Attributes

Order

Typeint

Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.

Parameter Mode Enable

Typeint

Parameter Mode Enable (not available from Parameters window)

Link to Scripting Name

Typeint

When checked, the Scripting Name is linked to the Long Name attribute.

Long Name

Typesymbol

The long name of the parameter. This name must be unique per patcher hierarchy.

Short Name

Typesymbol

Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters.

Type

Typeint

Specifies the data type. The data types used in Max for Live are:

Float
Int
Enum (enumerated list)
Blob

Note: By convention, the Live application uses floating point numbers for its calculations; the native integer representation is limited to a range of 0-255 (similar to the char data type used in Jitter). When working with Live UI objects whose integer values are likely to be outside of the 0-255 range, the Type attribute should be set to Float, and the Unit Style attribute should be set to Int.

Range/Enum

Typelist

When used with an integer or floating point data type, this field is used to specify the minimum and maximum values of the parameter.
When used with an enumerated list (Enum) data type, this field contains a space-delimited list of the enumerated values (if list items contain a space or special characters, the name should be enclosed in double quotes).

Modulation Mode

Typeint

Sets the Modulation Mode used by the Live application. The modulation modes are:

None
Unipolar
Bipolar
Additive
Absolute

Modulation Range

Typelist

This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.

Initial Enable

Typeint

When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).

Initial

Typelist

Sets the initial value to be stored and used when the Initial Enable attribute is checked.

Unit Style

Typeint

Sets the unit style to be used when displaying values. The unit style values are: Int: displays integer values
Float: displays floating point values
Time: displays time values in milliseconds (ms)
Hertz: displays frequency values (Hz/kHz).
deciBel: displays loudness (dB)
%: Percentage
Pan: displays Left and Right values
Semitones: displays steps (st)
MIDI: displays pitch corresponding to the MIDI note number
Custom: displays custom data type
Native: defaults to floating point values

Custom Units

Typesymbol

Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").

Exponent

Typefloat

When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.

Steps

Typeint

The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.

Parameter Visibility

Typeint

For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.

Update Limit (ms)

Typeint

Speed limits values triggered by automation.

Defer Automation Output

Typeint

Defers values triggered by automation.

Messages

bang

Sends the current value out the outlet.

int

Arguments

db-input [int]
The number received in the inlet sets the level (in dB).

float

Arguments

db-input [float]
The number received in the inlet sets the level (in dB).

assign

Arguments

assign-input [float]
The word assign , followed by a floating point value, causes that value to be stored and displayed and sent out the live.gain~ object's outlet. If the Parameter Visibility attribute is set to Stored Only, the assign message will not add the new value to the Live application’s undo chain.

init

Restore and output the initial value.

(mouse)

Click and drag the slider to change the amplification. Hold down the Command key (Macintosh) or the Control key (Windows) for more precise mouse control.

outputvalue

Sends the current value out the outlet.

set

Arguments

set-slider-value [float]
Sets the current value without causing output.

signal

In left inlet: The input signal (left channel) to be scaled.

In right inlet: The input signal (right channel) to be scaled.

rawfloat

Arguments

input [float]
A raw normalized value (between 0. and 1.) received in the inlet is converted to a real value, stored, displayed by live.gain~ object, and the current value is sent out the outlet.

Output

float

Out third outlet: The current slider value in dB, when dragging on the slider with the mouse or when live.gain~ receives an int or float.
Out fourth outlet: When an output is triggered, a raw normalized value (between 0. and 1.) is sent out this outlet.

list

Out fifth outlet: The amplitude of the two channels (in dB) is sent out this outlet.

signal

Out first and second outlet: The input signal, scaled by the current slider value.

See Also

Name Description
gain~ Gain control
meter~ Visual peak level indicator