@MediaClass(uuid1=218169601, uuid2=257, uuid3=7680, uuid4={6,14,43,52,2,6,1,1}, definedName="PluginDefinition", description="The PluginDefinition class identifies code objects that provide an implementation for a DefinitionObject.", symbol="PluginDefinition") public class PluginDefinitionImpl extends DefinitionObjectImpl implements PluginDefinition, Serializable, Cloneable
Implements the definition of code objects that provide an implementation for a definition, such as a codec definition, or for a meta definition, such as a class definition.
ObjectClassPropertyIDACCELERATOR_DEFAULT, AUTHENTICATION_DEFAULT, SOFTWAREONLY_DEFAULT| Constructor and Description |
|---|
PluginDefinitionImpl() |
PluginDefinitionImpl(AUID identification,
String name,
AUID pluginCategory,
VersionType versionNumber,
AUID definitionObject)
Creates and initializes a plugin definition, which is used to identify code
objects that provide an implementation for a definition object such
as codec definition, or for a
meta definition
such as a class definition. |
| Modifier and Type | Method and Description |
|---|---|
void |
appendPluginLocator(Locator pluginLocator)
Append a locator to the list of plugin locators of
this plugin definition, which specify an ordered list of locations
that provide access to the defined plugin's implementation.
|
void |
clearPluginLocators()
Clear the list of locators to this plugin definition, omitting this optional
property.
|
PluginDefinition |
clone()
Create a cloned copy of this interchange object.
|
int |
countPluginLocators()
Returns the number of locators in the list of plugin locators of this
plugin definition, which specify an ordered list locations that
provide access to the defined plugin's implementation.
|
AUID |
getCategoryClass()
Returns the category of the defined plugin.
|
String |
getDeviceManufacturerName()
Returns the plugin manufacturer name for the defined plugin, which specifies a string
that can be used to identify the plugin manufacturer to the user.
|
AUID |
getEngine()
Returns the software engine identifier that identifies the software
subsystem used for essence management and playback for the defined plugin.
|
VersionType |
getEngineMaximumVersion()
Returns the maximum acceptable software engine version of the defined plugin, which specifies
the maximum version of the engine for which this plugin will function.
|
VersionType |
getEngineMinimumVersion()
Returns the minimum acceptable software engine version of the defined plugin, which specifies
the minimum version of the engine for which this plugin will function.
|
String |
getEngineString() |
VersionType[] |
getEngineVersionRange()
Returns the minimum and maximum software engine versions of the defined plugin, which specify the minimum
and maximum versions of the engine for which this plugin will
function.
|
AUID |
getImplementedClass()
Returns the identifier of the implemented class of teh defined plugin.This property specifies
the AUID for the class definition
of the definition or meta definition that
the defined plugin provides an implementation for.
|
String |
getImplementedClassString() |
boolean |
getIsAccelerated()
Returns
true if the defined plugin
is capable of running with a hardware accelerator;
otherwise false. |
boolean |
getIsSoftwareOnly()
Returns
true if the defined plugin is
capable of running in a software-only environment;
otherwise false. |
AUID |
getManufacturerID()
Returns an AUID that identifies the
manufacturer of the defined plugin.
|
String |
getManufacturerIDString() |
NetworkLocator |
getManufacturerInfo()
Returns a network locator pointing to
manufacturer information for the defined plugin, which provides a link to
a web page containing information about the manufacturer.
|
String |
getMaxEngineVersionString() |
String |
getMaxPlatformVersionString() |
String |
getMaxPluginAPIString() |
String |
getMinEngineVersionString() |
String |
getMinPlatformVersionString() |
String |
getMinPluginAPIString() |
VersionType |
getPlatformMaximumVersion()
Returns the maximum acceptable platform version for the defined plugin, which
specifies the maximum version of the platform on which this plugin will
function.
|
VersionType |
getPlatformMinimumVersion()
Returns the minimum acceptable platform version for the defined plugin, which
specifies the minimum version of the platform on which this plugin will
function.
|
VersionType[] |
getPlatformVersionRange()
Returns the minimum and maximum platform version properties of the defined plugin, which specify
the minimum and maximum versions of the platform for which
the plugin will function.
|
AUID |
getPluginAPI()
Returns the identifier for the manufacturer's interface that is supported
by the defined plugin.
|
VersionType |
getPluginAPIMaximumVersion()
Returns the maximum acceptable plugin API version supporting the defined plugin,
which is the maximum version of the plugin API for which this plugin will function.
|
VersionType |
getPluginAPIMinimumVersion()
Returns the minimum acceptable plugin API version supporting the defined plugin,
which is the minimum version of the plugin API for which this plugin will function.
|
String |
getPluginAPIString() |
VersionType[] |
getPluginAPIVersionRange()
Returns the minimum and maximum plugin API version properties of the defined plugin, which are the minimum and maximum versions of
the plugin API for which this plugin will function.
|
String |
getPluginCategoryString() |
Locator |
getPluginLocatorAt(int index)
Returns the locator at the given index from the list of
locators of this plugin descriptor, which specify an ordered list of locations
that provide access to the defined plugin's implementation.
|
List<Locator> |
getPluginLocators()
Returns the list of locators of the plugin definition, which specify an ordered list
of locations that provide access to the defined plugin's implementation.
|
AUID |
getPluginPlatform()
Returns the hardware platform identifier of the defined plugin, which identifies
the platform by both its hardware platform and operating system.
|
String |
getPluginPlatformString() |
VersionType |
getPluginVersion()
Returns the plugin version of the defined plugin.
|
String |
getPluginVersionPersist() |
String |
getPluginVersionString()
Returns the plugin version string of the defined plugin, which specifies
a string that can be used to identify the plugin version to the user.
|
boolean |
getSupportsAuthentication()
Returns
true if the defined plugin is capable of supporting authentication;
otherwise false. |
static AUID |
initializePluginCategory() |
static VersionType |
initializePluginVersion() |
void |
insertPluginLocatorAt(int index,
Locator pluginLocator)
Insert a locator at the given index into the list of
locators of this plugin definition, which specify an ordered list of locations
that provide access to the defined plugin's implementation.
|
boolean |
isAccelerated()
Returns
true if the defined plugin
is capable of running with a hardware accelerator;
otherwise false. |
boolean |
isSoftwareOnly()
Returns
true if the defined plugin is
capable of running in a software-only environment;
otherwise false. |
void |
prependPluginLocator(Locator pluginLocator)
Prepend a locator to the list of plugin locators
of this plugin definition, which specify an ordered list of locations
that provide access to the defined plugin's implementation.
|
void |
removePluginLocatorAt(int index)
Remove the locator at the given index from
the list of locators of the plugin definition, which specify an ordered list of
locations that provide access to the defined plugin's implementation.
|
void |
setCategoryClass(AUID categoryClass)
Sets the category of the defined plugin.
|
void |
setDeviceManufacturerName(String deviceManufacturerName)
Set the plugin manufacturer name for the defined plugin, which specifies a string
that can be used to identify the plugin manufacturer to the user.
|
void |
setEngine(AUID engine)
Sets the software engine identifier that identifies the software
subsystem used for essence management and playback for the
defined plugin.
|
void |
setEngineMaximumVersion(VersionType maxEngineVersion)
Sets the maximum engine version property
of the defined plugin, which specifies the maximum version of the engine for which this
plugin will function.
|
void |
setEngineMinimumVersion(VersionType minVersion)
Sets the minimum engine version property
of the defined plugin, which specifies the minimum version of the engine for which this
plugin will function.
|
void |
setEngineString(String engine) |
void |
setImplementedClass(AUID implementedClass)
Sets the identifier of the implemented class of the defined plugin.
|
void |
setImplementedClassLegacy(AUID implementedClass) |
void |
setImplementedClassString(String implementedClass) |
void |
setIsAccelerated(Boolean isAccelerated)
Set to
true if the defined plugin is
capable of running with a hardware accelerator;
otherwise false. |
void |
setIsSoftwareOnly(Boolean isSoftwareOnly)
Set to
true if the defined plugin is capable
of running in a software-only environment;
otherwise false. |
void |
setManufacturerID(AUID manufacturerId)
Sets the AUID that identifies the
manufacturer of the defined plugin.
|
void |
setManufacturerIDString(String manufacturerID) |
void |
setManufacturerInfo(NetworkLocator manufacturerInfo)
Set a network locator pointing to the
location of manufacturer information for the defined plugin.
|
void |
setMaxEngineVersionString(String maxEngineVersion) |
void |
setMaxPlatformVersionString(String maxPlatformVersion) |
void |
setMaxPluginAPIString(String maxPluginAPI) |
void |
setMinEngineVersionString(String minEngineVersionString) |
void |
setMinPlatformVersionString(String minPlatformVersion) |
void |
setMinPluginAPIString(String minPluginAPI) |
void |
setPlatformMaximumVersion(VersionType maxVersion)
Sets the maximum platform version property
of the defined plugin, which specifies the maximum version of the platform
for which the plugin will function.
|
void |
setPlatformMinimumVersion(VersionType minVersion)
Sets the minimum platform version property
of the defined plugin, which specifies the minimum version of the platform
for which the plugin will function.
|
void |
setPluginAPI(AUID pluginAPI)
Sets the identifier for the manufacturer's interface that is supported
by the defined plugin.
|
void |
setPluginAPIMaximumVersion(VersionType maxVersion)
Sets the maximum plugin API version property
of the defined plugin, which specifies the maximum version number of the specified plugin
interfaces that the plugin supports.
|
void |
setPluginAPIMinimumVersion(VersionType minVersion)
Sets the minimum plugin API version property
of the defined plugin, which specifies the minimum version number of the specified plugin
interfaces that the plugin supports.
|
void |
setPluginAPIString(String pluginAPI) |
void |
setPluginCategoryString(String pluginCategory) |
void |
setPluginPlatform(AUID pluginPlatform)
Sets the hardware platform identifier of the defined plugin, which identifies
the platform by both the hardware platform and operating system.
|
void |
setPluginPlatformString(String pluginPlatform) |
void |
setPluginVersion(VersionType version)
Sets the plugin version of the defined plugin.
|
void |
setPluginVersionPersist(String pluginVersion) |
void |
setPluginVersionString(String pluginVersionString)
Sets the plugin version string of this defined plugin, which specifies
a string that can be used to identify the plugin version to the user.
|
void |
setSupportsAuthentication(Boolean supportsAuthentication)
Set to
true if the defined plugin defined is capable of supporting authentication;
otherwise false. |
boolean |
supportsAuthentication()
Returns
true if the defined plugin is capable of supporting authentication;
otherwise false. |
getAUID, getDefinitionObjectIdentificationString, getDescription, getLocalizedUID, getName, getWeakTargetReference, initializeDefinitionObjectIdentification, initializeDefinitionObjectName, setAUID, setDefinitionObjectIdentificationString, setDescription, setLocalizedUID, setNameaddApplicationPlugin, appendXMLChildren, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getComment, getGeneration, getLinkedGenerationID, getLinkedGenerationIDString, getObjectClass, getPersistentID, getPersistentIndex, hashCode, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setLinkedGenerationIDString, setObjectClass, setPersistentID, setPersistentIndex, toStringgetAUID, getDescription, getName, setDescription, setNameaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexgetWeakTargetReferencepublic PluginDefinitionImpl()
public PluginDefinitionImpl(AUID identification, @AAFString String name, AUID pluginCategory, VersionType versionNumber, AUID definitionObject) throws NullPointerException
Creates and initializes a plugin definition, which is used to identify code
objects that provide an implementation for a definition object such
as codec definition, or for a meta definition
such as a class definition.
The plugin category for the plugin can be set using one of the categories defined in the
toolkit through the static values of interface PluginCategoryType.
identification - Unique identifier for the new plugin definition.name - Display name for the new plugin definition.pluginCategory - Kind of plugin.versionNumber - Version of the plugin.definitionObject - Unique identifier of the class definition or meta definition that this
definition object provides an implementation of.NullPointerException - One or more of the arguments is null and all the
arguments are required in this implementation.@MediaProperty(uuid1=85985537, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="PluginCategory", typeName="PluginCategoryType", optional=false, uniqueIdentifier=false, pid=8707, symbol="PluginCategory") public AUID getCategoryClass()
PluginDefinitionReturns the category of the defined plugin. The AAF built in categories are:
getCategoryClass in interface PluginDefinitionPluginCategoryType,
TypeDefinitions.PluginCategoryType@MediaPropertySetter(value="PluginCategory") public void setCategoryClass(AUID categoryClass) throws NullPointerException
PluginDefinitionSets the category of the defined plugin. The AAF built in categories are:
setCategoryClass in interface PluginDefinitioncategoryClass - Kind of plugin defined.NullPointerException - The given plugin category is null.PluginCategoryType,
TypeDefinitions.PluginCategoryTypepublic static final AUID initializePluginCategory()
@MediaProperty(uuid1=85985551, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ImplementedClass", aliases={"DefinitionObject","PluginDefinitionDefinitionObject"}, typeName="AUID", optional=true, uniqueIdentifier=false, pid=8726, symbol="ImplementedClass") public AUID getImplementedClass() throws PropertyNotPresentException
PluginDefinitionReturns the identifier of the implemented class of teh defined plugin.This property specifies the AUID for the class definition of the definition or meta definition that the defined plugin provides an implementation for.
As of AAF version 1.1, this property must be specified. This was an optional property in version 1.0.
getImplementedClass in interface PluginDefinitionPropertyNotPresentException - Although the definition object should be specified, this
was not a required property in older versions of the AAF specification and is not present for
this plugin definition.@MediaPropertySetter(value="ImplementedClass") public void setImplementedClassLegacy(AUID implementedClass)
public void setImplementedClass(AUID implementedClass) throws NullPointerException
PluginDefinitionSets the identifier of the implemented class of the defined plugin. This property specifies the AUID for the class definition of the definition or meta definition that the defined plugin provides an implementation for.
As of AAF version 1.1, this property must be specified. This was an optional property in version 1.0.
setImplementedClass in interface PluginDefinitionimplementedClass - Implemented class of the defined plugin.NullPointerException - The given definition object identifier is null.PluginDefinition.getCategoryClass()@MediaProperty(uuid1=85985541, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Engine", typeName="AUID", optional=true, uniqueIdentifier=false, pid=8716, symbol="Engine") public AUID getEngine() throws PropertyNotPresentException
PluginDefinitionReturns the software engine identifier that identifies the software subsystem used for essence management and playback for the defined plugin. This is an optional property.
getEngine in interface PluginDefinitionPropertyNotPresentException - The optional engine property is not present
in this plugin definition.PluginIdentifiers.Engine_None@MediaPropertySetter(value="Engine") public void setEngine(AUID engine)
PluginDefinitionSets the software engine identifier that identifies the software
subsystem used for essence management and playback for the
defined plugin. Set this optional property to null to
omit it.
setEngine in interface PluginDefinitionengine - Software engine identifier for the defined plugin.PluginIdentifiers.Engine_Nonepublic VersionType[] getEngineVersionRange() throws PropertyNotPresentException
PluginDefinitionReturns the minimum and maximum software engine versions of the defined plugin, which specify the minimum and maximum versions of the engine for which this plugin will function. The engine version range properties are optional.
The value returned is an array containing two version numbers with the value at index 0 being the minimum version number and the value at index 1 being the maximum.
getEngineVersionRange in interface PluginDefinitionPropertyNotPresentException - The optional engine version range property is not fully
specified in this plugin definition.PluginDefinition.getEngine()@MediaProperty(uuid1=85985542, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="MinEngineVersion", typeName="VersionType", optional=true, uniqueIdentifier=false, pid=8717, symbol="MinEngineVersion") public VersionType getEngineMinimumVersion() throws PropertyNotPresentException
PluginDefinitionReturns the minimum acceptable software engine version of the defined plugin, which specifies the minimum version of the engine for which this plugin will function. The minimum engine version property is optional.
getEngineMinimumVersion in interface PluginDefinitionPropertyNotPresentException - The optional engine minimum version property is not present
for this plugin definition.PluginDefinition.getEngine(),
PluginDefinition.getEngineVersionRange(),
PluginDefinition.getEngineMaximumVersion()@MediaPropertySetter(value="MinEngineVersion") public void setEngineMinimumVersion(VersionType minVersion)
PluginDefinitionSets the minimum engine version property
of the defined plugin, which specifies the minimum version of the engine for which this
plugin will function. Set this optional property to null to omit it.
setEngineMinimumVersion in interface PluginDefinitionminVersion - Minimum engine version for the defined plugin.@MediaProperty(uuid1=85985543, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="MaxEngineVersion", typeName="VersionType", optional=true, uniqueIdentifier=false, pid=8718, symbol="MaxEngineVersion") public VersionType getEngineMaximumVersion() throws PropertyNotPresentException
PluginDefinitionReturns the maximum acceptable software engine version of the defined plugin, which specifies the maximum version of the engine for which this plugin will function. The maximum engine version property is optional.
getEngineMaximumVersion in interface PluginDefinitionPropertyNotPresentException - The optional engine maximum version property is not present
for this plugin definition.PluginDefinition.getEngine(),
PluginDefinition.getEngineVersionRange(),
PluginDefinition.getEngineMinimumVersion()@MediaPropertySetter(value="MaxEngineVersion") public void setEngineMaximumVersion(VersionType maxEngineVersion)
PluginDefinitionSets the maximum engine version property
of the defined plugin, which specifies the maximum version of the engine for which this
plugin will function. Set this optional property to null to omit it.
setEngineMaximumVersion in interface PluginDefinitionmaxEngineVersion - Maximum engine version for the defined plugin.@MediaProperty(uuid1=85985538, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="PluginPlatform", aliases={"Platform","PluginDefinitionPlatform"}, typeName="AUID", optional=true, uniqueIdentifier=false, pid=8713, symbol="PluginPlatform") public AUID getPluginPlatform() throws PropertyNotPresentException
PluginDefinitionReturns the hardware platform identifier of the defined plugin, which identifies the platform by both its hardware platform and operating system. This is an optional property.
getPluginPlatform in interface PluginDefinitionPropertyNotPresentException - The optional hardware platform property is not present
in this plugin definition.PluginIdentifiers.Platform_Independent@MediaPropertySetter(value="PluginPlatform") public void setPluginPlatform(AUID pluginPlatform)
PluginDefinitionSets the hardware platform identifier of the defined plugin, which identifies
the platform by both the hardware platform and operating system.
Set this optional property to null to omit it.
setPluginPlatform in interface PluginDefinitionpluginPlatform - Hardware platform identifier for the defined plugin.PluginIdentifiers.Platform_Independent@MediaProperty(uuid1=85985549, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="PluginLocators", aliases="Locators", typeName="LocatorStrongReferenceVector", optional=true, uniqueIdentifier=false, pid=8724, symbol="PluginLocators") public List<Locator> getPluginLocators() throws PropertyNotPresentException
PluginDefinitionReturns the list of locators of the plugin definition, which specify an ordered list of locations that provide access to the defined plugin's implementation. This is an optional property.
getPluginLocators in interface PluginDefinitionPropertyNotPresentException - No locators for the plugin implementation are
present in this plugin definition.TypeDefinitions.LocatorStrongReferenceVector@MediaListGetAt(value="PluginLocators") public Locator getPluginLocatorAt(int index) throws IndexOutOfBoundsException
PluginDefinitionReturns the locator at the given index from the list of locators of this plugin descriptor, which specify an ordered list of locations that provide access to the defined plugin's implementation.
getPluginLocatorAt in interface PluginDefinitionindex - Index of the locator to retrieve from the list of locators.IndexOutOfBoundsException - The given index is outside the
acceptable range for the current list of locators.@MediaListAppend(value="PluginLocators") public void appendPluginLocator(Locator pluginLocator) throws NullPointerException
PluginDefinitionAppend a locator to the list of plugin locators of this plugin definition, which specify an ordered list of locations that provide access to the defined plugin's implementation. Use this method to add a locator to be scanned last when searching for the plugin's implementation. The locator list is an optional property that will be made present by calling this method if it is currently omitted.
appendPluginLocator in interface PluginDefinitionpluginLocator - Locator of the plugin to append to the list of
locators of this plugin definition.NullPointerException - The given locator to append is null.@MediaPropertyCount(value="PluginLocators") public int countPluginLocators()
PluginDefinitionReturns the number of locators in the list of plugin locators of this plugin definition, which specify an ordered list locations that provide access to the defined plugin's implementation. The number of locators may be zero if the plugin is in the current file, which is also when this optional property is not present.
countPluginLocators in interface PluginDefinition@MediaListPrepend(value="PluginLocators") public void prependPluginLocator(Locator pluginLocator) throws NullPointerException
PluginDefinitionPrepend a locator to the list of plugin locators of this plugin definition, which specify an ordered list of locations that provide access to the defined plugin's implementation. Use this method to add a locator to be scanned first when searching for the plugin's implementation. The locator list is an optional property that will be made present by calling this method if it is currently omitted.
prependPluginLocator in interface PluginDefinitionpluginLocator - Locator to prepend to the list of plugin locators of the
plugin definition.NullPointerException - The given locator to prepend is null.@MediaListInsertAt(value="PluginLocators") public void insertPluginLocatorAt(int index, Locator pluginLocator) throws NullPointerException, IndexOutOfBoundsException
PluginDefinitionInsert a locator at the given index into the list of locators of this plugin definition, which specify an ordered list of locations that provide access to the defined plugin's implementation. Locators already existing at the named and higher indices will be moved up to the next higher index to accommodate to inserted item. The locator list is an optional property that may be made present by calling this method with an index of 0.
insertPluginLocatorAt in interface PluginDefinitionindex - Index where the locator should be inserted.pluginLocator - Locator to insert into the list of plugin locators of this
plugin definition.NullPointerException - The given locator to insert is null.IndexOutOfBoundsException - The given index is outside the
acceptable range for the current list of locators.@MediaListRemoveAt(value="PluginLocators") public void removePluginLocatorAt(int index) throws IndexOutOfBoundsException
PluginDefinitionRemove the locator at the given index from the list of locators of the plugin definition, which specify an ordered list of locations that provide access to the defined plugin's implementation.
removePluginLocatorAt in interface PluginDefinitionindex - Index of locator to remove from the list of locators
of the plugin definition.IndexOutOfBoundsException - The given index is outside
the acceptable range for the current list of locators.@MediaPropertyClear(value="PluginLocators") public void clearPluginLocators()
PluginDefinitionClear the list of locators to this plugin definition, omitting this optional property.
clearPluginLocators in interface PluginDefinition@MediaProperty(uuid1=17432833, uuid2=768, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ManufacturerID", aliases="PluginDefinitionManufacturerID", typeName="AUID", optional=true, uniqueIdentifier=false, pid=8712, symbol="ManufacturerID") public AUID getManufacturerID() throws PropertyNotPresentException
PluginDefinitionReturns an AUID that identifies the manufacturer of the defined plugin. This is an optional property.
getManufacturerID in interface PluginDefinitionPropertyNotPresentException - The optional manufacturer id property is not
present in this plugin definition.@MediaPropertySetter(value="ManufacturerID") public void setManufacturerID(AUID manufacturerId)
PluginDefinitionSets the AUID that identifies the
manufacturer of the defined plugin. Set this optional property to null
to omit it.
setManufacturerID in interface PluginDefinitionmanufacturerId - Manufacturer id for the defined plugin.@MediaProperty(uuid1=100729092, uuid2=523, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="ManufacturerInfo", typeName="NetworkLocatorStrongReference", optional=true, uniqueIdentifier=false, pid=8711, symbol="ManufacturerInfo") public NetworkLocator getManufacturerInfo() throws PropertyNotPresentException
PluginDefinitionReturns a network locator pointing to manufacturer information for the defined plugin, which provides a link to a web page containing information about the manufacturer.
getManufacturerInfo in interface PluginDefinitionPropertyNotPresentException - The optional manufacturer information property is not present
for this plugin definition.@MediaPropertySetter(value="ManufacturerInfo") public void setManufacturerInfo(NetworkLocator manufacturerInfo) throws NullPointerException
PluginDefinitionSet a network locator pointing to the location of manufacturer information for the defined plugin. A successful call to this method will result in any existing manufacturer information being replaced.
setManufacturerInfo in interface PluginDefinitionmanufacturerInfo - Network locator for pointing to manufacturer
information for the definition.NullPointerExceptionpublic VersionType[] getPlatformVersionRange() throws PropertyNotPresentException
PluginDefinitionReturns the minimum and maximum platform version properties of the defined plugin, which specify the minimum and maximum versions of the platform for which the plugin will function. The platform version range properties are optional.
The value returned is an array containing two version numbers with the value at index 0 being the minimum version number and the value at index 1 being the maximum.
getPlatformVersionRange in interface PluginDefinitionPropertyNotPresentException - The optional platform version range is
not fully specified in this plugin definition.PluginDefinition.getPlatformMinimumVersion(),
PluginDefinition.getPlatformMaximumVersion()@MediaProperty(uuid1=85985539, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="MinPlatformVersion", typeName="VersionType", optional=true, uniqueIdentifier=false, pid=8714, symbol="MinPlatformVersion") public VersionType getPlatformMinimumVersion() throws PropertyNotPresentException
PluginDefinitionReturns the minimum acceptable platform version for the defined plugin, which specifies the minimum version of the platform on which this plugin will function. This is an optional property.
getPlatformMinimumVersion in interface PluginDefinitionPropertyNotPresentException - The optional platform minimum version property
is not present for this plugin definition.PluginDefinition.getPlatformMaximumVersion(),
PluginDefinition.getPlatformVersionRange()@MediaPropertySetter(value="MinPlatformVersion") public void setPlatformMinimumVersion(VersionType minVersion)
PluginDefinitionSets the minimum platform version property
of the defined plugin, which specifies the minimum version of the platform
for which the plugin will function. Set this optional property to
null to omit it.
setPlatformMinimumVersion in interface PluginDefinitionminVersion - Minimum platform version of the defined plugin.@MediaProperty(uuid1=85985540, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="MaxPlatformVersion", typeName="VersionType", optional=true, uniqueIdentifier=false, pid=8715, symbol="MaxPlatformVersion") public VersionType getPlatformMaximumVersion() throws PropertyNotPresentException
PluginDefinitionReturns the maximum acceptable platform version for the defined plugin, which specifies the maximum version of the platform on which this plugin will function. This is an optional property.
getPlatformMaximumVersion in interface PluginDefinitionPropertyNotPresentException - The optional platform maximum version property
is not present for this plugin definition.PluginDefinition.getPlatformMinimumVersion(),
PluginDefinition.getPlatformVersionRange()@MediaPropertySetter(value="MaxPlatformVersion") public void setPlatformMaximumVersion(VersionType maxVersion)
PluginDefinitionSets the maximum platform version property
of the defined plugin, which specifies the maximum version of the platform
for which the plugin will function. Set this optional property to
null to omit it.
setPlatformMaximumVersion in interface PluginDefinitionmaxVersion - Maximum platform version of the defined plugin.@MediaProperty(uuid1=85985544, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="PluginAPI", typeName="AUID", optional=true, uniqueIdentifier=false, pid=8719, symbol="PluginAPI") public AUID getPluginAPI() throws PropertyNotPresentException
PluginDefinitionReturns the identifier for the manufacturer's interface that is supported by the defined plugin. This is an optional property.
getPluginAPI in interface PluginDefinitionPropertyNotPresentException - The optional plugin API property is not
present in this plugin definition.PluginIdentifiers.PluginAPI_EssenceAccess@MediaPropertySetter(value="PluginAPI") public void setPluginAPI(AUID pluginAPI)
PluginDefinitionSets the identifier for the manufacturer's interface that is supported
by the defined plugin. Set this optional property to null to
omit it.
setPluginAPI in interface PluginDefinitionpluginAPI - Identifier for the plugin interface of the defined plugin.PluginIdentifiers.Engine_Nonepublic VersionType[] getPluginAPIVersionRange() throws PropertyNotPresentException
PluginDefinitionReturns the minimum and maximum plugin API version properties of the defined plugin, which are the minimum and maximum versions of the plugin API for which this plugin will function. The plugin API version range properties are optional.
The value returned is an array containing two version numbers with the value at index 0 being the minimum version number and the value at index 1 being the maximum.
getPluginAPIVersionRange in interface PluginDefinitionPropertyNotPresentException - The optional plugin API version range is not present in
this plugin definition.PluginDefinition.getPluginAPI(),
PluginDefinition.getPluginAPIMinimumVersion(),
PluginDefinition.getPluginAPIMaximumVersion()@MediaProperty(uuid1=85985545, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="MinPluginAPI", typeName="VersionType", optional=true, uniqueIdentifier=false, pid=8720, symbol="MinPluginAPI") public VersionType getPluginAPIMinimumVersion() throws PropertyNotPresentException
PluginDefinitionReturns the minimum acceptable plugin API version supporting the defined plugin, which is the minimum version of the plugin API for which this plugin will function. The minimum plugin API version property is optional.
getPluginAPIMinimumVersion in interface PluginDefinitionPropertyNotPresentException - The optional plugin API minimum version property
is not present for this plugin definition.PluginDefinition.getPluginAPI(),
PluginDefinition.getPluginAPIVersionRange(),
PluginDefinition.getPlatformMaximumVersion()@MediaPropertySetter(value="MinPluginAPI") public void setPluginAPIMinimumVersion(VersionType minVersion)
PluginDefinitionSets the minimum plugin API version property
of the defined plugin, which specifies the minimum version number of the specified plugin
interfaces that the plugin supports. Set this optional property to null to
omit it.
setPluginAPIMinimumVersion in interface PluginDefinitionminVersion - The minimum plugin API version of the defined plugin.@MediaProperty(uuid1=85985546, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="MaxPluginAPI", typeName="VersionType", optional=true, uniqueIdentifier=false, pid=8721, symbol="MaxPluginAPI") public VersionType getPluginAPIMaximumVersion() throws PropertyNotPresentException
PluginDefinitionReturns the maximum acceptable plugin API version supporting the defined plugin, which is the maximum version of the plugin API for which this plugin will function. The maximum plugin API version property is optional.
getPluginAPIMaximumVersion in interface PluginDefinitionPropertyNotPresentException - The optional plugin API maximum version property
is not present for this plugin definition.PluginDefinition.getPluginAPI(),
PluginDefinition.getPluginAPIVersionRange(),
PluginDefinition.getPlatformMinimumVersion()@MediaPropertySetter(value="MaxPluginAPI") public void setPluginAPIMaximumVersion(VersionType maxVersion)
PluginDefinitionSets the maximum plugin API version property
of the defined plugin, which specifies the maximum version number of the specified plugin
interfaces that the plugin supports. Set this optional property to null to
omit it.
setPluginAPIMaximumVersion in interface PluginDefinitionmaxVersion - Maximum plugin API version for the defined plugin.@MediaProperty(uuid1=17432833, uuid2=257, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="DeviceManufacturerName", aliases={"Manufacturer","PluginDefinitionManufacturer"}, typeName="UTF16String", optional=true, uniqueIdentifier=false, pid=8710, symbol="DeviceManufacturerName") public String getDeviceManufacturerName() throws PropertyNotPresentException
PluginDefinitionReturns the plugin manufacturer name for the defined plugin, which specifies a string that can be used to identify the plugin manufacturer to the user. This is an optional property.
getDeviceManufacturerName in interface PluginDefinitionPropertyNotPresentException - The optional manufacturer's name is not set for the
plugin definition.@MediaPropertySetter(value="DeviceManufacturerName") public void setDeviceManufacturerName(String deviceManufacturerName)
PluginDefinitionSet the plugin manufacturer name for the defined plugin, which specifies a string
that can be used to identify the plugin manufacturer to the user. Set this optional
property to null to omit it.
setDeviceManufacturerName in interface PluginDefinitiondeviceManufacturerName - Plugin manufacturer name for this
plugin definition.@MediaProperty(uuid1=50529025, uuid2=768, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="PluginVersion", aliases="VersionNumber", typeName="VersionType", optional=false, uniqueIdentifier=false, pid=8708, symbol="PluginVersion") public VersionType getPluginVersion()
PluginDefinitionReturns the plugin version of the defined plugin.
getPluginVersion in interface PluginDefinition@MediaPropertySetter(value="PluginVersion") public void setPluginVersion(VersionType version) throws NullPointerException
PluginDefinitionSets the plugin version of the defined plugin.
setPluginVersion in interface PluginDefinitionversion - Plugin version of the defined plugin.NullPointerException - The given version number is null.public static final VersionType initializePluginVersion()
@MediaProperty(uuid1=50529025, uuid2=513, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="PluginVersionString", aliases="VersionString", typeName="UTF16String", optional=true, uniqueIdentifier=false, pid=8709, symbol="PluginVersionString") public String getPluginVersionString() throws PropertyNotPresentException
PluginDefinitionReturns the plugin version string of the defined plugin, which specifies a string that can be used to identify the plugin version to the user.
getPluginVersionString in interface PluginDefinitionPropertyNotPresentException - The optional version string property is not present in
this plugin definition.@MediaPropertySetter(value="PluginVersionString") public void setPluginVersionString(String pluginVersionString)
PluginDefinitionSets the plugin version string of this defined plugin, which specifies
a string that can be used to identify the plugin version to the user. Set
this optional property to null to omit it.
setPluginVersionString in interface PluginDefinitionpluginVersionString - Plugin version string of this plugin
definition.public boolean isAccelerated()
PluginDefinitionReturns true if the defined plugin
is capable of running with a hardware accelerator;
otherwise false. If the result is true
then the plugin may additionally support software decompression.
If this optional property is not present, the default value of false is returned.
isAccelerated in interface PluginDefinitionPluginDefinition.ACCELERATOR_DEFAULT,
PluginDefinition.getIsAccelerated()@MediaProperty(uuid1=85985548, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Accelerator", typeName="Boolean", optional=true, uniqueIdentifier=false, pid=8723, symbol="Accelerator") public boolean getIsAccelerated()
PluginDefinitionReturns true if the defined plugin
is capable of running with a hardware accelerator;
otherwise false. If the result is true
then the plugin may additionally support software decompression.
If this optional property is not present, the default value of false is returned.
getIsAccelerated in interface PluginDefinitionPluginDefinition.ACCELERATOR_DEFAULT,
PluginDefinition.isAccelerated()@MediaPropertySetter(value="Accelerator") public void setIsAccelerated(Boolean isAccelerated)
PluginDefinitionSet to true if the defined plugin is
capable of running with a hardware accelerator;
otherwise false. If the result is true
then the plugin may additionally support software decompression.
The default value for this optional property is false. To
omit this optional property, call this method with null.
setIsAccelerated in interface PluginDefinitionisAccelerated - Is the defined plugin capable of running with hardware acceleration?PluginDefinition.ACCELERATOR_DEFAULTpublic boolean isSoftwareOnly()
PluginDefinitionReturns true if the defined plugin is
capable of running in a software-only environment;
otherwise false. A value of true indicates
that no additional hardware is required. If the result is
true then this plugin may also support hardware
acceleration, as long as it also supports a software-only
method of processing data.
If this optional property is not present, the default value of false is returned.
isSoftwareOnly in interface PluginDefinitionPluginDefinition.SOFTWAREONLY_DEFAULT,
PluginDefinition.getIsSoftwareOnly()@MediaProperty(uuid1=85985547, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="SoftwareOnly", typeName="Boolean", optional=true, uniqueIdentifier=false, pid=8722, symbol="SoftwareOnly") public boolean getIsSoftwareOnly()
PluginDefinitionReturns true if the defined plugin is
capable of running in a software-only environment;
otherwise false. A value of true indicates
that no additional hardware is required. If the result is
true then this plugin may also support hardware
acceleration, as long as it also supports a software-only
method of processing data.
If this optional property is not present, the default value of false is returned.
getIsSoftwareOnly in interface PluginDefinitionPluginDefinition.SOFTWAREONLY_DEFAULT,
PluginDefinition.isSoftwareOnly()@MediaPropertySetter(value="SoftwareOnly") public void setIsSoftwareOnly(Boolean isSoftwareOnly)
PluginDefinitionSet to true if the defined plugin is capable
of running in a software-only environment;
otherwise false. A value of true indicates
that no additional hardware is required. If the result is
true then this plugin may also support hardware
acceleration, as long as it also supports a software-only
method of processing data.
The default value of this optional property is false. To
omit this optional property, call this method with null.
setIsSoftwareOnly in interface PluginDefinitionisSoftwareOnly - Is the defined plugin capable of running in a software-only
environment?PluginDefinition.SOFTWAREONLY_DEFAULTpublic boolean supportsAuthentication()
PluginDefinitionReturns true if the defined plugin is capable of supporting authentication;
otherwise false.
If this optional property is not present, the default value of false is returned.
supportsAuthentication in interface PluginDefinitionPluginDefinition.AUTHENTICATION_DEFAULT,
PluginDefinition.getSupportsAuthentication()@MediaProperty(uuid1=85985550, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="Authentication", typeName="Boolean", optional=true, uniqueIdentifier=false, pid=8725, symbol="Authentication") public boolean getSupportsAuthentication()
PluginDefinitionReturns true if the defined plugin is capable of supporting authentication;
otherwise false.
If this optional property is not present, the default value of false is returned.
getSupportsAuthentication in interface PluginDefinitionPluginDefinition.AUTHENTICATION_DEFAULT,
PluginDefinition.supportsAuthentication()@MediaPropertySetter(value="Authentication") public void setSupportsAuthentication(Boolean supportsAuthentication)
PluginDefinitionSet to true if the defined plugin defined is capable of supporting authentication;
otherwise false.
The default value for this optional property is false. To
omit this optional property, call this method with null.
setSupportsAuthentication in interface PluginDefinitionsupportsAuthentication - Is the defined plugin capable of supporting authentication?PluginDefinition.AUTHENTICATION_DEFAULTpublic PluginDefinition clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface DefinitionObjectclone in interface InterchangeObjectclone in interface PluginDefinitionclone in class DefinitionObjectImplpublic String getPluginCategoryString()
public void setPluginCategoryString(String pluginCategory)
public String getPluginVersionPersist()
public void setPluginVersionPersist(String pluginVersion)
public String getManufacturerIDString()
public void setManufacturerIDString(String manufacturerID)
public String getPluginPlatformString()
public void setPluginPlatformString(String pluginPlatform)
public String getMaxPlatformVersionString()
public void setMaxPlatformVersionString(String maxPlatformVersion)
public String getMinPlatformVersionString()
public void setMinPlatformVersionString(String minPlatformVersion)
public String getEngineString()
public void setEngineString(String engine)
public String getMinEngineVersionString()
public void setMinEngineVersionString(String minEngineVersionString)
public String getMaxEngineVersionString()
public void setMaxEngineVersionString(String maxEngineVersion)
public String getPluginAPIString()
public void setPluginAPIString(String pluginAPI)
public String getMinPluginAPIString()
public void setMinPluginAPIString(String minPluginAPI)
public String getMaxPluginAPIString()
public void setMaxPluginAPIString(String maxPluginAPI)
public String getImplementedClassString()
public void setImplementedClassString(String implementedClass)
(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.