Some StkUGens documentation

Author: tdug

source/StkUGens/sc/HelpSource/Classes/StkFlute.schelp

@@ -0,0 +1,37 @@
+TITLE:: StkFlute
+categories:: UGens>PhysicalModels>StkUGens
+related:: Classes/Stk, Classes/StkInst
+
+CLASSMETHODS::
+
+METHOD:: ar
+ARGUMENT:: freq
+ARGUMENT:: jetDelay
+ARGUMENT:: noisegain
+ARGUMENT:: jetRatio
+ARGUMENT:: mul
+ARGUMENT:: add
+
+
+EXAMPLES::
+code::
+( // Add SynthDef
+SynthDef(\helpStkFlute, {
+    arg freq=440, jetDelay=49, noisegain=0.15, jetRatio=0.32, amp=0.2, gate=1, out=1;
+    
+    var env = EnvGen.kr(Env.asr(0, 1, 0.1), gate, doneAction: 2);
+    var sig = StkFlute.ar(freq, jetDelay: jetDelay, noisegain: noisegain, jetRatio: jetRatio);
+    sig = sig * env * amp;
+    
+    Out.ar(0, sig.dup);
+}).add;
+)
+
+( // Play SynthDef
+Pbind(
+    \instrument, \helpStkFlute,
+    \degree, Pseq((0..7)),
+    \octave, 6
+).play;
+)
+::

source/StkUGens/sc/HelpSource/Classes/StkPluck.schelp

@@ -0,0 +1,56 @@
+TITLE:: StkPluck
+categories:: UGens>PhysicalModels>StkUGens
+related:: Classes/Stk, Classes/StkInst
+
+CLASSMETHODS::
+
+METHOD:: ar
+ARGUMENT:: freq
+ARGUMENT:: decay
+ARGUMENT:: mul
+ARGUMENT:: add
+
+
+EXAMPLES::
+code::
+( // Add SynthDef.
+SynthDef(\helpStkPluck, {
+    arg freq=440, decay=0.99, amp=0.2, gate=1, out=0;
+
+    var env = EnvGen.kr(Env.asr(0,1,0.1), gate, doneAction:2);
+    var sig = StkPluck.ar(freq, decay);
+    sig = sig * env * amp;
+
+    Out.ar(0, sig.dup);
+}).add;
+)
+
+( // Play SynthDef
+Pbind(
+    \instrument, \helpStkPluck,
+    \degree, Pseq([0,2,4,8], 1),
+    \dur, 1
+).play;
+)
+
+( // Guitar tuning.
+var midinotes=[40, 45, 50, 55, 59, 64];
+Pbind(
+    \instrument, \helpStkPluck,
+    \midinote, Pseq(midinotes),
+    \dur, 1
+).play;
+)
+
+( // Guitar chords.
+var midinotes=[40, 45, 50, 55, 59, 64];
+var fretsE=[ 0,  2,  2,  1,  0,  0];
+var fretsA=[Rest(0), 0, 2, 2, 2, 0];
+Pbind(
+    \instrument, \helpStkPluck,
+    \midinote, midinotes + Pseq([Pn(fretsE, 8), Pn(fretsA, 8)], 2),
+    \strum, Pseq([1, -1], inf) * Pwhite(0.0125, 0.035),
+    \dur, Pseq([2, 2, 1, 1, 1/2, 1/2, 1/2, 1/2], inf)
+).play;
+)
+::

source/StkUGens/sc/HelpSource/Classes/StkShakers.schelp

@@ -0,0 +1,48 @@
+TITLE:: StkShakers
+categories:: UGens>PhysicalModels>StkUGens
+related:: Classes/Stk, Classes/StkInst
+
+CLASSMETHODS::
+
+METHOD:: ar
+
+ARGUMENT:: instr
+An integer between 0 and 21, inclusive. Instruments can be found with link::#-directory::
+ARGUMENT:: energy
+ARGUMENT:: decay
+ARGUMENT:: objects
+ARGUMENT:: resfreq
+ARGUMENT:: mul
+ARGUMENT:: add
+
+METHOD:: directory
+Returns a dictionary of shaker instrument numbers.
+RETURNS:: A link::Classes/Dictionary::
+code::
+StkShakers.directory;
+::
+
+EXAMPLES::
+
+code::
+(
+SynthDef(\helpStkShakers, {
+    arg instr=0, energy=64, decay=64, objects=64, resfreq=64, amp=0.2, gate=1;
+
+    var env = EnvGen.kr(Env.asr(0, 1, 0.1), gate: gate, doneAction: 2);
+    var sig = StkShakers.ar(instr, energy, decay, objects, resfreq);
+    sig = sig * env * amp;
+
+    Out.ar(0, sig.dup);
+}).add;
+)
+
+(
+Pbind(
+    \instrument, \helpStkShakers,
+    \instr, 11,
+    \dur, Pseq([2, Rest(2), 2, Rest(2), 2]),
+    \amp, 0.5
+).play;
+)
+::