Struct LayerIdentity 

#[non_exhaustive]
pub struct LayerIdentity {
    pub layer_id: u16,
    pub view_id: Option<u16>,
    pub access_unit: Option<u64>,
}

Which layer / view a decoded VideoFrame belongs to.

#[non_exhaustive]: build it with new and the with_* builders, read the public fields directly. Default is the base layer with no view and no access-unit index.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

layer_id: u16

The codec’s layer identifier for the frame (H.265 / H.266 nuh_layer_id, AV1 spatial_id, …). 0 is the base layer.

view_id: Option<u16>

The view the frame belongs to, for multi-view content (the codec’s view identifier, e.g. H.265 Annex F ViewId). None when the stream is not multi-view or the decoder does not know the mapping.

access_unit: Option<u64>

Running index of the access unit (the set of pictures across all layers that share one presentation instant) the frame comes from, when the decoder counts them. Lets a consumer regroup the per-layer frames of one instant without relying on equal pts values. None when not tracked.

Implementations

impl LayerIdentity

pub const WIRE_LEN: usize = 13

Size in bytes of the frame side-channel encoding (to_bytes).

pub const fn new(layer_id: u16) -> Self

Identity for layer_id, with no view and no access-unit index.

pub const fn base() -> Self

The base layer (layer_id == 0), no view, no access unit — identical to Default.

pub const fn with_view_id(self, view_id: u16) -> Self

Builder: set the view identifier.

pub const fn with_access_unit(self, index: u64) -> Self

Builder: set the access-unit index.

pub const fn is_base_layer(&self) -> bool

true for the base layer (layer_id == 0).

pub fn to_bytes(&self) -> [u8; 13]

Fixed-size wire form used by the VideoFrame side-channel record: one flags byte (bit 0 = view_id present, bit 1 = access_unit present), then layer_id as two little-endian bytes, view_id as two (zero when absent) and access_unit as eight (zero when absent).

pub fn from_bytes(bytes: &[u8]) -> Option<Self>

Inverse of to_bytes. Accepts any slice of at least WIRE_LEN bytes (extra trailing bytes are reserved and ignored); returns None for a shorter slice. Unknown flag bits are ignored.

Trait Implementations

impl Clone for LayerIdentity

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LayerIdentity

impl Debug for LayerIdentity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LayerIdentity

fn default() -> Self

Returns the “default value” for a type.

impl Display for LayerIdentity

fn fmt(&self, f: &mut Formatter<'_>) -> Result

layer N, layer N view V, optionally @au A.

impl Eq for LayerIdentity

impl Hash for LayerIdentity

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LayerIdentity

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LayerIdentity