# acoustid

> Get music metadata from AcoustID Web Service

Latest version **1.2.1** (published 2014-09-10) · Public Domain license · 0 weekly downloads

## Install

```sh
npm install acoustid
pnpm add acoustid
yarn add acoustid
bun add acoustid
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.1 |
| Published | 2014-09-10 |
| First published | 2013-07-31 |
| Weekly downloads | 0 |
| License | Public Domain |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 29 |
| Author | Parsha Pourkhomami |
| Maintainers | parshap |
| Keywords | acoustid, music, audio, metadata, meta, mp3 |

## Links

- npm: https://www.npmjs.com/package/acoustid
- Repository: https://github.com/parshap/node-acoustid
- Issues: https://github.com/parshap/node-acoustid/issues
- npm.io page: https://npm.io/package/acoustid

## Dependencies (3)

- [fpcalc](https://npm.io/package/fpcalc.md) ^1.1.0
- [hyperquest](https://npm.io/package/hyperquest.md) ^0.3.0
- [concat-stream](https://npm.io/package/concat-stream.md) ^1.4.6

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.2.1 (latest) — 2014-09-10
- 1.2.0 — 2014-09-10
- 1.1.0 — 2013-08-21
- 1.0.0 — 2013-07-31

## README

# node-acoustid

Get MusicBrainz metadata for a given audio file via the [AcoustID Web
Service](http://acoustid.org/webservice).

# Example

```js
var acoustid = require("acoustid");
acoustid("./audio.mp3", { key: "8XaBELgH" }, callback);
function callback(err, results) {
	if (err) throw err;
	var artist = results[0].recordings[0].artists[0].name;
	console.log(artist);
}
```

# Documentation

## `acoustid(file, options, callback)`

Looks up information about the given audio file.

*File* must be the path to an audio file.

*Options* must be an object with the following keys:

 * `key`: Your AcoustID Web Service API Key (**required**)
 * `meta`: Meta parameter used in AcoustID API call (optional, default:
   all meta data) (see [docs](http://acoustid.org/webservice#lookup))
 * `fpcalc`: Passed to *fpcalc* as options (optional, see [*fpcalc*
   docs][fpcalc docs])

*Callback* must be a function that will be called with `callback(err,
results)`.

# Installation 

This module depends on [node-fpcalc][fpcalc] to calculate audio
fingerprints. **The [*fpcalc* command-line
tool](http://acoustid.org/chromaprint) must be installed.** This is
often available via your package manager (e.g., `apt-get install
libchromaprint-tools` or `brew install chromaprint`).

```
npm install acoustid
```

[fpcalc]: https://github.com/parshap/node-fpcalc
[fpcalc docs]: https://github.com/parshap/node-fpcalc#api

---
_Source: https://npm.io/package/acoustid · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._