Read and write media metadata using ffmpeg's metadata framework.
var ffmetadata = ;// Read song.mp3 metadataffmetadata;// Set the artist for song.mp3var data =artist: "Me";ffmetadata;
You can optionally include an array of files to be added to the source file. This is a destructive action, it will overwrite any previous streams on the file. For audio data, this is typically just one image. For video, this is where you would write additional audio streams or subtitle tracks.
var options =attachments: "cover.jpg";ffmetadata;
Metadata might include the following fields:
"artist": artist name
"album": album name
"title": song title
"track": place in the album (e.g.
"disc": for multidisc albums
"label": record label
"date": arbitrary, but usually year (e.g.
See FFmpeg Metadata for details.
ffmetadata.read(file, [options], callback)
callback function is called (
callback(err, data)) with an error
or an object containing metadata from
options.dryRun is truthy, the
ffmpeg process is not actually
invoked and instead an array of the arguments that would have been
used to invoke ffmpeg is returned synchronously. The
argument is not used in this case.
options.coverPath: Option to provide a path, where
ffmpeg will save cover image. Unfortunately,
ffmpeg will always convert resulted image, based on extension in provided
ffmetadata.write(file, data, [options], callback)
Write metadata to
file and optionally append additional attachments
(e.g., artwork image).
data object should contain metadata fields supported by FFmpeg.
See the metadata section above for more information.
options object may be provided with any of the following fields:
options.attachments: An array of files that should be appended as additional streams to the output. This can be used to e.g., attach artwork images; see the artwork section above for more information.
options["id3v2.3"]: If this property is truthy, id3 v2.3 will be used (instead of the default of v2.4). This is useful if compatibility with Windows Explorer is desired (see #8).
options.dryRun: If this property is truthy, the
ffmpegprocess is not actually invoked and instead an array of the arguments that would have been used to invoke ffmpeg is returned synchronously. The
callbackargument is not used in this case.
callback(err) is called when finished, with an error if one occurred.
FFMPEG_PATH: Path to
ffmpeg executable. Useful on Windows or when
ffmpeg is not in your
npm install ffmetadata