Trait mpris_server::RootInterface
source · pub trait RootInterface {
// Required methods
fn raise<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait;
fn quit<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait;
fn can_quit<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = bool> + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait;
fn can_raise<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = bool> + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait;
fn has_track_list<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = bool> + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait;
fn identity<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = String> + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait;
fn supported_uri_schemes<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Vec<String>> + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait;
fn supported_mime_types<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = Vec<String>> + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait;
// Provided methods
fn fullscreen<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = bool> + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait { ... }
fn set_fullscreen<'life0, 'async_trait>(
&'life0 self,
_fullscreen: bool
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait { ... }
fn can_set_fullscreen<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = bool> + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait { ... }
fn desktop_entry<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = String> + 'async_trait>>
where Self: 'async_trait,
'life0: 'async_trait { ... }
}Required Methods§
sourcefn raise<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn raise<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ()> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,
Brings the media player’s user interface to the front using any appropriate mechanism available.
The media player may be unable to control how its user
interface is displayed, or it may not have a graphical user
interface at all. In this case, the CanRaise property is
false and this method does nothing.
sourcefn quit<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = ()> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn quit<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = ()> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,
Causes the media player to stop running.
The media player may refuse to allow clients to shut it
down. In this case, the CanQuit property is false and
this method does nothing.
Note: Media players which can be D-Bus activated, or for which there is no sensibly easy way to terminate a running instance (via the main interface or a notification area icon for example) should allow clients to use this method. Otherwise, it should not be needed.
If the media player does not have a UI, this should be implemented.
sourcefn can_quit<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = bool> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn can_quit<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = bool> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,
If false, calling Quit will have no effect, and may raise a
NotSupported error. If true, calling Quit will cause the media
application to attempt to quit (although it may still be
prevented from quitting by the user, for example).
fn can_raise<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = bool> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,
fn has_track_list<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = bool> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,
fn identity<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = String> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,
fn supported_uri_schemes<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Vec<String>> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,
fn supported_mime_types<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Vec<String>> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,
Provided Methods§
sourcefn fullscreen<'life0, 'async_trait>(
&'life0 self
) -> Pin<Box<dyn Future<Output = bool> + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn fullscreen<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = bool> + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,
Whether the media player is occupying the fullscreen.
This is typically used for videos. A value of true indicates that the media player is taking up the full screen.
Media centre software may well have this value fixed to true
If CanSetFullscreen is true, clients may set this property to true to tell the media player to enter fullscreen mode, or to false to return to windowed mode.
If CanSetFullscreen is false, then attempting to set this property should have no effect, and may raise an error. However, even if it is true, the media player may still be unable to fulfil the request, in which case attempting to set this property will have no effect (but should not raise an error).