Functions — github.com/Mange/mpris-rs

hub / github.com/Mange/mpris-rs / functions

Functions402 in github.com/Mange/mpris-rs

⨍ Functions 402◇ Types & classes 39

↓ 50 callersMethodconnection_path

(&self)

src/player.rs:1282

↓ 25 callersFunctionprint_value

(name: &str, value: T)

examples/capabilities.rs:91

↓ 20 callersMethodread

(i: &mut arg::Iter)

src/generated/media_player_player.rs:63

↓ 16 callersMethodinsert

Insert a new track (via its metadata) after another one. If the provided ID cannot be found on the list, it will be inserted at the end. NOTE:** This

src/track_list.rs:212

↓ 14 callersMethodinto_iter

(self)

src/metadata.rs:186

↓ 12 callersMethodget

Get a value from the metadata by key name. # Examples ```rust # use mpris::{Metadata, MetadataValue}; # let mut metadata = Metadata::new(String::fro

src/metadata.rs:50

↓ 11 callersMethodcan_control

Queries the player to see if it can be controlled or not. See: [MPRIS2 specification about `CanControl`][can_control]. [can_control]: https://specif

src/player.rs:953

↓ 10 callersFunctioncontrol_player

(result: Result<(), mpris::DBusError>)

examples/control.rs:270

↓ 10 callersMethoditer

Iterate all metadata keys and values.

src/metadata.rs:167

↓ 9 callersMethodtrack_id

The track ID. If the [`TrackID`] could not be parsed as a proper [`TrackID`], [`None`] will be returned. Based on `mpris:trackid` > A unique identit

src/metadata.rs:61

↓ 8 callersMethodis_empty

Returns [`true`] if there is no metadata

src/metadata.rs:177

↓ 8 callersMethodlen

Returns the number of tracks on the list.

src/track_list.rs:192

↓ 7 callersMethodchange_metadata

Change metadata cache. As this requires a `&mut self`, the borrow is guaranteed to work.

src/track_list.rs:364

↓ 7 callersMethodfind_active

Try to find the "active" [`Player`] in the connection. This method will try to determine which player a user is most likely to use. First it will loo

src/find.rs:100

↓ 7 callersFunctionsend_value_over_dbus

(value: T)

src/metadata/value.rs:517

↓ 7 callersFunctiontrack_id

(s: &str)

src/track_list.rs:440

↓ 6 callersMethodas_str

Returns a `&str` variant of the ID.

src/track_list.rs:142

↓ 6 callersMethodmetadata

The track metadata at the point in time that this Progress was constructed.

src/progress.rs:342

↓ 6 callersMethodnext

Send a `Next` signal to the player. See: [MPRIS2 specification about `Next`][next]. [next]: https://specifications.freedesktop.org/mpris-spec/latest

src/player.rs:613

↓ 6 callersMethodremove

Removes a track from the list and metadata cache. Note:** If the same id is present multiple times, all of them will be removed.

src/track_list.rs:234

↓ 6 callersMethodreplace

Replace the contents with the contents of the provided list. Cache will be reused when possible.

src/track_list.rs:248

↓ 5 callersMethodartists

A list of artists of the track. Based on `xesam:artist` > The track artist(s).

src/metadata.rs:96

↓ 5 callersMethodas_ref

(&self)

src/track_list.rs:154

↓ 5 callersMethodcan_seek

Queries the player to see if it can seek within the media. See: [MPRIS2 specification about `CanSeek`][can_seek]. [can_seek]: https://specifications

src/player.rs:1000

↓ 5 callersMethodelapsed

(&self)

src/progress.rs:418

↓ 5 callersMethodloop_status

The loop status at the point in time that this Progress was constructed.

src/progress.rs:357

↓ 5 callersMethodplayback_status

The playback status at the point in time that this Progress was constructed.

src/progress.rs:347

↓ 5 callersMethodshuffle

The shuffle status at the point in time that this Progress was constructed.

src/progress.rs:352

↓ 4 callersMethodcan_pause

