filmstrip-core/dev.jordond.filmstrip.player/VideoPlayer

VideoPlayer

interface VideoPlayer : PlayerTransport, AutoCloseable(source)

Implemented by filmstrip, never by a consumer. State, events and the playhead come in a coroutine form and a listener form, so a caller without coroutines loses nothing.

Properties

events

abstract val events: SharedFlow<PlaybackEvent>

Edge facts, delivered losslessly to keeping-up collectors, with no replay.

features

abstract val features: PlayerFeatures

What this backend can do on this device.

nativePlayer

abstract val nativePlayer: Any?

The platform player underneath, or null when no backend is attached.

previewInfo

abstract val previewInfo: StateFlow<PreviewInfo>

What the preview is actually delivering, including its parity and per-property fidelity.

readback

abstract val readback: PreviewFrameReadback

Reads rendered preview frames back, post-effects and pre-encode.

state

abstract val state: StateFlow<PlayerState>

Serialised, in-order, internally consistent snapshots. Never torn across axes.

Functions

addEventListener

abstract fun addEventListener(listener: PlaybackEventListener): Cancellable

Observes events without coroutines.

addPositionListener

abstract fun addPositionListener(tick: Duration, listener: PlayerPositionListener): Cancellable

Observes the playhead without coroutines, at most once per tick.

addStateListener

abstract fun addStateListener(listener: PlayerStateListener): Cancellable

Observes state without coroutines.

beginScrub

abstract fun beginScrub()

Enters scrubbing mode, where seek accuracy may relax to keep up with a moving finger.

abstract override fun close()

Releases every resource. Idempotent, and nothing may be called afterwards.

currentPosition

abstract fun currentPosition(): Duration

Reads the playhead.

endScrub

abstract fun endScrub()

Leaves scrubbing mode and settles on an exact frame.

pause

abstract fun pause()

Pauses playback, holding the current position.

play

abstract fun play()

Starts playback, or resumes it.

positionFlow

abstract fun positionFlow(tick: Duration): Flow<Duration>

Observes the playhead as a cold flow.

seekTo

abstract fun seekTo(position: Duration, accuracy: SeekAccuracy = SeekAccuracy.Exact)

Seeks to position.

setComposition

abstract fun setComposition(request: SetCompositionRequest, callback: SetCompositionCallback): Cancellable

The callback form of setComposition, for callers without coroutines.

abstract suspend fun setComposition(composition: EditComposition, startAt: Duration? = null, playWhenReady: Boolean = false): SetCompositionResult

Loads a composition, or replaces the current one, suspending until it is presentable.

setExportSpec

abstract fun setExportSpec(spec: ExportSpec)

Sets the export this preview stands in for, so it renders at the HDR grade spec resolves to.

setLoopRange

abstract fun setLoopRange(range: TimeRange?)

Loops within range, or plays straight through when null.

setPlaybackRange

abstract fun setPlaybackRange(range: TimeRange?)

Restricts playback to range, or to the whole composition when null.

setQualityPolicy

abstract fun setQualityPolicy(policy: PreviewQualityPolicy)

Sets how hard the preview may work.

setVolume

abstract fun setVolume(volume: Float)

Sets monitor volume in 0f..1f.

stepFrames

abstract fun stepFrames(frames: Int = 1)

Steps by whole frames, forwards for a positive count and backwards for a negative one.