Package Exports
- musicmetadata
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (musicmetadata) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Installation
Install via npm:
npm install musicmetadata
Supports
mp3 (1.1, 2.2, 2.3, 2.4), m4a(mp4), vorbis (ogg, flac)
API
var fs = require('fs'),
musicmetadata = require('musicmetadata');
//create a new parser from a node ReadStream
var parser = new musicmetadata(fs.createReadStream('sample.mp3'));
//listen for the metadata event
parser.on('metadata', function(result) {
console.log(result);
});
This will output the standard music metadata:
{ artist : 'Spor',
album : 'Nightlife, Vol 5.',
albumartist : [ 'Andy C', 'Spor' ],
title : 'Stronger',
year : '2010',
track : { no : 1, of : 44 },
disk : { no : 1, of : 2 },
picture : [ { format : 'jpg', data : <Buffer> } ]
}
If you just want the artist - listen for the artist event:
parser.on('artist', function(result) {
console.log(result);
});
You can also listen for custom metadata types that are not part of the standard metadata as defined above. For example if you wanted to read the TLEN frame from a id3v2.x file you can do this:
parser.on('TLEN', function(result) {
console.log(result);
});
The done
event will be raised when parsing has finished or an error has occurred. This could be
used to disconnect from the stream as soon as parsing has finished, saving bandwidth.
parser.on('done', function(err) {
if (err) throw err;
stream.destroy();
});
Changelog
v0.1.2
- Fixed id3v1.1 implementation
- Implemented multiple artwork support (id4)
- Added flac support
v0.1.1
- Better utf-16 handling
- Now reads iso-8859-1 encoded id3 frames correctly
- Artwork is now part of the 'metadata' event