audios

Documentation

Index

• func DecodeFromFile(fsys fs.FS, name string) (StreamSeekCloser, Format, error)
• type Format
  • func FormatFromFS(fsys fs.FS) (Format, error)
• type MusicPlayer
  • func NewMusicPlayer(f beep.StreamSeekCloser, format beep.Format, ratio float64) MusicPlayer
  • func NewMusicPlayerFromFile(fsys fs.FS, name string, ratio float64) (MusicPlayer, error)
  • func (mp *MusicPlayer) Close()
  • func (mp MusicPlayer) Duration() time.Duration
  • func (mp MusicPlayer) IsEmpty() bool
  • func (mp MusicPlayer) IsPaused() bool
  • func (mp MusicPlayer) IsPlayed() bool
  • func (mp *MusicPlayer) Pause()
  • func (mp *MusicPlayer) Play()
  • func (mp MusicPlayer) PlaybackRate() float64
  • func (mp *MusicPlayer) Resume()
  • func (mp *MusicPlayer) Rewind()
  • func (mp *MusicPlayer) SetPlaybackRate(ratio float64)
  • func (mp *MusicPlayer) SetVolume(vol float64)
  • func (mp MusicPlayer) Time() time.Duration
• type Sound
  • func NewSound(fsys fs.FS, name string, volumeScale *float64) Sound
  • func (s Sound) Play(vol float64)
• type SoundMap
  • func NewSoundMap(fsys fs.FS, format beep.Format, volumeScale *float64) SoundMap
  • func (sm *SoundMap) AppendSound(name string, streamer beep.StreamSeekCloser)
  • func (sm *SoundMap) AppendSoundFromFile(fsys fs.FS, name string) error
  • func (sm SoundMap) Len() int
  • func (sm SoundMap) Play(name string, vol float64)
  • func (sm *SoundMap) SetResampleRatio(ratio float64)
• type SoundPlayer
• type SoundPod
  • func NewSoundPod(fsys fs.FS, format beep.Format, volumeScale *float64) SoundPod
  • func (sp SoundPod) Play(vol float64)
• type StreamSeekCloser
• type Streamer
  • func NewSilence(duration time.Duration) Streamer

Functions

func DecodeFromFile

func DecodeFromFile(fsys fs.FS, name string) (StreamSeekCloser, Format, error)

Types

type Format

type Format = beep.Format

func FormatFromFS

func FormatFromFS(fsys fs.FS) (Format, error)

FormatFromFS returns the format of the first audio file in the file system. It is possible that there is no audio file in file system.

type MusicPlayer

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

func NewMusicPlayer

func NewMusicPlayer(f beep.StreamSeekCloser, format beep.Format, ratio float64) MusicPlayer

func NewMusicPlayerFromFile

func NewMusicPlayerFromFile(fsys fs.FS, name string, ratio float64) (MusicPlayer, error)

func (*MusicPlayer) Close

func (mp *MusicPlayer) Close()

func (MusicPlayer) Duration

func (mp MusicPlayer) Duration() time.Duration

func (MusicPlayer) IsEmpty

func (mp MusicPlayer) IsEmpty() bool

func (MusicPlayer) IsPaused

func (mp MusicPlayer) IsPaused() bool

func (MusicPlayer) IsPlayed

func (mp MusicPlayer) IsPlayed() bool

func (*MusicPlayer) Pause

func (mp *MusicPlayer) Pause()

func (*MusicPlayer) Play

func (mp *MusicPlayer) Play()

func (MusicPlayer) PlaybackRate

func (mp MusicPlayer) PlaybackRate() float64

func (*MusicPlayer) Resume

func (mp *MusicPlayer) Resume()

func (*MusicPlayer) Rewind

func (mp *MusicPlayer) Rewind()

func (*MusicPlayer) SetPlaybackRate

func (mp *MusicPlayer) SetPlaybackRate(ratio float64)

func (*MusicPlayer) SetVolume

func (mp *MusicPlayer) SetVolume(vol float64)

func (MusicPlayer) Time

func (mp MusicPlayer) Time() time.Duration

type Sound

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

Sound is for playing simple sound effects.

func NewSound

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

NewSound returns an empty struct when error occurs because most of error just comes from file not found.

func (Sound) Play

func (s Sound) Play(vol float64)

Play plays a random sound from the sound pod.

type SoundMap

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

func NewSoundMap

func NewSoundMap(fsys fs.FS, format beep.Format, volumeScale *float64) SoundMap

It is possible that there is no sounds in file system. Hence, selecting format from the first met sound in file system then do beep.NewBuffer(format) may cause error.

func (*SoundMap) AppendSound

func (sm *SoundMap) AppendSound(name string, streamer beep.StreamSeekCloser)

func (*SoundMap) AppendSoundFromFile

func (sm *SoundMap) AppendSoundFromFile(fsys fs.FS, name string) error

func (SoundMap) Len

func (sm SoundMap) Len() int

Len returns the number of sounds in SoundMap.

func (SoundMap) Play

func (sm SoundMap) Play(name string, vol float64)

func (*SoundMap) SetResampleRatio

func (sm *SoundMap) SetResampleRatio(ratio float64)

type SoundPlayer

type SoundPlayer interface {
	Play(vol float64)
}

SoundPlayer is an interface for playing sound. It is implemented by Sound and SoundPod.

type SoundPod

type SoundPod struct {
	SoundMap
}

SoundBag is for playing randomly one of the sounds.

func NewSoundPod

func NewSoundPod(fsys fs.FS, format beep.Format, volumeScale *float64) SoundPod

func (SoundPod) Play

func (sp SoundPod) Play(vol float64)

Play plays a random sound from the sound pod.

type StreamSeekCloser

type StreamSeekCloser = beep.StreamSeekCloser

type Streamer

type Streamer = beep.Streamer

func NewSilence

func NewSilence(duration time.Duration) Streamer