Queries the player to see if it can pause. See: [MPRIS2 specification about `CanPause`][can_pause] [can_pause]: https://specifications.freedesktop.o

src/player.rs:982

↓ 4 callersMethodchecked_get_track_list

Query the player for the current tracklist. Note:** It's more expensive to rebuild this each time rather than trying to keep the same [`TrackList`] u

src/player.rs:425

↓ 4 callersMethodget_track_list

Query the player for the current tracklist. Note:** It's more expensive to rebuild this each time rather than trying to keep the same [`TrackList`] u

src/player.rs:404

↓ 4 callersMethodget_volume

Get the volume of the player. Volume should be between 0.0 and 1.0. Above 1.0 is possible, but not recommended. See: [MPRIS2 specification about `Vo

src/player.rs:1219

↓ 4 callersFunctionhandle_optional_property

(result: Result<T, dbus::Error>)

src/player.rs:1307

↓ 4 callersMethodidentity

Returns the player's MPRIS [`Identity`][identity]. This is usually the application's name, like `Spotify`. [identity]: https://specifications.freede

src/player.rs:168

↓ 4 callersMethoditer_players

Returns a [`PlayerIter`] iterator, or an [`DBusError`] if there was a problem with the D-Bus For more details see [`PlayerIter`] documentation

src/find.rs:180

↓ 4 callersMethodsupports_track_lists

Checks if the Player implements the `org.mpris.MediaPlayer2.TrackList` interface.

src/player.rs:173

↓ 4 callersMethodtitle

The name of the track. Based on `xesam:title` > The track title.

src/metadata.rs:138

↓ 3 callersMethodas_path

(&self)

src/track_list.rs:146

↓ 3 callersMethodcan_edit_tracks

Query the player to see if it allows changes to its TrackList. Will return [`Err`] if Player isn't supporting the [`TrackList`] interface. See [`che

src/player.rs:442

↓ 3 callersMethodcan_go_next

Queries the player to see if it can go to next or not. See: [MPRIS2 specification about `CanGoNext`][can_next]. [can_next]: https://specifications.f

src/player.rs:962

↓ 3 callersMethodcan_go_previous

Queries the player to see if it can go to previous or not. See: [MPRIS2 specification about `CanGoPrevious`][can_prev]. [can_prev]: https://specific

src/player.rs:971

↓ 3 callersMethodcan_loop

Queries the player to see if it supports the "LoopStatus" setting

src/player.rs:1034

↓ 3 callersMethodcan_shuffle

Queries the player to see if it supports the "Shuffle" setting

src/player.rs:1024

↓ 3 callersMethodcan_stop

Queries the player to see if it can stop. MPRIS2 defines [the `Stop` message to only work when the player can be controlled][can_stop], so that is th

src/player.rs:1013

↓ 3 callersMethodget_metadata

Query the player for current metadata. See [`Metadata`] for more information about what is included here.

src/player.rs:384

↓ 3 callersMethodget_playback_status

Query the player for current playback status.

src/player.rs:1105

↓ 3 callersMethodget_tracks_metadata

Query the player for metadata for the given [`TrackID`]s. This is used by the [`TrackList`] type to iterator metadata for the tracks in the track lis

src/player.rs:479

↓ 3 callersMethodhas_playback_rate

Queries the player to see if it supports the "Rate" setting

src/player.rs:1044

↓ 3 callersMethodhas_position

Queries the player to see if it supports the "Position" setting

src/player.rs:1054

↓ 3 callersMethodhas_volume

Queries the player to see if it supports the "Volume" setting

src/player.rs:1064

↓ 3 callersMethodmetadata_iter

Iterates the tracks in the tracklist, returning a tuple of [`TrackID`] and [`Metadata`] for that track. [`Metadata`] will be loaded from the provided

src/track_list.rs:302

↓ 3 callersMethodposition

Returns the current position of the current track as a [`Duration`]. This method will calculate the expected position of the track at the instant of

src/progress.rs:384

↓ 3 callersFunctionprint_time

(duration: Option<Duration>)

examples/progress_tracker.rs:22

↓ 3 callersFunctionprompt_string

(message: &str)

examples/tracklist_control.rs:18

↓ 3 callersMethodseek

Send a `Seek` signal to the player. See: [MPRIS2 specification about `Seek`][seek]. [seek]: https://specifications.freedesktop.org/mpris-spec/latest

src/player.rs:631

↓ 3 callersFunctionselect_track

(player: &Player, lower_bound: usize)

examples/tracklist_control.rs:82

↓ 3 callersFunctionsend_values_over_dbus

(appender: F)

src/metadata/value.rs:482

↓ 3 callersMethodset_volume

Set the volume of the player. Volume should be between 0.0 and 1.0. Above 1.0 is possible, but not recommended. See: [MPRIS2 specification about `Vo

src/player.rs:1243

↓ 3 callersMethodwith_path

( &'a self, bus_name: BusName<'a>, path: Path<'a>, timeout_ms: i32, )

src/pooled_connection.rs:44

↓ 2 callersMethodadd_track

Add a URI to the TrackList and optionally set it as current. It is placed after the specified [`TrackID`], if supported by the player. Requires the

src/player.rs:735

↓ 2 callersMethodbus_name

Returns the player's D-Bus bus name.

src/player.rs:105

↓ 2 callersMethodcan_play

Queries the player to see if it can play. See: [MPRIS2 specification about `CanPlay`][can_play]. [can_play]: https://specifications.freedesktop.org/

src/player.rs:991

↓ 2 callersMethodcan_quit

Queries the player to see if it can be asked to quit. See: [MPRIS2 specification about `CanQuit`][can_quit] and the [`quit`](Self::quit) method. [ca

src/player.rs:929

↓ 2 callersMethodcan_raise

Queries the player to see if it can be raised or not. See: [MPRIS2 specification about `CanRaise`][can_raise] and the [`raise`](Self::raise) method.

src/player.rs:920

↓ 2 callersFunctionchange_volume

(player: &Player, diff: f64)

examples/control.rs:288

↓ 2 callersMethodconnection

(&self)

src/player.rs:568

↓ 2 callersMethodcurrent_volume

Returns the player's volume as it was at the time of refresh. See: [`Player::get_volume`].

src/progress.rs:414

↓ 2 callersMethodfind_all

Find all available [`Player`]s in the connection. Will return an empty [`Vec`] and not [`NoPlayerFound`](FindingError::NoPlayerFound) if there are no

src/find.rs:79

↓ 2 callersFunctionformat_duration

(duration: Duration)

examples/control.rs:433

↓ 2 callersMethodget_has_track_list

Returns the player's `HasTrackList` property. See: [MPRIS2 specification about `HasTrackList`][track_list]. [track_list]: https://specifications.fre

src/player.rs:213

↓ 2 callersMethodget_loop_status

Query the player for the current loop status. See: [MPRIS2 specification about `LoopStatus`][loop_status]. [loop_status]: https://specifications.fr

src/player.rs:1165

↓ 2 callersMethodget_maximum_playback_rate

Gets the maximum allowed value for playback rate. See: [MPRIS2 specification about `MaximumRate`][max_rate]. [max_rate]: https://specifications.free

src/player.rs:368

↓ 2 callersMethodget_minimum_playback_rate

Gets the minimum allowed value for playback rate. See: [MPRIS2 specification about `MinimumRate`][min_rate]. [min_rate]: https://specifications.free

src/player.rs:359

↓ 2 callersMethodget_playback_rate

Returns the player's MPRIS (playback) `rate` as a factor. 1.0 would mean normal rate, while 2.0 would mean twice the playback speed.

src/player.rs:305

↓ 2 callersMethodget_shuffle

Query player for the state of the "Shuffle" setting. See: [MPRIS2 specification about `Shuffle`][shuffle]. [shuffle]: https://specifications.freedes

src/player.rs:1117

↓ 2 callersMethodindex_of_id

(&self, id: &TrackID)

src/track_list.rs:395

↓ 2 callersFunctionis_different_float

(a: f64, b: f64)

src/event.rs:267

↓ 2 callersMethodis_running

Returns true if the bus of this player is still occupied in the connection, or put in another way: If there's a process still listening on messages on

src/player.rs:562

↓ 2 callersMethodkeys

Iterate all metadata keys.

src/metadata.rs:172

↓ 2 callersMethodlength

The duration of the track, as a [`Duration`] Based on `mpris:length`.

src/metadata.rs:129

↓ 2 callersMethodpending_events

Return any events that are pending (for this player) on the connection.

src/player.rs:1302

↓ 2 callersMethodplay_pause

Send a `PlayPause` signal to the player. See: [MPRIS2 specification about `PlayPause`][play_pause] [play_pause]: https://specifications.freedesktop.

src/player.rs:577

↓ 2 callersMethodplayback_rate

The playback rate at the point in time that this Progress was constructed.

src/progress.rs:362

↓ 2 callersMethodprevious

Send a `Previous` signal to the player. See: [MPRIS2 specification about `Previous`][prev]. [prev]: https://specifications.freedesktop.org/mpris-spe

src/player.rs:622

↓ 2 callersFunctionprint_progress_bar

(screen: &mut Screen, progress: &Progress, supports_position: bool)

examples/control.rs:392

↓ 2 callersFunctionprint_track_info

(screen: &mut Screen, track: &Metadata)

examples/control.rs:328

↓ 2 callersMethodprocess_message

Takes a message and processes it appropriately. Returns the affected bus name, and a borrow to the generated [`MprisEvent`], if applicable.

src/pooled_connection.rs:157

↓ 2 callersMethodrefresh_track_list

(&mut self)

src/progress.rs:315

↓ 2 callersMethodreload

Reloads the tracklist from the given player. This can be compared with loading a new track list, but in this case the metadata cache can be maintained

src/track_list.rs:319

↓ 2 callersMethodreplace_track_metadata

Replaces a track on the list with a new entry. The new metadata could contain a new track ID, and will in that case replace the old ID on the tracklis

src/track_list.rs:280

↓ 2 callersMethodseek_backwards

Tell the player to seek backwards. See: [`seek`](Self::seek) method.

src/player.rs:705

↓ 2 callersMethodseek_forwards

Tell the player to seek forwards. See: [`seek`](Self::seek) method.

src/player.rs:640

↓ 2 callersMethodset_loop_status

Set the loop status of the player. See: [MPRIS2 specification about `LoopStatus`][loop_status]. [loop_status]: https://specifications.freedesktop.o

src/player.rs:1189

↓ 2 callersMethodset_position

Sets the position of the current track to the given position (as a [`Duration`]). Current [`TrackID`] must be provided to avoid race conditions with

src/player.rs:257

↓ 2 callersMethodset_shuffle

Set the "Shuffle" setting of the player. See: [MPRIS2 specification about `Shuffle`][shuffle]. [shuffle]: https://specifications.freedesktop.org/mpr

src/player.rs:1138

↓ 2 callersMethodstop

Send a `Stop` signal to the player. See: [MPRIS2 specification about `Stop`][stop]. [stop]: https://specifications.freedesktop.org/mpris-spec/latest

src/player.rs:604

↓ 2 callersMethodtick

Returns a [`ProgressTick`] at each interval, or as close to each interval as possible. The returned struct contains borrows of the current data along

src/progress.rs:213

↓ 2 callersMethodtrack_progress

Returns a new [`ProgressTracker`] for the player. Use this if you want to monitor a player in order to show close-to-realtime information about it.

src/player.rs:536

↓ 2 callersMethodurl

A URL to the media being played. Based on `xesam:url` > The location of the media file.

src/metadata.rs:154

↓ 1 callersFunctionadd_track

(player: &Player)

examples/tracklist_control.rs:124

next →1–100 of 402, ranked by callers