Audio components

audio:clock

A timer for audio patches synchronized to the sample rate clock. Sends a signal (empty value) every period.

For consistency, the pulse is quantized to a set number of audio buffers, so may differ slightly from the requested value.

out : ControlOut
bpm : Property (number 10..300) : beats per minute.
subdivision : Property (integer 1..16) : number of pulses per beat (eg. default 4 is equivalent to semiquaver).
actual-bpm : Property (number, read-only) : the actual bpm taking into account quantization.
period : Property (number, read-only) : the actual period in seconds.
buffer-count : Property (integer, read-only) : the number of audio buffers per pulse

audio:custom

Base for audio components. No ports or controls by default. See coding guide.

audio:gain

Control audio gain (volume).

in : AudioIn
out : AudioOut
level : Property (number 0..2) : gain level.

audio:input

Input from audio device. An input is optional in an audio graph. Supports 1-16 channels (default 2). Ports will be added dynamically.

out-1 : AudioOut
out-2 : AudioOut
channels : Property (1..16) : number of channels.

audio:looper

A stereo sample looper. Supports recording, looping, in/out points, variable speed.

The looper will not start automatically. To get it to start when the audio root is started, use a core:start-trigger attached to the play port.

in-1 / in-2 : AudioIn
out-1 / out-2 : AudioOut
recording : Property (boolean) : record input (must be playing)
play : Action : start playback
stop : Action : stop playback
position : Property (number 0..1, transient) : normalized playback position
start : Property (number 0..1) : start point for playback / looping
end : Property (number 0..1) : end point for playback / looping
speed : Property (number -4..4) : playback speed (supports reverse play)
loop : Property (boolean) : loop playback
playing : Property (boolean, transient) : playing
loop-size : Property (number 0..5) : loop size in seconds

audio:osc

Simple oscillator

out : AudioOut
waveform : Property (Sine, Square, Saw)
frequency : Property (number 20..3600)
level : Property (number 0..1)

audio:output

Output to audio device. An output is required in an audio graph. Supports 1-16 channels (default 2). Ports will be added dynamically.

in-1 : AudioIn
in-2 : AudioIn
channels : Property (1..16) : number of channels.

audio:player

A stereo sample player. Supports looping, in/out points, variable speed.

Samples are loaded in the background. If using the sample port to load new samples, make use of the ready and error ports to track loading.

The player will not start automatically. To get it to start when the audio root is started, use a core:start-trigger attached to the play port.

out-1 / out-2 : AudioOut
sample : Property (empty or resource) : audio file
position : Property (number 0..1, transient) : normalized playback position
start : Property (number 0..1) : start point for playback / looping
end : Property (number 0..1) : end point for playback / looping
speed : Property (number -4..4) : playback speed (supports reverse play)
loop : Property (boolean) : loop playback
play : Action : start playback
stop : Action : stop playback
ready : ControlOut : signal for new sample loaded
error : ControlOut : signal for error during new sample loading

audio:analysis:level

Calculate the level (volume) of the audio buffer using RMS.

The control cycle is always processed before the audio is calculated, therefore the output of this component will always be for the previous audio buffer.

in : AudioIn
out : AudioOut
level : ControlOut

audio:fx:chorus

A chorus component.

This is similar to audio:fx:lfo-delay but with more limited range on parameters.

in-1 / in-2 : AudioIn
out-1 / out-2 : AudioOut
depth : Property (number 0..40) : depth of chorus measured in milliseconds
rate : Property (number 0..15) : rate of LFO in Hz
feedback : Property (number 0..1) : amount of signal fed back into input

audio:fx:comb-filter

A comb filter.

in-1 / in-2 : AudioIn
out-1 / out-2 : AudioOut
frequency : Property (number 20..20000) : frequency of filter
feedback : Property (number 0..1) : amount of signal fed back into input

audio:fx:delay

A simple delay (echo) component.

in-1 / in-2 : AudioIn
out-1 / out-2 : AudioOut
time : Property (number 0..2) : delay time in seconds
feedback : Property (number 0..1) : amount of signal fed back into input

audio:fx:filter

An Infinite impulse response (IIR) filter with various types.

Types are LP6, LP12, HP12, BP12, NP12, LP24, HP24.

in-1 / in-2 : AudioIn
out-1 / out-2 : AudioOut
type : Property (in Types)
frequency : Property (number) : frequency of filter
resonance : Property (number 0..30) : resonance of filter

audio:fx:lfo-delay

A delay with delay time controlled by a low frequency oscillator.

This is similar to audio:modulation:chorus but with a wider range on parameters.

in-1 / in-2 : AudioIn
out-1 / out-2 : AudioOut
time : Property (number 0..1) : average delay time in seconds
range : Property (number 0..1) : depth of LFO as proportion of delay time
rate : Property (number 0..40) : rate of LFO in Hz
feedback : Property (number 0..1) : amount of signal fed back into input

audio:fx:overdrive

A simple overdrive distortion effect.

in-1 / in-2 : AudioIn
out-1 / out-2 : AudioOut
drive : Property (number 0..1) : distortion level

audio:fx:reverb

A stereo reverb, port of the popular Freeverb.

in-1 / in-2 : AudioIn
out-1 / out-2 : AudioOut
room-size : Property (number 0..1)
damp : Property (number 0..1) : amount of damping
width : Property (number 0..1) : stereo width
wet : Property (number 0..1) : level of reverberated signal
dry : Property (number 0..1) : level of original input signal (0.5 is original level)

audio:mix:xfader

Crossfade between two mono signals. When mix is set to 0 or 1 processing of the unused channel will be switched off.

Currently limited to linear fading.

in-1 : AudioIn
in-2 : AudioIn
out : AudioOut
mix : Property (number 0..1)