sound

package

v1.5.129 Latest Latest Go to latest Published: May 1, 2024 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Precache(s *splash.State) (splash.Status, error)

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

func (g *GroupedSound) CheckGC() dontgc.State

CheckGC checks if GC is currently allowed. Grouped sounds may be GC'd only while not playing.

func (g *GroupedSound) Close()

Close stops a grouped sound.

func (g *GroupedSound) IsPlayingNotForGameplay() bool

IsPlayingNotForGameplay returns whether the sound is currently playing. As this may depend on hardware, do not use this for gameplay.

func (g *GroupedSound) Play()

Play starts a grouped sound.

func (g *GroupedSound) PositionNotForGameplay() time.Duration

PositionNotForGameplay returns the current playback position. As this may depend on hardware, do not use this for gameplay.

func (g *GroupedSound) Reset()

Reset restarts a grouped sound.

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

Sound represents a sound effect.

func Load(name string) (*Sound, error)

Load loads a sound effect. Multiple Load calls to the same sound effect return the same cached instance.

func (s *Sound) DurationNotForGameplay() time.Duration

DurationNotForGameplay returns how long a sound takes. As this may depend on hardware, do not use this for gameplay.

func (s *Sound) Grouped() *GroupedSound

PlayGrouped starts the given sound effect in a grouped fashion.

func (s *Sound) Play() *audiowrap.Player

Play plays the given sound effect.

func (s *Sound) PlayAtVolume(vol float64) *audiowrap.Player

PlayAtVolume plays the given sound effect at the given volume.