Struct KeyEpochSerializer 

pub struct KeyEpochSerializer;

Reference ExtensionSerializer for the SFrame key-epoch (KID) RTP header extension.

Wire format

A fixed 4-byte, big-endian 32-bit KID, matching RFC 9605 §6.1 (the v1 KID width) and the sframe-ratchet browser client. This is the interoperable default; if your clients encode the KID differently, implement your own serializer that parses into / writes from a KeyEpoch user value — the fanout path keys on the KeyEpoch type, not these bytes.

KeyEpoch holds a u64 for generality, but the RFC v1 KID is 32-bit: a value exceeding u32::MAX cannot be represented in the 4-byte form and is not written (str0m then omits the extension), rather than silently truncated. Supply your own serializer for wider KIDs.

The serializer applies to both audio and video media (SFrame protects either). Its 4-byte value never requires the two-byte extension form (str0m may still pick that form globally if another registered extension needs it — a full u8 length encodes 4 bytes fine).

Trait Implementations

impl Clone for KeyEpochSerializer

fn clone(&self) -> KeyEpochSerializer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for KeyEpochSerializer

impl Debug for KeyEpochSerializer

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

Formats the value using the given formatter.

impl Default for KeyEpochSerializer

fn default() -> KeyEpochSerializer

Returns the “default value” for a type.

impl ExtensionSerializer for KeyEpochSerializer

fn write_to(&self, buf: &mut [u8], ev: &ExtensionValues) -> usize

Write the extension to the buffer of bytes. Must return the number of bytes written. This can be 0 if the extension could not be serialized.

fn parse_value(&self, buf: &[u8], ev: &mut ExtensionValues) -> bool

Parse a value and put it in the ExtensionValues::user_values field.

fn is_video(&self) -> bool

Tell if this extension should be used for video media.

fn is_audio(&self) -> bool

Tell if this extension should be used for audio media.

fn requires_two_byte_form(&self, _ev: &ExtensionValues) -> bool

When calling write_to, if the size of the written value may exceed 16 bytes, or may be 0 bytes, the two byte header extension form must be used. Otherwise, the one byte form may be used, which is usually the case.