VizKit::VisualConfiguration Class Reference

Common definitions and constants that must be customized for each individual plug-in. More...

#include <VisualConfiguration.h>

List of all members.

Static Public Member Functions
static const char *const	visualizerPluginIdentifierName (void)
	The name of the visualizer plug-in, the identifier.
static const char *const	visualPluginDomainIdentifier (void)
	The identifier of the visualizer plug-in (as used on Mac OS X for preferences identification and as CFBundleIdentifier).
static const uint8	majorReleaseNumber (void)
	The major release number of the visualizer (version number).
static const uint8	minorReleaseNumber (void)
	The minor release number of the visualizer (version number).
static const uint8	releaseRevisionNumber (void)
	The revision number of the visualizer (version number).
static const char *const	currentVersionInformationURL (void)
	The URL of the current version information for this visualizer.
static void	dispose (void)
	Disposes the VisualConfiguration.
static uint8	getMajorReleaseNumberAsBCD (void)
	Returns the major release number encoded as BCD value.
static uint8	getMinorReleaseNumberAsBCD (void)
	Returns the minor release number encoded as BCD value.
static uint8	getReleaseRevisionNumber (void)
	Returns the release revision number.
static uint16 *	getVisualizerShowName (long &numberOfCharactersOfVisualizerShowName)
	Returns the unicode-savvy show name of the visualizer.
Private Member Functions
	VisualConfiguration ()
	The constructor.
	~VisualConfiguration ()
	The destructor.
	VisualConfiguration (const VisualConfiguration &other)
	Copy constructor.
VisualConfiguration &	operator= (const VisualConfiguration &other)
	Assignment operator.
void	prepareVisualizerShowNameUnicode (void)
	Internal method to prepare the unicode-savvy show name of the visualizer.
Static Private Member Functions
static VisualConfiguration *	getInstance (void)
	Constructs a VisualConfiguration.
static uint8	getBCD (uint8 decimalNumber)
	Returns the binary-coded decimal value of a decimal number.
Private Attributes
uint16 *	visualizerShowName
	The name of the visualizer as shown in menu of iTunes (in UTF-16).
long	numberOfCharactersOfVisualizerShowName
	The number of UTF-16 characters in visualizer show name.
Static Private Attributes
static VisualConfiguration *	theVisualConfiguration = NULL
	VisualConfiguration is a singleton class.

---

Detailed Description

Common definitions and constants that must be customized for each individual plug-in.

---

Constructor & Destructor Documentation

VisualConfiguration::VisualConfiguration

(

)

[private]

The constructor.

VisualConfiguration is a singleton class. The constructor is private. New instance of class can only be created internally.

VisualConfiguration::~VisualConfiguration

(

)

[private]

The destructor.

VisualConfiguration is a singleton class. The destructor is private. Instance of class can only be destructed internally.

VizKit::VisualConfiguration::VisualConfiguration

(

const VisualConfiguration &

other

)

[private]

Copy constructor.

Parameters:

other

Another VisualConfiguration.

Remarks:

Explicitely declared in private section and not implemented to enforce uniqueness of singleton pattern.

---

Member Function Documentation

const char *const VisualConfiguration::currentVersionInformationURL

(

void

)

[static]

The URL of the current version information for this visualizer.

If an empty string is returned, no check for update information is performed.

The remote text information contains three items, separated by "|": 1) The current version number (major.minor.revision), set each component of the version (including 0). Zero values at the end of the version are dropped when presenting the current version to the user. 2) Info URL (web page with general information about the visualizer or specific information about the advertized version) 3) Download URL (URL pointing to download file of current visualizer) This information is used to prompt the user with update information in case an older version is running. The feature is turned on/off by preference VisualPreferences::kCheckForUpdate.

void VisualConfiguration::dispose

(

void

)

[static]

Disposes the VisualConfiguration.

uint8 VisualConfiguration::getBCD

(

uint8

decimalNumber

)

[static, private]

Returns the binary-coded decimal value of a decimal number.

Parameters:

decimalNumber

The decimal number to convert into binary-coded decimal number.

Remarks:

