Struct MprisHandle 

pub struct MprisHandle { /* private fields */ }

The widget-side handle to the host’s media controls, started through the current crate::host::MediaSessionFactory. When the host has none — the default (non-mpris) build, non-Unix platforms, no session bus, headless hosts — this is an inert stub: publish is a no-op and drain_commands yields nothing, so the widget code path is identical everywhere.

Implementations

impl MprisHandle

pub fn disabled() -> MprisHandle

An inert handle (no D-Bus). Used by the default build, --shots, tests, and as the graceful fallback when no session bus is reachable.

pub fn is_active(&self) -> bool

Whether the host’s media session is running.

pub fn spawn(config: MprisConfig, initial: PlayerSnapshot) -> MprisHandle

Register a player under config with the current host, publishing initial as the starting state. Never panics: when the host has no media controls it returns an inert Self::disabled.

pub fn drain_commands(&self) -> Vec<MprisCommand>

Drain every pending external control command (non-blocking).

pub fn publish(&mut self, snap: PlayerSnapshot)

Publish the current player state to the host, which for MPRIS emits PropertiesChanged for whatever changed. Cheap and deduped: identical/insignificant updates are dropped so the bus isn’t spammed each frame.

Trait Implementations

impl Default for MprisHandle

fn default() -> MprisHandle

Returns the “default value” for a type.