UGenSpec

Specification of a Unit Generator.

name: the name of the unit generator, as seen by the server
attr: a set of attributes which characterize the UGen, such as resource usage or uniqueness
rates: at which calculation rates the UGen runs, and whether the rate is implied
args: the constructor arguments of the UGen representation. This is the interface for the client-side instantiation and may include types other than GE, for example integers for fixed number of channels, etc., as well as definitions for default values.
inputs: the inputs as passed to the underlying UGen (server-side object). Inputs are things which expand to UGenInLike elements. Typically they correspond to client-side args arguments. The order of this sequence must be correctly reflecting the UGen plugin interface, whereas the order of the args sequence may diverge for an improved user interface.
outputs: a list of output specifications
doc: optional text documentation

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Instance Constructors

new UGenSpec(name: String, attr: Set[Attribute], rates: Rates, args: IndexedSeq[Argument], inputs: IndexedSeq[Input], outputs: IndexedSeq[Output], doc: Option[Doc])

name
the name of the unit generator, as seen by the server
attr
a set of attributes which characterize the UGen, such as resource usage or uniqueness
rates
at which calculation rates the UGen runs, and whether the rate is implied
args
the constructor arguments of the UGen representation. This is the interface for the client-side instantiation and may include types other than GE, for example integers for fixed number of channels, etc., as well as definitions for default values.
inputs
the inputs as passed to the underlying UGen (server-side object). Inputs are things which expand to UGenInLike elements. Typically they correspond to client-side args arguments. The order of this sequence must be correctly reflecting the UGen plugin interface, whereas the order of the args sequence may diverge for an improved user interface.
outputs
a list of output specifications
doc
optional text documentation

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
lazy val argMap: Map[String, Argument]

A convenience field which maps from argument names to arguments.
val args: IndexedSeq[Argument]

the constructor arguments of the UGen representation.
the constructor arguments of the UGen representation. This is the interface for the client-side instantiation and may include types other than GE, for example integers for fixed number of channels, etc., as well as definitions for default values.
final def asInstanceOf[T0]: T0

Definition Classes
Any
val attr: Set[Attribute]

a set of attributes which characterize the UGen, such as resource usage or uniqueness
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val doc: Option[Doc]

optional text documentation
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

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

Definition Classes
AnyRef → Any
lazy val inputMap: Map[String, Input]

A convenience field which maps from input argument names to inputs.
val inputs: IndexedSeq[Input]

the inputs as passed to the underlying UGen (server-side object).
the inputs as passed to the underlying UGen (server-side object). Inputs are things which expand to UGenInLike elements. Typically they correspond to client-side args arguments. The order of this sequence must be correctly reflecting the UGen plugin interface, whereas the order of the args sequence may diverge for an improved user interface.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val name: String

the name of the unit generator, as seen by the server
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val outputs: IndexedSeq[Output]

a list of output specifications
val rates: Rates

at which calculation rates the UGen runs, and whether the rate is implied
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
UGenSpec → 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: object UGenSpec | package synth

final case class UGenSpec(name: String, attr: Set[Attribute], rates: Rates, args: IndexedSeq[Argument], inputs: IndexedSeq[Input], outputs: IndexedSeq[Output], doc: Option[Doc]) extends Product with Serializable

Instance Constructors

new UGenSpec(name: String, attr: Set[Attribute], rates: Rates, args: IndexedSeq[Argument], inputs: IndexedSeq[Input], outputs: IndexedSeq[Output], doc: Option[Doc])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

lazy val argMap: Map[String, Argument]

val args: IndexedSeq[Argument]

final def asInstanceOf[T0]: T0

val attr: Set[Attribute]

def clone(): AnyRef

val doc: Option[Doc]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

lazy val inputMap: Map[String, Input]

val inputs: IndexedSeq[Input]

final def isInstanceOf[T0]: Boolean

val name: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val outputs: IndexedSeq[Output]

val rates: Rates

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

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 Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped