Burger::Sequencer::SongPackage Class Reference

Collaboration diagram for Burger::Sequencer::SongPackage:

Public Member Functions
	SongPackage ()
	Constructor for the song package.
	~SongPackage ()
	Destructor for the song package.
void	Shutdown (void)
	Dispose of all resources in the package.
void	RemoveInstrument (uint_t uInstrumentIndex)
	Remove an instrument from a song.

Static Public Member Functions
static SongPackage *	New (void)
	Allocate and initialize a SongPackage.

Public Attributes
PatternData_t *	m_pPartitions [cPatternMaxCount]
	Patterns.
SampleDescription *	m_pSampleDescriptions [cInstrumentMaxCount *cSampleMaxCount]
	Samples.
InstrData_t	m_InstrDatas [cInstrumentMaxCount]
	Instruments.
SongDescription_t	m_SongDescription
	Description of the entire song.
uint_t	m_bMusicUnderModification
	Tell the driver to NOT access music data.

Constructor & Destructor Documentation

SongPackage()

Burger::Sequencer::SongPackage::SongPackage

(

)

Constructor for the song package.

---

~SongPackage()

Burger::Sequencer::SongPackage::~SongPackage

(

)

Destructor for the song package.

---

Member Function Documentation

New()

Burger::Sequencer::SongPackage *BURGER_API Burger::Sequencer::SongPackage::New ( void )

static

Allocate and initialize a SongPackage.

---

Returns

A pointer to a default SongPackage class or NULL if out of memory

See also

Delete(const T *)

RemoveInstrument()

void BURGER_API Burger::Sequencer::SongPackage::RemoveInstrument

(

uint_t

uInstrumentIndex

)

Remove an instrument from a song.

---

Parameters

uInstrumentIndex

Which instrument number will be invalidated

Shutdown()

void BURGER_API Burger::Sequencer::SongPackage::Shutdown

(

void

)

Dispose of all resources in the package.

---

Release all allocated memory and reset the package to empty

Member Data Documentation

m_bMusicUnderModification

uint_t Burger::Sequencer::SongPackage::m_bMusicUnderModification

Tell the driver to NOT access music data.

m_InstrDatas

InstrData_t Burger::Sequencer::SongPackage::m_InstrDatas[cInstrumentMaxCount]

Instruments.

m_pPartitions

PatternData_t* Burger::Sequencer::SongPackage::m_pPartitions[cPatternMaxCount]

Patterns.

m_pSampleDescriptions

SampleDescription* Burger::Sequencer::SongPackage::m_pSampleDescriptions[cInstrumentMaxCount *cSampleMaxCount]

Samples.

m_SongDescription

SongDescription_t Burger::Sequencer::SongPackage::m_SongDescription

Description of the entire song.