Struct Packet 

pub struct Packet { /* private fields */ }

A compressed access unit and what the container recorded about it.

Every timing field is optional, and a missing value stays missing: nothing in this crate derives a timestamp from a nominal frame rate. A timestamp uses the track’s TimeBase.

Implementations

impl Packet

pub fn from_vec(bytes: Vec<u8>) -> Result<Self, PacketError>

A packet owning bytes, on track 0 with nothing else recorded.

Errors

PacketError::Empty for an empty payload.

pub fn from_accounted(bytes: SharedStorage<u8>) -> Result<Self, PacketError>

A packet over already admitted storage, without copying or releasing the charge. Packet clones and take() retain the same allocation owner.

pub fn from_shared( bytes: Arc<[u8]>, start: usize, len: usize, ) -> Result<Self, PacketError>

A packet over len bytes of bytes from start, without copying.

Errors

PacketError::Empty for len == 0; PacketError::OutOfRange when the range leaves the buffer.

pub fn with_track(self, track: u32) -> Self

The track this packet belongs to: an index into the demuxer’s tracks, or into what a muxer got at begin.

pub fn with_pts(self, pts: Timestamp) -> Self

The presentation timestamp.

pub fn with_dts(self, dts: Timestamp) -> Self

The decode timestamp, when the container stores one apart from the presentation timestamp.

pub fn with_duration_ticks(self, ticks: u64) -> Self

The duration, in ticks of the track’s time base, when the container records one.

pub fn with_random_access(self, ra: RandomAccess) -> Self

The container’s random-access evidence.

pub fn with_config_epoch(self, epoch: u32) -> Self

The codec configuration epoch this packet was coded under.

pub fn with_ordinal(self, ordinal: u64) -> Self

The packet’s position in the track’s packet order.

pub fn with_input_offset(self, offset: u64) -> Self

Where the payload starts in the container file.

pub fn with_discard(self, discard: Discard) -> Self

Media the decoder adapter drops from this packet’s output.

pub fn with_addition(self, addition: PacketAddition) -> Self

Attach side data.

pub fn bytes(&self) -> &[u8]

Payload bytes; empty once an accepting consumer took them.

pub fn len(&self) -> usize

Payload length; zero once taken.

pub fn is_empty(&self) -> bool

Whether no payload bytes are left (empty only once taken).

pub fn is_taken(&self) -> bool

Whether an accepting consumer took the payload.

pub fn take(&mut self) -> Option<PacketPayload>

Take the payload: what a consumer does when it accepts the packet. The metadata stays readable.

pub fn track(&self) -> u32

The track this packet belongs to.

pub fn pts(&self) -> Option<Timestamp>

The presentation timestamp, if recorded.

pub fn dts(&self) -> Option<Timestamp>

The decode timestamp, if recorded apart from the presentation one.

pub fn decode_time(&self) -> Option<Timestamp>

Decode-order time: dts when the container stores one, else pts.

pub fn duration_ticks(&self) -> Option<u64>

The recorded duration in ticks of the track’s time base.

pub fn random_access(&self) -> RandomAccess

The container’s random-access evidence.

pub fn config_epoch(&self) -> u32

The configuration epoch this packet was coded under.

pub fn ordinal(&self) -> Option<u64>

The packet’s position in its track’s packet order.

pub fn input_offset(&self) -> Option<u64>

Where the payload starts in the container file.

pub fn discard(&self) -> Option<Discard>

Media to drop from this packet’s output, as the container recorded it.

pub fn additions(&self) -> &[PacketAddition]

Side data carried with the packet.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.