Skip to main content

Packet

Struct Packet 

Source
pub struct Packet {
    pub stream_index: usize,
    pub data: Bytes,
    pub timestamp: Timestamp,
    pub flags: PacketFlags,
}
Expand description

A compressed media packet from a container.

Packets are the fundamental unit of compressed data in a container. Each packet typically contains one or more compressed frames from a single stream.

§Examples

use oximedia_container::{Packet, PacketFlags};
use oximedia_core::{Timestamp, Rational};
use bytes::Bytes;

let packet = Packet::new(
    0,
    Bytes::from_static(&[0, 1, 2, 3]),
    Timestamp::new(1000, Rational::new(1, 1000)),
    PacketFlags::KEYFRAME,
);

assert!(packet.is_keyframe());
assert_eq!(packet.size(), 4);

Fields§

§stream_index: usize

Index of the stream this packet belongs to.

§data: Bytes

Compressed packet data.

§timestamp: Timestamp

Presentation and decode timestamps.

§flags: PacketFlags

Packet flags.

Implementations§

Source§

impl Packet

Source

pub const fn new( stream_index: usize, data: Bytes, timestamp: Timestamp, flags: PacketFlags, ) -> Self

Creates a new packet.

§Arguments
  • stream_index - Index of the stream this packet belongs to
  • data - Compressed packet data
  • timestamp - Presentation/decode timestamps
  • flags - Packet flags (keyframe, corrupt, etc.)
Source

pub const fn is_keyframe(&self) -> bool

Returns true if this packet is a keyframe.

Keyframes can be decoded independently without reference to other frames in the stream.

Source

pub const fn is_corrupt(&self) -> bool

Returns true if this packet may be corrupt.

Source

pub const fn should_discard(&self) -> bool

Returns true if this packet should be discarded.

Source

pub fn size(&self) -> usize

Returns the size of the packet data in bytes.

Source

pub fn is_empty(&self) -> bool

Returns true if the packet data is empty.

Source

pub const fn pts(&self) -> i64

Returns the presentation timestamp in the stream’s timebase.

Source

pub const fn dts(&self) -> Option<i64>

Returns the decode timestamp if available.

Source

pub const fn duration(&self) -> Option<i64>

Returns the packet duration if available.

Trait Implementations§

Source§

impl Clone for Packet

Source§

fn clone(&self) -> Packet

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Packet

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.