MprisCustomHud

Important

• Linux only and intended to be used with CustomHud or Hudder

Description

Variables for CustomHud and Hudder to show currently playing music using the Mpris DBus Spec. Available for all versions CustomHud v4 is available for! Works with Hudder 8.x, 9.x on version 1.21.9/10 and 10.x for version 1.21.11/26.1.x It is heavily inspired by Hudify, so thank you for your work Lightningtow ig :)

Note

• Not all variables have to be/will be populated by the player/music application

General Variables

Name Type Description mpris_busname String busname mpris_track String track name mpris_trackid String the unique mpris track id (mostly for debugging) mpris_album String name of the album the track is from mpris_repeat String repeat status - "None", "Track" or "Playlist" mpris_artist String name of the first artist coming from mpris mpris_name String the pretty player name from the Identity attribute of org.mpris.MediaPlayer2 mpris_lyrics String xesam:asText mpris_created_at String xesam:contentCreated mpris_first_played String xesam:firstUsed mpris_last_played String xesam:lastUsed mpris_art_url String xesam:artUrl mpris_url String xesam:url mpris_shuffle Boolean wether shuffle is on mpris_playing Boolean wether the song is playing or paused/stopped mpris_exists Boolean wether the song is playing or paused/stopped mpris_has_album_art Boolean wether the track has an album art/it is loaded mpris_data_age Number the age of the metadata information (track, trackid, album, artist, artists, duration, ...) in milliseconds mpris_progress Number progress in milliseconds mpris_duration Number duration of the track in milliseconds mpris_rate Number the rate/speed the music is playing as floating point number mpris_volume Number the volume the music is playing at as a floating point number (usually between 0 and 1) mpris_bpm Number xesam:audioBPM mpris_disc Number xesam:discNumber mpris_number Number xesam:trackNumber mpris_times_played Number xesam:useCount mpris_auto_rating Number xesam:autoRating mpris_user_rating Number xesam:userRating mpris_album_width Number the absolute pixel width of the album art mpris_album_height Number the absolute pixel height of the album art mpris_album_color Number the rgb value of the dominant color of the album art mpris_artists List of String list of artists for the current player mpris_album_artists List of String xesam:albumArtist for the current player mpris_comments List of String xesam:comment for the current player mpris_composers List of String xesam:composer for the current player mpris_genres List of String xesam:genre for the current player mpris_lyricists List of String xesam:lyricist for the current player

CustomHud specific things

• From what I can tell, it is not easily possible to have a list as a field/attribte so here are only the lists for the current player
• All String variables are either not empty or null
• Lists have the the first four letters of the variable name after mpris_ as the default prefix (for iteration)
• PlayerInfo objects have all general variables + mpris_album_art with the mpris_ prefix removed as fields

Name Type/Usage Description mpris_player {mpris_player:<field>} or {mpris_player:<player>:<field>} exposes the fields of a PlayerInfo Object; player can be the full busname or only the last part mpris_players List of PlayerInfo like Objects just a list of currently active PlayerInfo Objects (same <fields> as above) mpris_album_art Icon draws the album art image of the current player to the screen

See https://www.freedesktop.org/wiki/Specifications/mpris-spec/metadata for details on the xesam:<name> and mpris:<name> variables.

Hudder specific things

Variables

Name Type Description has_mpris Boolean always true mpris_player Object/PlayerInfo the PlayerInfo object of the currently selected player or null mpris_players List<PlayerInfo> a list of currently tracked players

Functions/Methods

Name Arguments Effect mpris_player String name returns the PlayerInfo object with the bus name org.mpris.MediaPlayer2.<name> or null mpris_album_art String name or AlbumArt albumArt, int x, int y, int width, int height draws the album art image; if the track has no album art, it draws a fallback; if width or height is 0 it will retain the original aspect ratio; if both are 0, it will use the pixel dimensions (way too big lol)

Objects

PlayerInfo:

• String busname - the busname
• String name - player name
• String repeat - repeat status - see mpris_repeat
• boolean shuffle - shuffle status
• boolean playing - wether music is playing
• double rate - the rate the music is playing at
• double volume - the volume the music is playing at (usually between 0 and 1)
• Metadata metadata - metadata
• long progress() - returns the current progress (in ms)

Metadata:

• String track - current track - xesam:title
• String trackid - current track id - mpris:trackid
• String album - current album - xesam:album
• String artist - first artist
• String art_url - mpris:artUrl
• String lyrics - xesam:asText
• String created_at - xesam:contentCreated
• String first_played - xesam:firstUsed
• String last_played - xesam:lastUsed
• String url - xesam:url
• List<String> artists - all artists - xesam:artist
• List<String> album_artists - xesam:albumArtist
• List<String> comments - xesam:comment
• List<String> composers - xesam:composer
• List<String> genres - xesam:genre
• List<String> lyricists - xesam:lyricist
• int bpm - xesam:audioBPM
• int disc - xesam:discNumber
• int number - xesam:trackNumber
• int times_played - xesam:useCount
• float auto_rating - xesam:autoRating
• float user_rating - xesam:userRating
• long duration - duration of current track (in ms)
• AlbumArt album_art - information on the album art
• long data_age() - returns the age of the object (in ms)

AlbumArt

• int width - width in pixels
• int height - height in pixels
• int color - the rgb value of the dominant color of the album art
• boolean exists() - wether the object for the real image or the fallback one

Controls

There are keybindings for play/pause, next, previous, refresh and cycle through active players that all have correcsponding commands.

Configuration

By default a player is selected from the active ones. To cycle through the currently active ones, use the mpriscustomhud cycle command (only works onlyPreferred is disabled (default)). You can choose a player to prefer over others by using mpriscustomhud preferred <player> so that one will always be shown if it's active. If you don't want to see other players (only the preferred one), you can use mpriscustomhud onlyPreferred true. This will result in no player being selected if you didn't set a preferred one. With mpriscustomhud player, you get the currently active player, with mpriscustomhud onlyPreferred and mpriscustomhud preferred the values for that and with mpriscustomhud refresh, you can refresh the variables.

Flatpak notice

• when you're running Minecraft in a Flatpak sandbox, you have to add org.mpris.MediaPlayer2.* to the list of well known session bus names your launcher can talk to e.g. with Flatseal

Problems/Todo

• currently there is no album art variable; maybe I will try to add it at some point done

Libraries used

• dbus-java
  • Improved version of java DBus library provided by freedesktop.org https://dbus.freedesktop.org/doc/dbus-java

License

This Mod is licensed under the MIT License