AlgaPattern | SuperCollider 3.13.0 Help

Description

An AlgaPattern is the polyphonic counterpart of an AlgaNode. All the basic concepts that define AlgaNodes also apply to AlgaPatterns. However, AlgaPatterns also support Patterns as modifiers for their parameters.

It is highly suggested to look into the Examples folder for more advanced usage of AlgaPatterns.

Class Methods

.new

Create a new AlgaPattern.

Arguments:

def	Mandatory argument. It accepts either a UGen function, a symbol to lookup a defined AlgaSynthDef or an Event describing the pattern.
interpTime	Specify the interpolation time it takes whenever making a new connection to any parameter of this AlgaPattern.
interpShape	Specify the interpolation shape that is to be used to perform new connections. This must be defined with an Env that always starts at 0 and ends at 1. If not specified, a single ramp `Env([0, 1], 1)` is used by default.
playTime	Specify the fading in / fading out time that it takes for this AlgaPattern to play through speakers. These values are applied when calling the play or stop functions.
playSafety	Specify a different safety method to use to scale the output of a node when using the play method. Accepted values are: `'clip', 'tanh', 'softclip', 'limiter', 'none'`.
sched	Just like any other AlgaPattern method, the current function can be scheduled at specific times in the future, according to the clock that the Alga instance booted on the server is using.
start	Start the AlgaPattern when created. This will be started at the specified `sched`.
schedInSeconds	Specify if all sched actions should be scheduled in seconds, opposing to beats. Default is `false`.
tempoScaling	Specify if all timed actions should be scaled by the clock's tempo. Default is `false`.
sampleAccurateFuncs	Set if the Functions used in the `'def'` parameter should be sample accurate or not. Defaults to true.
player	Set an instance of a AlgaPatternPlayer that will be used to trigger the pattern.
server	Specify a Server to instantiated the AlgaPattern on. This Server must have had Alga booted on it. It defaults to `Server.default`.

Instance Methods

.advance

Advance the AlgaPattern manually.

Arguments:

sched

Schedule the triggering at a specific time.

.step

Alias for advance.

.value

Alias for advance.

.stopPattern

Stop the AlgaPattern.

Arguments:

sched

Schedule at a specific time.

.stopP

Alias for stopPattern.

.playPattern

Play the AlgaPattern.

Arguments:

sched

Schedule at a specific time.

.playP

Alias for playPattern.

.restartPattern

Restart the AlgaPattern, resetting the entries.

Arguments:

sched

Schedule at a specific time.

.restartP

Alias for restartPattern.

.restartPattern

Reset the entries of the AlgaPattern.

Arguments:

sched

Schedule at a specific time.

.resetP

Alias for restartPattern.

.interpolateDur

Manually trigger the interpolation of the 'dur' parameter. This can also be achieved with the standard from method, but interpolateDur also accepts a different set of arguments that are specific to this kind of interpolation.

Arguments:

value	The new value to use.
time	The time that it takes for the interpolation to complete.
shape	An Env that optionally allows you to define a specific shape for the interpolation.
resync	Specify if the pattern should be re-synced to the clock after the interpolation is completed. This option can also be permanently turned on with the `durInterpResync` method.
reset	Specify if the pattern entry should be reset (restart) from the first value. This option can also be permanently turned on with the `durInterpReset` method.
sched	Specify when the interpolation process should start. This can also be set with the `schedResync` method.

Discussion:

.interpDur

Alias for interpolateDur.

.interpolateDelta

Alias for interpolateDur.

.interpDelta

Alias for interpolateDur.

.interpolateStretch

Like interpolateDur, but setting the 'stretch' parameter.

.interpStretch

Alias for interpolateStretch.

.interpolateSustain

Like interpolateDur, but setting the 'sustain' parameter.

.interpSus

Alias for interpolateSustain.

.interpolateLegato

Like interpolateDur, but setting the 'legato' parameter.

.interpLegato

Alias for interpolateLegato.

.resync

Resync the pattern to its clock.

.useMultiChannelExpansion

Set if the AlgaPattern should treat multi channel expansion like an AlgaNode or not.

