ChucK Class Library Reference

ChuGins

ABSaturator

AmbPan3

Bitcrusher

MagicSine

KasFilter

FIR

Pan4

Pan8

Pan16

PitchTrack

GVerb

Mesh2D

Spectacle

Elliptic

WinFuncEnv

PowerADSR

FoldbackSaturator

WPDiodeLadder

WPKorg35

ABSaturator

: UGen : Object

Soft clip saturating distortion, based on examples from Abel/Berners' Music 424 course at Stanford.

member functions

float dcOffset(float arg)

Constant linear offset applied to the signal. A small offset will introduce odd harmonics into the distoration spectrum, whereas a zero offset will have only even harmonics.

float dcOffset()

Constant linear offset applied to the signal. A small offset will introduce odd harmonics into the distoration spectrum, whereas a zero offset will have only even harmonics.

float drive(float arg)

Input gain into the distortion section, in decibels. Controls overall amount of distortion.

float drive()

Input gain into the distortion section, in decibels. Controls overall amount of distortion.


AmbPan3

: UGen : Object

No description available

member functions

float azimuth(float arg)

No description available

float azimuth()

No description available

void channelMap(int[] arg)

No description available

float elevation(float arg)

No description available

float elevation()

No description available


Bitcrusher

: UGen : Object

No description available

member functions

int bits(int arg)

No description available

int bits()

No description available

int downsampleFactor(int arg)

No description available

int downsampleFactor()

No description available


MagicSine

: UGen : Object

No description available

member functions

float freq(float arg)

No description available

float freq()

No description available


KasFilter

: UGen : Object

No description available

member functions

float accent(float arg)

No description available

float accent()

No description available

float freq(float arg)

No description available

float freq()

No description available

float resonance(float arg)

No description available

float resonance()

No description available


FIR

: UGen : Object

No description available

member functions

int bpHetero(float arg)

No description available

float coeff(int arg, float arg2)

No description available

float coeff(int arg)

No description available

int gaussian(float arg)

No description available

int hpHetero()

No description available

int order(int arg)

No description available

int order()

No description available

int sinc(float arg)

No description available


Pan4

: UGen : Object

No description available

member functions

float pan(float arg)

No description available

float pan()

No description available


Pan8

: UGen : Object

No description available

member functions

float pan(float arg)

No description available

float pan()

No description available


Pan16

: UGen : Object

No description available

member functions

float pan(float arg)

No description available

float pan()

No description available


PitchTrack

: UGen : Object

No description available

member functions

float bias(float arg)

No description available

float bias()

No description available

float fidelity(float arg)

No description available

float fidelity()

No description available

int frame(int arg)

No description available

int frame()

No description available

float get()

No description available

int overlap(int arg)

No description available

int overlap()

No description available

float sensitivity(float arg)

No description available

float sensitivity()

No description available


GVerb

: UGen : Object

No description available

member functions

float bandwidth()

No description available

float bandwidth(float arg)

No description available

float damping()

No description available

float damping(float arg)

No description available

float dry()

No description available

float dry(float arg)

No description available

float early()

No description available

float early(float arg)

No description available

dur revtime(dur arg)

No description available

dur revtime()

No description available

float roomsize(float arg)

No description available

float roomsize()

No description available

float tail()

No description available

float tail(float arg)

No description available


Mesh2D

: UGen : Object

This class implements a rectilinear, two-dimensional digital waveguide mesh structure. For details, see Van Duyne and Smith, "Physical Modeling with the 2-D Digital Waveguide Mesh," Proceedings of the 1993 International Computer Music Conference.

This is a digital waveguide model, making its use possibly subject to patents held by Stanford University, Yamaha, and others.

member functions

float decay()

Decay constant (0 = instant decay, 1.0 = long decay time).

float decay(float arg)

Decay constant (0 = instant decay, 1.0 = long decay time).

float noteOff(float arg)

Release the model.

float noteOn(float arg)

Trigger the mesh with given amplitude.

int x()

X dimension of "plate" (max 12).

int x(int arg)

X dimension of "plate" (max 12).

float xpos()

Strike x position (appears to be on range (0.0, 2.0)).

float xpos(float arg)

Strike x position (appears to be on range (0.0, 2.0)).

int y()

Y dimension of "plate" (max 12).

int y(int arg)

Y dimension of "plate" (max 12).

float ypos()

Strike y position (appears to be on range (0.0, 2.0)).

float ypos(float arg)

Strike y position (appears to be on range (0.0, 2.0)).


Spectacle

: UGen : Object

No description available

member functions

int bands(int arg)

No description available

int bands()

No description available

void clear()

No description available

dur delay(dur delay)

No description available

dur delayMax(dur delay)

No description available

dur delayMax()

No description available

dur delayMin(dur delay)

No description available

dur delayMin()

No description available

float eq(float eq)

No description available

float feedback(float feedback)

No description available

int fftlen(int arg)

No description available

int fftlen()

No description available

float freqMax(float arg)

No description available

float freqMax()

No description available

float freqMin(float arg)

No description available

float freqMin()

No description available

int hold(int arg)

No description available

int hold()

No description available

float mix(float mix)

No description available

float mix()

No description available

int overlap(int arg)

No description available

int overlap()

No description available

int posteq(int arg)

No description available

int posteq()

No description available

