sounds

Documentation

Overview

Provides a way to play sound effects

Index

• Constants
• Variables
• type Sound
  • func NewSound(name string, buffers bufferList, selector int, volume int) Sound
• type SoundPlayer
  • func NewPlayer(name string, cfg common.Config) (SoundPlayer, error)

Constants

const (
	SELECT_SINGLE int = iota
	SELECT_RANDOM
	SELECT_SEQUENCE
)

Variables

var ErrSoundNotFound = errors.New("sound could not be found")

Types

type Sound

type Sound interface {
	Play()
	Loop()
	Unloop()
	GetName() string

	GetBufferCount() int
	// contains filtered or unexported methods
}

Sound is a playable sound effect

func NewSound

func NewSound(name string, buffers bufferList, selector int, volume int) Sound

NewSound returns a new playable sound object with a given name, a list of buffers and the method used to select one of the buffers when the song is played.

type SoundPlayer

type SoundPlayer interface {
	ListSounds() []string
	GetSound(name string) (Sound, error)
	LoadSounds(root string) error
}

SoundPlayer is a collection of playable sound effects

func NewPlayer

func NewPlayer(name string, cfg common.Config) (SoundPlayer, error)

NewPlayer returns a new SoundPlayer object with the given name according to the provided config. (see pkg/common/config.go)