Struct empris::Player

pub struct Player<'a> {
    pub name: String,
    // some fields omitted
}

A struct used to control an MPRIS player.

Fields

name: String

Implementations

impl<'a> Player<'a>

pub async fn try_new<T>(
    name: T,
    conn: &'a SyncConnection
) -> Result<Player<'a>, Box<dyn Error>> where
    T: AsRef<str> + Display, 

Tries to create a new Player instance from a given name.

Errors

Returns an Err if the provided player is invalid.

pub async fn next(&mut self) -> Result<(), Box<dyn Error>>

Skips to the next track

Errors

Will Err if the Player has closed.

pub async fn previous(&mut self) -> Result<(), Box<dyn Error>>

Skips to the previous track

Errors

Will Err if the Player has closed.

pub async fn pause(&mut self) -> Result<(), Box<dyn Error>>

Pauses the current track

Errors

Will Err if the Player has closed.

pub async fn play(&mut self) -> Result<(), Box<dyn Error>>

Starts or resumes the current track

Errors

Will Err if the Player has closed.

pub async fn play_pause(&mut self) -> Result<(), Box<dyn Error>>

Resumes/starts or pauses the current track

Errors

Will Err if the Player has closed.

pub async fn stop(&mut self) -> Result<(), Box<dyn Error>>

Stops playback

Errors

Will Err if the Player has closed.

pub async fn get_metadata(&mut self) -> Result<PropMap, Box<dyn Error>>

Retrieves track metadata from the Player. The prop_cast function may be used to get specific values out of the resulting metadata.

Errors

May Err if there is a failure in getting the metadata.

pub async fn get_property<T>(
    &mut self,
    property: &str
) -> Result<T, Box<dyn Error>> where
    T: for<'c> Get<'c> + 'static, 

Retrieves the value of an MPRIS property. Available properties can be found here.

Errors

May return an Err variant if:

• An invalid type was provided for the property
• An invalid property was provided

pub async fn set_property<T>(
    &mut self,
    property: &str,
    value: T
) -> Result<(), Box<dyn Error>> where
    T: Arg + Append, 

Sets the value of a writable MPRIS property. Available properties can be found here.

Errors

May return an Err variant if:

• An invalid type was provided for the property
• An invalid property was provided

pub async fn seek(&mut self, offset: Duration) -> Result<(), Box<dyn Error>>

Seeks the position of the active track.

pub async fn seek_reverse(
    &mut self,
    offset: Duration
) -> Result<(), Box<dyn Error>>

Same as seek, but in reverse.

pub async fn set_position(
    &mut self,
    position: i64
) -> Result<(), Box<dyn Error>>

Sets the position of the current track, by microseconds.

pub async fn open_uri(&mut self, uri: &str) -> Result<(), Box<dyn Error>>

Opens a track by its URI.

Errors

May return an Err variant if the provided URI is invalid.

Trait Implementations

impl<'a> Clone for Player<'a>

fn clone(&self) -> Player<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.