UGenSpec

Type Members

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

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.
sealed trait ArgumentType extends AnyRef

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.
sealed trait ArgumentValue extends AnyRef

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.
sealed trait Attribute extends AnyRef

An attribute describes an aspect of a UGen related to how it consumes resources, whether it is individual etc.
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

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.
final case class Example(name: String, code: List[String], tpe: Type) extends Product with Serializable
final case class Input(arg: String, tpe: Type) extends Product with Serializable

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.
final case class Output(name: Option[String], shape: SignalShape, variadic: Option[String]) extends Product with Serializable

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.
sealed trait RateConstraint extends AnyRef

One of a fixed set of constraints on a UGen argument's calculation rate.
sealed trait RateMethod extends AnyRef

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.
sealed trait Rates extends AnyRef

The supported calculation rates of a UGen can be either implied or a specified set of rates.
sealed trait SignalShape extends AnyRef

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

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
object ArgumentType
object ArgumentValue
object Attribute
object Example extends Serializable
object Input extends Serializable
object RateConstraint
object RateMethod
object Rates
object SignalShape
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

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

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.
def parseAll(source: InputSource, docs: Boolean = false, verify: Boolean = false): Map[String, UGenSpec]

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.
final val standardPlugins: List[String]

List of standard UGen plugin names.
lazy val standardUGens: Map[String, UGenSpec]

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.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
final val thirdPartyPlugins: List[String]

List of third-party UGens as per https://github.com/supercollider/sc3-plugins, This is currently incomplete.
lazy val thirdPartyUGens: Map[String, UGenSpec]

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.
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: class UGenSpec | package synth

object UGenSpec extends Serializable

Type Members

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

sealed trait ArgumentType extends AnyRef

sealed trait ArgumentValue extends AnyRef

sealed trait Attribute extends AnyRef

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

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

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

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

sealed trait RateConstraint extends AnyRef

sealed trait RateMethod extends AnyRef

sealed trait Rates extends AnyRef

sealed trait SignalShape extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object ArgumentType

object ArgumentValue

object Attribute

object Example extends Serializable

object Input extends Serializable

object RateConstraint

object RateMethod

object Rates

object SignalShape

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def parse(node: scala.xml.Node, docs: Boolean = false, verify: Boolean = false): UGenSpec

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

final val standardPlugins: List[String]

lazy val standardUGens: Map[String, UGenSpec]

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

final val thirdPartyPlugins: List[String]

lazy val thirdPartyUGens: Map[String, UGenSpec]

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped