MultipleDescriptor (MAJ API)

Overview

Package

Class

Tree

Deprecated

Index

Media Authoring
with Java API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

tv.amwa.maj.entity
Class MultipleDescriptor

java.lang.Object
  tv.amwa.maj.entity.InterchangeObject
      tv.amwa.maj.entity.EssenceDescriptor
          tv.amwa.maj.entity.AAFFileDescriptor
              tv.amwa.maj.entity.MultipleDescriptor

All Implemented Interfaces:: Serializable, Cloneable, MAJCommon, AAFFileDescriptor, EssenceDescriptor, InterchangeObject, MultipleDescriptor, XMLSerializable

@AAFClass(uuid1=218169601, uuid2=257, uuid3=17408, uuid4={6,14,43,52,2,6,1,1}, definedName="MultipleDescriptor", description="Describes the format of the content data associated with a file source mob containing multiple tracks of essence.") public class MultipleDescriptor
extends AAFFileDescriptor
implements MultipleDescriptor, Serializable, Cloneable, MAJCommon
extends AAFFileDescriptor
implements MultipleDescriptor, Serializable, Cloneable, MAJCommon

Implements the description of content data associated with a single file source mob that contains multiple tracks of essence. Each file descriptor within a multiple descriptor should set the linked slot property that links it to the source mob slot that it describes.

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:: Richard Cartwright
See Also:: Serialized Form

Nested Class Summary
`static class`	`MultipleDescriptor.FileDescriptorsXMLHandler`
`static class`	`MultipleDescriptor.XMLHandler`

Nested classes/interfaces inherited from class tv.amwa.maj.entity.AAFFileDescriptor
`AAFFileDescriptor.FileDescriptorXMLHandler`

Nested classes/interfaces inherited from class tv.amwa.maj.entity.EssenceDescriptor
`EssenceDescriptor.EssenceDescriptorXMLHandler, EssenceDescriptor.LocatorXMLHandler, EssenceDescriptor.SubDescriptorXMLHandler`

Nested classes/interfaces inherited from class tv.amwa.maj.entity.InterchangeObject
`InterchangeObject.InterchangeObjectXMLHandler`

Field Summary
`static String`	`MULTIPLEDESCRIPTOR_TAG`

Fields inherited from class tv.amwa.maj.entity.AAFFileDescriptor
`FILEDESCRIPTOR_ITEM`

Fields inherited from class tv.amwa.maj.entity.EssenceDescriptor
`ESSENCEDESCRIPTOR_ITEM`

Constructor Summary
`MultipleDescriptor()` Creates and initializes a new multiple descriptor for static essence, which describes the format of the content data associated with a `file source mob` containing multiple tracks of essence.
`MultipleDescriptor(Rational sampleRate, long length)` Creates and initializes a new multiple descriptor for time varying essence, which describes the format of the content data associated with a `file source mob` containing multiple tracks of essence.

Method Summary
`void`	`appendFileDescriptor(AAFFileDescriptor fileDescriptor)` Appends a file descriptor to the list of file descriptors of this multiple descriptor.
`void`	`appendXMLChildren(Node parent)` Append child elements to the given parent node to serialize the value of an object to an XML fragment.
`MultipleDescriptor`	`clone()` Creates a cloned copy of this entity.
`int`	`countFileDescriptors()` Returns the number of file descriptors of this multiple descriptor.
`boolean`	`equals(Object o)` Tests to see if the given object is equal to this interchange object.
`AAFFileDescriptor`	`getFileDescriptorAt(int index)` Returns the file descriptor at the given index through the list of file descriptors of this multiple descriptor.
`List<AAFFileDescriptor>`	`getFileDescriptors()` Returns a copy of the list of file descriptors of this multiple descriptor.
`int`	`hashCode()` Returns a hash code value for this interchange object.
`void`	`insertFileDescriptorAt(int index, AAFFileDescriptor fileDescriptor)` Insert a file descriptor into the list of file descriptors of this multiple descriptor at the given index.
`void`	`prependFileDescriptor(AAFFileDescriptor fileDescriptor)` Prepends a file descriptor to the list of file descriptors of this multiple essence descriptor.
`void`	`removeFileDescriptorAt(int index)` Removes the file descriptor at the given index from the list of file descriptors of this multiple descriptor.
`void`	`setPropertiesFromInterface(MultipleDescriptor castFrom)`

Methods inherited from class tv.amwa.maj.entity.AAFFileDescriptor
`describesStaticEssence, getCodecDefinition, getContainerFormat, getLength, getLinkedSlotID, getSampleRate, setCodecDefinition, setContainerFormat, setDescribesStaticEssence, setDescribesTimeVaryingEssence, setLength, setLinkedSlotID, setPropertiesFromInterface, setSampleRate`

Methods inherited from class tv.amwa.maj.entity.EssenceDescriptor
`appendLocator, appendSubDescriptor, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAt, setPropertiesFromInterface`

Methods inherited from class tv.amwa.maj.entity.InterchangeObject
`castFromInterface, countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, registerImplementation, setPropertiesFromInterface, setPropertyValue, toString`

Methods inherited from class java.lang.Object
`getClass, notify, notifyAll, wait, wait, wait`

Methods inherited from interface tv.amwa.maj.iface.AAFFileDescriptor
`getCodecDefinition, getContainerFormat, getLength, getLinkedSlotID, getSampleRate, setCodecDefinition, setContainerFormat, setLength, setLinkedSlotID, setSampleRate`

Methods inherited from interface tv.amwa.maj.iface.EssenceDescriptor
`appendLocator, appendSubDescriptor, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAt`

Methods inherited from interface tv.amwa.maj.iface.InterchangeObject
`countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue`

Methods inherited from interface tv.amwa.maj.entity.MAJCommon
`toString`

Field Detail

MULTIPLEDESCRIPTOR_TAG

public static final String MULTIPLEDESCRIPTOR_TAG

See Also:: Constant Field Values

Constructor Detail

MultipleDescriptor

public MultipleDescriptor()

Creates and initializes a new multiple descriptor for static essence, which describes the format of the content data associated with a file source mob containing multiple tracks of essence. File descriptors for each of the tracks of data can then be added using the append, insert and prepend methods.

MultipleDescriptor

public MultipleDescriptor(Rational sampleRate,
                          @LengthType
                          long length)
                   throws NullPointerException,
                          IllegalArgumentException

Creates and initializes a new multiple descriptor for time varying essence, which describes the format of the content data associated with a file source mob containing multiple tracks of essence. File descriptors for each of the tracks of data can then be added using the append, insert and prepend methods.

Parameters:: sampleRate - Sample rate for the content represented by this multiple descriptor.; length - Length of content represented by this multiple descriptor.
Throws:: NullPointerException - The sample rate argument is null.; IllegalArgumentException - The length of the multiple descriptor cannot be a negative value.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(MultipleDescriptor castFrom)

See Also:: InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)