public interface CodecDefinition extends DefinitionObject
Specifies the definition of an essence codec. A codec is a program or system capable of performing encoding and decoding on a digital data stream, which is often the case for the data streams represented by essence data in the MAJ API.
| Modifier and Type | Method and Description |
|---|---|
void |
appendEssenceKind(DataDefinition essenceKind)
Appends the given essence kind to the list of those supported by the codec, which
specify the data definitions of the
essence formats that the defined codec processes.
|
void |
clearEssenceKinds()
Clears the list of essence kinds for this codec definition.
|
CodecDefinition |
clone()
Create a cloned copy of this codec definition.
|
int |
countEssenceKinds()
Returns the number of supported essence kinds of this codec
definition, which specify the data definitions of the
essence formats that the defined codec processes.
|
DataDefinition |
getEssenceKindAt(int index)
Returns the essence kind at the given index in the list of supported essence
kinds of this codec.
|
List<? extends DataDefinition> |
getEssenceKinds()
Returns a set of the essence kinds for the defined codec, which
specify the data definitions of the
essence formats that the defined codec processes.
|
ClassDefinition |
getFileDescriptorClass()
Returns the file descriptor class object associated with the
defined codec, which specifies the class definition of the sub-class
of file descriptor that identifies the essence format that the defined
codec processes.
|
void |
insertEssenceKind(int index,
DataDefinition essenceKind)
Inserts the given essence kind to the list of those supported by the codec at the given
index.
|
boolean |
isEssenceKindSupported(DataDefinition essenceKind)
Returns
true if the given codec supports transfers to essence
of the given essence kind. |
void |
prependEssenceKind(DataDefinition essenceKind)
Prepends the given essence kind to the list of those supported by the codec, which
specify the data definitions of the
essence formats that the defined codec processes.
|
void |
removeEssenceKind(DataDefinition essenceKind)
Removes the given essence kind from the list of those supported
by the codec, which specify the data definitions of the
essence formats that the defined codec processes.
|
void |
removeEssenceKindAt(int index)
Removes the essence kind at the given index in the list of essence kinds
for this codec definition.
|
void |
setFileDescriptorClass(ClassDefinition fileClass)
Sets the file descriptor class associated with this codec, which specifies
the class definition of the sub-class of
FileDescriptor that identifies the essence format
that the defined codec processes. |
getAUID, getDescription, getName, setDescription, setNameaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexgetWeakTargetReference@Bool boolean isEssenceKindSupported(DataDefinition essenceKind) throws NullPointerException
Returns true if the given codec supports transfers to essence
of the given essence kind.
essenceKind - The essence kind to test.NullPointerException - The given essence kind is null.DataDefinitionConstantvoid appendEssenceKind(DataDefinition essenceKind) throws NullPointerException, DuplicateEssenceKindException
Appends the given essence kind to the list of those supported by the codec, which specify the data definitions of the essence formats that the defined codec processes. The content of the list is dependent upon the specified format for the codec, not on whether an implementation supports all parts of the format.
essenceKind - The essence kind to append.NullPointerException - The given essence kind is null.DuplicateEssenceKindException - The given essence kind is already
contained.prependEssenceKind(DataDefinition),
insertEssenceKind(int, DataDefinition),
DataDefinitionConstantvoid prependEssenceKind(DataDefinition essenceKind) throws NullPointerException, DuplicateEssenceKindException
Prepends the given essence kind to the list of those supported by the codec, which specify the data definitions of the essence formats that the defined codec processes. The content of the list is dependent upon the specified format for the codec, not on whether an implementation supports all parts of the format.
essenceKind - The essence kind to prepend.NullPointerException - The given essence kind is null.DuplicateEssenceKindException - The given essence kind is already
contained.appendEssenceKind(DataDefinition),
insertEssenceKind(int, DataDefinition),
DataDefinitionConstantvoid insertEssenceKind(int index,
DataDefinition essenceKind)
throws NullPointerException,
DuplicateEssenceKindException,
IndexOutOfBoundsException
Inserts the given essence kind to the list of those supported by the codec at the given index. Essence kinds specify the data definitions of the essence formats that the defined codec processes. The content of the list is dependent upon the specified format for the codec, not on whether an implementation supports all parts of the format.
index - Index in the list where the essence kind is to be inserted.essenceKind - The essence kind to insert.NullPointerException - The given essence kind is null.DuplicateEssenceKindException - The given essence kind is already
contained.IndexOutOfBoundsException - The given index is outside the acceptable range for the
current list of supported essence kinds.appendEssenceKind(DataDefinition),
prependEssenceKind(DataDefinition),
DataDefinitionConstantDataDefinition getEssenceKindAt(int index) throws IndexOutOfBoundsException
Returns the essence kind at the given index in the list of supported essence kinds of this codec.
index - Index of the essence kind to retrieve.IndexOutOfBoundsException - The given index is outside the acceptable range for the
current list of supported essence kinds.getEssenceKinds()void clearEssenceKinds()
Clears the list of essence kinds for this codec definition. Note that the list of essence kinds is a required property and so a call to this method should be followed by a call to add another essence kind.
void removeEssenceKind(DataDefinition essenceKind) throws NullPointerException, ObjectNotFoundException, IllegalArgumentException
Removes the given essence kind from the list of those supported by the codec, which specify the data definitions of the essence formats that the defined codec processes.
essenceKind - The essence kind to remove.NullPointerException - Argument is null.ObjectNotFoundException - The given kind of essence is not already
contained.IllegalArgumentException - Cannot remove an item from the set if it
will become empty.removeEssenceKindAt(int),
DataDefinitionConstantvoid removeEssenceKindAt(int index)
throws IndexOutOfBoundsException
Removes the essence kind at the given index in the list of essence kinds for this codec definition.
index - Index of the essence kind to remove.IndexOutOfBoundsException - The given index is outside the acceptable range for the
current list of supported essence kinds.removeEssenceKind(DataDefinition)@UInt32 int countEssenceKinds()
Returns the number of supported essence kinds of this codec definition, which specify the data definitions of the essence formats that the defined codec processes.
List<? extends DataDefinition> getEssenceKinds()
Returns a set of the essence kinds for the defined codec, which specify the data definitions of the essence formats that the defined codec processes.
getEssenceKindAt(int),
DataDefinitionConstant,
TypeDefinitions.DataDefinitionWeakReferenceSet,
TypeDefinitions.DataDefinitionWeakReferenceVectorClassDefinition getFileDescriptorClass()
Returns the file descriptor class object associated with the defined codec, which specifies the class definition of the sub-class of file descriptor that identifies the essence format that the defined codec processes.
FileDescriptor that identifies the essence format that the defined
codec processes.void setFileDescriptorClass(ClassDefinition fileClass) throws NullPointerException, IllegalArgumentException
Sets the file descriptor class associated with this codec, which specifies
the class definition of the sub-class of
FileDescriptor that identifies the essence format
that the defined codec processes.
fileClass - Specifies the class definition of the sub-class
of AAFFileDescriptor that identifies the essence format that the defined
codec processes.NullPointerException - The given class definition for a sub-class of file descriptor
is null.IllegalArgumentException - The given class definition is not for a sub-class of
FileDescriptor.CodecConstantCodecDefinition clone()
Create a cloned copy of this codec definition.
clone in interface DefinitionObjectclone in interface InterchangeObjectclone in interface MediaEntity(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.