Type Members

1.  final case class Action(trig: B, key: String) extends Expander[Unit] 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. the value peer stored at that location should be of type proc.Action

2.  final case class Attribute[A](key: String, default: Option[Default[A]], fixed: Int)(implicit from: FromAny[A]) extends GE.Lazy[A] with ProductWithAdjuncts with Product with Serializable
3.  final case class AudioFileIn(key: String) extends GE.Lazy[Double] with Product with Serializable
4.  trait AudioFileInPlatform extends AnyRef
5.  final case class AudioFileOut(key: String, in: D, fileType: I = -1, sampleFormat: I = 2, sampleRate: D = 44100.0) extends GE.Lazy[Long] with Product with Serializable

   A graph element that creates a UGen 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 UGen 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 or AudioCue

   in

   the signal to write

   fileType

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

   sampleFormat

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

   sampleRate

   the nominal sample-rate of the file. The default is 44100.

6.  final case class ImageFileIn(key: String) extends GE.Lazy[Double] with Product with Serializable
7.  final case class ImageFileOut(key: String, in: D, width: I, height: I, fileType: I = -1, sampleFormat: I = 0, quality: I = 80) extends Expander[Unit] with Product with Serializable

   A graph element that creates a UGen 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 UGen 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 ".png", the PNG format will used, if the path ends in ".jpg", then JPEG will be used. The default is PNG.

   key

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

   in

   the signal to write

   width

   image's width in pixels

   height

   image's height in pixels

   fileType

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

   sampleFormat

   a sample format id as given by ImageFileOut.id(). The default is 0 (8-bit Int).

   quality

   the compression quality for a lossy format such as JPG. The default is 80.

8.  final case class ImageFileSeqIn(key: String, indices: I) extends GE.Lazy[Double] with Product with Serializable

   Reads a sequence of images, outputting them directly one after the other, determining their file names by formatting a template taken from an artifact stored in the object's attribute map at key, with a numeric argument given through indices.

   Reads a sequence of images, outputting them directly one after the other, determining their file names by formatting a template taken from an artifact stored in the object's attribute map at key, with a numeric argument given through indices.

   key

   key into the FScape object's attribute map, where an Artifact should be stored. The artifact's file name is taken as a template. Either that file contains a single placeholder for java.util.Formatter syntax, such as %d to insert an integer number. Or alternatively, if the file name does not contain a % character but a digit or a sequence of digits, those digits will be replaced by %d to produce a valid template. Therefore, if the template is foo-123.jpg and the indices contain 4 and 5, then the UGen will read the images foo-4 and foo-5 (the placeholder 123 is irrelevant).

9.  final case class ImageFileSeqOut(key: String, in: D, width: I, height: I, fileType: I = -1, sampleFormat: I = 0, quality: I = 80, indices: I) extends Expander[Unit] with Product with Serializable

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

   A graph element that creates a UGen writing to a file sequence 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 ".png", the PNG format will used, if the path ends in ".jpg", then JPEG will be used. The default is PNG.

   key

   the key into the enclosing object's attribute map, pointing to an Artifact for the file template. The artifact's file name is taken as a template. Either that file contains a single placeholder for java.util.Formatter syntax, such as %d to insert an integer number. Or alternatively, if the file name does not contain a % character but a digit or a sequence of digits, those digits will be replaced by %d to produce a valid template. Therefore, if the template is foo-123.jpg and the indices contain 4 and 5, then the UGen will write the images foo-4 and foo-5 (the placeholder 123 is irrelevant).

   in

   the signal to write

   width

   image's width in pixels

   height

   image's height in pixels

   fileType

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

   sampleFormat

   a sample format id as given by ImageFileSeqOut.id(). The default is 0 (8-bit Int).

   quality

   the compression quality for a lossy format such as JPG. The default is 80.

