filmstrip-core/dev.jordond.filmstrip.player

Package-level declarations

Types

interface EngineListener

Receives an engine's state and event pushes.

sealed interface PlaybackError

Why playback failed.

sealed interface PlaybackEvent

Something that happened, delivered once.

PlaybackEventListener

fun interface PlaybackEventListener

Receives PlaybackEvent edges.

sealed interface PlaybackStatus

Where the player is in its lifecycle.

class PlayerConfig(val qualityPolicy: PreviewQualityPolicy = PreviewQualityPolicy.Full, val exportSpec: ExportSpec = ExportSpec())

How a player should be built.

interface PlayerEngine : PlayerTransport

A playback engine.

PlayerEngineFactory

fun interface PlayerEngineFactory

Builds a PlayerEngine, or declines.

enum PlayerFeature : Enum<PlayerFeature>

A backend ability that may or may not be present on this device.

class PlayerFeatures

Which PlayerFeature values this backend actually has.

PlayerPositionListener

fun interface PlayerPositionListener

Receives playhead ticks.

class PlayerState

An atomic snapshot of the player, across five orthogonal axes.

PlayerStateListener

fun interface PlayerStateListener

Receives PlayerState snapshots.

PlayerTransport

interface PlayerTransport

The transport commands a VideoPlayer and a PlayerEngine share.

interface PreviewFactory

Opens a VideoPlayer over an EditComposition.

PreviewFrameReadback

fun interface PreviewFrameReadback

Reads back a fully rendered preview frame: post-effects, pre-encode.

class PreviewInfo(val outputSize: Size, val renderScale: Float, val parity: EffectParity, val parityNotes: List<ParityNote>, val fidelity: List<FidelityNote>, val inertNotices: List<InertNotice> = emptyList())

What the preview is actually delivering, while the user is watching.

PreviewQualityPolicy

sealed interface PreviewQualityPolicy

How hard the preview may work.

ReadbackCallback

fun interface ReadbackCallback

Receives the outcome of one PreviewFrameReadback.requestFrame.

class ReadbackFrame

One frame read back out of the preview pipeline.

sealed interface ReadbackResult

The outcome of one readback.

enum SeekAccuracy : Enum<SeekAccuracy>

How exact a seek needs to be.

SetCompositionCallback

fun interface SetCompositionCallback

Receives the outcome of one PlayerEngine.setComposition.

SetCompositionRequest

class SetCompositionRequest(val composition: EditComposition, val startAt: Duration? = null, val playWhenReady: Boolean = false)

What to load, and how.

SetCompositionResult

sealed interface SetCompositionResult

The outcome of setting a composition.

interface VideoPlayer : PlayerTransport, AutoCloseable

A player over an EditComposition.

Functions

suspend fun PreviewFrameReadback.frameAt(position: Duration): ReadbackResult

Renders the frame at position through the current effect chain, suspending until it is ready.