live.gain~ Reference

Decibel volume slider and monitor

live.gain~

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.

annotation_name [symbol] (default: )

The string that is prepended to annotations. This shows up in the Info pane in Live, and the clue window in Max.

channels [int] (default: 2)

Sets the number of channels. The maximum number of channels allowed is 64.

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]

When enabled, the live.gain~ UI displays a db level label.

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.

parameter_mappable [int] (default: 1)

When parameter_mappable is enabled, the object will be available for mapping to keyboard or MIDI input using the Mappings feature.

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

Parameter Attributes

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 Shift key for more precise mouse control.

outputvalue

Sends the current value out the outlet.

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.

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.

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
Max For Live Max For Live
gain~
meter~