README.md | 10 +++++++++- diff --git a/README.md b/README.md index 58cbf173cd1d9f40806644b7920e0779f0c76273..6675de3c9d3d68f908a25d036db3326216821c9d 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,13 @@ ch2 := pcm[i*channels+1] } ``` -For more examples, see the `_test.go` files. +### Vorbis (streams and files) + +To decode a .opus file (or .ogg with Opus data), or to decode a "Opus stream" +(which is a Ogg stream with Opus data), use the `Stream` interface. It wraps an +io.Reader providing the raw stream bytes and returns the decoded Opus data. + +See https://godoc.org/github.com/hraban/opus#Stream for further info. ### API Docs @@ -106,6 +112,8 @@ https://godoc.org/github.com/hraban/opus Full libopus C API reference: https://www.opus-codec.org/docs/opus_api-1.1.3/ + +For more examples, see the `_test.go` files. ## Build & installation