tv.amwa.maj.iface
Interface WAVEDescriptor

All Superinterfaces:

AAFFileDescriptor, EssenceDescriptor, InterchangeObject

All Known Implementing Classes:

WAVEDescriptor

public interface WAVEDescriptor
extends AAFFileDescriptor

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

For more information, see the description of WAVE on Wikipedia.

Author:

Richard Cartwright

See Also:

makeWAVEDescriptor(), CodecConstant.WAVE, SourceMob.getEssenceDescriptor(), ContainerConstant.RIFFWAVE

Method Summary

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() Deprecated. Use getSummary().length instead.
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 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

Method Detail

getSummary

@DataValue
byte[] getSummary()

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

Returns:

Summary property of this WAVE descriptor.

getSummaryBufferSize

@Deprecated
@UInt32
int getSummaryBufferSize()

Deprecated. Use getSummary().length instead.

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

Returns:

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

setSummary

void setSummary(@DataValue
                byte[] summary)
                throws NullPointerException

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

Parameters:

summary - Summary property for this WAVE descriptor.

Throws:

NullPointerException - The given summary is null.