https://github.com/surekap/MMM-ShairportMetadata

AirTunes metadata module for MagicMirror
https://github.com/surekap/MMM-ShairportMetadata

Last synced: 3 months ago
JSON representation

AirTunes metadata module for MagicMirror

• Host: GitHub
• URL: https://github.com/surekap/MMM-ShairportMetadata
• Owner: surekap
• License: mit
• Created: 2017-01-29T21:18:48.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2020-07-07T22:28:56.000Z (over 4 years ago)
• Last Synced: 2024-06-29T08:36:07.354Z (5 months ago)
• Language: JavaScript
• Size: 283 KB
• Stars: 17
• Watchers: 3
• Forks: 10
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-mmm - **MMM-ShairportMetadata**

README

        
# MMM-ShairportMetadata

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

![preview](preview.jpg)

This version finally includes a progress bar!

## Using the module

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

``` javascript

modules: [

  {

    module: 'MMM-ShairportMetadata',

    position: 'bottom_left',

    header: 'Now playing',

    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`:

``` javascript

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.

};

```