From a1a36a351935ee9de7f34d6f0a01c0659fe2889d Mon Sep 17 00:00:00 2001 From: Hraban Luyat Date: Thu, 27 Oct 2016 16:39:39 +0100 Subject: [PATCH] Note (without example) about Stream in README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 58cbf17..6675de3 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,13 @@ for i := 0; i < n; i++ { } ``` -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 @@ -107,6 +113,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 This package requires libopus and libopusfile development packages to be -- 2.48.1