TriDevs.TriEngine.Audio.Song Class Reference

Song class that can be used with AudioManager. More...

Inheritance diagram for TriDevs.TriEngine.Audio.Song:

Collaboration diagram for TriDevs.TriEngine.Audio.Song:

Public Member Functions
void	Dispose ()
void	Play ()
	Starts playback of the song. More...
void	Stop ()
	Stops playback of the song. More...
void	Pause ()
	Pauses playback of the song. More...
void	Resume ()
	Resumes playback of a paused song. More...

Properties
string	Name [get]
string	File [get]
float	Volume [get, set]
bool	IsLooped [get, set]
Properties inherited from TriDevs.TriEngine.Audio.ISong
string	File [get]
	Gets the file this song was loaded from. More...
float	Volume [get, set]
	Gets or sets the song volume. More...
bool	IsLooped [get, set]
	Gets or sets a value indicating that the song should be looped once it reaches the end. More...
Properties inherited from TriDevs.TriEngine.Resources.IResource
string	Name [get]
	Gets the name associated with this resource. More...

Detailed Description

Song class that can be used with AudioManager.

The song class will stream from a specified file, instead of loading it into memory.

Member Function Documentation

void TriDevs.TriEngine.Audio.Song.Dispose

(

)

        {
            if (_stream == null)
                return;

            Stop();
            _stream.Dispose();
            _stream = null;
        }

void TriDevs.TriEngine.Audio.Song.Pause

(

)

Pauses playback of the song.

Call the Resume or Play method to resume playback.

Implements TriDevs.TriEngine.Audio.ISong.

        {
            _stream.Pause();
        }

void TriDevs.TriEngine.Audio.Song.Play

(

)

Starts playback of the song.

Implements TriDevs.TriEngine.Audio.ISong.

        {
            try
            {
                _stream.Play();
            }
            catch (InvalidDataException)
            {
                Stop();
                Play();
            }
        }

void TriDevs.TriEngine.Audio.Song.Resume

(

)

Resumes playback of a paused song.

Implements TriDevs.TriEngine.Audio.ISong.

        {
            _stream.Resume();
        }

void TriDevs.TriEngine.Audio.Song.Stop

(

)

Stops playback of the song.

Implements TriDevs.TriEngine.Audio.ISong.

        {
            _stream.Stop();
        }

Property Documentation

string TriDevs.TriEngine.Audio.Song.File

get

bool TriDevs.TriEngine.Audio.Song.IsLooped

getset

string TriDevs.TriEngine.Audio.Song.Name

get

float TriDevs.TriEngine.Audio.Song.Volume

getset

---

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

• TriDevs.TriEngine/Audio/Song.cs