node-id3tag

node-id3tag is a ID3-Tag library written in JavaScript without other dependencies. It reads both ID3v2.3 and ID3v2.4 tags, and writes ID3v2.4 tags. It supports multi-value fields, and userDefined TXXX fields. It attempts to conform to tags written by foobar2000.

> Note: This project was originally forked from Zazama's project node-id3, and heavily modified to add read/write support for ID3v2.4. The underlying API is essentially unchanged.

Installation

``
npm install node-id3tag
`

Usage

`javascript
const NodeID3tag = require('node-id3tag')

/ Variables found in the following usage examples /

// file can be a buffer or string with the path to a file
let file = './path/to/(mp3)file' || new Buffer("Some Buffer of a (mp3) file")
let filebuffer = new Buffer("Some Buffer of a (mp3) file")
let filepath = './path/to/(mp3)file'
`

$3

`javascript
// Define the tags for your file using the ID (e.g. APIC) or the alias (see at bottom)
let tags = {
title: "Tomorrow",
artist: "Kevin Penkin",
album: "TVアニメ「メイドインアビス」オリジナルサウンドトラック",
APIC: "./example/mia_cover.jpg",
TRCK: "27"
}

// Create a ID3-Frame buffer from passed tags
// Synchronous
let ID3FrameBuffer = NodeID3tag.create(tags) // Returns ID3-Frame buffer
// Asynchronous
NodeID3tag.create(tags, function(frame) { })

// Write ID3-Frame into (.mp3) file
let success = NodeID3tag.write(tags, file) // Returns true/false or, if buffer passed as file, the tagged buffer
NodeID3tag.write(tags, file, function(err, buffer) { }) // Buffer is only returned if a buffer was passed as file

// Update existing ID3-Frame with new/edited tags
let success = NodeID3tag.update(tags, file) // Returns true/false or, if buffer passed as file, the tagged buffer
NodeID3tag.update(tags, file, function(err, buffer) { }) // Buffer is only returned if a buffer was passed as file
`

$3

`javascript
let tags = NodeID3tag.read(file)
NodeID3tag.read(file, function(err, tags) {
/*
tags: {
title: "Tomorrow",
artist: "Kevin Penkin",
image: {
mime: "jpeg",
type: {
id: 3,
name: "front cover"
},
description: String,
imageBuffer: Buffer
},
raw: {
TIT2: "Tomorrow",
TPE1: "Kevin Penkin",
APIC: Object (See above)
}
}
*/
})
`

$3

`javascript
let success = NodeID3tag.removeTags(filepath) // returns true/false
NodeID3tag.removeTags(filepath, function(err) { })

let bufferWithoutID3Frame = NodeID3tag.removeTagsFromBuffer(filebuffer) // Returns Buffer
`

Supported aliases


`
album:
bpm:
composer:
genre:
copyright:
date:
playlistDelay:
encodedBy:
textWriter:
fileType:
time:
contentGroup:
title:
subtitle:
initialKey:
language:
length:
mediaType:
originalTitle:
originalFilename:
originalTextwriter:
originalArtist:
originalYear:
fileOwner:
artist:
performerInfo:
conductor:
remixArtist:
partOfSet:
publisher:
trackNumber:
recordingDates:
internetRadioName:
internetRadioOwner:
size:
ISRC:
encodingTechnology:
year:
comment: {
language: "eng",
text: "mycomment"
}
unsynchronisedLyrics: {
language: "eng",
text: "lyrics"
}
image: {
mime: "png/jpeg"/undefined,
type: {
id: 3,
name: "front cover
}, //See https://en.wikipedia.org/wiki/ID3#ID3v2_embedded_image_extension
description: "image description",
imageBuffer: (file buffer)
}
`

$3

You can also use the currently supported raw tags like TALB instead of album etc.
`
album: "TALB"
bpm: "TBPM"
composer: "TCOM"
genre: "TCON"
copyright: "TCOP"
date: "TDAT"
playlistDelay: "TDLY"
encodedBy: "TENC"
textWriter: "TEXT"
fileType: "TFLT"
time: "TIME"
contentGroup: "TIT1"
title: "TIT2"
subtitle: "TIT3"
initialKey: "TKEY"
language: "TLAN"
length: "TLEN"
mediaType: "TMED"
originalTitle: "TOAL"
originalFilename: "TOFN"
originalTextwriter: "TOLY"
originalArtist: "TOPE"
originalYear: "TORY"
fileOwner: "TOWN"
artist: "TPE1"
performerInfo: "TPE2"
conductor: "TPE3"
remixArtist: "TPE4"
partOfSet: "TPOS"
publisher: "TPUB"
trackNumber: "TRCK"
recordingDates: "TRDA"
internetRadioName: "TRSN"
internetRadioOwner: "TRSO"
size: "TSIZ"
ISRC: "TSRC"
encodingTechnology: "TSSE"
year: "TYER"
comment: "COMM"
image: "APIC"
unsynchronisedLyrics "USLT"
``