Frame

interface Frame

A frame delivered by the sink.

All frame API methods, except released, throw IllegalStateException in case the frame is released.

Types

Link copied to clipboard
interface Plane

A frame data plane.

Properties

Link copied to clipboard
abstract val captureTimestamp: ULong

Capture time of the frame, in microseconds on the monotonic clock of the drone, or 0 if unknown.

Link copied to clipboard
abstract val metadata: VideoMetadata.TimedMetadata

Frame metadata.

Link copied to clipboard
abstract val nativePtr: Long

Native pointer on to the struct sdkcore_frame C structure which is this frame native backend.

Link copied to clipboard

Frame data planes.

Link copied to clipboard
abstract val released: Boolean

true when the frame is released, otherwise false.

Link copied to clipboard
abstract val silent: Boolean

true when the frame is not intended to be displayed.

Link copied to clipboard
abstract val timeScale: UInt

time scale, in Hz.

Link copied to clipboard
abstract val timestamp: ULong

Frame timestamp, in timeScale units.

Link copied to clipboard
abstract val visualError: Boolean

true when the frame contains a visual error.

Functions

Link copied to clipboard
abstract fun copy(): RawVideoSink.Frame

Copies this frame.

Link copied to clipboard
abstract fun release()

Releases this frame.