frame
abstract suspend fun frame(composition: EditComposition, at: Duration, heightPx: Int? = null, exportSpec: ExportSpec = ExportSpec()): FrameResult(source)
Renders one frame of a composition, with its effects applied.
Lands on the frame covering at, rather than on the nearest sync sample the way frames may.
Return
The frame, which the caller owns and must close, or why it could not be produced.
Parameters
composition
The edit to render from.
at
Where in the composition to render.
heightPx
The height to render at, in pixels. Null renders at the composition's own output height, and so does a height at or above it. Zero or less fails with dev.jordond.filmstrip.FilmstripError.InvalidComposition.
exportSpec
The export this frame stands in for, which renders it at the HDR grade that export resolves to.