#include <VisualMain.h>
List of all members.
Detailed Description
Handles the events and messages passed in by iTunes. In its public section VisualMain contains the functions called by iTunes. Private static functions access the various internal classes of the visualizer. Essential events are: audio play start, audio play stop, show start, show stop, and render message. When displaying graphics, the visualizer spends most of its time with executing the render message.
Constructor & Destructor Documentation
| VizKit::VisualMain::VisualMain |
( |
|
) |
[private] |
The constructor. VisualMain is a collection of static methods. Class does not need any instances. Constructor is private and not implemented.
| VizKit::VisualMain::~VisualMain |
( |
|
) |
[private] |
The destructor. VisualMain is a collection of static methods. Class does not need any instances. Destructor is private and not implemented.
Member Function Documentation
| void VisualMain::convertVisualPluginMessageToString |
( |
const OSType |
visualPluginMessage, |
|
|
char * |
outString | |
|
) |
| | [static, private] |
Static helper function that converts a VisualPluginMessage to the string. Possibly useful for debugging or tracing purposes.
- Parameters:
-
| visualPluginMessage | The visualPluginMessage. |
| outString | The character string value of the VisualNotificationKey enum value. |
Called by iTunes, dispatched from main function. Registers the visualizer plug-in to iTunes. The function calls PlayerRegisterVisualPlugin to be registered by iTunes.
- Parameters:
-
| pluginMessageInfo | A pointer to a data structure passed in by iTunes and sent on to PlayerRegisterVisualPlugin. |
- Returns:
- Status of the operation.
| void VisualMain::storeAudioStreamMetadata |
( |
const ITStreamInfoV1 *const |
streamMetadata |
) |
[static, private] |
Stores textual audio stream information (single byte string data).
- Parameters:
-
| streamMetadata | Pointer to all accessible stream information. |
| void VisualMain::storeAudioStreamMetadata |
( |
const ITStreamInfo *const |
streamMetadata |
) |
[static, private] |
Stores textual audio stream information.
- Parameters:
-
| streamMetadata | Pointer to all accessible stream information. |
| bool VisualMain::storeAudioTrackMetadata |
( |
const ITTrackInfo *const |
trackMetadata, |
|
|
bool |
isAudioStream | |
|
) |
| | [static, private] |
Stores textual audio track information.
- Parameters:
-
| trackMetadata | Pointer to all accessible track information. |
| isAudioStream | True if track meta data belongs to audio stream. False if meta data belongs to audio track. |
- Returns:
- True if audio track changed compared to previous one. False if metadata is the same as with the previous audio track.
Called by iTunes to send messages to visualizer plug-in. Known by iTunes via call to PlayerRegisterVisualPlugin. These types of messages can be received: kVisualPluginInitMessage kVisualPluginCleanupMessage kVisualPluginEnableMessage kVisualPluginDisableMessage kVisualPluginIdleMessage kVisualPluginConfigureMessage kVisualPluginShowWindowMessage kVisualPluginHideWindowMessage kVisualPluginSetWindowMessage kVisualPluginRenderMessage kVisualPluginUpdateMessage kVisualPluginPlayMessage kVisualPluginChangeTrackMessage kVisualPluginStopMessage kVisualPluginSetPositionMessage kVisualPluginPauseMessage kVisualPluginUnpauseMessage kVisualPluginEventMessage kVisualPluginDisplayChangedMessage
- Parameters:
-
| message | Type of message. |
| visualPluginMessageInfo | Additional data. |
| refCon | Pointer to untyped additional data. |
- Returns:
- Error status.
The documentation for this class was generated from the following files: