Music

Displays currently playing song from your music player. This module supports both MPRIS players and MPD servers. Clicking on the widget opens a popout displaying info about the current song, album art and playback controls.

in MPRIS mode, the widget will listen to all players and automatically detect/display the active one.

Use truncate or marquee options to control how long titles are shown on the bar and popup.

Screenshot showing MPD widget with track playing with popout open

Example

{
  start = [
    {
      type = "music"
      player_type = "mpd"
      format = "{title} / {artist}"
      truncate = "end"
      icons.play = ""
      icons.pause = ""
      music_dir = "/home/jake/Music"
    }
  ]
}

{
  "start": [
    {
      "type": "music",
      "player_type": "mpd",
      "format": "{title} / {artist}",
      "truncate": "end",
      "icons": {
        "play": "",
        "pause": ""
      },
      "music_dir": "/home/jake/Music"
    }
  ]
}

start:
  - type: music
    player_type: mpd
    format: "{title} / {artist}"
    truncate: end
    icons:
      play: 
      pause: 
    music_dir: /home/jake/Music

[[start]]
type = "music"
player_type = "mpd"
format = "{title} / {artist}"
truncate = "end"
music_dir = "/home/jake/Music"

  [start.icons]
  play = ""
  pause = ""

Configuration

Type: music

`cover_image_size`

Size to render the album art image at inside the popup, in pixels.

Type: integer
Default: 128

`format`

Format of current song info to display on the bar.

Info on formatting tokens below.

Type: string
Default: {title} / {artist}

`host`

[MPD Only] TCP or Unix socket address of the MPD server. For TCP, this should include the port number.

Type: string
Default: localhost:6600

`icon_size`

Size to render the icons at, in pixels (image icons only).

Type: integer
Default: 32

`icons`

Player state icons.

See icons.

Default: None

Object keys

`icons.album`

Icon to display nex to album name.

Type: string
Default: 󰀥

`icons.artist`

Icon to display nex to artist name.

Type: string
Default: 󰠃

`icons.next`

Icon to display for next button.

Type: string
Default: 󰒭

`icons.pause`

Icon to display when paused.

Type: string
Default: 

`icons.play`

Icon to display when playing.

Type: string
Default: 

`icons.prev`

Icon to display for previous button.

Type: string
Default: 󰒮

`icons.track`

Icon to display nex to track title.

Type: string
Default: 󰎈

`icons.volume`

Icon to display under volume slider.

Type: string
Default: 󰕾

`justify`

The justification (alignment) of the widget text shown on the bar.

Type: 'left' | 'right' | 'center' | 'fill'
Default: 'left'

`marquee`

See marquee options.

Default: None

Object keys

`marquee.enable`

Whether to enable scrolling on long lines of text. This may not be supported by all modules.

Type: boolean
Default: None

`marquee.max_length`

The maximum length of text (roughly, in characters) before it gets truncated and starts scrolling.

Type: integer
Default: None

`marquee.on_hover`Enum

Controls marquee behavior on hover.

Options:

"none": Always scroll (default)
"pause": Pause scrolling on hover
"play": Only scroll on hover

Default: None

1`none`

Scrolling is always active, hover has no effect.

2`pause`

Scrolling pauses when the widget is hovered.

3`play`

Scrolling only occurs when the widget is hovered.

`marquee.pause_duration`

Duration in milliseconds to pause at each loop point.

Type: integer
Default: 5000

`marquee.scroll_speed`

Scroll speed in pixels per frame. Higher values scroll faster.

Type: number
Default: 0.5

`marquee.separator`

String displayed between the end and beginning of text as it loops.

Type: string
Default:

`marquee_popup_album`

See marquee options.

Default: None

Object keys

`marquee_popup_album.enable`

Whether to enable scrolling on long lines of text. This may not be supported by all modules.

Type: boolean
Default: None

`marquee_popup_album.max_length`

