Categorygithub.com/microidea/beep
modulepackage
1.0.3
Repository: https://github.com/microidea/beep.git
Documentation: pkg.go.dev

# README

# Packages

Package effects provides additional audio effects for the Beep library.
No description provided by the author
Package flac implements audio data decoding in FLAC format.
Package mp3 implements audio data decoding in MP3 format.
Package speaker implements playback of beep.Streamer values through physical speakers.
Package vorbis implements audio data decoding in oggvorbis format.
Package wav implements audio data decoding and encoding in WAVE format.

# Functions

Callback returns a Streamer, which does not stream any samples, but instead calls f the first time its Stream method is called.
Dup returns two Streamers which both stream the same data as the original s.
Iterate returns a Streamer which successively streams Streamers obtains by calling the provided g function.
Loop takes a StreamSeeker and plays it count times.
Mix takes zero or more Streamers and returns a Streamer which streams them mixed together.
NewBuffer creates a new empty Buffer which stores samples in the provided format.
Resample takes a Streamer which is assumed to stream at the old sample rate and returns a Streamer, which streams the data from the original Streamer resampled to the new sample rate.
ResampleRatio is same as Resample, except it takes the ratio of the old and the new sample rate, specifically, the old sample rate divided by the new sample rate.
Seq takes zero or more Streamers and returns a Streamer which streams them one by one without pauses.
Silence returns a Streamer which streams num samples of silence.
Take returns a Streamer which streams at most num samples from s.

# Structs

Buffer is a storage for audio data.
Ctrl allows for pausing a Streamer.
Format is the format of a Buffer or another audio source.
Mixer allows for dynamic mixing of arbitrary number of Streamers.
Resampler is a Streamer created by Resample and ResampleRatio functions.

# Interfaces

StreamCloser is a Streamer streaming from a resource which needs to be released, such as a file or a network connection.
Streamer is able to stream a finite or infinite sequence of audio samples.
StreamSeekCloser is a union of StreamSeeker and StreamCloser.
StreamSeeker is a finite duration Streamer which supports seeking to an arbitrary position.

# Type aliases

SampleRate is the number of samples per second.
StreamerFunc is a Streamer created by simply wrapping a streaming function (usually a closure, which encloses a time tracking variable).