advanceTimeBy

abstract fun advanceTimeBy(duration: Duration, ignoreFrameDuration: Boolean = false)

Advances currentTime by duration.

Steps in frameDuration increments, sending one frame per step, until currentTime has advanced by at least duration - so the final step can land past the target by less than a frame. Set ignoreFrameDuration to deliver the whole duration in a single frame instead.

Parameters

duration

the composition time to add; nothing waits in real time for it to pass.

ignoreFrameDuration

true delivers duration as a single frame, which lands currentTime exactly on the target rather than up to a frame past it; false by default.

Throws

if duration is negative or not finite. Composition time only moves forward by a duration frames can actually step through: the frames a composition is sent carry a monotonically rising time, and Duration.INFINITE (or a NaN duration) has no frame count that reaches it.