om::sound::plugins::PluginType Class Reference

A class that represents of a particular type of plugin, such as AU, VST, or filter. More...

#include <omSoundPluginType.h>

Public Member Functions
	PluginType ()
	Create a new plugin type with an undefined type string, the empty string. More...
	PluginType (const UTF8String &newName)
	Create a new plugin type with the specified type name string. More...
	PluginType (const char *newName)
	Create a new plugin type with the specified constant type string. More...
const UTF8String &	getName () const
	Return a reference to a string which uniquely represents the name of this plugin type. More...
void	setName (const UTF8String &newName)
	Set a reference to a string which uniquely represents the name of this plugin type. More...
Hash	getHashCode () const
	Return an integer hash-code value for this plugin type. More...
Bool	operator== (const PluginType &other) const
	Return whether or not this plugin type is equivalent to another. More...
Bool	operator!= (const PluginType &other) const
	Return whether or not this plugin type is not equivalent to another. More...

Static Public Attributes
static const PluginType	UNDEFINED
	A plugin type object that represents an undefined plugin architecture. More...
static const PluginType	FILTER
	A plugin type object that represents the built-in SoundFilter plugin architecture. More...
static const PluginType	AU
	A plugin type object that represents Apple's Audio Unit (AU) plugin architecture. More...
static const PluginType	VST
	A plugin type object that represents Steinberg's Virtual Studio Technology (VST) plugin architecture. More...
static const PluginType	RTAS
	A plugin type object that represents Avid's Real Time AudioSuite (RTAS) plugin architecture. More...

Detailed Description

A class that represents of a particular type of plugin, such as AU, VST, or filter.

Constructor & Destructor Documentation

om::sound::plugins::PluginType::PluginType ( )

inline

Create a new plugin type with an undefined type string, the empty string.

om::sound::plugins::PluginType::PluginType ( const UTF8String &  newName )

inline

Create a new plugin type with the specified type name string.

om::sound::plugins::PluginType::PluginType ( const char *  newName )

inline

Create a new plugin type with the specified constant type string.

Member Function Documentation

const UTF8String& om::sound::plugins::PluginType::getName ( ) const

inline

Return a reference to a string which uniquely represents the name of this plugin type.

void om::sound::plugins::PluginType::setName ( const UTF8String &  newName )

inline

Set a reference to a string which uniquely represents the name of this plugin type.

Hash om::sound::plugins::PluginType::getHashCode ( ) const

inline

Return an integer hash-code value for this plugin type.

Bool om::sound::plugins::PluginType::operator== ( const PluginType &  other ) const

inline

Return whether or not this plugin type is equivalent to another.

The plugin types are equal if the type name strings are equal. The string are compared in a case-insensitive manner.

Bool om::sound::plugins::PluginType::operator!= ( const PluginType &  other ) const

inline

Return whether or not this plugin type is not equivalent to another.

The plugin types are not equal if the type name strings are not equal. The string are compared in a case-insensitive manner.

Member Data Documentation

const PluginType om::sound::plugins::PluginType::UNDEFINED

static

A plugin type object that represents an undefined plugin architecture.

const PluginType om::sound::plugins::PluginType::FILTER

static

A plugin type object that represents the built-in SoundFilter plugin architecture.

const PluginType om::sound::plugins::PluginType::AU

static

A plugin type object that represents Apple's Audio Unit (AU) plugin architecture.

const PluginType om::sound::plugins::PluginType::VST

static

A plugin type object that represents Steinberg's Virtual Studio Technology (VST) plugin architecture.

const PluginType om::sound::plugins::PluginType::RTAS

static

A plugin type object that represents Avid's Real Time AudioSuite (RTAS) plugin architecture.

---

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

• omSoundPluginType.h