10.  final case class InSeq[A](key: String)(implicit from: FromAny[Seq[A]]) extends GE.Lazy[A] with ProductWithAdjuncts with Product with Serializable
11.  final case class MkAudioCue(key: String, in: D, fileType: I = 0, sampleFormat: I = 2, sampleRate: D = 44100.0) extends GE.Lazy[Long] with Reader with Product with Serializable

    A graph element that creates a UGen writing to an audio file designated by an FScape.Output with a given key and the value being an AudioCue.

    A graph element that creates a UGen writing to an audio file designated by an FScape.Output with a given key and the value being an AudioCue.

    key

    the key into the enclosing object's outputs map, producing an AudioCue

    in

    the signal to write

    fileType

    a file type id as given by MkAudioCue.id(). The default is 0 (AIFF). Must be resolvable at init time.

    sampleFormat

    a sample format id as given by MkAudioCue.id(). The default is 2 (32-bit Float). Must be resolvable at init time.

    sampleRate

    the nominal sample-rate of the file. The default is 44100. Must be resolvable at init time.

12.  final case class MkDouble(key: String, in: D) extends Expander[Unit] with Reader with Product with Serializable
13.  final case class MkDoubleVector(key: String, in: D) extends Expander[Unit] with Reader with Product with Serializable
14.  final case class MkInt(key: String, in: I) extends Expander[Unit] with Reader with Product with Serializable
15.  final case class MkIntVector(key: String, in: I) extends Expander[Unit] with Reader with Product with Serializable
16.  final case class MkLong[L](key: String, in: GE[L])(implicit numL: NumInt[L]) extends Expander[Unit] with Reader with ProductWithAdjuncts with Product with Serializable
17.  final case class OnComplete(key: String) extends Expander[Unit] with Product with Serializable

    A UGen that invokes an action once the surrounding graph has completed.

    A UGen that invokes an action once the surrounding graph has completed. The action is called with a Try[Unit] as its universe value.

    key

    key to the hosting object's attribute map, at which an action is expected to be found.

18.  final case class PhysicalIn(indices: I = 0, numChannels: Int = 1) extends GE.Lazy[Double] with Product with Serializable

    An unusual UGen that couples FScape to a real-time audio interface input.

    An unusual UGen that couples FScape to a real-time audio interface input. It is similar to the standard (ScalaCollider) PhysicalIn UGen, and it was added to be able to work-around limitations of SuperCollider on WebAssembly (such as missing audio file output). It is also useful for testing FScape processes by directly feeding in signals, possibly playing them back in real-time with the corresponding PhysicalOut UGen.

    This UGen should be considered experimental, and it is probably not suited to run in permanently a sound installation. It is important to know that the implementation is different between the JVM (desktop) platform and the JS (browser) platform. On the desktop, the input signal comes from SuperCollider (transferring buffer data between SuperCollider and FScape), whereas in the browser, the Web Audio API is used directly. This also leads to different behaviour in terms of latency and drop-out stability.

    For drop-out free combined use of PhysicalIn and PhysicalOut, consider inserting a delay by prepending a DC(0.0) of 0.5 to 1.0 seconds duration to the output.

    indices

    the zero-based channel offset. Note: this is currently not implemented, therefore leave it at the default of zero.

    numChannels

    the number of channels to stream. The UGen has been tested with mono and stereo signals, and bandwidth seems to be sufficient in these cases. Higher values have not been battle-tested.

    See also

    PhysicalOut

19.  final case class PhysicalOut(indices: I, in: D) extends Expander[Unit] with Product with Serializable

    An unusual UGen that couples FScape to a real-time audio interface output.

    An unusual UGen that couples FScape to a real-time audio interface output. It is similar to the standard (ScalaCollider) PhysicalOut UGen, and it was added to be able to work-around limitations of SuperCollider on WebAssembly (such as missing audio file input). It is also useful for testing FScape processes by directly listening to signals, possibly coming from real-time input as well with the corresponding PhysicalIn UGen.

    This UGen should be considered experimental, and it is probably not suited to run in permanently a sound installation. It is important to know that the implementation is different between the JVM (desktop) platform and the JS (browser) platform. On the desktop, the output signal is sent to SuperCollider (transferring buffer data between FScape and SuperCollider), whereas in the browser, the Web Audio API is used directly. This also leads to different behaviour in terms of latency and drop-out stability.

    For drop-out free combined use of PhysicalIn and PhysicalOut, consider inserting a delay by prepending a DC(0.0) of 0.5 to 1.0 seconds duration to the output.

    indices

    the zero-based channel offset. Note: this is currently not implemented, therefore leave it at the default of zero.

    in

    the signal stream. The UGen has been tested with mono and stereo signals, and bandwidth seems to be sufficient in these cases. Higher values have not been battle-tested.

    See also

    PhysicalIn