filmstrip-compose/dev.jordond.filmstrip.compose/ScrubState

ScrubState

The three calls a scrubbing gesture makes, in order.

Call onScrubStart on touch down, onScrubTo on every drag delta and onScrubEnd on touch up. Between the first and the last the engine relaxes seek accuracy to keep up with the finger, and the last one settles on the exact frame under it. A gesture that never calls onScrubStart seeks nothing, since onScrubTo is ignored outside a gesture.

Built by rememberScrubState, either over a VideoPlayer or over a host's own transport.

Properties

isScrubbing

var isScrubbing: Boolean

Whether a gesture is in flight.

Functions

onScrubEnd

fun onScrubEnd()

Leaves scrubbing mode and settles on the frame the gesture ended on.

onScrubStart

fun onScrubStart()

Enters scrubbing mode. Repeating it during a gesture does nothing.

onScrubTo

fun onScrubTo(position: Duration)

Moves the playhead to position. Ignored outside a gesture.