XSPF Playlist

Automagic XSPF Playlists

Generate an XSPF playlist file for audio and video files and autofill track details from ID3 tags.

Usage

  $ npm install -g xspf-playlist
  
  $ xspf-playlist 'path/to/media' '{"id3": false}' > playlist.xspf

Place media files into a directory (often named media) and pass it to xspf-playlist. Your media directory will be scanned and exported into an XSPF playlist file automatically. That's it!

Nested directories can be treated as the <artist> and <album> fields with a hierarchy like media/artist/album/track.xxx

xspfPlaylist( media, [{ options }], [ callback( err, res ) ])

Accepts either a directory path as a string or an array of track objects as media input. A callback API is provided. Returns a Promise which resolves to a string.

const xspfPlaylist = require('xspf-playlist')
 
// Scanning a directory
xspfPlaylist('/media', {'id3': true, 'depth': 0})
    .then(console.log)

Or, using a callback

xspfPlaylist('/media', function (err, res) {
    console.log(res)
})

Example passing an object

xspfPlaylist([
    {
        title: 'file1',
        location: 'file1.mp3'
    },
    ...
]).then(console.log)

Tracks will be titled by their filename, sans-extension. Additional creator and album information can be provided by organizing your files into a media/creator/album/title.xxx hierarchy.

An image may be associated with a track by giving it the same filename. To associate one image with an entire folder of tracks, give it the filename artwork. artwork images associate themselves to every sibling and child directory and may be placed anywhere in your media directory hierarchy, so an artwork.jpg in the media directory will act as a global image, filling in for every track that did not already have one provided.

ID3

By default, supported files will be scanned for ID3 tag info which will automatically fill the following track information if present:

• title
• artist
• album
• year
• comment
• track
• genre
• picture
• lyrics

Tag readers

• ID3v1
• ID3v2 (with unsynchronisation support!)
• MP4
• FLAC

File Types

Supports mp3, wav, and ogg audio and mp4, webm, and ogv video formats.

Options

options is a valid JSON object.

id3

boolean

By default, the jsmediatags library is used to scan mp3 files and will automatically use the meta information associated with a track, rather than the menu directory hierarchy. This feature can be disabled by passing id3: false in the options parameter.

depth

integer

By default, this tool will scan two directories deep (in order to accomodate media/creator/album/title.ext formats). You can manually set the search depth by passing an integer to the depth option. 0 means no recursion, will only search the supplied directory.

Default options

{"id3": true, "depth": 2}

Related

• Used by: lacymorrow/xspf-jukebox

• lacymorrow/xspf-playlister-php

• lacymorrow/xspf-playlister-py

License

MIT © Lacy Morrow