abl.device.utility~
Swiss army knife for audio
Description
This object can be used to change the gain, separate a single channel from a stereo signal, widen or narrow the stereo image or suppress DC offsets.
Arguments
gain[number]
optional
Gain
balance[number]
optional
Balance
Attributes
audition_bass_mono[int]
Solos the mono bass frequencies. When enabled, only the low frequencies can be heard. This can help to tune bass_mono_frequency.
balance[float]
Pans the input signal anywhere within the stereo field. [-1., 1.]
bass_mono[int]
Converts low frequencies of the input signal to mono. This is useful for avoiding coloration of low frequencies when they are replayed in mono.
bass_mono_frequency[float]
Sets the bass mono threshold frequency (in Hz). Signals below this frequency are converted to mono when the bassmono attribute is on. [50., 500.]
channelmode[int]
Sets the channel mode
Possible values:
0 = 'Left'
(
Left
)
Only pass the left channel of the input
1 = 'Stereo'
(
Stereo
)
Pass input to the output as normal
2 = 'Right'
(
Right
)
Only pass the right channel of the input
3 = 'Swap'
(
Swap
)
Swap the left and right channels of input
dcblock[int]
Enables/disables the DC blocking filter.
gain[float]
Boosts or attenuates signal gain in dB. If you want to mute the output signal entirely, see the mute attribute. [-70.6, 6.]
invert_phase_l[int]
Inverts the phase of the left inlet signal.
invert_phase_r[int]
Inverts the phase of the right inlet signal.
midside[2 floats]
Sets the gain of the mid and side stereo fields. [0., 1.]
mono[int]
Converts stereo input to mono.
mute[int]
Mutes the input signal.
ins[symbol]
Declares additional inlets that can be used to control float-type attributes at either event or signal rate. Any declared attributes already mapped to inlets will be ignored. This attribute can only be set when the object is instantiated.
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]: 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'
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]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.
patching_rect[4 floats]: 0. 0. 100. 0.
Aliases: patching_position, patching_size
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
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]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 0. 0. 0. 0.
Aliases: presentation_position, presentation_size
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]
write-only
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]
write-only
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[4 floats]
Sets the color for the object's text in RGBA format.
textjustification[int]
Sets the justification for the object's text.
Possible values:
0 = 'left'
1 = 'center'
2 = 'right'
valuepopup[int]: 0
For objects with single values, enabling valuepopup will display the object's current value in a popup caption when the mouse is over the object or it is being changed with the mouse.
valuepopuplabel[int]: 0
Sets the source of a text label shown in a value popup caption.
Possible values:
0 = 'None'
1 = 'Hint'
2 = 'Scripting Name'
3 = 'Parameter Long Name'
4 = 'Parameter Short Name'
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
float
Function depends on inlet
reset
Reset
signal
Function depends on inlet