void range(float arg1, float arg2)

No description available

int table(string table, string type)

No description available


Elliptic

: UGen : Object

No description available

member functions

float atten(float arg)

No description available

float atten()

No description available

void bpf(float stop, float hip, float lop)

No description available

int bypass(int arg)

No description available

int bypass()

No description available

void hpf(float stop, float pass)

No description available

void lpf(float stop, float pass)

No description available

float ripple(float arg)

No description available

float ripple()

No description available


WinFuncEnv

: Envelope : UGen : Object

No description available

member functions

dur attack(dur attackDuration)

Set duration of the attack phase.

int keyOff()

Start release phase.

int keyOff(int keyOff)

Start release phase.

int keyOn()

Start attack phase.

int keyOn(int keyOn)

Start attack phase.

dur release(dur releaseDuration)

Set duration of the release phase.

void setBlackman()

Set Blackman Window Envelope with default value (0.16).

void setBlackman(float a)

Set Blackman Window Envelope with a custom value.

void setBlackmanDerivative(float a0, float a1, float a2, float a3)

Set a custom Blackman Derivative Envelope with custom values.

void setBlackmanHarris()

Set BlackmanHarris Window Envelope.

void setBlackmanNutall()

Set BlackmanNutall Window Envelope.

void setExponential()

Set Exponential Function Envelope with default value (8.69/60.0).

void setExponential(float a)

Set Exponential Function Envleope with a custom value.

void setHann()

Set Hann (Hanning) Window Envelope.

void setHannPoisson()

Set Hann-Poisson Window Envelope with default value (0.5).

void setHannPoisson(float a)

Set Hann-Poisson Window Envelope with a custom value.

void setNutall()

Set Nutall Window Envelope.

void setParzen()

Set Parzen Window Envelope.

void setPoisson()

Set Poisson Window Envelope with default value (6.0).

void setPoisson(float a)

Set Poisson Window Envelope with a custom value.

void setTukey()

Set Tukey Window Envelope with default value (0.5).

void setTukey(float a)

Set Tukey Window Envelope with a custom value.

void setWelch()

Set Welch Window Window.

float windowValue()

Get current window value.


PowerADSR

: Envelope : UGen : Object

ADSR envelope that uses a power function to create curved envelope phases, extends Envelope.

member functions

dur attack(dur attackDuration)

Sets duration of the attack phase.

float attackCurve(float attackCurve)

Sets envelope curve of the attack phase.

dur decay(dur decayDuration)

Sets duration of the decay phase.

float decayCurve(float decayCurve)

Sets envelope curve of the decay phase.

int keyOff()

Begins the release phase of the envelope.

int keyOff(int keyOff)

Begins the release phase of the envelope.

int keyOn()

Begins the attack phase of the envelope.

int keyOn(int keyOn)

Begins the attack phase of the envelope.

dur release(dur releaseDuration)

Sets duration of the release phase.

float releaseCurve(float releaseCurve)

Sets envelope curve of the release phase.

void set(dur attackDuration, dur decayDuration, float sustainLevel, dur releaseDuration)

Sets duration of the attack, decay, and release phases; as well as the sustain level (ADSR order).

void setCurves(float attackCurve, float decayCurve, float releaseCurve)

Sets envelope curves of the attack, decay, and release phases.

float sustain(float sustainLevel)

Sets sustain level.


FoldbackSaturator

: UGen : Object

Foldback saturator that inverts a signal and multiplies it by an index as it passes a threshold.

member functions

float index(float arg)

The index that the signal is multiplied by after it is inverted against the threshold. Defaults to 2.0

float index()

The index that the signal is multiplied by after it is inverted against the threshold. Defaults to 2.0

float makeupGain(float arg)

The amount of makeup gain applied to the signal after processing, multiplied against the reciprocal of the threshold. Defaults to 1.0

float makeupGain()

The amount of makeup gain applied to the signal after processing, multiplied against the reciprocal of the threshold. Defaults to 1.0

float threshold(float arg)

The threshold (positive and negative) that the signal is inverted against as it is passed. Defaults to 0.6

float threshold()

The threshold (positive and negative) that the signal is inverted against as it is passed. Defaults to 0.6


WPDiodeLadder

: UGen : Object

Virtual analog low pass filter based on Will Pirkle's Diode Ladder application notes

member functions

float cutoff(float arg)

Cuttoff is in Hz [0..Nyquist).

float cutoff()

No description available

int nlp_type(int arg)

Set to 1 to normalize non-linear output.

int nlp_type()

No description available

int nonlinear(int arg)

Enable non linear saturator.

int nonlinear()

No description available

float resonance(float arg)

Resonance goes between [0...17].

float resonance()

No description available

float saturation(float arg)

Saturation is a scalar gain, and can be used to drive the non-linearity.

float saturation()

No description available


WPKorg35

: UGen : Object

Virtual analog low pass filter based on Will Pirkle's Korg35 application notes

member functions

float cutoff(float arg)

Cuttoff is in Hz [0..Nyquist).

float cutoff()

No description available

int nonlinear(int arg)

Enable non linear saturator.

int nonlinear()

No description available

float resonance(float arg)

Resonance goes between [0...2).

float resonance()

No description available

float saturation(float arg)

Saturation is a scalar gain, and can be used to drive the non-linearity.

float saturation()

No description available