Skip to main content

Module frames

Module frames 

Source
Expand description

Frame types for video, audio, and metadata.

Structs§

AudioFrame
Owned, tightly packed planar floating-point audio with a validated layout.
AudioFrameBuilder
Builder for configuring an AudioFrame with ergonomic method chaining
AudioRef
A zero-copy borrowed audio frame, generic over its free strategy S.
MetadataFrame
Owned UTF-8 metadata text and its timecode.
MetadataFrameRef
A zero-copy borrowed metadata frame.
PixelFormatInfo
Compile-time pixel format properties.
VideoFrame
An owned video frame with validated dimensions, format, stride, and buffer size.
VideoFrameBuilder
Builder for configuring a VideoFrame with ergonomic method chaining
VideoPlane
An allocation-free view of one video plane’s initialized active bytes.
VideoPlanes
Video planes in SDK memory order, with no allocation or pixel copies. Send + Sync for scoped reads; the owning frame’s thread rules still apply.
VideoRef
A zero-copy borrowed video frame, generic over its free strategy S.
VideoRows
Active video rows, borrowing the frame that owns the SDK allocation. Send + Sync through its immutable plane; iteration never calls the SDK.

Enums§

AudioFormat
Audio format identifiers (FourCC codes).
AudioLayout
Audio data layout format
FormatCategory
Category of pixel format for buffer calculation and union field access.
ImageFormat
Image format specification for encoding video frames.
LineStrideOrSize
First-plane line stride for the supported uncompressed video formats. Compressed and opaque payloads are not represented by safe frame types.
PixelFormat
Video pixel format identifiers (FourCC codes).
ScanType
Video scan type (progressive, interlaced, or field-based).

Type Aliases§

AudioFrameRef
A zero-copy borrowed audio frame from a Receiver capture.
VideoFrameRef
A zero-copy borrowed video frame from a Receiver capture.