Object/Class

de.sciss.synth

UGenSpec

Related Docs: class UGenSpec | package synth

Permalink

object UGenSpec extends Serializable

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. UGenSpec
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final case class Argument(name: String, tpe: ArgumentType, defaults: Map[MaybeRate, ArgumentValue], rates: Map[MaybeRate, RateConstraint]) extends Product with Serializable

    Permalink

    A UGen client-side (logical) input argument.

    A UGen client-side (logical) input argument.

    name

    the name of the argument. On the server-side UGen inputs do not have argument names, so this is purely for the user-interface. It will be the argument name of the constructor arguments of the UGen class.

    tpe

    the argument type, such as graph element GE or integer.

    defaults

    default values for the argument, as specified depending on the UGen's calculation rate.

    rates

    constraints for the argument's own rate, as specified depending on this UGen's calculation rate.

  2. sealed trait ArgumentType extends AnyRef

    Permalink

    Currently, two types of arguments are supported for UGen classes: GE and Int.

    Currently, two types of arguments are supported for UGen classes: GE and Int. However, the actual Scala type for graph elements may differ, depending on the GE's signal shape. If that shape is String, the argument may appear to have type String which is then internally converted to a UGen input.

  3. sealed trait ArgumentValue extends AnyRef

    Permalink

    Type of default value for a UGen constructor argument.

    Type of default value for a UGen constructor argument. This allows for the inclusion of special values such as Nyquist or done actions that are more specific than for example Constant.

  4. sealed trait Attribute extends AnyRef

    Permalink

    An attribute describes an aspect of a UGen related to how it consumes resources, whether it is individual etc.

  5. final case class Doc(body: List[String], args: Map[String, List[String]], outputs: Map[String, List[String]], links: List[String], warnPos: Boolean, examples: List[Example]) extends Product with Serializable

    Permalink

    Documentation of a UGen.

    Documentation of a UGen.

    body

    the main UGen description text, as a list of paragraphs.

    args

    maps argument names to documentation for that argument, given as a list of paragraphs.

    outputs

    maps output names to documentation for that output, given as a list of paragraphs.

    links

    list of cross-links to related UGens.

    warnPos

    if true, indicates that the argument positions are different than in SC-Lang, warranting an explicit warning to the user to raise awareness.

  6. final case class Example(name: String, code: List[String], tpe: Type) extends Product with Serializable

    Permalink
  7. final case class Input(arg: String, tpe: Type) extends Product with Serializable

    Permalink

    A UGen (server-side) input corresponds with a particular argument in the client-side interface.

    A UGen (server-side) input corresponds with a particular argument in the client-side interface.

    arg

    the name of the argument (in the spec's args sequence) corresponding to the UGen input.

    tpe

    if variadic, the signal is treated as a multi-channel input with variable number of channels. only the last input of a UGen can be variadic. An example is the second input of the Out UGen.

  8. final case class Output(name: Option[String], shape: SignalShape, variadic: Option[String]) extends Product with Serializable

    Permalink

    Specification of a UGen output.

    Specification of a UGen output. Note that this describes one logical output. A UGen with a variable number of output channels can be seen has having _one_ logical output. For instance, the In UGen has one output signal, even if that signal may have any number of channels. In contrast, the Pitch UGen has two discrete logical outputs, one indicating the status ("hasFreq"), the other giving the actually seen frequency.

    name

    logical name of the output. The server does not know about output names, this is purely for client side usage (e.g. in a GUI or help system).

    shape

    the "shape" or type of output signal, for example (continuous) generic or binary trigger. technically all signals are the same, the shape just indicates the expected shape of that signal.

    variadic

    if defined, specifies the name of an argument (in the spec's args) which must be of type Int, determining the number of channels in this output.

  9. sealed trait RateConstraint extends AnyRef

    Permalink

    One of a fixed set of constraints on a UGen argument's calculation rate.

  10. sealed trait RateMethod extends AnyRef

    Permalink

    The shape of a UGen's constructor method relating to a particular calculation rate.

    The shape of a UGen's constructor method relating to a particular calculation rate. For example, it may be one of the standard namings like ar for audio-rate (RateMethod.Default), or it may be a custom method.

  11. sealed trait Rates extends AnyRef

    Permalink

    The supported calculation rates of a UGen can be either implied or a specified set of rates.

  12. sealed trait SignalShape extends AnyRef

    Permalink

    The logical shape or type or "meaning" of a signal.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object ArgumentType

    Permalink
  5. object ArgumentValue

    Permalink
  6. object Attribute

    Permalink
  7. object Example extends Serializable

    Permalink
  8. object Input extends Serializable

    Permalink
  9. object RateConstraint

    Permalink
  10. object RateMethod

    Permalink
  11. object Rates

    Permalink
  12. object SignalShape

    Permalink
  13. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  14. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  24. def parse(node: scala.xml.Node, docs: Boolean = false, verify: Boolean = false): UGenSpec

    Permalink

    Parses an individual XML node for one specific UGen specification.

    Parses an individual XML node for one specific UGen specification.

    node

    the <ugen> node.

    docs

    if true, parses documentation as well. if false skips documentation, thus spec.doc will be None.

  25. def parseAll(source: InputSource, docs: Boolean = false, verify: Boolean = false): Map[String, UGenSpec]

    Permalink

    Parses a complete XML file containing a number of UGen specifications.

    Parses a complete XML file containing a number of UGen specifications.

    source

    the XML source, such as obtained from a file or input stream.

    docs

    if true, parses documentation as well. if false skips documentation, thus spec.doc will be None.

    returns

    a map from UGen names to their specifications.

  26. final val standardPlugins: List[String]

    Permalink

    List of standard UGen plugin names, including ScalaCollider helper elements.

  27. lazy val standardUGens: Map[String, UGenSpec]

    Permalink

    Lazily computes the specs of the UGens bundled with the standard SuperCollider distribution.

    Lazily computes the specs of the UGens bundled with the standard SuperCollider distribution. The result maps from UGen names to their specifications.

  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. final val thirdPartyPlugins: List[String]

    Permalink

    List of third-party UGens as per https://github.com/supercollider/sc3-plugins, This is currently incomplete.

  30. lazy val thirdPartyUGens: Map[String, UGenSpec]

    Permalink

    Lazily computes the specs of the UGens found in the sc3-plugins project.

    Lazily computes the specs of the UGens found in the sc3-plugins project. The result maps from UGen names to their specifications.

  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  32. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped