Expand description
§mpris
mpris
is an idiomatic library for dealing with MPRIS2-compatible media players over D-Bus.
This would mostly apply to the Linux-ecosystem which is a heavy user of D-Bus.
§Getting started
Some hints on how to use this library:
- Look at the examples under
examples/
. - Look at the
PlayerFinder
struct.
Structs§
- Invalid
Loop Status LoopStatus
had an invalid string value.- Invalid
Playback Status PlaybackStatus
had an invalid string value.- Metadata
- A structured representation of the
Player
metadata. - Player
- A MPRIS-compatible player.
- Player
Events - Iterator that blocks forever until the player has an
Event
. - Player
Finder - Used to find
Player
s running on a D-Bus connection. - Player
Iter - An iterator that lazily iterates over all of the found
Player
s. Useful for efficiently searching for a specific player. - Progress
- Struct containing information about current progress of a
Player
. - Progress
Tick - Return value of
ProgressTracker::tick
, which gives details about the latest refresh. - Progress
Tracker - Controller for calculating
Progress
and maintaining aTrackList
(if supported) for a givenPlayer
. - TrackID
- Represents the MPRIS
Track_Id
type. - Track
List - Represents a
MediaPlayer2.TrackList
.
Enums§
- DBus
Error - Something went wrong when communicating with the D-Bus. This could either be an underlying D-Bus library problem, or that the other side did not conform to the expected protocols.
- Event
- Represents a change in
Player
state. - Event
Error - Errors that can occur while processing event streams.
- Finding
Error - This enum encodes possible error cases that could happen when finding players.
- Loop
Status - A
Player
’s looping status. - Metadata
Value - Holds a dynamically-typed metadata value.
- Metadata
Value Kind - Playback
Status - The
Player
’s playback status - Progress
Error - Errors that can occur while refreshing progress.
- Track
List Error - TrackList-related errors.