The maximum length of text (roughly, in characters) before it gets truncated and starts scrolling.

Type: integer
Default: None

`marquee_popup_album.on_hover`Enum

Controls marquee behavior on hover.

Options:

"none": Always scroll (default)
"pause": Pause scrolling on hover
"play": Only scroll on hover

Default: None

1`none`

Scrolling is always active, hover has no effect.

2`pause`

Scrolling pauses when the widget is hovered.

3`play`

Scrolling only occurs when the widget is hovered.

`marquee_popup_album.pause_duration`

Duration in milliseconds to pause at each loop point.

Type: integer
Default: 5000

`marquee_popup_album.scroll_speed`

Scroll speed in pixels per frame. Higher values scroll faster.

Type: number
Default: 0.5

`marquee_popup_album.separator`

String displayed between the end and beginning of text as it loops.

Type: string
Default:

`marquee_popup_artist`

See marquee options.

Default: None

Object keys

`marquee_popup_artist.enable`

Whether to enable scrolling on long lines of text. This may not be supported by all modules.

Type: boolean
Default: None

`marquee_popup_artist.max_length`

The maximum length of text (roughly, in characters) before it gets truncated and starts scrolling.

Type: integer
Default: None

`marquee_popup_artist.on_hover`Enum

Controls marquee behavior on hover.

Options:

"none": Always scroll (default)
"pause": Pause scrolling on hover
"play": Only scroll on hover

Default: None

1`none`

Scrolling is always active, hover has no effect.

2`pause`

Scrolling pauses when the widget is hovered.

3`play`

Scrolling only occurs when the widget is hovered.

`marquee_popup_artist.pause_duration`

Duration in milliseconds to pause at each loop point.

Type: integer
Default: 5000

`marquee_popup_artist.scroll_speed`

Scroll speed in pixels per frame. Higher values scroll faster.

Type: number
Default: 0.5

`marquee_popup_artist.separator`

String displayed between the end and beginning of text as it loops.

Type: string
Default:

`marquee_popup_title`

See marquee options.

Default: None

Object keys

`marquee_popup_title.enable`

Whether to enable scrolling on long lines of text. This may not be supported by all modules.

Type: boolean
Default: None

`marquee_popup_title.max_length`

The maximum length of text (roughly, in characters) before it gets truncated and starts scrolling.

Type: integer
Default: None

`marquee_popup_title.on_hover`Enum

Controls marquee behavior on hover.

Options:

"none": Always scroll (default)
"pause": Pause scrolling on hover
"play": Only scroll on hover

Default: None

1`none`

Scrolling is always active, hover has no effect.

2`pause`

Scrolling pauses when the widget is hovered.

3`play`

Scrolling only occurs when the widget is hovered.

`marquee_popup_title.pause_duration`

Duration in milliseconds to pause at each loop point.

Type: integer
Default: 5000

`marquee_popup_title.scroll_speed`

Scroll speed in pixels per frame. Higher values scroll faster.

Type: number
Default: 0.5

`marquee_popup_title.separator`

String displayed between the end and beginning of text as it loops.

Type: string
Default:

`music_dir`

[MPD Only] Path to root of the MPD server’s music directory. This is required for displaying album art.

Type: string
Default: $HOME/Music

`orientation`

The orientation to display the widget contents. Setting to vertical will rotate text 90 degrees.

Type: 'horizontal' | 'vertical'
Default: 'horizontal'

`player_type`

Type of player to connect to

Type: 'mpd' | 'mpris'
Default: None

`show_status_icon`

Whether to show the play/pause status icon on the bar.

Type: boolean
Default: true

`truncate`Enum

See truncate options.

Default: None

1`null`

Do not truncate content.

Setting this option may cause excessively long content to overflow other widgets, shifting them off-screen.

Example

{ truncate = "off" }

{
  "truncate": "off"
}

truncate: off

truncate = "off"

2`'none' | 'start' | 'middle' | 'end'`