BCD or Binary-coded decimal format is a format where each digit has a range of 0 - 9 (normal binary digits have a range of 0 - 15). Further info on encoding of version information: http://developer.apple.com/technotes/tn/tn1132.html (Technote OV 12- Version Territory) For a discussion of BCD see also documentation of CFBundle's CFBundleGetVersionNumber.

VisualConfiguration * VisualConfiguration::getInstance

(

void

)

[static, private]

Constructs a VisualConfiguration.

The VisualConfiguration acts as a singleton. Returns a pointer to the initialised VisualConfiguration.

Returns:

A pointer to the singleton instance.

uint8 VisualConfiguration::getMajorReleaseNumberAsBCD

(

void

)

[static]

Returns the major release number encoded as BCD value.

Returns:

The major release number encoded as BCD value.

Remarks:

The BCD value is passed to iTunes in PlayerRegisterVisualPlugin() by setting the pluginVersion of the PlayerRegisterVisualPluginMessage.

uint8 VisualConfiguration::getMinorReleaseNumberAsBCD

(

void

)

[static]

Returns the minor release number encoded as BCD value.

Returns:

The minor release number encoded as BCD value.

Remarks:

The BCD value is passed to iTunes in PlayerRegisterVisualPlugin() by setting the pluginVersion of the PlayerRegisterVisualPluginMessage.

uint8 VisualConfiguration::getReleaseRevisionNumber

(

void

)

[static]

Returns the release revision number.

Returns:

The release revision number.

Remarks:

The release revision number is not encoded as BCD.

uint16 * VisualConfiguration::getVisualizerShowName

(

long &

numberOfCharactersOfVisualizerShowName

)

[static]

Returns the unicode-savvy show name of the visualizer.

Returns:

The unicode-savvy show name of the visualizer.

const uint8 VisualConfiguration::majorReleaseNumber

(

void

)

[static]

The major release number of the visualizer (version number).

Range: 0 - 99. For instance 1.2.5 means: major release number 1, minor release number 2, revision number 5.

const uint8 VisualConfiguration::minorReleaseNumber

(

void

)

[static]

The minor release number of the visualizer (version number).

Range: 0 - 9. For instance 1.2.5 means: major release number 1, minor release number 2, revision number 5.

VisualConfiguration& VizKit::VisualConfiguration::operator=

(

const VisualConfiguration &

other

)

[private]

Assignment operator.

Remarks:

Explicitely declared in private section and not implemented to enforce uniqueness of singleton pattern.

void VisualConfiguration::prepareVisualizerShowNameUnicode

(

void

)

[private]

Internal method to prepare the unicode-savvy show name of the visualizer.

const uint8 VisualConfiguration::releaseRevisionNumber

(

void

)

[static]

The revision number of the visualizer (version number).

Range: 0 - 255. For instance 1.2.5 means: major release number 1, minor release number 2, revision number 5.

const char *const VisualConfiguration::visualizerPluginIdentifierName

(

void

)

[static]

The name of the visualizer plug-in, the identifier.

const char *const VisualConfiguration::visualPluginDomainIdentifier

(

void

)

[static]

The identifier of the visualizer plug-in (as used on Mac OS X for preferences identification and as CFBundleIdentifier).

Preferences can be stored with the Options Dialog. The values are stored in preferences text file. The preferences file is located at application data (Windows); and on Mac OS X the preferences are stored in Preferences folder inside Library folder in user's home directory. The domain identifier specifies the name of the plist file on Mac OS X. On Windows the domain identifier specifies the name of the folder inside the application data directory.

---

Member Data Documentation

long VizKit::VisualConfiguration::numberOfCharactersOfVisualizerShowName [private]

The number of UTF-16 characters in visualizer show name.

VisualConfiguration * VisualConfiguration::theVisualConfiguration = NULL [static, private]

VisualConfiguration is a singleton class.

Pointer to private instance is handled internally.

uint16* VizKit::VisualConfiguration::visualizerShowName [private]

The name of the visualizer as shown in menu of iTunes (in UTF-16).

---

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

• vizkit/source/VisualConfiguration.h
• vizkit/source/VisualConfiguration.cpp