AgateLib.ImplementationBase.MusicImpl Class Reference

Class which implements a Music object. More...

Inherited by AgateLib.Drivers.NullSoundImpl.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 AgateLib.ImplementationBase.MusicImpl.Dispose

(

)

[pure virtual]

Dispose.

abstract void AgateLib.ImplementationBase.MusicImpl.OnSetLoop

(

bool

value

)

[protected, pure virtual]

Function called when IsLooping is set to a new value.

Parameters:

value

abstract void AgateLib.ImplementationBase.MusicImpl.Play

(

)

[pure virtual]

Start over at beginning.

abstract void AgateLib.ImplementationBase.MusicImpl.Stop

(

)

[pure virtual]

Stop playing.

---

Property Documentation

bool AgateLib.ImplementationBase.MusicImpl.IsLooping [get, set]

Gets or sets whether or not this Music is looping.

abstract bool AgateLib.ImplementationBase.MusicImpl.IsPlaying [get]

Gets whether or not it's currently playing.

abstract double AgateLib.ImplementationBase.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.

abstract double AgateLib.ImplementationBase.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.

---

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

• ImplementationBase/AudioImpl.cs