Media Authoring
with Java API

tv.amwa.maj.iface
Interface ParameterDefinition

All Superinterfaces:
DefinitionObject, InterchangeObject
All Known Implementing Classes:
ParameterDefinition

public interface ParameterDefinition
extends DefinitionObject

Specifies the definition of a kind of parameter for an effect.

Author:
Richard Cartwright
See Also:
makeParameterDefinition(), Parameter, ParameterConstant, ParameterDefinition.forName(String), ParameterDefinition.forIdentification(tv.amwa.maj.record.AUID), Dictionary.getParameterDefinitions()

Method Summary
 String getDisplayUnits()
          Returns the display unit property of this parameter definition, which is a displayable string identifying the units in which the parameter is measured.
 TypeDefinition getTypeDefinition()
          Returns the type definition attached to this parameter definition, which specifies the data type of the parameter.
 void setDisplayUnits(String displayUnits)
          Sets the display units of this parameter definition, which is a displayable string identifying the units in which the parameter is measured.
 
Methods inherited from interface tv.amwa.maj.iface.DefinitionObject
getAUID, getDescription, getName, setDescription, setName
 
Methods inherited from interface tv.amwa.maj.iface.InterchangeObject
countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue
 

Method Detail

getTypeDefinition

TypeDefinition getTypeDefinition()

Returns the type definition attached to this parameter definition, which specifies the data type of the parameter.

Returns:
Type definition attached to this parameter definition.

setDisplayUnits

void setDisplayUnits(@AAFString
                     String displayUnits)

Sets the display units of this parameter definition, which is a displayable string identifying the units in which the parameter is measured. For example: "% of picture width". Set this optional property to null to omit it.

Parameters:
displayUnits - Display units of this parameter definition.

getDisplayUnits

@AAFString
String getDisplayUnits()
                       throws PropertyNotPresentException

Returns the display unit property of this parameter definition, which is a displayable string identifying the units in which the parameter is measured. For example: "% of picture width". This property is optional.

Returns:
Display unit property of the parameter definition.
Throws:
PropertyNotPresentException - The optional display units property is not present in this parameter definition.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.