|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OperationDefinition
Specifies the definition of an operation that is performed on an array of segments. Operation definitions specify which parameters are possible on an operation, while an operation group specifies specific parameters and input segments for a particular operation invocation.
makeOperationDefinition()
,
OperationConstant
,
OperationDefinition.forName(String)
,
OperationDefinition.forIdentification(AUID)
,
Dictionary.getOperationDefinitions()
Field Summary | |
---|---|
static boolean |
ISTIMEWARP_DEFAULT
Default value for the is time warp property, which is false. |
Method Summary | |
---|---|
void |
addParameterDefinition(ParameterDefinition parameterDefinition)
Add a parameter definition to the unordered collection of parameter definitions of this operation definition, which specify the parameters that can be used as controls for the operation. |
void |
appendDegradeToOperation(OperationDefinition operationDefinition)
Append an operation definition tto the degrade-to list of operation definitions of this operation definition, which specify simpler operations that an application can substitute for the defined operation if it cannot process it. |
int |
countDegradeToOperations()
Returns the number of degrade-to operations in this operation definition, which specify simpler operations that an application can substitute for the defined operation if it cannot process it. |
int |
countParameterDefinitions()
Return the number of parameter definitions of this operation definition, which specify the parameters that can be used as controls for the operation. |
int |
getBypass()
Gets the bypass media segment index, which specifies the array index (1-based) of the input segment which is the primary input. |
AUID |
getCategory()
Returns an AUID identifying the category of this operation definition, which specifies the kind of operation, such as video effect, audio effect, or 3D operation. |
DataDefinition |
getDataDefinition()
Returns the data definition referenced from this operation definition, which identifies the kind of data that is produced by the operation. |
List<? extends OperationDefinition> |
getDegradeToOperations()
Returns the list of degrade-to operation definitions of this operation definition, which specify simpler operations that an application can substitute for the defined operation if it cannot process it. |
int |
getNumberInputs()
Returns the number of input media segments of this operation definition. |
Set<? extends ParameterDefinition> |
getParameterDefinitions()
Returns the collection of parameter definitions of this operation definition, which specify the parameters that can be used as controls for the operation. |
void |
insertDegradeToOperationAt(int index,
OperationDefinition operationDefinition)
Insert an operation definition into the degrade-to list of definitions of this operation definition at the given index. |
boolean |
isTimeWarp()
Returns true if the length of an operation group
is different from the lengths of the input segments, for example a
slow motion effect. |
ParameterDefinition |
lookupParameterDefinition(AUID parameterDefinition)
Looks up and returns the parameter definition corresponding to the given identifier from the collection of defined parameters of this operation definition. |
void |
prependDegradeToOperation(OperationDefinition operationDefinition)
Prepend an operation definition to the degrade-to list of operation definitions of this operation definition, which specify simpler operations that an application can substitute for the defined operation if it cannot process it. |
void |
removeDegradeToOperationAt(int index)
Removes the indexed operation definition from the degrade-to list of operation definitions of this operation definition, which specify simpler operations that an application can substitute for the defined operation if it cannot process it. |
void |
setBypass(Integer bypass)
Sets the bypass media segment index, which specifies the array index (1-based) of the input segment which is the primary input. |
void |
setCategory(AUID category)
Sets an AUID identifying the category of this operation definition, which specifies the kind of operation, such as video effect, audio effect, or 3D operation. |
void |
setDataDefinition(DataDefinition dataDefinition)
Sets the data definition of this operation definition, which identifies the kind of data that is produced by the operation. |
void |
setIsTimeWarp(Boolean isTimeWarp)
Set to true to indicate that the the length of an
operation group is different from the lengths of the input segments,
for example a slow motion effect. |
void |
setNumberInputs(int numberInputs)
Sets the number of input media segments for the operation definition. |
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 |
Field Detail |
---|
static final boolean ISTIMEWARP_DEFAULT
Default value for the is time warp property, which is false.
isTimeWarp()
,
setIsTimeWarp(Boolean)
,
Constant Field ValuesMethod Detail |
---|
DataDefinition getDataDefinition()
Returns the data definition referenced from this operation definition, which identifies the kind of data that is produced by the operation.
void setDataDefinition(DataDefinition dataDefinition) throws NullPointerException
Sets the data definition of this operation definition, which identifies the kind of data that is produced by the operation.
dataDefinition
- Data definition of the operation.
NullPointerException
- The given data definition is null
.@Bool boolean isTimeWarp()
Returns true
if the length of an operation group
is different from the lengths of the input segments, for example a
slow motion effect.
If this optional property is not present, its default value of false is returned.
ISTIMEWARP_DEFAULT
void setIsTimeWarp(@Bool Boolean isTimeWarp)
Set to true
to indicate that the the length of an
operation group is different from the lengths of the input segments,
for example a slow motion effect.
The default value for this optional property is false. To
omit this optional property, call this method with null
.
isTimeWarp
- Does this operation change the total length of segments
in the associated operation group?ISTIMEWARP_DEFAULT
void prependDegradeToOperation(OperationDefinition operationDefinition) throws NullPointerException
Prepend an operation definition to the degrade-to list of operation definitions of this operation definition, which specify simpler operations that an application can substitute for the defined operation if it cannot process it. Use this function to add an operation definition to be scanned first when searching for a replacement, to be considered as a more desirable alternate operation.
operationDefinition
- Degrade-to operation definition to add.
NullPointerException
- The given degrade-to operation definition is null
.void appendDegradeToOperation(OperationDefinition operationDefinition) throws NullPointerException
Append an operation definition tto the degrade-to list of operation definitions of this operation definition, which specify simpler operations that an application can substitute for the defined operation if it cannot process it. Use this function to add an operation definition to be scanned last when searching for a replacement, to be considered as a less desirable alternate operation.
operationDefinition
- Degrade-to operation to append.
NullPointerException
- The given degrade-to operation definition is null
.void insertDegradeToOperationAt(@UInt32 int index, OperationDefinition operationDefinition) throws NullPointerException, IndexOutOfBoundsException
Insert an operation definition into the degrade-to list of definitions of this operation definition at the given index. The degrade-to list of operation definitions specify simpler operations that an application can substitute for the defined operation if it cannot process it. Operation definitions already existing at the given and higher indices will be moved up to the next higher index to accommodate.
index
- 0-based index at which the operation definition is to be inserted.operationDefinition
- Degrade-to operation definition to insert at the
specified index.
NullPointerException
- The given operation definition is null
.
IndexOutOfBoundsException
- The index is outside the acceptable range for
the current degrade-to list.void removeDegradeToOperationAt(@UInt32 int index) throws IndexOutOfBoundsException
Removes the indexed operation definition from the degrade-to list of operation definitions of this operation definition, which specify simpler operations that an application can substitute for the defined operation if it cannot process it. Operation definitions already existing at indices higher than the given index will be moved down to the next lower index to accommodate.
index
- 0-based index of operation definition to remove from the
degrade-to list of this operation definition
IndexOutOfBoundsException
- The index is outside the range acceptable range for
the current degrade-to list.List<? extends OperationDefinition> getDegradeToOperations()
Returns the list of degrade-to operation definitions of this operation definition, which specify simpler operations that an application can substitute for the defined operation if it cannot process it. The definitions are ordered from the most desirable to the least desirable alternative.
@UInt32 int countDegradeToOperations()
Returns the number of degrade-to operations in this operation definition, which specify simpler operations that an application can substitute for the defined operation if it cannot process it.
AUID getCategory() throws PropertyNotPresentException
Returns an AUID identifying the category of this operation definition, which specifies the kind of operation, such as video effect, audio effect, or 3D operation. This is an optional property.
PropertyNotPresentException
- The optional operation category property is not present
for this operation definition.OperationCategoryType
,
TypeDefinitionExtendibleEnumeration.OperationCategoryType
void setCategory(AUID category)
Sets an AUID identifying the
category of this operation definition, which specifies the kind of operation, such as video effect,
audio effect, or 3D operation. Set this optional property to null
to omit
it.
category
- AUID indicating the category of the operation definition.OperationCategoryType
,
TypeDefinitionExtendibleEnumeration.OperationCategoryType
@Int32 int getNumberInputs()
Returns the number of input media segments of this operation definition. A value of -1 indicates that the effect can have any number of input segments.
void setNumberInputs(@Int32 int numberInputs)
Sets the number of input media segments for the operation definition. A value of -1 indicates that the effect can have any number of input segments.
numberInputs
- Number of input media segments of this operation
definition.@UInt32 int getBypass() throws PropertyNotPresentException
Gets the bypass media segment index, which specifies the array index (1-based) of the input segment which is the primary input. This value allows the client application to pick one of the inputs (foreground, background, etc.) to stand in for the effect if it is not available and none of the degrade-to effects are available. This is an optional property.
Note that the methods of the C-based AAF reference implementation use 0-based indexing.
PropertyNotPresentException
- The optional bypass property is
not present in this operation definition.void setBypass(@UInt32 Integer bypass)
Sets the bypass media segment index, which specifies the array index (1-based)
of the input segment which is the primary input. This value
allows the client application to pick one of the inputs
(foreground, background, etc.) to stand in for the
effect if it is not available, and none of the degrade to
effects are available. Set this optional property to null
to omit it.
bypass
- Index of bypass media segment for the operation definition.void addParameterDefinition(ParameterDefinition parameterDefinition) throws NullPointerException, ObjectAlreadyAttachedException
Add a parameter definition to the unordered collection of parameter definitions of this operation definition, which specify the parameters that can be used as controls for the operation.
parameterDefinition
- Parameter definition object to add.
NullPointerException
- The given parameter definition is null
.
ObjectAlreadyAttachedException
- Parameter definition is already
present within this operation definition.OperationGroup.addParameter(Parameter)
Set<? extends ParameterDefinition> getParameterDefinitions()
Returns the collection of parameter definitions of this operation definition, which specify the parameters that can be used as controls for the operation.
OperationGroup.addParameter(Parameter)
@UInt32 int countParameterDefinitions()
Return the number of parameter definitions of this operation definition, which specify the parameters that can be used as controls for the operation.
ParameterDefinition lookupParameterDefinition(AUID parameterDefinition) throws NullPointerException, ObjectNotFoundException
Looks up and returns the parameter definition corresponding to the given identifier from the collection of defined parameters of this operation definition.
parameterDefinition
- Identity of the parameter definition to look up.
NullPointerException
- The given identifier for a parameter definition is
null
.
ObjectNotFoundException
- The given identifier does not correspond
to a parameter definition of this operation definition.
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |