Packages

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

elemOption

diverging name of the graph element, as seen by the client

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

Instance Constructors

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

    elemOption

    diverging name of the graph element, as seen by the client

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. lazy val argMap: Map[String, Argument]

    A convenience field which maps from argument names to arguments.

  5. val args: IndexedSeq[Argument]
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val attr: Set[Attribute]
  8. def className: String
  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  10. val doc: Option[Doc]
  11. val elemOption: Option[String]
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. lazy val inputMap: Map[String, Input]

    A convenience field which maps from input argument names to inputs.

  16. val inputs: IndexedSeq[Input]
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val name: String
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. val outputs: IndexedSeq[Output]
  23. val rates: Rates
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    UGenSpec → AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped