|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Documented @Retention(value=RUNTIME) @Target(value=FIELD) public @interface ParameterDescription
Labels an AUID that is a unique identifier for a parameter to an operation. The additional metadata provided by this annotation can be used in combination with the identifier to create a parameter definition.
See the description of managing definitions in the package summary for more details of how to use these constants and dynamically extend the range of supported parameters.
ParameterConstant
,
ParameterDefinition
,
Parameter
Required Element Summary | |
---|---|
String |
typeName
The name of the AAF data type for all values of the parameter. |
Optional Element Summary | |
---|---|
String[] |
aliases
A list of alternative names that can be used as aliases for the parameter. |
String |
description
A brief description of the operation parameter. |
String |
displayUnits
An optional string of characters to display next to a value of the parameter to indicate its type, eg. |
Element Detail |
---|
public abstract String typeName
The name of the AAF data type for all values of the parameter.
TypeDefinitionWarehouse.forName(String)
,
LookupTable
public abstract String description
A brief description of the operation parameter.
public abstract String[] aliases
A list of alternative names that can be used as aliases for the parameter.
public abstract String displayUnits
An optional string of characters to display next to a value of the parameter to indicate its type, eg. "fps" for frames per second.
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |