Type Members

1.  final case class Action(trig: GE, key: String) extends Expander[Unit] with HasSideEffect with Product with Serializable

   A graph element that executes an action upon receiving a trigger.

   A graph element that executes an action upon receiving a trigger.

   trig

   the trigger input signal

   key

   a key into the process' attribute map or the caller's context map. The value peer stored at that location should be of type proc.Action. Alternatively, if the process is started by a control program, an instance of Act can be passed via runWith.

2.  final case class Attribute(rate: Rate, key: String, default: Option[IndexedSeq[Float]], fixed: Int) extends GE.Lazy with Product with Serializable
3.  final case class BufChannels(rate: Rate, key: String) extends Info with Product with Serializable
4.  final case class BufRateScale(rate: Rate, key: String) extends Info with Product with Serializable
5.  final case class BufSampleRate(rate: Rate, key: String) extends Info with Product with Serializable
6.  final case class Buffer(rate: Rate, key: String) extends GE.Lazy with Product with Serializable

   An element referring to a random access buffer provided through an attribute.

   An element referring to a random access buffer provided through an attribute. The attribute will typically be an audio grapheme.

   key

   the attribute key.

7.  final case class BufferGen(cmd: Command, numFrames: GE, numChannels: GE = 1) extends GE.Lazy with ScalarRated with Product with Serializable

   Creates a buffer filled by a special buffer-generation (/b_gen) function, for example to create a wave-shaper table.

   Creates a buffer filled by a special buffer-generation (/b_gen) function, for example to create a wave-shaper table.

   cmd

   the buffer generator command

   numFrames

   the number of frames for the buffer. Must be resolvable at graph expansion time.

   numChannels

   the number of channels for the buffer (defaults to 1). Must be resolvable at graph expansion time.

8.  final case class BufferOut(rate: Rate, artifact: String, action: String, numFrames: GE, numChannels: GE) extends GE.Lazy with Product with Serializable

   A graph element that creates an empty buffer for the synth graph to write to.

   A graph element that creates an empty buffer for the synth graph to write to. Upon completion of the encompassing proc, the buffer contents is written to an artifact referred to by its attribute-map key. When the file has been written, the action referred to by its attribute-map key is called. The element outputs the buffer-id.

   An alternative is Action.WriteBuf which is slightly more flexible. It writes the buffer contents when a trigger is received, and outputs another trigger when writing finishes.

   rate

   the rate at which the buffer-id is presented

   artifact

   a key into the encompassing object's attribute map, leading to an Artifact.

   action

   a key into the encompassing object's attribute map, leading to an Action.

   numFrames

   the number of frames to allocate

   numChannels

   the number of channels to allocate

   See also

   Action.WriteBuf

9.  final case class DiskIn(rate: Rate, key: String, loop: GE) extends Stream with IsIndividual with Product with Serializable
10.  final case class DiskOut(rate: Rate, key: String, in: GE, fileType: GE = -1, sampleFormat: GE = 2) extends GE.Lazy with WritesBuffer with Product with Serializable

    A graph element that creates a DiskOut writing to a file designated by an object attribute with a given key and the value being an Artifact.

    A graph element that creates a DiskOut writing to a file designated by an object attribute with a given key and the value being an Artifact.

    If the given file-type GE is -1, the type is determined by this artifact. For example, if the artifact's path ends in ".aif", the AIFF format will used, if the path ends in ".w64", then Wave64 will be used. The default is AIFF.

    If an AudioCue is found at the key, its spec will override file type, sample-format and rate.

    key

    the key into the enclosing object's attribute map, pointing to an Artifact

    in

    the signal to write

    fileType

    a file type id as given by DeskOut.id(). The default is -1 (auto-detect).

    sampleFormat

    a sample format id as given by DeskOut.id(). The default is 2 (32-bit Float).

11.  final case class DoneSelf(trig: GE, pause: GE = 1) extends Expander[Unit] with Product with Serializable

    A UGen that when triggers stops the encompassing synth, marking the runner as done.

    A UGen that when triggers stops the encompassing synth, marking the runner as done. As opposed to FreeSelf, this triggers a disposal action on the client side, possibly synchronising the disposal of associated resources.

    trig

    the trigger signal that invokes the disposal

    pause

    if non-zero, immediately pauses the synth when the trigger is received. This can be useful because the client may take a moment to actually dispose the synth.

    See also

    StopSelf

12.  final case class Duration() extends GE.Lazy with ScalarRated with Product with Serializable

    Total duration of proc in seconds.

    Total duration of proc in seconds. If proc was started midway through, this is still its total length. To gather for how long it's going to play, use Duration() - Offset().

    Reports infinity if no durational information is available.

13.  final case class FadeIn(rate: Rate, key: String) extends SingleBase with Product with Serializable

    A graph element that produces an amplitude factor corresponding with the process' fade-in segment.

    A graph element that produces an amplitude factor corresponding with the process' fade-in segment. If no segment is provided, produces a constant signal of one.

