AgateLib.AudioLib.SoundBufferSession Class Reference

A class which represents a playback instance of a SoundBuffer object. More...

List of all members.

Public Member Functions
void	Dispose ()
	Destroys the unmanaged resources associated with this object.
void	Play ()
	Begins playback of the SoundBufferSession object.
void	Stop ()
	Stops playback.
Properties
SoundBufferSessionImpl	Impl [get]
	Returns the implemented object.
SoundBuffer	Source [get]
	Returns the SoundBuffer object which created this SoundBufferSession.
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. -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 Session is playing.
bool	Recycle [get, set]
	Gets or sets a bool value which indicates whether or not this SoundBufferSession object should be recycled when it is done playing.

---

Detailed Description

A class which represents a playback instance of a SoundBuffer object.

After a SoundBufferSession is done playing, it may be recycled if its parent SoundBuffer object's Play or CreateSession methods are called. This behavior can be suppressed by setting the Recycle property to false. If you do this, you are responsible for freeing the unmanaged resources on the SoundBufferSession by calling its Dispose method.

---

Member Function Documentation

void AgateLib.AudioLib.SoundBufferSession.Dispose

(

)

Destroys the unmanaged resources associated with this object.

void AgateLib.AudioLib.SoundBufferSession.Play

(

)

Begins playback of the SoundBufferSession object.

void AgateLib.AudioLib.SoundBufferSession.Stop

(

)

Stops playback.

---

Property Documentation

SoundBufferSessionImpl AgateLib.AudioLib.SoundBufferSession.Impl [get]

Returns the implemented object.

bool AgateLib.AudioLib.SoundBufferSession.IsPlaying [get]

Returns true if this Session is playing.

double AgateLib.AudioLib.SoundBufferSession.Pan [get, set]

Gets or sets the left-right balance. -1 is entirely in the left speaker, 0 is equally in both and, 1 is entirely in the right speaker.

bool AgateLib.AudioLib.SoundBufferSession.Recycle [get, set]

Gets or sets a bool value which indicates whether or not this SoundBufferSession object should be recycled when it is done playing.

If you set this to false, you should Dispose the SoundBufferSession object yourself when you're done with it.

SoundBuffer AgateLib.AudioLib.SoundBufferSession.Source [get]

Returns the SoundBuffer object which created this SoundBufferSession.

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