VizKit
3.3.7
|
Meta data (like track name, artist name, or lyrics, etc.) of audio track or audio stream. More...
#include <VisualAudioMetaData.h>
Public Member Functions | |
VisualAudioMetaData () | |
Constructor. | |
~VisualAudioMetaData () | |
Destructor. | |
VisualAudioMetaData (const VisualAudioMetaData &other) | |
Copy constructor. | |
VisualAudioMetaData & | operator= (const VisualAudioMetaData &other) |
Assignment operator. | |
bool | operator== (const VisualAudioMetaData &other) |
Equality operator. | |
bool | operator!= (const VisualAudioMetaData &other) |
Inequality operator. | |
void | init (void) |
Resets the values of the audio meta data to their initial default empty values. | |
void | setIsStream (bool isAStream) |
Sets whether data belongs to stream or track. | |
void | setTrackName (const VisualString &aTrackName) |
Sets the name of the track. | |
void | setTrackArtist (const VisualString &aTrackArtist) |
Sets the artist of the track. | |
void | setTrackAlbum (const VisualString &aTrackAlbum) |
Sets the name of the album. | |
void | setTrackLyrics (const VisualString &someTrackLyrics) |
Sets the lyrics of the track. | |
void | setTrackComposer (const VisualString &aComposer) |
Sets the composer of the track. | |
void | setStreamTitle (const VisualString &aStreamTitle) |
Sets the title of a stream. | |
void | setStreamMessage (const VisualString &aStreamMessage) |
Sets the message of a stream. | |
void | setStreamURL (const VisualString &aStreamURL) |
Sets the URL of a stream. | |
void | setStreamName (const VisualString &aStreamName) |
Sets the name of a stream. | |
void | setTrackSizeInBytes (uint32 aTrackSizeInBytes) |
Sets the size of the track in bytes. | |
void | setYear (uint16 aYear) |
Sets the year of the audio data. | |
const VisualString & | getTrackName (void) |
Returns the name of the track. | |
const VisualString & | getTrackArtist (void) |
Returns the artist of the track. | |
const VisualString & | getTrackAlbum (void) |
Returns the name of the album. | |
const VisualString & | getTrackLyrics (void) |
Returns the lyrics of the track. | |
const VisualString & | getTrackComposer (void) |
Returns the composer of the track. | |
const VisualString & | getStreamTitle (void) |
Returns the title of a stream. | |
const VisualString & | getStreamMessage (void) |
Returns the message of a stream. | |
const VisualString & | getStreamURL (void) |
Returns the URL of a stream. | |
const VisualString & | getStreamName (void) |
Returns the name of a stream. | |
uint32 | getTrackSizeInBytes (void) |
Returns the size of the track in bytes. | |
uint16 | getYear (void) |
Returns the year of the audio data in bytes. | |
VisualItemIdentifier | getTrackIdentifier (void) |
Returns the unique identifer of the track for the meta data. | |
bool | getIsStream (void) |
Answers the question whether audio meta data belongs to stream or track. | |
Private Member Functions | |
void | copy (const VisualAudioMetaData &other) |
Copy method for assignment operator and copy constructor. | |
Private Attributes | |
bool | isStream |
True if audio meta data belongs to stream. | |
VisualString | trackName |
Name of audio track. | |
VisualString | trackArtist |
Name of track artist. | |
VisualString | trackAlbum |
Name of album the track belongs to. | |
VisualString | trackLyrics |
Lyrics of track. | |
VisualString | trackComposer |
Composer of track. | |
VisualString | streamTitle |
Title of a stream. | |
VisualString | streamMessage |
Message of a stream. | |
VisualString | streamURL |
URL of a stream. | |
VisualString | streamName |
Name of a stream. | |
VisualString | returnString |
Utility string for thread-safe returning string value. | |
uint32 | trackSizeInBytes |
Size of audio track in bytes. | |
uint16 | year |
The year of the audio track. | |
VisualItemIdentifier * | trackIdentifier |
The identifier of the audio track. |
Meta data (like track name, artist name, or lyrics, etc.) of audio track or audio stream.
Constructor.
Destructor.
VisualAudioMetaData::VisualAudioMetaData | ( | const VisualAudioMetaData & | other | ) |
Copy constructor.
other | Another VisualAudioMetaData. |
void VisualAudioMetaData::copy | ( | const VisualAudioMetaData & | other | ) | [private] |
Copy method for assignment operator and copy constructor.
other | Another VisualAudioMetaData. |
bool VisualAudioMetaData::getIsStream | ( | void | ) |
Answers the question whether audio meta data belongs to stream or track.
const VisualString & VisualAudioMetaData::getStreamMessage | ( | void | ) |
Returns the message of a stream.
const VisualString & VisualAudioMetaData::getStreamName | ( | void | ) |
Returns the name of a stream.
const VisualString & VisualAudioMetaData::getStreamTitle | ( | void | ) |
Returns the title of a stream.
const VisualString & VisualAudioMetaData::getStreamURL | ( | void | ) |
Returns the URL of a stream.
const VisualString & VisualAudioMetaData::getTrackAlbum | ( | void | ) |
Returns the name of the album.
const VisualString & VisualAudioMetaData::getTrackArtist | ( | void | ) |
Returns the artist of the track.
const VisualString & VisualAudioMetaData::getTrackComposer | ( | void | ) |
Returns the composer of the track.
Returns the unique identifer of the track for the meta data.
const VisualString & VisualAudioMetaData::getTrackLyrics | ( | void | ) |
Returns the lyrics of the track.
const VisualString & VisualAudioMetaData::getTrackName | ( | void | ) |
Returns the name of the track.
Returns the size of the track in bytes.
uint16 VisualAudioMetaData::getYear | ( | void | ) |
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.
other | Another VisualAudioMetaData. |
VisualAudioMetaData & VisualAudioMetaData::operator= | ( | const VisualAudioMetaData & | other | ) |
Assignment operator.
bool VisualAudioMetaData::operator== | ( | const VisualAudioMetaData & | other | ) |
Equality operator.
other | Another VisualAudioMetaData. |
void VisualAudioMetaData::setIsStream | ( | bool | isAStream | ) |
Sets whether data belongs to stream or track.
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.
aStreamMessage | The message of a stream. |
void VisualAudioMetaData::setStreamName | ( | const VisualString & | aStreamName | ) |
Sets the name of a stream.
aStreamName | The name of a stream. |
void VisualAudioMetaData::setStreamTitle | ( | const VisualString & | aStreamTitle | ) |
Sets the title of a stream.
aStreamTitle | The title of a stream. |
void VisualAudioMetaData::setStreamURL | ( | const VisualString & | aStreamURL | ) |
Sets the URL of a stream.
aStreamURL | The URL of a stream. |
void VisualAudioMetaData::setTrackAlbum | ( | const VisualString & | aTrackAlbum | ) |
Sets the name of the album.
aTrackAlbum | The name of the album the track belongs to. |
void VisualAudioMetaData::setTrackArtist | ( | const VisualString & | aTrackArtist | ) |
Sets the artist of the track.
aTrackArtist | The name of the track artist. |
void VisualAudioMetaData::setTrackComposer | ( | const VisualString & | aComposer | ) |
Sets the composer of the track.
aComposer | The composer of the track. |
void VisualAudioMetaData::setTrackLyrics | ( | const VisualString & | someTrackLyrics | ) |
Sets the lyrics of the track.
someTrackLyrics | The lyrics of the track. |
void VisualAudioMetaData::setTrackName | ( | const VisualString & | aTrackName | ) |
Sets the name of the track.
aTrackName | The name of the track. |
void VisualAudioMetaData::setTrackSizeInBytes | ( | uint32 | aTrackSizeInBytes | ) |
Sets the size of the track in bytes.
aTrackSizeInBytes | The size of the track in bytes. |
void VisualAudioMetaData::setYear | ( | uint16 | aYear | ) |
Sets the year of the audio data.
aYear | The year of the audio data. |
bool VizKit::VisualAudioMetaData::isStream [private] |
True if audio meta data belongs to stream.
False if audio meta data belongs to track.
Utility string for thread-safe returning string value.
Message of a stream.
Name of a stream.
Title of a stream.
URL of a stream.
Name of album the track belongs to.
Name of track artist.
Composer of track.
The identifier of the audio track.
Lyrics of track.
Name of audio track.
Size of audio track in bytes.
uint16 VizKit::VisualAudioMetaData::year [private] |
The year of the audio track.