Skip to main content

PlayerState

Struct PlayerState 

Source
pub struct PlayerState {
    pub position: usize,
    pub player_position: Duration,
    pub player_volume: PlayerVolume,
    pub playback_state: PlaybackState,
    pub tracks: Vec<Track>,
    pub shuffled_tracks: Vec<Track>,
    pub shuffle_state: ShuffleState,
    pub loop_state: LoopState,
}
Expand description

Data structure used to store playback state on the disc and in the RAM at runtime.

Fields§

§position: usize

The index of the current track.

It can either point to the tracks variable or shuffled_tracks is shuffle is supported and set to ShuffleState::On.

§player_position: Duration§player_volume: PlayerVolume§playback_state: PlaybackState§tracks: Vec<Track>§shuffled_tracks: Vec<Track>§shuffle_state: ShuffleState§loop_state: LoopState

Implementations§

Source§

impl PlayerState

Source

pub fn set_tracks(&mut self, tracks: Vec<Track>)

Source

pub fn append_tracks(&mut self, tracks: &mut Vec<Track>)

Source

pub fn shuffle(&mut self)

Shuffle the queue without changing the current track.

Source

pub fn set_shuffle_state(&mut self, shuffle_state: ShuffleState)

Source

pub fn increment_player_position(&mut self, duration: Duration)

Source

pub fn set_player_position(&mut self, player_position: Duration)

Source

pub fn set_player_volume(&mut self, player_volume: PlayerVolume)

Source

pub fn set_loop_state(&mut self, loop_state: LoopState)

Source

pub fn set_playback_state(&mut self, playback_state: PlaybackState)

Source

pub fn is_empty(&self) -> bool

Source

pub fn current(&self) -> Option<&Track>

Source

pub fn play_track(&mut self, index: usize) -> Option<&Track>

Source

pub fn can_seek(&self) -> bool

Source

pub fn can_play(&self) -> bool

Source

pub fn can_pause(&self) -> bool

Source

pub fn can_go_next(&self) -> bool

Source

pub fn next_track(&mut self) -> Option<&Track>

Source

pub fn can_go_previous(&self) -> bool

Source

pub fn previous_track(&mut self) -> Option<&Track>

Trait Implementations§

Source§

impl Clone for PlayerState

Source§

fn clone(&self) -> PlayerState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PlayerState

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for PlayerState

Source§

fn default() -> PlayerState

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

impl PartialEq for PlayerState

Source§

fn eq(&self, other: &PlayerState) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PlayerState

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
§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

impl<T> Instrument for T

§

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

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

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.

§

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

§

fn into_sample(self) -> T

§

impl<T> NoneValue for T
where T: Default,

§

type NoneType = T

§

fn null_value() -> T

The none-equivalent value.
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
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

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

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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