VizKit::VisualAudioData Class Reference

Raw audio data as received with pulse message via iTunes visualizer interface. More...

#include <VisualAudioData.h>

List of all members.

Public Member Functions
	VisualAudioData ()
	Constructor.
	~VisualAudioData ()
	Destructor.
	VisualAudioData (const VisualAudioData &other)
	Copy constructor.
VisualAudioData &	operator= (const VisualAudioData &other)
	Assignment operator.
bool	operator== (const VisualAudioData &other)
	Equality operator.
bool	operator!= (const VisualAudioData &other)
	Inequality operator.
void	setNumberOfWaveformChannels (uint8 aWaveformChannelCount)
	Sets the number of waveform channels.
void	setNumberOfWaveformEntries (uint16 aWaveformEntryCount)
	Sets the number of waveform entries.
void	setWaveformData (const uint8 *const someWaveformData)
	Sets the waveform data.
void	setNumberOfSpectrumChannels (uint8 aSpectrumChannelCount)
	Sets the number of spectrum channels.
void	setNumberOfSpectrumEntries (uint16 aSpectrumEntryCount)
	Sets the number of spectrum entries.
void	setSpectrumData (const uint8 *const someSpectrumData)
	Sets the spectrum data.
uint8	getNumberOfWaveformChannels (void) const
	Returns the number of waveform channels.
uint16	getNumberOfWaveformEntries (void) const
	Returns the number of waveform entries.
const uint8 *const	getWaveformData (void) const
	Returns the waveform data.
uint8	getNumberOfSpectrumChannels (void) const
	Returns the number of spectrum channels.
uint16	getNumberOfSpectrumEntries (void) const
	Returns the number of spectrum entries.
const uint8 *const	getSpectrumData (void) const
	Returns the spectrum data.
Private Member Functions
void	copy (const VisualAudioData &other)
	Copy method for assignment operator and copy constructor.
Private Attributes
uint8	waveformChannelCount
	The number of waveform channels.
uint16	waveformEntryCount
	The number of waveform entries.
uint8 *	waveformData
	The waveform data.
uint8	spectrumChannelCount
	The number of spectrum channels.
uint16	spectrumEntryCount
	The number of spectrum entries.
uint8 *	spectrumData
	The spectrum data.

---

Detailed Description

Raw audio data as received with pulse message via iTunes visualizer interface.

---

Constructor & Destructor Documentation

VisualAudioData::VisualAudioData

(

)

Constructor.

VisualAudioData::~VisualAudioData

(

)

Destructor.

VisualAudioData::VisualAudioData

(

const VisualAudioData &

other

)

Copy constructor.

Parameters:

other

Another VisualAudioData.

---

Member Function Documentation

void VisualAudioData::copy

(

const VisualAudioData &

other

)

[private]

Copy method for assignment operator and copy constructor.

Parameters:

other

Another VisualAudioData.

uint8 VisualAudioData::getNumberOfSpectrumChannels

(

void

)

const

Returns the number of spectrum channels.

Returns:

The number of spectrum channels.

uint16 VisualAudioData::getNumberOfSpectrumEntries

(

void

)

const

Returns the number of spectrum entries.

Returns:

The number of spectrum entries.

uint8 VisualAudioData::getNumberOfWaveformChannels

(

void

)

const

Returns the number of waveform channels.

Returns:

The number of waveform channels.

uint16 VisualAudioData::getNumberOfWaveformEntries

(

void

)

const

Returns the number of waveform entries.

Returns:

The number of waveform entries.

const uint8 *const VisualAudioData::getSpectrumData

(

void

)

const

Returns the spectrum data.

Returns:

The spectrum data.

const uint8 *const VisualAudioData::getWaveformData

(

void

)

const

Returns the waveform data.

Returns:

The waveform data.

bool VisualAudioData::operator!=

(

const VisualAudioData &

other

)

Inequality operator.

Parameters:

other

Another VisualAudioData.

VisualAudioData & VisualAudioData::operator=

(

const VisualAudioData &

other

)

Assignment operator.

bool VisualAudioData::operator==

(

const VisualAudioData &

other

)

Equality operator.

Parameters:

other

Another VisualAudioData.

void VisualAudioData::setNumberOfSpectrumChannels

(

uint8

aSpectrumChannelCount

)

Sets the number of spectrum channels.

Parameters:

aSpectrumChannelCount

The number of spectrum channels.

void VisualAudioData::setNumberOfSpectrumEntries

(

uint16

aSpectrumEntryCount

)

Sets the number of spectrum entries.

Parameters:

aSpectrumEntryCount

The number of spectrum entries.

void VisualAudioData::setNumberOfWaveformChannels

(

uint8

aWaveformChannelCount

)

Sets the number of waveform channels.

Parameters:

aWaveformChannelCount

The number of waveform channels.

void VisualAudioData::setNumberOfWaveformEntries

(

uint16

aWaveformEntryCount

)

Sets the number of waveform entries.

Parameters:

aWaveformEntryCount

The number of waveform entries.

void VisualAudioData::setSpectrumData

(

const uint8 *const

someSpectrumData

)

Sets the spectrum data.

Parameters:

someSpectrumData

The spectrum data.

void VisualAudioData::setWaveformData

(

const uint8 *const

someWaveformData

)

Sets the waveform data.

Parameters:

someWaveformData

The waveform data.

---

Member Data Documentation

uint8 VizKit::VisualAudioData::spectrumChannelCount [private]

The number of spectrum channels.

uint8* VizKit::VisualAudioData::spectrumData [private]

The spectrum data.

uint16 VizKit::VisualAudioData::spectrumEntryCount [private]

The number of spectrum entries.

uint8 VizKit::VisualAudioData::waveformChannelCount [private]

The number of waveform channels.

uint8* VizKit::VisualAudioData::waveformData [private]

The waveform data.

uint16 VizKit::VisualAudioData::waveformEntryCount [private]

The number of waveform entries.

---

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

• vizkit/source/AudioLab/VisualAudioData.h
• vizkit/source/AudioLab/VisualAudioData.cpp