audio: add Ctrl doc comments

This commit is contained in:
faiface 2017-07-12 22:43:55 +02:00
parent 82afa289f4
commit 3a40ec4435
1 changed files with 35 additions and 0 deletions

View File

@ -2,12 +2,46 @@ package audio
import "time"
// Ctrl allows for pausing and tracking a Streamer.
//
// Wrap a Streamer in a Ctrl.
//
// ctrl := &audio.Ctrl{Streamer: s}
//
// Then, we can pause the streaming (this will cause Ctrl to stream silence).
//
// ctrl.Paused = true
//
// And we can check how much has already been streamed. Position is not incremented when the Ctrl is
// paused.
//
// fmt.Println(ctrl.Position)
//
// To completely stop a Ctrl before the wrapped Streamer is drained, just set the wrapped Streamer
// to nil.
//
// ctrl.Streamer = nil
//
// If you're playing a Streamer wrapped in a Ctrl through the speaker, you need to lock and unlock
// the speaker when modifying the Ctrl to avoid race conditions.
//
// speaker.Play(ctrl)
// // ...
// speaker.Lock()
// ctrl.Paused = true
// speaker.Unlock()
// // ...
// speaker.Lock()
// fmt.Println(ctrl.Position)
// speaker.Unlock()
type Ctrl struct {
Streamer Streamer
Paused bool
Position time.Duration
}
// Stream streams the wrapped Streamer, if not nil. If the Streamer is nil, Ctrl acts as drained.
// When paused, Ctrl streams silence.
func (c *Ctrl) Stream(samples [][2]float64) (n int, ok bool) {
if c.Streamer == nil {
return 0, false
@ -23,6 +57,7 @@ func (c *Ctrl) Stream(samples [][2]float64) (n int, ok bool) {
return n, ok
}
// Err returns the error of the wrapped Streamer, if not nil.
func (c *Ctrl) Err() error {
if c.Streamer == nil {
return nil