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

PlayerEngine

interface PlayerEngine : PlayerTransport(source)

A playback engine.

The extension point behind VideoPlayer. Implement it to plug in an engine, from Kotlin or from Swift, and register it with a PlayerEngineFactory. Consumers use VideoPlayer, which is the facade built on top of this.

Properties

features

abstract val features: PlayerFeatures

What this engine can do, as it finds it on this device.

abstract val id: String

A stable identifier for diagnostics, such as filmstrip.exoplayer.

nativePlayer

abstract val nativePlayer: Any?

The platform player object, for a surface to attach itself to. Null when there is none.

readback

abstract val readback: PreviewFrameReadback

Reads rendered frames back out of the preview pipeline. Required, not optional.

Functions

addListener

abstract fun addListener(listener: EngineListener): Cancellable

Registers a listener for state, events, position and preview info.

beginScrub

abstract fun beginScrub()

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

dispose

abstract fun dispose()

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

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.

seekTo

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

Seeks to position.

setComposition

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

Loads a composition, or replaces the current one.

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.