Burger::Sequencer::SampleDescription Class Reference

A buffer describing digital sample for an instrument. More...

Public Member Functions
	~SampleDescription ()
	Standard destructor.
void	SetName (const char *pName)
	Set the name of the sample.

Static Public Member Functions
static SampleDescription *	New (void)
	Allocate a new, initialized SampleDescription.

Public Attributes
void *	m_pSample
	Pointer to the sample data.
uint32_t	m_uSampleSize
	Number of bytes in the sample.
uint32_t	m_uLoopStart
	Byte to start the loop.
uint32_t	m_uLoopLength
	Byte to end the loop.
uint_t	m_uC2SamplesPerSecond
	Samples per second to generate C2 (Fine tune adjust)
int_t	m_iRelativeNote
	Note adjust in semitones.
uint8_t	m_uVolume
	Default volume of the sample.
uint8_t	m_eLoopType
	Default loop behavior.
uint8_t	m_uBitsPerSample
	8 or 16 bits
uint8_t	m_bStereo
	Stereo.
char	m_Name [32]
	Sample name.

Detailed Description

A buffer describing digital sample for an instrument.

---

All the settings for this sample is stored in this structure

Constructor & Destructor Documentation

~SampleDescription()

Burger::Sequencer::SampleDescription::~SampleDescription

(

)

Standard destructor.

---

Release sample data if any had been allocated

Member Function Documentation

New()

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

static

Allocate a new, initialized SampleDescription.

---

Returns

NULL if out of memory or a pointer to an initialized SampleDescription

SetName()

void Burger::Sequencer::SampleDescription::SetName ( const char * pName )

inline

Set the name of the sample.

---

Note

If the string exceeds the size of the buffer, it will be truncated.

Parameters

pName

Pointer to a "C" string for the new name

Member Data Documentation

m_bStereo

uint8_t Burger::Sequencer::SampleDescription::m_bStereo

Stereo.

m_eLoopType

uint8_t Burger::Sequencer::SampleDescription::m_eLoopType

Default loop behavior.

m_iRelativeNote

int_t Burger::Sequencer::SampleDescription::m_iRelativeNote

Note adjust in semitones.

m_Name

char Burger::Sequencer::SampleDescription::m_Name[32]

Sample name.

m_pSample

void* Burger::Sequencer::SampleDescription::m_pSample

Pointer to the sample data.

m_uBitsPerSample

uint8_t Burger::Sequencer::SampleDescription::m_uBitsPerSample

8 or 16 bits

m_uC2SamplesPerSecond

uint_t Burger::Sequencer::SampleDescription::m_uC2SamplesPerSecond

Samples per second to generate C2 (Fine tune adjust)

m_uLoopLength

uint32_t Burger::Sequencer::SampleDescription::m_uLoopLength

Byte to end the loop.

m_uLoopStart

uint32_t Burger::Sequencer::SampleDescription::m_uLoopStart

Byte to start the loop.

m_uSampleSize

uint32_t Burger::Sequencer::SampleDescription::m_uSampleSize

Number of bytes in the sample.

m_uVolume

uint8_t Burger::Sequencer::SampleDescription::m_uVolume

Default volume of the sample.