audios

Documentation

Index

• Constants
• Variables
• type MusicPlayer
  • func NewMusicPlayer(fsys fs.FS, name string) (MusicPlayer, error)
  • func (p MusicPlayer) Close()
• type Sound
  • func NewSound(fsys fs.FS, name string) Sound
  • func (s Sound) IsValid() bool
  • func (s Sound) Play(vol float64)
• type SoundBag
  • func NewSoundBag(fsys fs.FS, name string) SoundBag
  • func (sb SoundBag) Play(vol float64)
• type SoundPlayer
  • func NewSoundPlayer(fsys fs.FS, vol *float64) (s SoundPlayer)
  • func (s SoundPlayer) Play(name string, vol2 float64)
• type Sounder

Constants

const SampleRate = 44100

Variables

var Context = audio.NewContext(SampleRate)

Types

type MusicPlayer

type MusicPlayer struct {
	*audio.Player
	Closer func() error
}

func NewMusicPlayer

func NewMusicPlayer(fsys fs.FS, name string) (MusicPlayer, error)

func (MusicPlayer) Close

func (p MusicPlayer) Close()

type Sound

type Sound []byte

func NewSound

func NewSound(fsys fs.FS, name string) Sound

NewSound is for effect sounds, which is short. Long audio file will make the game stutter. No closers are related since no any files are open.

func (Sound) IsValid

func (s Sound) IsValid() bool

func (Sound) Play

func (s Sound) Play(vol float64)

type SoundBag

type SoundBag []Sound

SoundBag is for playing one of effects in the slice. Useful for playing slightly different effect when doing same actions.

func NewSoundBag

func NewSoundBag(fsys fs.FS, name string) SoundBag

Todo: remove redundancy with NewImages()?

func (SoundBag) Play

func (sb SoundBag) Play(vol float64)

type SoundPlayer

type SoundPlayer struct {
	Sounds map[string]Sound
	Volume *float64
}

A player for sample sound is generated at a place.

func NewSoundPlayer

func NewSoundPlayer(fsys fs.FS, vol *float64) (s SoundPlayer)

Todo: need a test

func (SoundPlayer) Play

func (s SoundPlayer) Play(name string, vol2 float64)

type Sounder

type Sounder interface {
	Play(vol float64)
}