ERY.AgateLib.Music Class Reference

A class which performs Music playback. More...

List of all members.

Public Member Functions
	Music (string filename)
	Constructs a Music object.
void	Dispose ()
	Destroys the unmanaged resources associated with this object.
void	Play ()
	Begins playback.
void	Stop ()
	Stops playback.
Properties
bool	IsLooping [get, set]
	Returns whether or not this Music object is playing in a loop.
string	Filename [get]
	The name of the file this was loaded from.
double	Volume [get, set]
	Gets or sets the volume. Range is: 0.0 Quiet 0.5 Sounds half volume 1.0 Full volume.
double	Pan [get, set]
	Gets or sets the left-right balance. This may or may not be supported by some drivers. -1 is entirely in the left speaker, 0 is equally in both and, 1 is entirely in the right speaker.
bool	IsPlaying [get]
	Returns true if this Music is currently playing.

---

Detailed Description

A class which performs Music playback.

This class should support loading of .ogg and .mid files, at the very least.

---

Constructor & Destructor Documentation

ERY.AgateLib.Music.Music

(

string

filename

)

Constructs a Music object.

---

Member Function Documentation

void ERY.AgateLib.Music.Dispose

(

)

Destroys the unmanaged resources associated with this object.

void ERY.AgateLib.Music.Play

(

)

Begins playback.

void ERY.AgateLib.Music.Stop

(

)

Stops playback.

---

Property Documentation

bool ERY.AgateLib.Music.IsLooping [get, set]

Returns whether or not this Music object is playing in a loop.

string ERY.AgateLib.Music.Filename [get]

The name of the file this was loaded from.

double ERY.AgateLib.Music.Volume [get, set]

Gets or sets the volume. Range is: 0.0 Quiet 0.5 Sounds half volume 1.0 Full volume.

double ERY.AgateLib.Music.Pan [get, set]

Gets or sets the left-right balance. This may or may not be supported by some drivers. -1 is entirely in the left speaker, 0 is equally in both and, 1 is entirely in the right speaker.

bool ERY.AgateLib.Music.IsPlaying [get]

Returns true if this Music is currently playing.

---

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

• E:/Devel/AgateLib/trunk/src/Audio.cs

---

AgateLib Awesome Game and Tool Engine Library