Auto mode lets GTK decide when to ellipsize.

To use this mode, set the truncate option to a string declaring the location to truncate text from and place the ellipsis.

Example

{ truncate = "start" }

{
  "truncate": "start"
}

truncate: start

truncate = "start"

3`object`

Length mode defines a fixed point at which to ellipsize.

Generally you will want to set only one of length or max_length, but you can set both if required.

Example

{
    truncate.mode = "start"
    truncate.length = 50
    truncate.max_length = 70
}

{
  "truncate": {
    "mode": "start",
    "length": 50,
    "max_length": 70
  }
}

truncate:
  mode: start
  length: 50
  max_length: 70

[truncate]
mode = "start"
length = 50
max_length = 70

Object keys

`object.length`

The fixed width (in characters) of the widget.

The widget will be expanded to this width if it would have otherwise been smaller.

Leave unset to let GTK automatically handle.

Type: integer
Default: None

`object.max_length`

The maximum number of characters to show before truncating.

Leave unset to let GTK automatically handle.

Type: integer
Default: None

`object.mode`Required

The location to truncate text from and place the ellipsis.

Type: 'none' | 'start' | 'middle' | 'end'
Default: None

`truncate_popup_album`Enum

See truncate options.

Default: None

1`null`

Do not truncate content.

Setting this option may cause excessively long content to overflow other widgets, shifting them off-screen.

Example

{ truncate = "off" }

{
  "truncate": "off"
}

truncate: off

truncate = "off"

2`'none' | 'start' | 'middle' | 'end'`

Auto mode lets GTK decide when to ellipsize.

To use this mode, set the truncate option to a string declaring the location to truncate text from and place the ellipsis.

Example

{ truncate = "start" }

{
  "truncate": "start"
}

truncate: start

truncate = "start"

3`object`

Length mode defines a fixed point at which to ellipsize.

Generally you will want to set only one of length or max_length, but you can set both if required.

Example

{
    truncate.mode = "start"
    truncate.length = 50
    truncate.max_length = 70
}

{
  "truncate": {
    "mode": "start",
    "length": 50,
    "max_length": 70
  }
}

truncate:
  mode: start
  length: 50
  max_length: 70

[truncate]
mode = "start"
length = 50
max_length = 70

Object keys

`object.length`

The fixed width (in characters) of the widget.

The widget will be expanded to this width if it would have otherwise been smaller.

Leave unset to let GTK automatically handle.

Type: integer
Default: None

`object.max_length`

The maximum number of characters to show before truncating.

Leave unset to let GTK automatically handle.

Type: integer
Default: None

`object.mode`Required

The location to truncate text from and place the ellipsis.

Type: 'none' | 'start' | 'middle' | 'end'
Default: None

`truncate_popup_artist`Enum

See truncate options.

Default: None

1`null`

Do not truncate content.

Setting this option may cause excessively long content to overflow other widgets, shifting them off-screen.

Example

{ truncate = "off" }

{
  "truncate": "off"
}

truncate: off

truncate = "off"

2`'none' | 'start' | 'middle' | 'end'`

Auto mode lets GTK decide when to ellipsize.

To use this mode, set the truncate option to a string declaring the location to truncate text from and place the ellipsis.

Example

{ truncate = "start" }

{
  "truncate": "start"
}

truncate: start

truncate = "start"

3`object`

Length mode defines a fixed point at which to ellipsize.

Generally you will want to set only one of length or max_length, but you can set both if required.

Example

{
    truncate.mode = "start"
    truncate.length = 50
    truncate.max_length = 70
}

{
  "truncate": {
    "mode": "start",
    "length": 50,
    "max_length": 70
  }
}

truncate:
  mode: start
  length: 50
  max_length: 70

[truncate]
mode = "start"
length = 50
max_length = 70

Object keys

`object.length`

The fixed width (in characters) of the widget.

The widget will be expanded to this width if it would have otherwise been smaller.

