Skip to main content

ChunkRequest

Struct ChunkRequest 

Source
pub struct ChunkRequest {
    pub start: StreamInstant,
    pub pps: u32,
    pub min_points: usize,
    pub target_points: usize,
    pub buffered_points: u64,
    pub buffered: Duration,
    pub device_queued_points: Option<u64>,
}
Expand description

A request to fill a buffer with points for streaming.

This is the streaming API with pure buffer-driven timing. The callback receives a ChunkRequest describing buffer state and requirements, and fills points into a library-owned buffer.

§Point Tiers

  • min_points: Minimum points needed to avoid imminent underrun (ceiling rounded)
  • target_points: Ideal number of points to reach target buffer level (clamped to buffer length)
  • buffer.len() (passed separately): Maximum points the callback may write

§Rounding Rules

  • min_points: Always ceiling (underrun prevention)
  • target_points: ceiling, then clamped to buffer length

Fields§

§start: StreamInstant

Estimated playback time when this chunk starts.

Calculated as: playhead + buffered_points Use this for audio synchronization.

§pps: u32

Points per second (fixed for stream duration).

§min_points: usize

Minimum points needed to avoid imminent underrun.

Calculated with ceiling to prevent underrun: ceil((min_buffer - buffered) * pps) If 0, buffer is healthy.

§target_points: usize

Ideal number of points to reach target buffer level.

Calculated as: ceil((target_buffer - buffered) * pps), clamped to buffer length.

§buffered_points: u64

Current buffer level in points (for diagnostics/adaptive content).

§buffered: Duration

Current buffer level as duration (for audio sync convenience).

§device_queued_points: Option<u64>

Raw device queue if available (best-effort, may differ from buffered_points).

Trait Implementations§

Source§

impl Clone for ChunkRequest

Source§

fn clone(&self) -> ChunkRequest

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 ChunkRequest

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<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> 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> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,