Type Members

1.  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.

2.  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.

3.  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.

4.  sealed trait Attribute extends AnyRef

   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

   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
7.  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.

8.  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.

9.  sealed trait RateConstraint extends AnyRef

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

10.  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.

11.  sealed trait Rates extends AnyRef

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

12.  sealed trait SignalShape extends AnyRef

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