MMM-ShairportMetadata

This is a stripped-down version forked from surekap. This metadata module would be a drop-in replacement for the default compliment module. It can also display lyrics for apps (e.g. netease music, qq music, et al.) that support outputing lyrics to the title field of the metadata.

A module to integrate AirPlay metadata coming via shairport-sync into the MagicMirror. This plugin does not work with video streaming or screen mirroring.

Preview

This module replaces the default compliment module to display lyrics (requires supported apps) for music fans!

Using the module

Add MMM-ShairportMetadata module to the modules array in the config/config.js file:

modules: [
  {
    module: 'MMM-ShairportMetadata',
    position: 'middle_center',
    config: {
      metadataPipe: "/tmp/shairport-sync-metadata", // location of pipe with shairport-sync metadata
	  alignment: "center",	// Possible values [left|right|center]. Default: center
    }
  },
]

Integration with shairport-sync

Example configuration for shairport-sync:

metadata =
{
		enabled = "yes"; // set to yes to get Shairport Sync to solicit metadata from the source and to pass it on via a pipe
		include_cover_art = "yes"; // set to "yes" to get Shairport Sync to solicit cover art from the source and pass it via the pipe. You must also set "enabled" to "yes".
		pipe_name = "/tmp/shairport-sync-metadata";
		pipe_timeout = 5000; // wait for this number of milliseconds for a blocked pipe to unblock before giving up
//      socket_address = "226.0.0.1"; // if set to a host name or IP address, UDP packets containing metadata will be sent to this address. May be a multicast address. "socket-port" must be non-zero and "enabled" must be set to yes"
//      socket_port = 5555; // if socket_address is set, the port to send UDP packets to
//      socket_msglength = 65000; // the maximum packet size for any UDP metadata. This will be clipped to be between 500 or 65000. The default is 500.
};