Back to godoc.org

Package wav

v1.11.7
Latest Go to latest
Published: 5 hours ago | License: Apache-2.0 | Module: github.com/hajimehoshi/ebiten

Overview

Package wav provides WAV (RIFF) decoder.

Index

Package Files

type Stream

type Stream struct {
	// contains filtered or unexported fields
}

Stream is a decoded audio stream.

func Decode

func Decode(context *audio.Context, src audio.ReadSeekCloser) (*Stream, error)

Decode decodes WAV (RIFF) data to playable stream.

The format must be 1 or 2 channels, 8bit or 16bit little endian PCM. The format is converted into 2 channels and 16bit.

Decode returns error when decoding fails or IO error happens.

Decode automatically resamples the stream to fit with the audio context if necessary.

Decode takes the ownership of src, and Stream's Close function closes src.

func (*Stream) Close

func (s *Stream) Close() error

Read is implementation of io.Closer's Close.

func (*Stream) Length

func (s *Stream) Length() int64

Length returns the size of decoded stream in bytes.

func (*Stream) Read

func (s *Stream) Read(p []byte) (int, error)

Read is implementation of io.Reader's Read.

func (*Stream) Seek

func (s *Stream) Seek(offset int64, whence int) (int64, error)

Seek is implementation of io.Seeker's Seek.

Note that Seek can take long since decoding is a relatively heavy task.

func (*Stream) Size

func (s *Stream) Size() int64

Size is deprecated as of version 1.6.0-alpha. Use Length instead.

Documentation was rendered with GOOS=linux and GOARCH=amd64.

Jump to identifier

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to identifier