Skip to content

Commit 1af064e

Browse files
committed
Updated documentation
1 parent a4bb3ec commit 1af064e

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ You can compile both applications with `make cmd`which places the binaries into
5353
Use the `-help` option on either application to see the options.
5454

5555

56-
## The Media Transcoding API
56+
## Media Transcoding
5757

58-
The API is split into two parts:
58+
You can programmatically demultiplex, re-multiplex and re-sample media files using the following packages:
5959

6060
* `sys/ffmpeg51` provides the implementation of the lower-level function calls
6161
to ffmpeg. The documentation is [here](https://pkg.go.dev/github.com/mutablelogic/go-media/sys/ffmpeg51)
@@ -69,7 +69,15 @@ The API is split into two parts:
6969

7070
## Audio Fingerprinting
7171

72-
TODO
72+
You can programmatically fingerprint audio files, compare fingerprints and identify music using the following packages:
73+
74+
* `sys/chromaprint` provides the implementation of the lower-level function calls
75+
to chromaprint. The documentation is [here](https://pkg.go.dev/github.com/mutablelogic/go-media/sys/chromaprint)
76+
* `pkg/chromaprint` provides the higher-level API for fingerprinting and identifying music. The documentation
77+
is [here](https://pkg.go.dev/github.com/mutablelogic/go-media/pkg/chromaprint).
78+
79+
You'll need an API key in order to use the [AcoustID](https://acoustid.org/) service. You can get a key
80+
[here](https://acoustid.org/login).
7381

7482
## Contributing & Distribution
7583

@@ -80,7 +88,7 @@ The license is Apache 2 so feel free to redistribute. Redistributions in either
8088
code or binary form must reproduce the copyright notice, and please link back to this
8189
repository for more information:
8290

83-
> Copyright (c) 2021, David Thorpe, All rights reserved.
91+
> Copyright (c) 2021-2023 David Thorpe, All rights reserved.
8492
8593
## References
8694

0 commit comments

Comments
 (0)