Struct PlaybackTimeline 

pub struct PlaybackTimeline {
    pub samples_played: Arc<AtomicU64>,
    /* private fields */
}

Shared timeline that the decode thread writes and the UI reads. The decode thread appends boundaries; the UI reads them + samples_played to derive current track and position.

Fields

samples_played: Arc<AtomicU64>

Total interleaved samples consumed (played) by the audio engine. Written by the audio render callback, read by UI.

Implementations

impl PlaybackTimeline

pub fn new() -> Arc<Self>

pub fn clock(&self) -> Option<RendererClock>

The renderer’s clock, in milliseconds of the stream.

pub fn set_clock(&self, clock: Option<RendererClock>)

pub fn track_at(&self, samples: u64) -> Option<QueueItemId>

The track at samples into the session.

pub fn until_end(&self) -> Option<Duration>

How long until the playhead reaches the end of what has been written.

pub fn on_queued(&self, f: impl Fn() + Send + Sync + 'static)

Call f whenever the decoder queues another track.

pub fn playhead(&self) -> Option<Playhead>

The play under the playhead and how far into it, without the clones current_playback makes.

pub fn boundary_count(&self) -> usize

How many boundaries the session has: the index the next one takes.

pub fn position_in(&self, boundary: usize) -> Option<u64>

How far into the play at boundary playback has got, stopping at its end once the playhead has moved on to the next.

pub fn until_next_track(&self) -> Option<Duration>

How long until the playhead reaches the track queued after the one playing, at the rate this one plays. None with nothing queued.

pub fn queued_after_playhead(&self) -> Vec<QueueItemId>

The tracks the decoder has queued after the one under the playhead, in order. Committed: the ring cannot be truncated, so only a new session takes them back.

pub fn writer(&self) -> TimelineWriter<'_>

The decode thread’s write access.

pub fn reset(&self)

Reset for a new playback session.

pub fn samples_played_counter(&self) -> Arc<AtomicU64>

Get a clone of the samples_played Arc for the audio engine.

pub fn current_playback( &self, ) -> Option<(QueueItemId, PathBuf, StreamInfo, u64)>

Derive current track info and position from the playback head. Returns (id, path, stream_info, position_ms).

Acquires the boundaries read lock BEFORE reading samples_played so channels/sample_rate/boundaries are all from a consistent snapshot. Without this ordering, a track transition could update the atomics after we read samples_played but before we read the boundary list.

Trait Implementations

impl Debug for PlaybackTimeline

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

Formats the value using the given formatter.