ERY.AgateLib.ImplBase.MusicImpl Class Reference

Class which implements a Music object. More...

Inherited by ERY.AgateLib.NullSoundImpl.NullMusicImpl.

List of all members.

Public Member Functions
abstract void	Dispose ()
	Dispose.
abstract void	Play ()
	Start over at beginning.
abstract void	Stop ()
	Stop playing.
Protected Member Functions
abstract void	OnSetLoop (bool value)
	Function called when IsLooping is set to a new value.
Properties
bool	IsLooping [get, set]
	Gets or sets whether or not this Music is looping.
abstract double	Volume [get, set]
	Gets or sets the volume this audio file is playing at. 0.0 is completely quiet. 0.5 sounds like half maximum volume 1.0 is maximum volume.
abstract 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.
abstract bool	IsPlaying [get]
	Gets whether or not it's currently playing.

---

Detailed Description

Class which implements a Music object.

---

Member Function Documentation

abstract void ERY.AgateLib.ImplBase.MusicImpl.OnSetLoop

(

bool

value

)

[protected, pure virtual]

Function called when IsLooping is set to a new value.

Parameters:

value

Implemented in ERY.AgateLib.NullSoundImpl.NullMusicImpl.

abstract void ERY.AgateLib.ImplBase.MusicImpl.Dispose

(

)

[pure virtual]

Dispose.

Implemented in ERY.AgateLib.NullSoundImpl.NullMusicImpl.

abstract void ERY.AgateLib.ImplBase.MusicImpl.Play

(

)

[pure virtual]

Start over at beginning.

Implemented in ERY.AgateLib.NullSoundImpl.NullMusicImpl.

abstract void ERY.AgateLib.ImplBase.MusicImpl.Stop

(

)

[pure virtual]

Stop playing.

Implemented in ERY.AgateLib.NullSoundImpl.NullMusicImpl.

---

Property Documentation

bool ERY.AgateLib.ImplBase.MusicImpl.IsLooping [get, set]

Gets or sets whether or not this Music is looping.

abstract double ERY.AgateLib.ImplBase.MusicImpl.Volume [get, set]

Gets or sets the volume this audio file is playing at. 0.0 is completely quiet. 0.5 sounds like half maximum volume 1.0 is maximum volume.

Reimplemented in ERY.AgateLib.NullSoundImpl.NullMusicImpl.

abstract double ERY.AgateLib.ImplBase.MusicImpl.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.

If this is unsupported by the driver, don't allow impl.Pan to change from zero.

Reimplemented in ERY.AgateLib.NullSoundImpl.NullMusicImpl.

abstract bool ERY.AgateLib.ImplBase.MusicImpl.IsPlaying [get]

Gets whether or not it's currently playing.

Reimplemented in ERY.AgateLib.NullSoundImpl.NullMusicImpl.

---

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

• E:/Devel/AgateLib/trunk/src/ImplBase/AudioImpl.cs

---

AgateLib Awesome Game and Tool Engine Library