14.  final case class FadeInOut(rate: Rate, inKey: String, outKey: String) extends Base with Product with Serializable
15.  final case class FadeOut(rate: Rate, key: String) extends SingleBase with Product with Serializable
16.  final case class MkValue(key: String, trig: GE, in: GE) extends Expander[Unit] with HasSideEffect with Product with Serializable

    A graph element that writes values to a caller variable upon receiving a trigger, sampling the values at that moment.

    A graph element that writes values to a caller variable upon receiving a trigger, sampling the values at that moment. If the variable is absent, the element is simply a no-op. The variable type should be Double or Seq[Double].

    key

    a key into the process' attribute map. the value peer stored at that location should be of type expr.Var

    trig

    the trigger input signal

    in

    the input signal to sample and write into the variable

17.  final case class Offset() extends GE.Lazy with ScalarRated with Product with Serializable

    Start time offset within the proc, in seconds.

    Start time offset within the proc, in seconds. Will be zero if proc is started from the beginning.

    Reports zero if no time information is available.

18.  final case class Param(rate: Rate, key: String, default: Option[Vec[Float]], fixed: Int) extends GE.Lazy with Product with Serializable
19.  final case class PartConv(rate: Rate, key: String, in: GE, fftSize: GE) extends GE.Lazy with Product with Serializable

    A SoundProcesses aware variant of PartConv, a UGen for partitioned convolution.

    A SoundProcesses aware variant of PartConv, a UGen for partitioned convolution. It takes its buffer input from an attribute with the given key. Partitioned convolution breaks up a long impulse response into piece, allowing them to very large. CPU load increases with IR size, and there are tradeoffs based on fftSize choice, due to rarer but larger FFTs. Amortisation to used to spread processing and avoid spikes.

    The buffer contents must be monophonic. If multiple channels are desired, they must be individually provided to separate PartConv instances.

    key

    key into the containing object's attribute map, where an AudioCue is to be found.

    fftSize

    the size of the internal fft used during partitioned convolution. the default is 2048, but 1024 and higher powers-of-two should be possible. Must be resolvable at graph expansion time.

20.  final case class Reaction(trig: GE, in: GE, key: String) extends Expander[Unit] with HasSideEffect with Product with Serializable

    A graph element that executes an action upon receiving a trigger, sampling the values at that moment and making them available in the action through the values method.

    A graph element that executes an action upon receiving a trigger, sampling the values at that moment and making them available in the action through the values method.

    trig

    the trigger input signal

    in

    the input signal to sample and pass on to the action

    key

    a key into the process' attribute map. the value peer stored at that location should be of type proc.Action

21.  final case class ScanIn(key: String) extends Like with Product with Serializable
22.  final case class ScanInFix(key: String, numChannels: Int) extends Like with Product with Serializable

    Like ScanIn but with a predetermined number of channels.

23.  final case class ScanOut(key: String, in: GE) extends ZeroOut with WritesBus with Product with Serializable
24.  final case class StopSelf(trig: GE, pause: GE = 1) extends Expander[Unit] with Product with Serializable

    A UGen that when triggers stops the encompassing synth, marking the runner as stopped.

    A UGen that when triggers stops the encompassing synth, marking the runner as stopped. As opposed to FreeSelf, this triggers a disposal action on the client side, possibly synchronising the disposal of associated resources.

    When there is a need to distinguish a runner's stop from done, the DoneSelf UGen can be used.

    trig

    the trigger signal that invokes the disposal

    pause

    if non-zero, immediately pauses the synth when the trigger is received. This can be useful because the client may take a moment to actually dispose the synth.

    See also

    DoneSelf

25.  final case class Time() extends GE.Lazy with ScalarRated with Product with Serializable

    Absolute time on the canvas, in seconds.

    Absolute time on the canvas, in seconds.

    Reports zero if no time information is available.

26.  final case class TrigAttribute(key: String) extends GE.Lazy with ControlRated with Product with Serializable
27.  final case class VDiskIn(rate: Rate, key: String, speed: GE, loop: GE, interp: Int, maxSpeed: Double) extends Stream with IsIndividual with Product with Serializable

    A SoundProcesses aware variant of VDiskIn.

    A SoundProcesses aware variant of VDiskIn. It takes its streaming buffer input from an attribute with the given key. Default values provide automatic sample-rate-conversion to match the audio server.

    key

    key into the containing object's attribute map, where an AudioCue is to be found.

    speed

    speed factor as in ugen.VDiskIn. If a negative constant value is given, the actual factor is BufRateScale.kr * -speed, thus -1 indicates playback at correct sample rate.

    interp

    same as in ugen.VDiskIn. Additionally, a value of -1 indicates that interpolation should be chosen according to speed. This is useful in conjunction with negative speed values where interpolation might depend on actual SRC.

    maxSpeed

    maximum expected speed, which will be used in consideration of the buffer size needed. if zero (default), and speed is a constant, this will be aligned with speed.