abl.device.roar~
A three-stage saturation effect with flexible modulation
Description
A three-stage saturation effect with flexible modulation.
Arguments
None.
Attributes
blend[float64]
Create a blend between the first and second stages when in serial, parallel, or mid/side routing mode.
compressor_amount[float64]
Sets the amount of main bus compression.
compressor_highpass[long]
Activates a highpass filter for the analysis signal used in the compressor's sidechain. This is useful to reduce the amount of gain reduction for low frequency signals.
crossover_high[float64]
Set the frequency of the higher crossover band.
crossover_low[float64]
Set the frequency of the lower crossover band.
enable_filter_1[long]
Enable/disable filter 1.
enable_filter_2[long]
Enable/disable filter 2.
enable_filter_3[long]
Enable/disable filter 3.
enable_shaper_1[long]
Enable/disable shaper 1.
enable_shaper_2[long]
Enable/disable shaper 2.
enable_shaper_3[long]
Enable/disable shaper 3.
enable_stage_1[long]
Enable/disable stage 1.
enable_stage_2[long]
Enable/disable stage 2.
enable_stage_3[long]
Enable/disable stage 3.
envelope_attack[float64]
Sets the envelope attack time in seconds.
envelope_filter_frequency[float64]
Sets the envelope filter frequency in Hz.
envelope_filter_width[float64]
Sets the envelope filter bandwidth.
envelope_gain[float64]
Sets the amplitude of the envelope follower modulator in dB.
envelope_release[float64]
Sets the envelope release time in seconds.
envelope_threshold[float64]
Set the envelope threshold in dB.
feedback_amount[float64]
Sets the amount of feedback.
feedback_delay[float64]
Sets the delay time of the feedback stage in seconds.
feedback_frequency[float64]
Sets the frequency in Hz of the feedback filter.
feedback_gate[long]
Enable/disable the feedback gate. The feedback gate ensures that feedback is silenced once no signal is detected at the input of the object.
feedback_invert[long]
Enable/disable inverting the phase of the feedback signal.
feedback_mode[long]
Set the mode of the feedback stage. Currently, only 'time' is supported.
feedback_width[float64]
Sets the width of the bandpass filter in the feedback path.
filter_frequency_1[float64]
Filter 1 cutoff frequency (Hz).
filter_frequency_2[float64]
Filter 2 cutoff frequency (Hz).
filter_frequency_3[float64]
Filter 3 cutoff frequency (Hz).
filter_morph_1[float64]
Sets the filter's position in its morph cycle. The morph filter can be continuously morphed between low-pass, high-pass, band-pass, and notch filtering.
filter_morph_2[float64]
Sets the filter's position in its morph cycle. The morph filter can be continuously morphed between low-pass, high-pass, band-pass, and notch filtering.
filter_morph_3[float64]
Sets the filter's position in its morph cycle. The morph filter can be continuously morphed between low-pass, high-pass, band-pass, and notch filtering.
filter_peak_gain_1[float64]
Boost or attenuate a specific frequency range for the stage1 peak filter.
filter_peak_gain_2[float64]
Boost or attenuate a specific frequency range for the stage2 peak filter.
filter_peak_gain_3[float64]
Boost or attenuate a specific frequency range for the stage3 peak filter.
filter_resonance_1[float64]
Filter 1 resonance.
filter_resonance_2[float64]
Filter 2 resonance.
filter_resonance_3[float64]
Filter 3 resonance.
filter_type_1[long]
Stage 1 filter type
filter_type_2[long]
Stage 2 filter type
filter_type_3[long]
Stage 3 filter type
filterpre1[long]
Sets whether the filter processes the input before (1) or after (0) the shaper.
filterpre2[long]
Sets whether the filter processes the input before (1) or after (0) the shaper.
filterpre3[long]
Sets whether the filter processes the input before (1) or after (0) the shaper.
input_gain[float64]
Sets the input gain in dB.
lfo1ratemode[long]
Set the rate mode of LFO 1. Currently, only 'free' is supported.
lfo1waveform[long]
Set the waveform for LFO 1 modulator.
lfo2ratemode[long]
Set the rate mode of LFO 2. Currently, only 'free' is supported.
lfo2waveform[long]
Set the waveform for LFO 2 modulator.
lfo_frequency_1[float64]
Sets the LFO 1 frequency in Hz.
lfo_frequency_2[float64]
Sets the LFO 2 frequency in Hz.
lfo_morph_1[float64]
Sets the amount of morph of the LFO 1 shape.
lfo_morph_2[float64]
Sets the amount of morph of the LFO 2 shape.
lfo_smooth_1[float64]
Sets the amount of smoothing of the LFO 1 shape.
lfo_smooth_2[float64]
Sets the amount of smoothing of the LFO 2 shape.
mix[float64]
Sets the dry/wet mix of the output signal
noise_frequency[float64]
Sets the noise frequency in Hz.
noise_rate_mode[long]
Set the rate mode of the noise modulator. Currently, only 'free' is supported.
noise_smoothing[float64]
Sets the noise smoothing. Only affects noise when in sample and hold mode.
noise_type[long]
Set the type of noise used in the noise modulator.
output_gain[float64]
Sets the gain of the output signal in dB.
routing[long]
Routing
shaper_amount_1[float64]
Shaper 1 amount
shaper_amount_2[float64]
Shaper 2 amount
shaper_amount_3[float64]
Shaper 3 amount
shaper_bias_1[float64]
Shaper 1 bias
shaper_bias_2[float64]
Shaper 2 bias
shaper_bias_3[float64]
Shaper 3 bias
shaper_level_1[float64]
Shaper 1 level in dB.
shaper_level_2[float64]
Shaper 2 level in dB.
shaper_level_3[float64]
Shaper 3 level in dB.
shaper_type_1[long]
Shaper 1 type
shaper_type_2[long]
Shaper 2 type
shaper_type_3[long]
Shaper 3 type
tone_amount[float64]
A positive tone amount boosts high frequencies and attenuates low frequencies when the amount. For negative tone amounts, high frequencies are attenuated and low frequencies are boosted.
tone_color_compensation[long]
Compensate the effect of the Tone attribute by applying an inverted version of the same filter to the output. When tone_color_compensation 1, positive Tone values are attenuated before the Shaper and then boosted again at the output to prevent high frequencies from distorting. When tone_color_compensation 0, negative Tone values boost low frequencies before the Shaper, while positive values boost high frequencies.
tone_frequency[float64]
Sets the tone frequency for the low shelving filter used in tone control.
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.
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.
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
mod
Set a modulation source, target, and amount. Available sources are: 'lfo1', 'lfo2', 'env', and 'noise'. Modulation targets are 'input', 'tone_amount', 'tone_frequency', 'blend', 'stage1_amount', 'stage1_bias', 'stage1_level', 'stage1_frequency', 'stage1_resonance', 'stage1_morph', 'stage1_peak', 'stage2_amount', 'stage2_bias', 'stage2_level', 'stage2_frequency', 'stage2_resonance', 'stage2_morph', 'stage2_peak', 'stage3_amount', 'stage3_bias', 'stage3_level', 'stage3_frequency', 'stage3_resonance', 'stage3_morph', 'stage3_peak', 'lfo1_rate', 'lfo1_morph', 'lfo2_rate', 'lfo2_morph', 'noise_rate', 'feedback_amount', 'feedback_time','feedback_frequency', 'feedback_bandwidth', 'output', and 'drywet'.
reset
Reset