VizKit::VisualAudioMetaData Class Reference

#include <VisualAudioMetaData.h>

List of all members.

Public Member Functions
	VisualAudioMetaData ()
	~VisualAudioMetaData ()
	VisualAudioMetaData (const VisualAudioMetaData &other)
VisualAudioMetaData &	operator= (const VisualAudioMetaData &other)
bool	operator== (const VisualAudioMetaData &other)
bool	operator!= (const VisualAudioMetaData &other)
void	init (void)
void	setIsStream (bool isAStream)
void	setTrackName (const VisualString &aTrackName)
void	setTrackArtist (const VisualString &aTrackArtist)
void	setTrackAlbum (const VisualString &aTrackAlbum)
void	setTrackLyrics (const VisualString &someTrackLyrics)
void	setTrackComposer (const VisualString &aComposer)
void	setStreamTitle (const VisualString &aStreamTitle)
void	setStreamMessage (const VisualString &aStreamMessage)
void	setStreamURL (const VisualString &aStreamURL)
void	setStreamName (const VisualString &aStreamName)
void	setTrackSizeInBytes (uint32 aTrackSizeInBytes)
void	setYear (uint16 aYear)
const VisualString &	getTrackName (void)
const VisualString &	getTrackArtist (void)
const VisualString &	getTrackAlbum (void)
const VisualString &	getTrackLyrics (void)
const VisualString &	getTrackComposer (void)
const VisualString &	getStreamTitle (void)
const VisualString &	getStreamMessage (void)
const VisualString &	getStreamURL (void)
const VisualString &	getStreamName (void)
uint32	getTrackSizeInBytes (void)
uint16	getYear (void)
VisualItemIdentifier	getTrackIdentifier (void)
bool	getIsStream (void)
Private Member Functions
void	copy (const VisualAudioMetaData &other)
Private Attributes
bool	isStream
VisualString	trackName
VisualString	trackArtist
VisualString	trackAlbum
VisualString	trackLyrics
VisualString	trackComposer
VisualString	streamTitle
VisualString	streamMessage
VisualString	streamURL
VisualString	streamName
VisualString	returnString
uint32	trackSizeInBytes
uint16	year
VisualItemIdentifier *	trackIdentifier

---

Detailed Description

Meta data (like track name, artist name, or lyrics, etc.) of audio track or audio stream.

---

Constructor & Destructor Documentation

VisualAudioMetaData::VisualAudioMetaData

(

)

Constructor.

VisualAudioMetaData::~VisualAudioMetaData

(

)

Destructor.

VisualAudioMetaData::VisualAudioMetaData

(

const VisualAudioMetaData &

other

)

Copy constructor.

Parameters:

other

Another VisualAudioMetaData.

---

Member Function Documentation

void VisualAudioMetaData::copy

(

const VisualAudioMetaData &

other

)

[private]

Copy method for assignment operator and copy constructor.

Parameters:

other

Another VisualAudioMetaData.

bool VisualAudioMetaData::getIsStream

(

void

)

Answers the question whether audio meta data belongs to stream or track.

Returns:

True if audio meta data belongs to stream. False if audio meta data belongs to track.

const VisualString & VisualAudioMetaData::getStreamMessage

(

void

)

Returns the message of a stream.

Returns:

The message of a stream.

const VisualString & VisualAudioMetaData::getStreamName

(

void

)

Returns the name of a stream.

Returns:

The name of a stream.

const VisualString & VisualAudioMetaData::getStreamTitle

(

void

)

Returns the title of a stream.

Returns:

The title of a stream.

const VisualString & VisualAudioMetaData::getStreamURL

(

void

)

Returns the URL of a stream.

Returns:

The URL of a stream.

const VisualString & VisualAudioMetaData::getTrackAlbum

(

void

)

Returns the name of the album.

Returns:

The name of the album the track belongs to.

const VisualString & VisualAudioMetaData::getTrackArtist

(

void

)

Returns the artist of the track.

Returns:

The artist of the track.

const VisualString & VisualAudioMetaData::getTrackComposer

(

void

)

Returns the composer of the track.

Returns:

The composer of the track.

VisualItemIdentifier VisualAudioMetaData::getTrackIdentifier

(

void

)

Returns the unique identifer of the track for the meta data.

Returns:

The unique identifer of the track for the meta data.

const VisualString & VisualAudioMetaData::getTrackLyrics

(

void

)

Returns the lyrics of the track.

Returns:

The lyrics of the track.

const VisualString & VisualAudioMetaData::getTrackName

(

void

)

Returns the name of the track.

Returns:

The name of the track.

