Struct Player 

pub struct Player { /* private fields */ }

Manages playback of Songs through cpal and sample conversion through rubato.

Implementations

impl Player

pub fn new(preferred_sampling_rates: Option<Vec<u32>>) -> Result<Player>

Creates a new Player to play Songs. If specified, the player will attempt to use one of the specified sampling rates. If not specified or the list is empty, the preferred rates are 48000 and 44100.

If none of the preferred sampling rates are available, the closest available rate to the first preferred rate will be selected.

On Linux, this prefers pipewire, jack, and pulseaudio devices over alsa.

pub fn set_playback_speed(&self, speed: f64)

Set the playback speed (This will also affect song pitch)

pub fn play_song_next( &self, song: &Song, start_time: Option<Duration>, ) -> Result<()>

Set the song that will play after the current song is over (or immediately if no song is currently playing), optionally start playing in the middle of the song.

pub fn play_song_now( &self, song: &Song, start_time: Option<Duration>, ) -> Result<()>

Start playing a song immediately, while discarding any song that might have been queued to play next. Optionally start playing in the middle of the song.

pub fn force_replace_next_song( &self, song: &Song, start_time: Option<Duration>, ) -> Result<()>

Used to replace the next song, or the current song if there is no next song. Optionally start playing in the middle of the song.

This will remove the current song if no next song exists to avoid a race condition in case the current song ends after you have determined that the next song must be replaced but before you call this function. See also force_remove_next_song

pub fn force_remove_next_song(&self) -> Result<()>

Used to remove the next song, or the current song if there is no next song.

This will remove the current song if no next song exists to avoid a race condition in case the current song ends after you have determined that the next song must be replaced but before you call this function. See also force_replace_next_song

pub fn stop(&self)

Stop playing any songs and remove a next song if it has been queued.

Note that this does not pause playback (use set_playing), meaning new songs will play upon adding them.

pub fn skip(&self)

Skip the currently playing song (i.e. stop playing it immediately.

This will immediately start playing the next song if it exists.

pub fn get_playback_position(&self) -> Option<(Duration, Duration)>

Return the current playback position, if there is currently a song playing (see has_current_song)

See also seek

pub fn seek(&self, time: Duration) -> bool

Set the current playback position if there is a song playing or a song queued to be played next.

Returns whether the seek was successful (whether there was a song to seek). Note that seeking past the end of the song will be successful and will cause playback to begin at the beginning of the next song.

See also get_playback_position

pub fn set_playing(&self, playing: bool)

Sets whether playback is enabled or not, without touching the song queue.

See also is_playing

pub fn is_playing(&self) -> bool

Returns whether playback is currently paused.

See also set_playing

pub fn has_next_song(&self) -> bool

Returns whether there is a song queued to play next after the current song has finished

If you want to check whether there is currently a song playing, use has_current_song and is_playing. This should always be queried before calling play_song_next if you do not intend on replacing the song currently in the queue.

pub fn has_current_song(&self) -> bool

Returns whether there is a song currently playing (or about to start playing next audio frame)

Note that this does not indicate whether the current song is actively being played or paused, for that functionality you can use is_playing.

pub fn get_errors(&self) -> (Vec<Report>, u64)

Returns a list of playback errors that have been collected and the total number of errors detected.

The library will only store 5 errors at a time and all others will be thrown away, so this function also returns a count of the errors up to this point.

pub fn reset_errors(&self) -> u64

Resets the playback error count and returns the old value.

This also has the effect of clearing out any errors that have been saved so that the library will only ever collect up to 5 errors.