tv.amwa.maj.entity
Class WAVEDescriptor

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

All Implemented Interfaces:

Serializable, Cloneable, MAJCommon, AAFFileDescriptor, EssenceDescriptor, InterchangeObject, WAVEDescriptor, XMLSerializable

@AAFClass(uuid1=218169601,
          uuid2=257,
          uuid3=11264,
          uuid4={6,14,43,52,2,6,1,1},
          definedName="WAVEDescriptor",
          description="The WAVEDescriptor class specifies that a File SourceMob is associated with audio essence formatted according to the RIFF Waveform Audio File Format (WAVE).")
public class WAVEDescriptor
extends AAFFileDescriptor
implements WAVEDescriptor, Serializable, Cloneable, MAJCommon

Implements the description of a file of audio essence formatted according to the RIFF Waveform Audio File Format (WAVE).

THE COMMENTS FOR THIS CLASS ARE INCOMPLETE.

Author:

Richard Cartwright

See Also:

Serialized Form

Nested Class Summary

static class

WAVEDescriptor.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

WAVEDESCRIPTOR_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

WAVEDescriptor(ContainerDefinition containerFormat, byte[] summary)
Creates and initializes a new WAVE descriptor, which specifies that a file source mob is associated with audio essence formatted according to the RIFF Waveform Audio File Format (WAVE).

Method Summary

void	appendXMLChildren(Node parent) Append child elements to the given parent node to serialize the value of an object to an XML fragment.
WAVEDescriptor	clone() Creates a cloned copy of this entity.
boolean	equals(Object o) Tests to see if the given object is equal to this interchange object.
byte[]	getSummary() Returns a copy of the WAVE file information without the associated sample data from the audio essence described by this WAVE descriptor.
int	getSummaryBufferSize() Returns the size of the data buffer required for the WAVEDescriptor.getSummary() method.
int	hashCode() Returns a hash code value for this interchange object.
void	setPropertiesFromInterface(WAVEDescriptor castFrom)
void	setSummary(byte[] summary) Sets the copy of WAVE file information without the sample data from the audio essence described by this WAVE descriptor.

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

WAVEDESCRIPTOR_TAG

public static final String WAVEDESCRIPTOR_TAG

See Also:

Constant Field Values

Constructor Detail

WAVEDescriptor

public WAVEDescriptor(ContainerDefinition containerFormat,
                      @DataBuffer
                      byte[] summary)
               throws NullPointerException

Creates and initializes a new WAVE descriptor, which specifies that a file source mob is associated with audio essence formatted according to the RIFF Waveform Audio File Format (WAVE).

Parameters:

containerFormat - Container mechanism used to store the essence.

summary - A copy of the WAVE file information without the sample data.

Throws:

NullPointerException - One or both of the arguments is/are null and both are required.

Method Detail

setPropertiesFromInterface

public final void setPropertiesFromInterface(WAVEDescriptor castFrom)

See Also:

InterchangeObject.setPropertiesFromInterface(tv.amwa.maj.iface.InterchangeObject)

getSummary

@AAFProperty(uuid1=50529026,
             uuid2=256,
             uuid3=0,
             uuid4={6,14,43,52,1,1,1,2},
             definedName="Summary",
             typeName="DataValue",
             optional=false,
             uniqueIdentifier=false,
             pid=14337)
public byte[] getSummary()

Description copied from interface: WAVEDescriptor

Returns a copy of the WAVE file information without the associated sample data from the audio essence described by this WAVE descriptor.

Specified by:

getSummary in interface WAVEDescriptor

Returns:

Summary property of this WAVE descriptor.

setSummary

public void setSummary(byte[] summary)
                throws NullPointerException

Description copied from interface: WAVEDescriptor

Sets the copy of WAVE file information without the sample data from the audio essence described by this WAVE descriptor.

Specified by:

setSummary in interface WAVEDescriptor

Parameters:

summary - Summary property for this WAVE descriptor.

Throws:

NullPointerException - The given summary is null.

getSummaryBufferSize

public int getSummaryBufferSize()

Description copied from interface: WAVEDescriptor

Returns the size of the data buffer required for the WAVEDescriptor.getSummary() method.

Specified by:

getSummaryBufferSize in interface WAVEDescriptor

Returns:

Size of the data buffer required for the WAVEDescriptor.getSummary() method.

equals

public boolean equals(Object o)

Description copied from interface: MAJCommon

Tests to see if the given object is equal to this interchange object. To be equal, the given value must be not null, share the same interface to its value and each of the properties of the value must each be equal.

Specified by:

equals in interface MAJCommon

Overrides:

equals in class AAFFileDescriptor

Parameters:

o - Object to test for equality with.

Returns:

Is the given object equals to this value?

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Description copied from interface: MAJCommon

Returns a hash code value for this interchange object.

Specified by:

hashCode in interface MAJCommon

Overrides:

hashCode in class AAFFileDescriptor

Returns:

Hash code value for this interchange object.

See Also:

Object.hashCode()

clone

public WAVEDescriptor clone()

Description copied from interface: MAJCommon

Creates a cloned copy of this entity. The clone will be initialized to have the same value as this value but exists independently from then on. Changes to this value will not effect the clone and changes to the clone will not effect this. MAJ API clones are true deep clones with no shared references to areas of memory within the original.

This method does not throw a CloneNotSupportedException as all entity values must implement the Cloneable interface. If a cloning error does occur, a null value will be returned but this is very unlikely to happen.

Specified by:

clone in interface MAJCommon

Overrides:

clone in class EssenceDescriptor

Returns:

Independent clone of this value, which is a deep copy.

See Also:

Object.clone()

appendXMLChildren

public void appendXMLChildren(Node parent)

Description copied from interface: XMLSerializable

Append child elements to the given parent node to serialize the value of an object to an XML fragment. Methods of the XMLBuilder class are provided to help with this process.

Specified by:

appendXMLChildren in interface XMLSerializable

Overrides:

appendXMLChildren in class AAFFileDescriptor

Parameters:

parent - XML parent element to append child nodes to.