interesting
/
go-opengl-pixel
mirror of https://github.com/faiface/pixel.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

audio: wav: add doc comments

This commit is contained in:
faiface 2017-07-12 21:30:35 +02:00
parent 502347d987
commit 82afa289f4
1 changed files with 7 additions and 0 deletions
audio/wav
decode.go

7
audio/wav/decode.go
View File

@ -1,3 +1,4 @@
// Package wav implements audio data decoding in WAVE format through an audio.StreamSeekCloser.
package wav package wav
import ( import (
@ -10,12 +11,18 @@ import (
"github.com/pkg/errors" "github.com/pkg/errors"
) )
// ReadSeekCloser is a union of io.Reader, io.Seeker and io.Closer.
type ReadSeekCloser interface { type ReadSeekCloser interface {
io.Reader io.Reader
io.Seeker io.Seeker
io.Closer io.Closer
} }
// Decode takes a ReadSeekCloser containing audio data in WAVE format and returns a
// StreamSeekCloser, which streams that audio.
//
// Do not close the supplied ReadSeekCloser, instead, use the Close method of the returned
// StreamSeekCloser when you want to release the resources.
func Decode(rsc ReadSeekCloser) (s audio.StreamSeekCloser, err error) { func Decode(rsc ReadSeekCloser) (s audio.StreamSeekCloser, err error) {
var d decoder var d decoder
d.rsc = rsc d.rsc = rsc