Packages

final class AuralPatternAttribute[T <: Txn[T], I <: Txn[I]] extends AuralStreamLikeAttribute[T, I, Pattern[T]] with AuralAttribute[T]

Self Type
AuralPatternAttribute[T, I]
Linear Supertypes
AuralStreamLikeAttribute[T, I, Pattern[T]], AuralAttribute[T], AuralScheduledBase[T, proc.AuralAttribute.Target[T], View[T]], ObservableImpl[T, State], ObjViewBase[T, proc.AuralAttribute.Target[T]], AuralViewBase[T, proc.AuralAttribute.Target[T]], ViewBase[T], Disposable[T], Observable[T, State], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AuralPatternAttribute
  2. AuralStreamLikeAttribute
  3. AuralAttribute
  4. AuralScheduledBase
  5. ObservableImpl
  6. ObjViewBase
  7. AuralViewBase
  8. ViewBase
  9. Disposable
  10. Observable
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new AuralPatternAttribute(key: String, objH: Source[T, Pattern[T]], observer: Observer[T], tree: Map[I, Long, View[T]])(implicit context: AuralContext[T], iSys: (T) => I)

Type Members

  1. type Elem = View[T]
    Definition Classes
    AuralStreamLikeAttribute
  2. type ElemHandle = View[T]
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
  3. final class IPlaying extends ITimedState
    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  4. final class IPreparing extends ITimedState
    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  5. sealed trait ITimedState extends InternalState
    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  6. sealed trait InternalState extends Disposable[T]
    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  7. type Model = View[T]

    An opaque type coming out of processPrepare and ending up in mkView and elemAdded.

    An opaque type coming out of processPrepare and ending up in mkView and elemAdded. Typically Obj[T].

    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
  8. type PrepareResult = (ViewId, SpanLike, Model)
    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  9. type Repr = Pattern[T]
    Definition Classes
    AuralStreamLikeAttribute → ObjViewBase → AuralViewBase
  10. type St = (patterns.Stream[I, Any], Context[T, I])
    Attributes
    protected
    Definition Classes
    AuralPatternAttribute → AuralStreamLikeAttribute
  11. type Target = proc.AuralAttribute.Target[T]
    Definition Classes
    AuralStreamLikeAttribute
  12. type ViewId = Unit

    An opaque type passed into playView that may be used by an overriding implementation.

    An opaque type passed into playView that may be used by an overriding implementation. Otherwise it may simply be set to Unit.

    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. final def checkReschedule(h: ElemHandle, currentOffset: Long, oldTarget: Long, elemPlays: Boolean)(implicit tx: T): Boolean
    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
  6. final def childPreparedOrRemoved(childView: View[T])(implicit tx: T): Unit
    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. implicit val context: AuralContext[T]
    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
  9. def dispose()(implicit tx: T): Unit

    Sub-classes may override this and call super.dispose() if they wish to free additional observers, e.g.

    Sub-classes may override this and call super.dispose() if they wish to free additional observers, e.g. the timeline or grapheme observer.

    Definition Classes
    AuralPatternAttribute → AuralScheduledBase → Disposable
  10. def disposeStream(st: St)(implicit tx: T): Unit
    Attributes
    protected
    Definition Classes
    AuralPatternAttribute → AuralStreamLikeAttribute
  11. final def elemAdded(vid: ViewId, span: SpanLike, obj: Model)(implicit tx: T): Unit
    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  12. final def elemFromHandle(h: ElemHandle): Elem
    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
  13. final def elemRemoved(h: ElemHandle, elemPlays: Boolean)(implicit tx: T): Unit
    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def fire(update: State)(implicit tx: T): Unit
    Attributes
    protected
    Definition Classes
    ObservableImpl
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. implicit val iSys: (T) => I
    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute
  20. def init(pat: Pattern[T])(implicit tx: T): AuralPatternAttribute.this.type
  21. final def internalState(implicit tx: T): InternalState
    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  22. final def internalState_=(value: InternalState)(implicit tx: T): Unit
    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. val key: String

    The key into the sink's attribute map.

    The key into the sink's attribute map.

    Definition Classes
    AuralStreamLikeAttribute → AuralAttribute
  25. def makeStream(patObj: Pattern[T])(implicit tx: T): St
    Attributes
    protected
    Definition Classes
    AuralPatternAttribute → AuralStreamLikeAttribute
  26. final def mkView(vid: Unit, span: SpanLike, obj: Model)(implicit tx: T): ElemHandle

    Should create a new view for the given object and return a handle to it.

    Should create a new view for the given object and return a handle to it. As a side effect should also memorize the view in a view-tree, if such structure is maintained, for later retrieval in viewEventAfter

    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
  27. final def modelEventAfter(offset: Long)(implicit tx: T): Long

    Report the next interesting frame greater than the given frame for which gridReached (internal) and processPrepare will be called.

    Report the next interesting frame greater than the given frame for which gridReached (internal) and processPrepare will be called. If no such event exists, the method must return Long.MaxValue.

    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
    Annotations
    @tailrec()
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. final def obj(implicit tx: T): Repr
    Definition Classes
    AuralStreamLikeAttribute → AuralViewBase
  32. final def playView(h: ElemHandle, timeRef: Option, target: proc.AuralAttribute.Target[T])(implicit tx: T): Unit

    Should be called from processPlay.

    Should be called from processPlay. It calls play on the view and adds it to the list of playing views. Note: timeRef must already have been updated through appropriate intersection.

    Sub-classes may override this if they call super.playView

    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
  33. final 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.

    Definition Classes
    AuralStreamLikeAttribute → AuralAttribute
  34. final def prepare(timeRef: Option)(implicit tx: T): Unit

    Prepares the view to be able to run.

    Prepares the view to be able to run.

    timeRef

    an optional context of temporal position

    Definition Classes
    AuralScheduledBase → AuralViewBase
  35. final def prepareSpan()(implicit tx: T): Span

    Note: the prepare span will always start from current-frame and have a duration of at least LOOK_STOP.

    Note: the prepare span will always start from current-frame and have a duration of at least LOOK_STOP. I.e. during playback it contains the current play position.

    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  36. final def processEvent(play: IPlaying, timeRef: TimeRef)(implicit tx: T): Unit

    Called when a next interesting frame has been reached.

    Called when a next interesting frame has been reached. The method should look for and invoke the events such as starting or stopping a view.

    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
  37. final def processPlay(timeRef: TimeRef, target: Target)(implicit tx: T): Unit

    Called during play.

    Called during play. Sub-classes should intersect the current elements and for each of them call playView.

    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
  38. final def processPrepare(spanP: Span, timeRef: TimeRef, initial: Boolean)(implicit tx: T): Iterator[PrepareResult]

    Called during preparation of armed elements.

    Called during preparation of armed elements. This happens either during initial prepare or during grid-events. Given the prepareSpan, the sub-class should

    - find the elements using an intersect - for each build a view and store it somewhere - for each view call prepareChild - accumulate the results of prepareChild into a Map that is returned.

    The map will become part of IPreparing. (NOT: The returned Boolean indicates if elements were found (true) or not (false)).

    initial

    if true this is an initial preparation which means the method must include views that start before prepareSpan if their span overlaps with prepareSpan. If false this is a follow up from gridReached and the search must be restricted to views that start no earlier than prepareSpan.

    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
    Annotations
    @tailrec()
  39. final def react(fun: (T) => (State) => Unit)(implicit tx: T): Disposable[T]

    Registers a live observer with this observable.

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

    Definition Classes
    ObservableImpl → Observable
  40. 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.

    Definition Classes
    ViewBase
  41. final def run(timeRef: Option, target: proc.AuralAttribute.Target[T])(implicit tx: T): Unit

    Ensures state is consistent, then checks preparation of children.

    Ensures state is consistent, then checks preparation of children. If all is good, sets internal state to IPlaying and calls processPlay. Next instructs scheduler and sets external state to Playing.

    Definition Classes
    AuralScheduledBase → AuralViewBase
  42. final def scheduledEvent()(implicit tx: T): Scheduled
    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  43. final def scheduledGrid()(implicit tx: T): Scheduled
    Attributes
    protected
    Definition Classes
    AuralScheduledBase
  44. final def setRepr(r: Repr)(implicit tx: T): Boolean
    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute
  45. final def state(implicit tx: T): State
    Definition Classes
    AuralScheduledBase → ViewBase
  46. final def stop()(implicit tx: T): Unit
    Definition Classes
    AuralScheduledBase → ViewBase
  47. final def stopView(h: ElemHandle)(implicit tx: T): Unit

    Should be called from processEvent for views that should be stopped and disposed.

    Should be called from processEvent for views that should be stopped and disposed. The caller is responsible for removing the view also from a view-tree if such structure is maintained. NOT: This method ends by calling viewRemoved.

    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
  48. final def stopViews()(implicit tx: T): Unit

    Stops and disposes all currently playing views.

    Stops and disposes all currently playing views.

    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
  49. def streamHasNext(st: St)(implicit tx: T): Boolean
    Attributes
    protected
    Definition Classes
    AuralPatternAttribute → AuralStreamLikeAttribute
  50. def streamNext(st: St)(implicit tx: T): Any
    Attributes
    protected
    Definition Classes
    AuralPatternAttribute → AuralStreamLikeAttribute
  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. final def targetOption(implicit tx: T): Option[proc.AuralAttribute.Target[T]]
    Definition Classes
    AuralScheduledBase
  53. def toString(): String
    Definition Classes
    AnyRef → Any
  54. def tpe: Type
    Definition Classes
    AuralPatternAttribute → ObjViewBase
  55. final def viewEventAfter(offset: Long)(implicit tx: T): Long

    Report the next interesting frame greater than the given frame for which eventReached (internal) and processEvent will be called.

    Report the next interesting frame greater than the given frame for which eventReached (internal) and processEvent will be called. If no such event exists, the method must return Long.MaxValue.

    Attributes
    protected
    Definition Classes
    AuralStreamLikeAttribute → AuralScheduledBase
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  58. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. case object IStopped extends InternalState with Product with Serializable
    Attributes
    protected
    Definition Classes
    AuralScheduledBase

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AuralStreamLikeAttribute[T, I, Pattern[T]]

Inherited from AuralAttribute[T]

Inherited from AuralScheduledBase[T, proc.AuralAttribute.Target[T], View[T]]

Inherited from ObservableImpl[T, State]

Inherited from ObjViewBase[T, proc.AuralAttribute.Target[T]]

Inherited from AuralViewBase[T, proc.AuralAttribute.Target[T]]

Inherited from ViewBase[T]

Inherited from Disposable[T]

Inherited from Observable[T, State]

Inherited from AnyRef

Inherited from Any

Ungrouped