SoundProcesses-core/de.sciss.proc/AuralAttribute

AuralAttribute

trait AuralAttribute[T <: Txn[T]] extends AuralViewBase[T, Target[T]]

An AuralAttribute is the aural view of an object that is used as an input to another object, patched into that other object's attribute map. When the sink is run, it in turn calls run on the aural attribute, passing it a Target instance, to which the aural attribute can then attach itself.

Companion
object
trait AuralViewBase[T, Target[T]]
trait ViewBase[T]
trait Disposable[T]
trait Observable[T, State]
class Object
trait Matchable
class Any
trait TrySink[T]
trait ValueBaseImpl[T, A]
trait ExprImpl[T, A]

Type members

Inherited types

type Repr <: Form[T]
Inherited from
AuralViewBase

Value members

Abstract methods

def key: String

The key into the sink's attribute map.

The key into the sink's attribute map.

def preferredNumChannels(implicit tx: T): Int

Or -1 if the number of channels cannot be determined.

Or -1 if the number of channels cannot be determined.

def targetOption(implicit tx: T): Option[Target[T]]

Inherited methods

def dispose()(implicit tx: T): Unit
Inherited from
Disposable
def obj(implicit tx: T): Repr
Inherited from
AuralViewBase
def prepare(timeRef: Option)(implicit tx: T): Unit

Prepares the view to be able to run.

Prepares the view to be able to run.

Value Params
timeRef

an optional context of temporal position

Inherited from
AuralViewBase
def react(fun: T => State => Unit)(implicit tx: T): Disposable[T]

Registers a live observer with this observable. The method is called with the observing function which receives the observable's update message of type A, and the method generates an opaque Disposable instance, which may be used to remove the observer eventually (through the dispose method).

Registers a live observer with this observable. The method is called with the observing function which receives the observable's update message of type A, and the method generates an opaque Disposable instance, which may be used to remove the observer eventually (through the dispose method).

Inherited from
Observable
final
def reactNow(fun: T => State => Unit)(implicit tx: T): Disposable[T]

Like react, but also invokes the function with the current state immediately.

Like react, but also invokes the function with the current state immediately.

Inherited from
ViewBase
def run(timeRef: Option, target: Target[T])(implicit tx: T): Unit

Runs the view, whatever that means for the particular object. If the object is not prepared and needs preparing, the view will take care of running the prepare step (without mapping any attr map).

Runs the view, whatever that means for the particular object. If the object is not prepared and needs preparing, the view will take care of running the prepare step (without mapping any attr map).

Inherited from
AuralViewBase
def state(implicit tx: T): State
Inherited from
ViewBase
def stop()(implicit tx: T): Unit
Inherited from
ViewBase