Struct Mpris

pub struct Mpris {
    pub port: u16,
    pub state: RwLock<StateAudio>,
    /* private fields */
}

Fields

port: u16

state: RwLock<StateAudio>

Implementations

impl Mpris

pub fn new(port: u16) -> Self

Create a new Mpris instance pending a connection to a daemon.

pub async fn daemon(&self) -> RwLockReadGuard<'_, Option<MusicPlayerClient>>

Give access to the inner Daemon client (checks if the daemon is connected first).

pub fn new_with_daemon(daemon: MusicPlayerClient) -> Self

Create a new Mpris instance with a daemon already connected.

pub async fn connect(&self) -> Result<()>

Connect to the daemon.

Errors

Returns an error if the daemon cannot be connected.

pub async fn connect_with_retry(&self) -> Result<()>

Connect to the daemon if not already connected.

Errors

Returns an error if the daemon cannot be connected after 5 retries.

pub async fn start_server( self, bus_name_suffix: &str, ) -> Result<Server<Self>, ZbusError>

Start the Mpris server.

Consumes self, but you can get back a reference to it by calling imp() on the returned Server.

Errors

Returns an error if the server cannot be started.

Trait Implementations

impl PlayerInterface for Mpris

async fn next(&self) -> Result<()>

Skips to the next track in the tracklist.

async fn previous(&self) -> Result<()>

Skips to the previous track in the tracklist.

async fn pause(&self) -> Result<()>

Pauses playback.

async fn play_pause(&self) -> Result<()>

Pauses playback.

async fn stop(&self) -> Result<()>

Stops playback.

async fn play(&self) -> Result<()>

Starts or resumes playback.

async fn open_uri(&self, uri: String) -> Result<()>

Opens the uri given as an argument

async fn playback_status(&self) -> Result<PlaybackStatus>

The current playback status.

async fn loop_status(&self) -> Result<LoopStatus>

The current loop / repeat status

async fn set_loop_status( &self, loop_status: LoopStatus, ) -> Result<(), ZbusError>

Sets the current loop / repeat status

async fn rate(&self) -> Result<PlaybackRate>

The current playback rate.

async fn set_rate(&self, _: PlaybackRate) -> Result<(), ZbusError>

Sets the current playback rate.

async fn shuffle(&self) -> Result<bool>

Whether playback is shuffled.

async fn set_shuffle(&self, shuffle: bool) -> Result<(), ZbusError>

Sets whether playback is shuffled.

async fn metadata(&self) -> Result<Metadata>

The metadata of the current element.

async fn volume(&self) -> Result<Volume>

The volume level.

async fn set_volume(&self, volume: Volume) -> Result<(), ZbusError>

Sets the volume level.

async fn position(&self) -> Result<Time>

The current track position, between 0 and the mpris:length metadata entry.

async fn seek(&self, offset: Time) -> Result<()>

Seeks forward in the current track by the specified offset in time.

async fn set_position(&self, track_id: TrackId, position: Time) -> Result<()>

Sets the current track position.

async fn minimum_rate(&self) -> Result<PlaybackRate>

The minimum value which the Rate property can take. Clients should not attempt to set the Rate property below this value.

async fn maximum_rate(&self) -> Result<PlaybackRate>

The maximum value which the Rate property can take. Clients should not attempt to set the Rate property above this value.

async fn can_go_next(&self) -> Result<bool>

Whether the client can call the Next method on this interface and expect the current track to change.

async fn can_go_previous(&self) -> Result<bool>

Whether the client can call the Previous method on this interface and expect the current track to change.

async fn can_play(&self) -> Result<bool>

Whether playback can be started using Play or PlayPause.

async fn can_pause(&self) -> Result<bool>

Whether playback can be paused using Pause or PlayPause.

async fn can_seek(&self) -> Result<bool>

Whether the client can control the playback position using Seek and SetPosition. This may be different for different tracks.

async fn can_control(&self) -> Result<bool>

Whether the media player may be controlled over this interface.

impl RootInterface for Mpris

async fn raise(&self) -> Result<()>

Brings the media player’s user interface to the front using any appropriate mechanism available.

async fn quit(&self) -> Result<()>

Causes the media player to stop running.

async fn can_quit(&self) -> Result<bool>

Whether the player may be asked to quit.

async fn fullscreen(&self) -> Result<bool>

Whether the media player is occupying the fullscreen.

async fn set_fullscreen(&self, _: bool) -> Result<(), ZbusError>

Sets whether the media player is occupying the fullscreen.

async fn can_set_fullscreen(&self) -> Result<bool>

Whether the player may be asked to enter or leave fullscreen.

async fn can_raise(&self) -> Result<bool>

Whether the media player may be asked to be raised.

async fn has_track_list(&self) -> Result<bool>

Indicates whether the /org/mpris/MediaPlayer2 object implements the TrackList interface.

async fn identity(&self) -> Result<String>

A friendly name to identify the media player to users (eg: “VLC media player”).

async fn desktop_entry(&self) -> Result<String>

The basename of an installed .desktop file which complies with the Desktop entry specification, with the “.desktop” extension stripped.

async fn supported_uri_schemes(&self) -> Result<Vec<String>>

The URI schemes supported by the media player.

async fn supported_mime_types(&self) -> Result<Vec<String>>

The mime-types supported by the media player.