This implements a data class that can be used for the CS sound system to play a song from a musical sheet. More...

#include <songdata.h>

Public Member Functions
virtual iSndSysStream *	CreateStream (csSndSysSoundFormat *renderFormat, int mode3D)
virtual size_t	GetDataSize ()
	Return the size of the song in bytes.
virtual const char *	GetDescription ()
virtual const csSndSysSoundFormat *	GetFormat ()
virtual size_t	GetFrameCount ()
	Return the size of the song in frames.
bool	Initialize (csRef< iDocument > musicalScore)
	Reads the given musical sheet and extract all the necessary data from it.
virtual void	SetDescription (const char *description)
	SndSysSongData (Instrument *instrument)
	Constructor.
	~SndSysSongData ()
	Destructor.

Detailed Description

This implements a data class that can be used for the CS sound system to play a song from a musical sheet.

Definition at line 78 of file songdata.h.

Constructor & Destructor Documentation

SndSysSongData::SndSysSongData ( Instrument * instrument )

Constructor.

Parameters:

instrument the instrument used to play the song.

SndSysSongData::~SndSysSongData ( )

Destructor.

virtual iSndSysStream* SndSysSongData::CreateStream	(	csSndSysSoundFormat *	renderFormat,
		int	mode3D
	)		`[virtual]`

virtual size_t SndSysSongData::GetDataSize ( ) [virtual]

Return the size of the song in bytes.

virtual const char* SndSysSongData::GetDescription ( ) [virtual]

virtual const csSndSysSoundFormat* SndSysSongData::GetFormat ( ) [virtual]

virtual size_t SndSysSongData::GetFrameCount ( ) [virtual]

Return the size of the song in frames.

bool SndSysSongData::Initialize ( csRef< iDocument > musicalScore )

Reads the given musical sheet and extract all the necessary data from it.

Parameters:

musicalScore the musical score.

virtual void SndSysSongData::SetDescription ( const char * description ) [virtual]

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