uint32 VisualAudioMetaData::getTrackSizeInBytes

(

void

)

Returns the size of the track in bytes.

Returns:

The size of the track in bytes.

uint16 VisualAudioMetaData::getYear

(

void

)

Returns the year of the audio data in bytes.

Returns:

The year of the audio data in bytes.

void VisualAudioMetaData::init

(

void

)

Resets the values of the audio meta data to their initial default empty values.

bool VisualAudioMetaData::operator!=

(

const VisualAudioMetaData &

other

)

Inequality operator.

Parameters:

other

Another VisualAudioMetaData.

VisualAudioMetaData & VisualAudioMetaData::operator=

(

const VisualAudioMetaData &

other

)

Assignment operator.

bool VisualAudioMetaData::operator==

(

const VisualAudioMetaData &

other

)

Equality operator.

Parameters:

other

Another VisualAudioMetaData.

void VisualAudioMetaData::setIsStream

(

bool

isAStream

)

Sets whether data belongs to stream or track.

Parameters:

isAStream

If true data is stream meta data. If false data is track meta data.

void VisualAudioMetaData::setStreamMessage

(

const VisualString &

aStreamMessage

)

Sets the message of a stream.

Parameters:

aStreamMessage

The message of a stream.

void VisualAudioMetaData::setStreamName

(

const VisualString &

aStreamName

)

Sets the name of a stream.

Parameters:

aStreamName

The name of a stream.

void VisualAudioMetaData::setStreamTitle

(

const VisualString &

aStreamTitle

)

Sets the title of a stream.

Parameters:

aStreamTitle

The title of a stream.

void VisualAudioMetaData::setStreamURL

(

const VisualString &

aStreamURL

)

Sets the URL of a stream.

Parameters:

aStreamURL

The URL of a stream.

void VisualAudioMetaData::setTrackAlbum

(

const VisualString &

aTrackAlbum

)

Sets the name of the album.

Parameters:

aTrackAlbum

The name of the album the track belongs to.

void VisualAudioMetaData::setTrackArtist

(

const VisualString &

aTrackArtist

)

Sets the artist of the track.

Parameters:

aTrackArtist

The name of the track artist.

void VisualAudioMetaData::setTrackComposer

(

const VisualString &

aComposer

)

Sets the composer of the track.

Parameters:

aComposer

The composer of the track.

void VisualAudioMetaData::setTrackLyrics

(

const VisualString &

someTrackLyrics

)

Sets the lyrics of the track.

Parameters:

someTrackLyrics

The lyrics of the track.

void VisualAudioMetaData::setTrackName

(

const VisualString &

aTrackName

)

Sets the name of the track.

Parameters:

aTrackName

The name of the track.

void VisualAudioMetaData::setTrackSizeInBytes

(

uint32

aTrackSizeInBytes

)

Sets the size of the track in bytes.

Parameters:

aTrackSizeInBytes

The size of the track in bytes.

void VisualAudioMetaData::setYear

(

uint16

aYear

)

Sets the year of the audio data.

Parameters:

aYear

The year of the audio data.

---

Member Data Documentation

bool VizKit::VisualAudioMetaData::isStream [private]

True if audio meta data belongs to stream. False if audio meta data belongs to track.

VisualString VizKit::VisualAudioMetaData::returnString [private]

Utility string for thread-safe returning string value.

VisualString VizKit::VisualAudioMetaData::streamMessage [private]

Message of a stream.

VisualString VizKit::VisualAudioMetaData::streamName [private]

Name of a stream.

VisualString VizKit::VisualAudioMetaData::streamTitle [private]

Title of a stream.

VisualString VizKit::VisualAudioMetaData::streamURL [private]

URL of a stream.

VisualString VizKit::VisualAudioMetaData::trackAlbum [private]

Name of album the track belongs to.

VisualString VizKit::VisualAudioMetaData::trackArtist [private]

Name of track artist.

VisualString VizKit::VisualAudioMetaData::trackComposer [private]

Composer of track.

VisualItemIdentifier* VizKit::VisualAudioMetaData::trackIdentifier [private]

The identifier of the audio track.

VisualString VizKit::VisualAudioMetaData::trackLyrics [private]

Lyrics of track.

VisualString VizKit::VisualAudioMetaData::trackName [private]

Name of audio track.

uint32 VizKit::VisualAudioMetaData::trackSizeInBytes [private]

Size of audio track in bytes.

uint16 VizKit::VisualAudioMetaData::year [private]

The year of the audio track.

---

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

• source/AudioLab/VisualAudioMetaData.h
• source/AudioLab/VisualAudioMetaData.cpp