Leave unset to let GTK automatically handle.

Type: integer
Default: None

`object.max_length`

The maximum number of characters to show before truncating.

Leave unset to let GTK automatically handle.

Type: integer
Default: None

`object.mode`Required

The location to truncate text from and place the ellipsis.

Type: 'none' | 'start' | 'middle' | 'end'
Default: None

`truncate_popup_title`Enum

See truncate options.

Default: None

1`null`

Do not truncate content.

Setting this option may cause excessively long content to overflow other widgets, shifting them off-screen.

Example

{ truncate = "off" }

{
  "truncate": "off"
}

truncate: off

truncate = "off"

2`'none' | 'start' | 'middle' | 'end'`

Auto mode lets GTK decide when to ellipsize.

To use this mode, set the truncate option to a string declaring the location to truncate text from and place the ellipsis.

Example

{ truncate = "start" }

{
  "truncate": "start"
}

truncate: start

truncate = "start"

3`object`

Length mode defines a fixed point at which to ellipsize.

Generally you will want to set only one of length or max_length, but you can set both if required.

Example

{
    truncate.mode = "start"
    truncate.length = 50
    truncate.max_length = 70
}

{
  "truncate": {
    "mode": "start",
    "length": 50,
    "max_length": 70
  }
}

truncate:
  mode: start
  length: 50
  max_length: 70

[truncate]
mode = "start"
length = 50
max_length = 70

Object keys

`object.length`

The fixed width (in characters) of the widget.

The widget will be expanded to this width if it would have otherwise been smaller.

Leave unset to let GTK automatically handle.

Type: integer
Default: None

`object.max_length`

The maximum number of characters to show before truncating.

Leave unset to let GTK automatically handle.

Type: integer
Default: None

`object.mode`Required

The location to truncate text from and place the ellipsis.

Type: 'none' | 'start' | 'middle' | 'end'
Default: None

Styling

Selector	Description
`.music`	Tray widget button
`.music .contents`	Tray widget button contents box
`.music .contents .icon`	Tray widget button icon (any type)
`.music .contents .text-icon`	Tray widget button icon (textual only)
`.music .contents .image`	Tray widget button icon (image only)
`.popup-music`	Popup box
`.popup-music .album-art`	Album art image inside popup box
`.popup-music .title`	Track title container inside popup box
`.popup-music .title .icon-box`	Track title icon container inside popup box
`.popup-music .title .icon-box .icon`	Track title icon inside its container (any type)
`.popup-music .title .icon-box .text-icon`	Track title icon inside its container (textual only)
`.popup-music .title .icon-box .image`	Track title icon inside its container (image only)
`.popup-music .title .label`	Track title label inside popup box
`.popup-music .album`	Track album container inside popup box
`.popup-music .album .icon-box`	Track album icon container inside popup box
`.popup-music .album .icon-box .icon`	Track album icon inside its container (any type)
`.popup-music .album .icon-box .text-icon`	Track album icon inside its container (textual only)
`.popup-music .album .icon-box .image`	Track album icon inside its container (image only)
`.popup-music .album .label`	Track album label inside popup box
`.popup-music .artist`	Track artist container inside popup box
`.popup-music .artist .icon-box`	Track artist icon container inside popup box
`.popup-music .artist .icon-box .icon`	Track artist icon inside its container (any type)
`.popup-music .artist .icon-box .text-icon`	Track artist icon inside its container (textual only)
`.popup-music .artist .icon-box .image`	Track artist icon inside its container (image only)
`.popup-music .artist .label`	Track artist label inside popup box
`.popup-music .controls`	Controls container inside popup box
`.popup-music .controls .btn-prev`	Previous button inside popup box
`.popup-music .controls .btn-play`	Play button inside popup box
`.popup-music .controls .btn-pause`	Pause button inside popup box
`.popup-music .controls .btn-next`	Next button inside popup box
`.popup-music .volume`	Volume container inside popup box
`.popup-music .volume .slider`	Slider inside volume container
`.popup-music .volume .icon`	Icon inside volume container
`.popup-music .progress`	Progress (seek) bar container
`.popup-music .progress .slider`	Slider inside progress container
`.popup-music .progress .label`	Duration label inside progress container

