AgateLib.AudioLib.Audio Class Reference

Static class which contains basic functions for playing sound and music. This is analogous to the static Display class, but playing audio files is much less complicated. More...

List of all members.

Public Member Functions
delegate void	AudioCoreEventDelegate ()
	Delegate type for events which are raised by this class.
Static Public Member Functions
static void	Initialize (AudioTypeID audioType)
	Initializes the audio system by instantiating the driver with the given AudioTypeID. The audio driver must be registered with the Registrar class.
static void	Dispose ()
	Disposes of the audio driver.
static void	StopAll ()
	Stops all sound and music currently playing.
static void	StopAllSounds ()
	Stops all sound effects playing. Music objects will continue playing.
static void	StopAllMusic ()
	Stops all music currently playing. Sound objects will continue playing.
static double	TransformByLog (double x)
	This is for use by drivers whose underlying technology does not provide a volume control which sounds linear.
static double	TransformByExp (double x)
	This is for use by drivers whose underlying technology does not provide a volume control which sounds linear.
static void	Update ()
	Updates audio information. There is no need to call this explicitly if you are calling Core.KeepAlive on a regular basis.
Properties
static AudioImpl	Impl [get]
	Gets the object which handles all of the actual calls to Audio functions.
Events
static AudioCoreEventDelegate	DisposeAudio
	Event that is called when Display.Dispose() is invoked, to shut down the display system and release all resources.

---

Detailed Description

Static class which contains basic functions for playing sound and music. This is analogous to the static Display class, but playing audio files is much less complicated.

---

Member Function Documentation

delegate void AgateLib.AudioLib.Audio.AudioCoreEventDelegate

(

)

Delegate type for events which are raised by this class.

static void AgateLib.AudioLib.Audio.Dispose

(

)

[static]

Disposes of the audio driver.

static void AgateLib.AudioLib.Audio.Initialize

(

AudioTypeID

audioType

)

[static]

Initializes the audio system by instantiating the driver with the given AudioTypeID. The audio driver must be registered with the Registrar class.

Parameters:

audioType

static void AgateLib.AudioLib.Audio.StopAll

(

)

[static]

Stops all sound and music currently playing.

static void AgateLib.AudioLib.Audio.StopAllMusic

(

)

[static]

Stops all music currently playing. Sound objects will continue playing.

static void AgateLib.AudioLib.Audio.StopAllSounds

(

)

[static]

Stops all sound effects playing. Music objects will continue playing.

static double AgateLib.AudioLib.Audio.TransformByExp

(

double

x

)

[static]

This is for use by drivers whose underlying technology does not provide a volume control which sounds linear.

Transforms the input in the range 0 to 1 by an exponential into the range of 0 to 1.

Parameters:

x

Returns:

static double AgateLib.AudioLib.Audio.TransformByLog

(

double

x

)

[static]

This is for use by drivers whose underlying technology does not provide a volume control which sounds linear.

Transforms the input in the range 0 to 1 by a logarithm into the range of 0 to 1.

Parameters:

x

Returns:

static void AgateLib.AudioLib.Audio.Update

(

)

[static]

Updates audio information. There is no need to call this explicitly if you are calling Core.KeepAlive on a regular basis.

---

Property Documentation

AudioImpl AgateLib.AudioLib.Audio.Impl [static, get]

Gets the object which handles all of the actual calls to Audio functions.

---

Event Documentation

AudioCoreEventDelegate AgateLib.AudioLib.Audio.DisposeAudio [static]

Event that is called when Display.Dispose() is invoked, to shut down the display system and release all resources.

---

The documentation for this class was generated from the following file:

• AudioLib/Audio.cs