System.Taffybar.Widget.MPRIS2

This is a "Now Playing" widget that listens for MPRIS2 events on DBus. You can find the MPRIS2 specification here at (https://specifications.freedesktop.org/mpris-spec/latest/).

Documentation

mprisLog :: (MonadIO m, Show t) => Priority -> String -> t -> m ()

type WidgetAdder a m = (IsDescendantOf Widget a, MonadIO m, GObject a) => a -> m ()

A type representing a function that produces an IO action that adds the provided widget to some container.

type UpdateMPRIS2PlayerWidget a = (forall w. WidgetAdder w IO) -> Maybe a -> Maybe NowPlaying -> TaffyIO a

The type of a customization function that is used to update a widget with the provided now playing info. The type a should be the internal state used for the widget (typically just references to the child widgets that may need to be updated ). When the provided value is nothing, it means that the widget does not exist yet and it should be instantiated. When the provided NowPlaying value is Nothing, the dbus client is no longer, and typically the widget should be hidden.

data MPRIS2Config a

Configuration for an MPRIS2 Widget

Constructors

MPRIS2Config

Fields

• mprisWidgetWrapper :: Widget -> IO Widget

  A function that will be used to wrap the outer MPRIS2 grid widget

• updatePlayerWidget :: UpdateMPRIS2PlayerWidget a

  This function will be called to instantiate and update the player widgets of each dbus player client. See the docstring for UpdateMPRIS2PlayerWidget for more details.

defaultMPRIS2Config :: MPRIS2Config MPRIS2PlayerWidget

data MPRIS2PlayerWidget

Constructors

MPRIS2PlayerWidget

Fields

• playerLabel :: Label
• playerWidget :: Widget

data SimpleMPRIS2PlayerConfig

Constructors

SimpleMPRIS2PlayerConfig

Fields

• setNowPlayingLabel :: NowPlaying -> IO Text
• showPlayerWidgetFn :: NowPlaying -> IO Bool

Instances

Default SimpleMPRIS2PlayerConfig

Defined in System.Taffybar.Widget.MPRIS2

Methods

def :: SimpleMPRIS2PlayerConfig

defaultPlayerConfig :: SimpleMPRIS2PlayerConfig

makeExcept :: String -> (a -> IO (Maybe b)) -> a -> ExceptT String IO b

loadIconAtSize :: Client -> BusName -> Int32 -> IO Pixbuf

simplePlayerWidget :: SimpleMPRIS2PlayerConfig -> UpdateMPRIS2PlayerWidget MPRIS2PlayerWidget

This is the default player widget constructor that is used to build mpris widgets. It provides only an icon and NowPlaying text.

mpris2New :: TaffyIO Widget

Construct a new MPRIS2 widget using the simplePlayerWidget constructor.

mpris2NewWithConfig :: MPRIS2Config a -> TaffyIO Widget

Construct a new MPRIS2 widget with the provided configuration.

playingText :: MonadIO m => Int -> Int -> NowPlaying -> m Text

Generate now playing text with the artist truncated to a maximum given by the first provided int, and the song title truncated to a maximum given by the second provided int.