Skip to main content

Player

Struct Player 

Source
pub struct Player { /* private fields */ }
Expand description

The player controller. Owns the audio pipeline and processes commands.

Implementations§

Source§

impl Player

Source

pub fn new() -> Self

Source

pub fn shared_state(&self) -> Arc<SharedPlayerState>

Get a clone of the shared state for UI reads.

Source

pub fn timeline(&self) -> Arc<PlaybackTimeline>

Get the playback timeline for UI reads.

Source

pub fn viz_buffer(&self) -> Arc<VizBuffer>

Get the visualization buffer for the TUI.

Source

pub fn viz_snapshot(&self) -> Arc<VizSnapshot>

Get the shared analysis snapshot for the TUI. The analysis thread writes here; the UI thread reads a clone each frame.

Source

pub fn undo_stack(&self) -> &UndoStack

Access undo stack (for tests and UI state queries).

Source

pub fn set_output_device(&mut self, name: String)

Switch the output device. Persists to config and restarts the engine on the current track if playing.

Source

pub fn clear_output_device(&mut self)

Clear the configured output device, reverting to system default.

Source

pub fn output_device_name(&self) -> Option<&str>

Get the current output device name (if configured).

Source

pub fn command_sender(&self) -> Sender<PlayerCommand>

Get a command sender for the UI layer.

Source

pub fn play(&mut self, id: QueueItemId)

Play a specific item in the playlist by ID. Sets cursor, starts playback if Ready or streaming-ready, otherwise waits for TrackReady.

Source

pub fn seek(&mut self, position_ms: u64)

Seek within the current track. Clamps to just before the end to avoid accidentally skipping. Preserves pause state.

Source

pub fn next_track(&mut self)

Skip to next track in playlist.

Source

pub fn prev_track(&mut self)

Go back to previous track.

Source

pub fn pause(&mut self)

Pause playback.

Source

pub fn resume(&mut self)

Resume playback.

Source

pub fn stop(&mut self)

Stop playback and clear playlist.

Source

pub fn remove_from_playlist(&mut self, id: QueueItemId)

Remove a track from the playlist. If it was the cursor, skip to next.

Source

pub fn track_ready(&mut self, id: QueueItemId)

A download finished — if cursor is waiting on this item, start playback. If already streaming this item, trigger progressive metadata enhancement.

Source

pub fn track_stream_ready(&mut self, id: QueueItemId)

Called when enough data has been buffered for streaming playback. If the cursor is waiting on this track and nothing is playing, start streaming.

Source

pub fn update_playback_state(&self)

Poll the timeline and update shared state with current track/position. Called from the command loop on each tick.

Source

pub fn process_command(&mut self, cmd: PlayerCommand)

Process a single command.

Source

pub fn run(&mut self)

Run the command loop. Blocks until the sender is dropped.

Source

pub fn spawn() -> (Arc<SharedPlayerState>, Arc<PlaybackTimeline>, Arc<VizSnapshot>, Sender<PlayerCommand>)

Spawn the player on a background thread, returning the shared state, timeline, visualization snapshot, and command sender.

Trait Implementations§

Source§

impl Default for Player

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Player

§

impl !RefUnwindSafe for Player

§

impl Send for Player

§

impl !Sync for Player

§

impl Unpin for Player

§

impl UnsafeUnpin for Player

§

impl !UnwindSafe for Player

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> 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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