.multiChannelExpansion

Alias for useMultiChannelExpansion.

.mc

Alias for useMultiChannelExpansion.

.replaceDur

Set if replace should be executed when changing the 'dur' parameter.

.stopPatternBeforeReplace

Set the mode for how replace should be executed. If true (default), the pattern will be stopped before the replace happens. If false, the pattern will only be stopped after the entire replace has happened. This case allows to perform both the fade in and fade out stages of the replace.

.schedSustainInSeconds

Set if the 'sustain' parameter should be scheduled in seconds. If false (default), it will be scheduled using the AlgaPattern's clock, whose tempo could be scaled.

.sustainToDur

Set if the 'dur' parameter should be added to the 'sustain' one. Basically, this permits to scale the 'sustain' according to 'dur'.

.sampleAccurateFuncs

Set if the Functions used in the 'def' parameter should be sample accurate or not. Defaults to true.

.schedResync

Set the default sched value for interpolateDur (and accompanying functions).

.durInterpResync

Set if interpolateDur (and accompanying functions) should resync by default.

.durResync

Alias for durInterpResync.

.durInterpReset

Set if interpolateDur (and accompanying functions) should reset by default.

.durReset

Alias for durInterpReset.

Examples

(
//Boot Alga
Alga.boot({
    //Declare a simple AlgaSynthDef.
    //Note that for it to be used in an AlgaPattern it must free itself.
    //Also, note the 'sampleAccurate' argument. This allows the AlgaSynthDef to use OffsetOut instead of Out
    //for sample accurate retriggering.
    AlgaSynthDef(\sinePerc, {
        SinOsc.ar(\freq.kr(440)) * EnvPerc.ar
    }, sampleAccurate: true).add;

//Wait for definition to be sent to server
    s.sync;

//Create an AlgaPattern and play it.
    //Unlike Pbind, AlgaPatterns use an Event to describe the parameter -> value mapping.
    a = AlgaPattern((
        def: \sinePerc,
        dur: 0.5
    )).play(chans: 2);
});
)

//Interpolate over the new Pseq. 'sched: 1' triggers it at the next beat
a.from(Pseq([220, 440, 880], inf), \freq, time: 3, sched: 1);

//Interpolate over the new Pwhite.
a.from(Pwhite(220, 880), \freq, time: 3, sched: 1);

//Interpolation can be sampled and held instead of being dynamic
a.from(Pseq([220, 440, 880], inf), \freq, sampleAndHold: true, time: 3, sched: 1);

//Change \dur does not trigger interpolation (yet), but it applies the changes directly
a.from(Pwhite(0.03, 0.5), \dur, sched: 1);

//Alternatively, the 'replaceDur' option can be used to trigger a 'replace' call, allowing for volume transitions
a.replaceDur = true;

//'The stopPatternBeforeReplace' option permits to either just stop the pattern before replacing (true),
//or to wait for the crossfade to finish before stopping the old one (false)
a.stopPatternBeforeReplace = false;

//Now it will 'replace'
a.from(0.25, \dur, time: 3, sched: 1);

//Bye bye
a.clear(time: 2);

helpfile source: HelpSource/Classes/AlgaPattern.schelp
link::AlgaLib/Classes/AlgaPattern::

AlgaPatternExtension

Description

Class Methods

.new

Arguments:

Instance Methods

.advance

Arguments:

.step

.value

.stopPattern

Arguments:

.stopP

.playPattern

Arguments:

.playP

.restartPattern

Arguments:

.restartP

.restartPattern

Arguments:

.resetP

.interpolateDur

Arguments:

Discussion:

.interpDur

.interpolateDelta

.interpDelta

.interpolateStretch

.interpStretch

.interpolateSustain

.interpSus

.interpolateLegato

.interpLegato

.resync

.useMultiChannelExpansion

.multiChannelExpansion

.mc

.replaceDur

.stopPatternBeforeReplace

.schedSustainInSeconds

.sustainToDur

.sampleAccurateFuncs

.schedResync

.durInterpResync

.durResync

.durInterpReset

.durReset

Examples

AlgaPattern
Extension