gain~
MSP Reference
Open Help

gain~

Gain control

Description

gain~ is a slider that scales signals. It can also make a smooth transition as you move from one value of the slider to the next.

Examples

Specialized fader to scale a signal exponentially or logarithmically

Discussion

Parameters of line's formula that translates between slider values and the signal scalar can be changed via messages or by selecting the object and choosing Get Info... from the Max menu. The formula values are the same as for the linedrive object.
The default values of range (158), base value (7.94231), and increment (1.071519) provide for a slider where 128 is full scale (multiplying by 1.0), 0 produces a zero signal, and 1 is 75.6 dB below the value at 127. A change of 10 in the slider produces a 6 dB change in the output. In addition, since the range is 158, slider values from 129 to 157 provide 17.4 dB of headroom. When the slider is at 157, the output signal is 17.4 dB louder than the input signal.

Arguments

None.

Attributes

bgcolor [4 floats]

Sets the first interior color (background) of the gain~ object in RGBA format.

inc [float] (default: 1.071519)

Sets the increment value used to calculate the output scale factor based on the input value. The default value is 1.071519.

interp [float] (default: 10.)

Sets the interpolation ramp time in milliseconds for the gain~ object. The default is 10.

interpinlet [int] (default: 0)7.0.0

Toggles the display of the interpolation inlet.

knobcolor [4 floats]

Sets the color of the knob and the stripes of the value color in RGBA format. The knobcolor attribute is mapped to the color style color.

orientation [int] (default: 0)

Sets the gain~ object to a horizontal or vertical data display.
Automatic : (the default) sets the display dependent on the size of the slider - longest side of the rectangle that describes the slider sets the orientation.
Horizontal
Vertical

Possible values:

0 = 'Automatic'
1 = 'Horizontal'
2 = 'Vertical'

parameter_enable [int]

Enables use of this object with Max for Live Parameters and allows for setting initial parameter values in the Max environment.

relative [int] (default: 0)

Sets way that the gain~ object responds to mouse clicks.

Possible values:

0 = 'Absolute' ( Absolute mode )
In absolute mode, the gain~ will automatically jump directly to the clicked location.

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

scale [float] (default: 7.94321)

Sets the base output value used to calculate the output scale factor based on the input value. The default value is 7.94231. See the "Inspector" section for an explanation of the calculation. The word size , followed by a number, sets the range of gain~ to the number. The values of the slider will then be 0 to the range value minus 1. The default value is 158.

size [int] (default: 158)

Sets the number of steps (range) of the gain~ object. The default value is 158.

stripecolor [4 floats]

Sets the "off" color for the slider in RGBA format. The stripecolor attribute is mapped to the elementcolor style color.

style [symbol]7.0.0

Sets the style to be applied to the object. Styles can be set using the Format palette.

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 current slider value out right outlet.

int

Arguments

slider-value [int]
In left inlet: Sets the value of the slider, ramps the output signal to the level corresponding to the new value over the specified ramp time, and outputs the slider's value out the right outlet.

float

Arguments

slider-value [float]
In left inlet: Converted to int . Sets the value of the slider, ramps the output signal to the level corresponding to the new value over the specified ramp time, and outputs the slider's value out the right outlet.

  (inlet1)

Arguments

ramp-time [float]
In right inlet: Sets the ramp time in milliseconds. The default is 10 milliseconds.

list

Arguments

slider-value [list]
The object takes list messages in conjunction with pattr objects.

color7.0.0

Arguments

ARG_NAME_0 [int]
TEXT_HERE

(mouse)

Clicking and dragging with the mouse sets the value of the slider, ramps the output signal to the level corresponding to the new value over the specified ramp time, and outputs the slider’s value out the right outlet.

set

Arguments

set-slider-value [int]
In left inlet: The word set , followed by a number, sets the value of the slider, ramps the output signal to the level corresponding to the new value over the specified ramp time, but does not output the slider's value out the right outlet.

signal

In left inlet: The input signal to be scaled by the slider.

Output

int

Out right outlet: The current slider value, when dragging on the slider with the mouse or when gain~ receives an int or float in its left inlet.

signal

Out left outlet: The input signal, scaled by the current slider value as x in the equation shown above.

See Also

Name Description
linedrive Scale numbers exponentially
MSP Delay Tutorial 6: Comb Filter MSP Delay Tutorial 6: Comb Filter