Struct Jukebox

pub struct Jukebox<'a> { /* private fields */ }

A wrapper on a Client to control just the jukebox.

Any method invoked on a Jukebox will fail if the user that created the Client is not authorized to control the jukebox.

Implementations

impl<'a> Jukebox<'a>

pub fn start(client: &'a Client) -> Jukebox<'_>

Creates a new handler to the jukebox of the client.

pub fn playlist(&self) -> Result<JukeboxPlaylist>

Returns the current playlist of the jukebox, as well as its status. The status is also returned as it contains the position of the jukebox in its playlist.

pub fn status(&self) -> Result<JukeboxStatus>

Returns the status of the jukebox.

pub fn play(&self) -> Result<JukeboxStatus>

Tells the jukebox to start playing.

pub fn stop(&self) -> Result<JukeboxStatus>

Tells the jukebox to pause playback.

pub fn skip_to(&self, n: usize) -> Result<JukeboxStatus>

Moves the jukebox’s currently playing song to the provided index (zero-indexed).

Using an index outside the range of the jukebox playlist will play the last song in the playlist.

pub fn add(&self, song: &Song) -> Result<JukeboxStatus>

Adds the song to the jukebox’s playlist.

pub fn add_id(&self, id: usize) -> Result<JukeboxStatus>

Adds a song matching the provided ID to the playlist.

Errors

The method will return an error if a song matching the provided ID cannot be found.

pub fn add_all(&self, songs: &[Song]) -> Result<JukeboxStatus>

Adds all the songs to the jukebox’s playlist.

pub fn add_all_ids(&self, ids: &[usize]) -> Result<JukeboxStatus>

Adds multiple songs matching the provided IDs to the playlist.

Errors

The method will return an error if at least one ID cannot be matched to a song.

pub fn clear(&self) -> Result<JukeboxStatus>

Clears the jukebox’s playlist.

pub fn remove_id(&self, idx: usize) -> Result<JukeboxStatus>

Removes the song at the provided index from the playlist.

pub fn shuffle(&self) -> Result<JukeboxStatus>

Shuffles the jukebox’s playlist.

pub fn set_volume(&self, volume: f32) -> Result<JukeboxStatus>

Sets the jukebox’s playback volume.

Seting the volume above 1.0 will have no effect.

Trait Implementations

impl<'a> Debug for Jukebox<'a>

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

Formats the value using the given formatter.