For more information on styling, please see the styling guide.

Music

Example

Configuration

cover_image_size

format

host

icon_size

icons

icons.album

icons.artist

icons.next

icons.pause

icons.play

icons.prev

icons.track

icons.volume

justify

marquee

marquee.enable

marquee.max_length

marquee.on_hoverEnum

1none

2pause

3play

marquee.pause_duration

marquee.scroll_speed

marquee.separator

marquee_popup_album

marquee_popup_album.enable

marquee_popup_album.max_length

marquee_popup_album.on_hoverEnum

1none

2pause

3play

marquee_popup_album.pause_duration

marquee_popup_album.scroll_speed

marquee_popup_album.separator

marquee_popup_artist

marquee_popup_artist.enable

marquee_popup_artist.max_length

marquee_popup_artist.on_hoverEnum

1none

2pause

3play

marquee_popup_artist.pause_duration

marquee_popup_artist.scroll_speed

marquee_popup_artist.separator

marquee_popup_title

marquee_popup_title.enable

marquee_popup_title.max_length

marquee_popup_title.on_hoverEnum

1none

2pause

3play

marquee_popup_title.pause_duration

marquee_popup_title.scroll_speed

marquee_popup_title.separator

music_dir

orientation

player_type

show_status_icon

truncateEnum

1null

Example

2'none' | 'start' | 'middle' | 'end'

Example

3object

Example

object.length

object.max_length

object.modeRequired

truncate_popup_albumEnum

1null

Example

2'none' | 'start' | 'middle' | 'end'

Example

3object

Example

object.length

object.max_length

`cover_image_size`

`format`

`host`

`icon_size`

`icons`

`icons.album`

`icons.artist`

`icons.next`

`icons.pause`

`icons.play`

`icons.prev`

`icons.track`

`icons.volume`

`justify`

`marquee`

`marquee.enable`

`marquee.max_length`

`marquee.on_hover`Enum

1`none`

2`pause`

3`play`

`marquee.pause_duration`

`marquee.scroll_speed`

`marquee.separator`

`marquee_popup_album`

`marquee_popup_album.enable`

`marquee_popup_album.max_length`

`marquee_popup_album.on_hover`Enum

1`none`

2`pause`

3`play`

`marquee_popup_album.pause_duration`

`marquee_popup_album.scroll_speed`

`marquee_popup_album.separator`

`marquee_popup_artist`

`marquee_popup_artist.enable`

`marquee_popup_artist.max_length`

`marquee_popup_artist.on_hover`Enum

1`none`

2`pause`

3`play`

`marquee_popup_artist.pause_duration`

`marquee_popup_artist.scroll_speed`

`marquee_popup_artist.separator`

`marquee_popup_title`

`marquee_popup_title.enable`

`marquee_popup_title.max_length`

`marquee_popup_title.on_hover`Enum

1`none`

2`pause`

3`play`

`marquee_popup_title.pause_duration`

`marquee_popup_title.scroll_speed`

`marquee_popup_title.separator`

`music_dir`

`orientation`

`player_type`

`show_status_icon`

`truncate`Enum

1`null`

2`'none' | 'start' | 'middle' | 'end'`

3`object`

`object.length`

`object.max_length`

`object.mode`Required

`truncate_popup_album`Enum

1`null`

2`'none' | 'start' | 'middle' | 'end'`

3`object`

`object.length`

`object.max_length`

`object.mode`Required

`truncate_popup_artist`Enum

1`null`

2`'none' | 'start' | 'middle' | 'end'`

3`object`

`object.length`

`object.max_length`

`object.mode`Required

`truncate_popup_title`Enum