From 27d2e7c3950e820092e0a326da726b981c612eda Mon Sep 17 00:00:00 2001 From: Hraban Luyat Date: Fri, 2 Sep 2016 11:38:03 +0100 Subject: [PATCH] Elaborate on stream comment --- stream.go | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/stream.go b/stream.go index 167b274..077ddf1 100644 --- a/stream.go +++ b/stream.go @@ -23,7 +23,12 @@ import "C" // Stream wraps a io.Reader in a decoding layer. It provides an API similar to // io.Reader, but it provides raw PCM data instead of the encoded Opus data. // -// This wraps the libopusfile library. +// This is not the same as directly decoding the bytes on the io.Reader; opus +// streams are Ogg Opus audio streams, which package raw Opus data. +// +// This wraps libopusfile. For more information, see the api docs on xiph.org: +// +// https://www.opus-codec.org/docs/opusfile_api-0.7/index.html type Stream struct { id uintptr oggfile *C.OggOpusFile -- 2.48.1