AnimationClockObservable

Kotlin |Java

interface AnimationClockObservable

androidx.compose.animation.core.AnimationClockObservable

Known Direct Subclasses BaseAnimationClock, DisposableAnimationClock, MonotonicFrameAnimationClock, TestAnimationClock BaseAnimationClock Base implementation for the AnimationClockObservable that handles the subscribing and unsubscribing logic that would be common for all custom animation clocks. DisposableAnimationClock Clock that remembers all of its active subscriptions so that it can dispose of upstream subscriptions. MonotonicFrameAnimationClock A MonotonicFrameAnimationClock is an AnimationClockObservable that is built on top of the MonotonicFrameClock found in the given scope. TestAnimationClock Interface for animation clocks that can report their idleness and can switch between ticking automatically (e.

Known Indirect Subclasses DefaultAnimationClock, ManualAnimationClock DefaultAnimationClock Default Choreographer based clock that pushes a new frame to all subscribers on each Choreographer tick, until all subscribers have unsubscribed. ManualAnimationClock A custom clock whose frame time can be manually updated via mutating clockTimeMillis.

This interface allows AnimationClock to be subscribed and unsubscribed.

Summary

Public methods
abstract Unit	subscribe(observer: AnimationClockObserver) Subscribes an observer to the animation clock source.
abstract Unit	unsubscribe(observer: AnimationClockObserver) Unsubscribes an observer from the animation clock.

Extension functions
From androidx.compose.animation DisposableAnimationClock AnimationClockObservable.asDisposableClock() Return a new AnimationClockObservable wrapping this one that will auto-unsubscribe all AnimationClockObservers when this call leaves the composition, preventing clock subscriptions from persisting beyond the composition lifecycle.

Public methods

subscribe

abstract fun subscribe(observer: AnimationClockObserver): Unit

Subscribes an observer to the animation clock source.

Observers may only be added to a clock once. Calls to add the same observer more than once will be ignored, and a single call to unsubscribe will unregister from further callbacks.

Parameters
observer: AnimationClockObserver	The observer that will be notified when animation clock time is updated.

unsubscribe

abstract fun unsubscribe(observer: AnimationClockObserver): Unit

Unsubscribes an observer from the animation clock.

Observers may only be added to a clock once. If subscribe has been called multiple times with the same observer, a single call to this method will unregister the observer completely.

Parameters
observer: AnimationClockObserver	The observer to be removed from the subscription list.