kiteffmpeg/io.github.yuroyami.kiteffmpeg/AsyncFrame

AsyncFrame

One decoded frame of an AsyncMediaRuntime. It is the suspending form of Frame. info was read when the frame was made. Everything that reads the frame's data waits for the lane.

Properties

durationMicros

val durationMicros: Long?

The frame's duration in microseconds, or null when it has none.

info

val info: FrameInfo

What the frame holds: its size, format, time and colour.

ptsMicros

val ptsMicros: Long?

The frame's time in microseconds, or null when it has none.

Functions

open suspend override fun close()

Releases the resource. A second call waits for the first and reports the same result. A close finishes even when its caller is cancelled.

closedCaptions

suspend fun closedCaptions(): ByteArray?

The closed caption bytes the frame carries, or null.

copy

suspend fun copy(): AsyncFrame

A second reference to the same data, which the caller owns and closes.

copyPlanesInto

suspend fun copyPlanesInto(destination: ByteArray): Int

Copies the frame's planes into destination and answers the count. See Frame.copyPlanesInto.

copyPlanesToByteArray

suspend fun copyPlanesToByteArray(): ByteArray

The frame's planes in a new array. See Frame.copyPlanesToByteArray.

dolbyVision

suspend fun dolbyVision(): DolbyVisionMetadata?

The Dolby Vision metadata the frame carries, or null.

dolbyVisionRpu

suspend fun dolbyVisionRpu(): DolbyVisionRpu?

The Dolby Vision RPU the frame carries, or null.

downloadFromHardware

suspend fun downloadFromHardware(): AsyncFrame

A copy of a hardware frame in main memory. See Frame.downloadFromHardware.

planesByteCount

suspend fun planesByteCount(): Int

How many bytes copyPlanesInto writes.