	MidiVid Home
Main Page \| Class Hierarchy \| Class List \| File List \| Class Members \| File Members \| Related Pages

MVPlugDesc Class Reference

Inheritance diagram for MVPlugDesc:

List of all members.

Detailed Description

When implementing your own MidiVid plugins, MVPlugDesc objects are the way you tell MidiVid about them. When a plugin DLL is started, MidiVid calls the mvpGetNumPlugs function to find out how many plugins the DLL contains, and then calls mvpGetPlugDesc for each of those plugins. By creating an object implementing the MVPlugDesc interface for each plugin in your DLL, you give MidiVid access to information about your plugin, as well as a function to create instances of it. Generally you create a single static instance of each descriptor in your DLL, and return those.

See also:: MVSourcePlugDesc

Public Member Functions

virtual MVPlugType GetType (void)=0

Gets the type of plug in.

virtual const MVGuid & GetGUID (void)=0

Gets the GUID of the plug in.

virtual const char * GetClass (void)=0

Gets the classification of the plug-in.

virtual const char * GetName (void)=0

Gets the name of the plug-in.

virtual const char * GetDesc (void)=0

Gets the description of the plug-in.

virtual MVBasePlug * CreatePlug (void)=0

returns a new instance of this plug in

Member Function Documentation

MVPlugDesc::GetType ( void ) [pure virtual]

Returns:
An MVPlugType value indicating the type of work this plugin does.

See also:
MVPlugType

MVPlugDesc::GetGUID ( void ) [pure virtual]

Returns:
An MVGuid object which is the unique GUID of your plugin. This value will be used to identify your plugin when saving and loading Performance files.

See also:
MVGuid

MVPlugDesc::GetClass ( void ) [pure virtual]

Returns:
A null terminated string which describes a group, or classification, for your plugin. This can be an author or company name, or a general classification value. This value is used to group related plugins together within the plugin selection dialog.
MidiVid plugins use Basic, 2D Effect, 3D Effect, and Controller.

MVPlugDesc::GetName ( void ) [pure virtual]

Returns:
A null terminated string which is the display name of your plugin. This value will be shown in the plugin selection dialog.

MVPlugDesc::GetDesc ( void ) [pure virtual]

Returns:
A null terminated string which is a short description of your plugin. This value will be shown either as a tool tip, or a secondary info box in the plugin selection dialog when your plugin is highlighted.

MVPlugDesc::CreatePlug ( void ) [pure virtual]

Returns:
A new instance of the MVPlug object that this object describes. This function is called by MidiVid to create a new instance of your plugin.

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


Public Member Functions
virtual MVPlugType	GetType (void)=0
	Gets the type of plug in.
virtual const MVGuid &	GetGUID (void)=0
	Gets the GUID of the plug in.
virtual const char *	GetClass (void)=0
	Gets the classification of the plug-in.
virtual const char *	GetName (void)=0
	Gets the name of the plug-in.
virtual const char *	GetDesc (void)=0
	Gets the description of the plug-in.
virtual MVBasePlug *	CreatePlug (void)=0
	returns a new instance of this plug in