Package-level declarations

Types

Link copied to clipboard

Renders frames of an EditComposition with its effects applied.

Link copied to clipboard
sealed interface StillBytes

An encoded still held in memory, or why there is none.

Link copied to clipboard

An image format a still can be encoded in.

Link copied to clipboard
sealed interface StillResult

A still that was written somewhere, or why it was not.

Link copied to clipboard
class StillSpec(val format: StillFormat = StillFormat.Jpeg, val quality: Int = DEFAULT_QUALITY, val heightPx: Int? = null)

What an encoded still should look like.

Functions

Link copied to clipboard
suspend fun PlatformImage.encodeStill(spec: StillSpec = StillSpec()): StillBytes

Encodes this frame as a still image.

Link copied to clipboard
suspend fun FrameRenderer.frame(source: MediaSource, at: Duration, heightPx: Int? = null): FrameResult

Renders one frame of a single source, with no composition to build by hand.

Link copied to clipboard
suspend fun FrameRenderer.still(composition: EditComposition, at: Duration, to: MediaSink, spec: StillSpec = StillSpec()): StillResult

Renders one frame of a composition and writes it as a still image.

suspend fun FrameRenderer.still(source: MediaSource, at: Duration, to: MediaSink, spec: StillSpec = StillSpec()): StillResult

Encodes one frame of a single source as a still image, with no composition to build by hand.