final case class UGenSpec(name: String, attr: Set[Attribute], rates: Rates, args: IndexedSeq[Argument], inputs: IndexedSeq[Input], outputs: IndexedSeq[Output], doc: Option[Doc], elemOption: Option[String]) extends Product with Serializable
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-sideargs
arguments. The order of this sequence must be correctly reflecting the UGen plugin interface, whereas the order of theargs
sequence may diverge for an improved user interface.- outputs
a list of output specifications
- doc
optional text documentation
- elemOption
diverging name of the graph element, as seen by the client
- Alphabetic
- By Inheritance
- UGenSpec
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new UGenSpec(name: String, attr: Set[Attribute], rates: Rates, args: IndexedSeq[Argument], inputs: IndexedSeq[Input], outputs: IndexedSeq[Output], doc: Option[Doc], elemOption: Option[String])
- 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-sideargs
arguments. The order of this sequence must be correctly reflecting the UGen plugin interface, whereas the order of theargs
sequence may diverge for an improved user interface.- outputs
a list of output specifications
- doc
optional text documentation
- elemOption
diverging name of the graph element, as seen by the client
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]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val attr: Set[Attribute]
- def className: String
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val doc: Option[Doc]
- val elemOption: Option[String]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- lazy val inputMap: Map[String, Input]
A convenience field which maps from input argument names to inputs.
- val inputs: IndexedSeq[Input]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val outputs: IndexedSeq[Output]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val rates: Rates
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- UGenSpec → AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated