sdlaudio

Documentation

Overview

Package sdlaudio provides the Audio type. The Audio type implements the AudioMixer interface using SDL and is suitable for use with any SDL presenation.

Index

• Constants
• type Audio
  • func NewAudio() (*Audio, error)
  • func (aud *Audio) EndMixing() error
  • func (aud *Audio) Mute(muted bool)
  • func (aud *Audio) Reset()
  • func (aud *Audio) SetAudio(sig []signal.AudioSignalAttributes) error
  • func (aud *Audio) SetSpec(spec specification.Spec)
• type Preferences
  • func NewPreferences() (*Preferences, error)
  • func (p *Preferences) Load() error
  • func (p *Preferences) Save() error
  • func (p *Preferences) SetDefaults()
  • func (p *Preferences) String() string

Constants

const (
	QueueOkay    = 2000
	QueueWarning = 8000
)

Types

type Audio

type Audio struct {

	// audio preferences
	Prefs *Preferences

	QueuedBytes atomic.Int32
	// contains filtered or unexported fields
}

Audio outputs sound using SDL.

func NewAudio

func NewAudio() (*Audio, error)

NewAudio is the preferred method of initialisation for the Audio Type.

func (*Audio) EndMixing

func (aud *Audio) EndMixing() error

EndMixing implements the television.AudioMixer interface.

func (*Audio) Mute

func (aud *Audio) Mute(muted bool)

Mute silences the audio device.

func (*Audio) Reset

func (aud *Audio) Reset()

Reset implements the television.AudioMixer interface.

func (*Audio) SetAudio

func (aud *Audio) SetAudio(sig []signal.AudioSignalAttributes) error

SetAudio implements the television.AudioMixer interface.

func (*Audio) SetSpec

func (aud *Audio) SetSpec(spec specification.Spec)

SetSpec implements the television.RealtimeAudioMixer interface.

type Preferences

type Preferences struct {
	Stereo     prefs.Bool
	Discrete   prefs.Bool
	Separation prefs.Int
	// contains filtered or unexported fields
}

func NewPreferences

func NewPreferences() (*Preferences, error)

NewPreferences is the preferred method of initialisation for the Preferences type.

func (*Preferences) Load

func (p *Preferences) Load() error

Load disassembly preferences and apply to the current disassembly.

func (*Preferences) Save

func (p *Preferences) Save() error

Save current disassembly preferences to disk.

func (*Preferences) SetDefaults

func (p *Preferences) SetDefaults()

SetDefaults reverts all audio settings to default values.

func (*Preferences) String

func (p *Preferences) String() string