AgateLib.AudioLib.Music Class Reference

A class which performs Music playback. More...

List of all members.

Public Member Functions
	Music (string filename)
	Constructs a Music object from a file.
	Music (IFileProvider fileProvider, string filename)
	Constructs a Music object from a file given by the specified IFileProvider.
	Music (Stream source)
	Constructs a Music object from a stream.
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

AgateLib.AudioLib.Music.Music

(

string

filename

)

Constructs a Music object from a file.

Parameters:

filename

The name of the file to load.

AgateLib.AudioLib.Music.Music	(	IFileProvider	fileProvider,
		string	filename
	)

Constructs a Music object from a file given by the specified IFileProvider.

Parameters:

	fileProvider
	filename

AgateLib.AudioLib.Music.Music

(

Stream

source

)

Constructs a Music object from a stream.

Parameters:

source

---

Member Function Documentation

void AgateLib.AudioLib.Music.Dispose

(

)

Destroys the unmanaged resources associated with this object.

void AgateLib.AudioLib.Music.Play

(

)

Begins playback.

void AgateLib.AudioLib.Music.Stop

(

)

Stops playback.

---

Property Documentation

string AgateLib.AudioLib.Music.Filename [get]

The name of the file this was loaded from.

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

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

bool AgateLib.AudioLib.Music.IsPlaying [get]

Returns true if this Music is currently playing.

double AgateLib.AudioLib.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.

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

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

---

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

• AudioLib/Music.cs