@MediaClass(uuid1=218169601, uuid2=257, uuid3=18432, uuid4={6,14,43,52,2,6,1,1}, definedName="WAVEPCMDescriptor", aliases="PCMDescritpor", description="The WAVEPCMDescriptor class specifies that a File SourcePackage is associated with audio essence formatted according to the BWF File Format.", symbol="WAVEPCMDescriptor") public class WAVEPCMDescriptorImpl extends SoundDescriptorImpl implements WAVEPCMDescriptor, WAVEPCMDescriptor, Serializable, Cloneable
Implements the description of a file source package that is associated with audio essence formatted according to the BWF file format.
BWFImportDescriptorImpl,
Serialized FormObjectClassPropertyID| Constructor and Description |
|---|
WAVEPCMDescriptorImpl() |
WAVEPCMDescriptorImpl(ContainerDefinition containerFormat,
Rational audioSamplingRate,
int channels,
int quantizationBits,
short blockAlign,
int averageBPS)
Creates and initializes a new PCM sound descriptor, which is associated with audio essence
formatted according to the
BWF File
Format.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
areAllPeakEnvelopePropertiesPresent()
Returns
true if all the following optional properties are
set for this PCM descriptor: |
WAVEPCMDescriptor |
clone()
Create a cloned copy of this interchange object.
|
int |
getAverageBytesPerSecond()
Returns the average bytes per second of the essence stream described
by this PCM descriptor.
|
short |
getBlockAlign()
Returns the number of bytes used to store one sample of all channels
of data associated with this PCM descriptor.
|
AUID |
getChannelAssignment()
Returns the channel assignment scheme for this PCM descriptor.
|
String |
getChannelAssignmentString() |
int |
getDataOffset() |
int |
getPeakChannelCount()
Returns the number of peak channels for this PCM descriptor.
|
int |
getPeakEnvelopeBlockSize()
Returns the number of audio samples used to generate each peak
frame for this PCM descriptor.
|
Stream |
getPeakEnvelopeData()
Returns the stream containing the peak envelope data for this PCM descriptor.
|
long |
getPeakEnvelopeDataPosition()
Returns the offset from the beginning of the peak envelope data
for this PCM descriptor.
|
long |
getPeakEnvelopeDataSize()
Returns the size of the peak envelope data of this PCM
descriptor.
|
int |
getPeakEnvelopeFormat()
Returns the format of the peak point for this PCM descriptor.
|
TimeStamp |
getPeakEnvelopeTimestamp()
Returns the time stamp for the date and time
of the creation of this peak data for this PCM descriptor.
|
String |
getPeakEnvelopeTimestampString() |
int |
getPeakEnvelopeVersion()
Returns the version information of the peak envelope data of this PCM
descriptor.
|
int |
getPeakFrameCount()
Returns the number of peak frames for this PCM descriptor.
|
long |
getPeakOfPeaksPosition()
Returns the offset to the first audio sample whose absolute
value is the maximum value of the entire audio file represented by
this PCM descriptor.
|
int |
getPointsPerPeakValue()
Returns the number of peak points per peak value for this PCM
descriptor.
|
byte |
getSequenceOffset()
Returns the frame number of the beginning of the essence data
within a five-frame sequence for this PCM descriptor.
|
static int |
initializeAverageBytesPerSecond() |
static short |
initializeBlockAlign() |
ByteBuffer |
readPeakEnvelopeData(int bytes)
Read the given number of bytes of data from the peak envelope
data stream of this PCM descriptor at the
WAVEPCMDescriptor.getPeakEnvelopeDataPosition()
current position. |
void |
setAverageBytesPerSecond(int bps)
Sets the average bytes per second of the essence stream described
by this PCM descriptor.
|
void |
setBlockAlign(short blockAlign)
Sets the number of bytes used to store one sample of all channels
of data associated with this PCM descriptor.
|
void |
setChannelAssignment(AUID channelAssignment)
Sets the channel assignment scheme of this PCM descriptor.
|
void |
setChannelAssignmentString(String channelAssignment) |
void |
setDataOffset(Integer dataOffset) |
void |
setPeakChannelCount(Integer channelCount)
Sets the number of peak channels for this PCM descriptor.
|
void |
setPeakEnvelopeBlockSize(Integer blockSize)
Sets the number of audio samples used to generate each peak
frame for this PCM descriptor.
|
void |
setPeakEnvelopeData(Stream peakEnvelopeData)
Set the peak envelope data stream of this PCM descriptor.
|
void |
setPeakEnvelopeDataPosition(long position)
Sets the offset from the beginning of the peak envelope data
for this PCM descriptor.
|
void |
setPeakEnvelopeFormat(Integer format)
Sets the format of the peak point for this PCM descriptor.
|
void |
setPeakEnvelopeTimestamp(TimeStamp timeStamp)
Sets the time stamp for the date and time of
the creation of the peak data for the PCM descriptor.
|
void |
setPeakEnvelopeTimestampString(String peakEnvelopeTimestampString) |
void |
setPeakEnvelopeVersion(Integer version)
Sets the version information of the peak envelope data of this PCM
descriptor.
|
void |
setPeakFrameCount(Integer frameCount)
Sets the number of peak frames for this PCM descriptor.
|
void |
setPeakOfPeaksPosition(Long position)
Sets the offset to the first audio sample whose absolute
value is the maximum value of the entire audio file described by
this PCM descriptor.
|
void |
setPointsPerPeakValue(Integer pointCount)
Sets the number of peak points per peak value for this PCM
descriptor.
|
void |
setSequenceOffset(Byte offset)
Sets the frame number of the beginning of the essence data
within a five-frame sequence for this PCM descriptor.
|
int |
writePeakEnvelopeData(ByteBuffer bytes)
Write the given bytes to the peak envelope data stream of the
PCM descriptor at the current position, as determined by calling
WAVEPCMDescriptor.getPeakEnvelopeDataPosition(). |
getAudioReferenceLevel, getAudioSampleRate, getAudioSampleRateString, getChannelCount, getDialNorm, getElectrospatialFormulation, getLocked, getQuantizationBits, getSoundCompression, getSoundCompressionString, initializeAudioSampleRate, initializeChannelCount, initializeQuantizationBits, isLocked, setAudioReferenceLevel, setAudioSampleRate, setAudioSampleRateString, setChannelCount, setDialNorm, setElectrospatialFormulation, setIsLocked, setQuantizationBits, setSoundCompression, setSoundCompressionStringdescribesStaticEssence, getCodec, getContainerFormat, getEssenceLength, getLinkedTrackID, getSampleRate, getSampleRateString, getTwentyFourBitAudio, initializeEssenceLength, initializeSampleRate, setCodec, setContainerFormat, setDescribesStaticEssence, setDescribesTimeVaryingEssence, setEssenceLength, setEssenceLengthFromStream, setLinkedTrackID, setSampleRate, setSampleRateFromStream, setSampleRateString, setTwentyFourBitAudioappendLocator, appendSubDescriptor, clearLocators, clearSubDescriptors, countLocators, countSubDescriptors, getComment, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAtaddApplicationPlugin, appendXMLChildren, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getLinkedGenerationIDString, getObjectClass, getPersistentID, getPersistentIndex, hashCode, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setLinkedGenerationIDString, setObjectClass, setPersistentID, setPersistentIndex, toStringgetAudioReferenceLevel, getAudioSampleRate, getChannelCount, getDialNorm, getElectrospatialFormulation, getLocked, getQuantizationBits, getSoundCompression, isLocked, setAudioReferenceLevel, setAudioSampleRate, setChannelCount, setDialNorm, setElectrospatialFormulation, setIsLocked, setQuantizationBits, setSoundCompressiongetCodec, getContainerFormat, getEssenceLength, getLinkedTrackID, getSampleRate, setCodec, setContainerFormat, setEssenceLength, setLinkedTrackID, setSampleRateappendLocator, appendSubDescriptor, clearLocators, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAtaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexpublic WAVEPCMDescriptorImpl()
public WAVEPCMDescriptorImpl(ContainerDefinition containerFormat, Rational audioSamplingRate, @UInt32 int channels, @UInt32 int quantizationBits, @UInt16 short blockAlign, @UInt32 int averageBPS) throws NullPointerException, IllegalArgumentException
Creates and initializes a new PCM sound descriptor, which is associated with audio essence formatted according to the BWF File Format.
containerFormat - Identifies the container mechanism used to store the essence.audioSamplingRate - Sampling rate of the audio essence.channels - Number of audio channels.quantizationBits - Number of quantization bits.blockAlign - Sample block alignment.averageBPS - Average bytes per second.NullPointerException - The container format or sampling rate properties are
null.IllegalArgumentException - Cannot set the channels, quantization bits, block align
or average bits per second values to negative values.public boolean areAllPeakEnvelopePropertiesPresent()
WAVEPCMDescriptorReturns true if all the following optional properties are
set for this PCM descriptor:
WAVEPCMDescriptor.setPeakEnvelopeVersion(Integer)WAVEPCMDescriptor.setPeakEnvelopeFormat(Integer)WAVEPCMDescriptor.setPointsPerPeakValue(Integer)WAVEPCMDescriptor.setPeakEnvelopeBlockSize(Integer)WAVEPCMDescriptor.setPeakChannelCount(Integer)WAVEPCMDescriptor.setPeakChannelCount(Integer)WAVEPCMDescriptor.setPeakOfPeaksPosition(Long)WAVEPCMDescriptor.setPeakEnvelopeTimestamp(TimeStamp)WAVEPCMDescriptor.setPeakEnvelopeDataPosition(long),
WAVEPCMDescriptor.getPeakEnvelopeDataSize(), WAVEPCMDescriptor.writePeakEnvelopeData(ByteBuffer) and
WAVEPCMDescriptor.readPeakEnvelopeData(int).areAllPeakEnvelopePropertiesPresent in interface WAVEPCMDescriptor@MediaProperty(uuid1=67240707, uuid2=1280, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="AverageBytesPerSecond", aliases="AverageBPS", typeName="UInt32", optional=false, uniqueIdentifier=false, pid=15625, symbol="AverageBytesPerSecond") public int getAverageBytesPerSecond()
WAVEPCMDescriptorReturns the average bytes per second of the essence stream described by this PCM descriptor.
getAverageBytesPerSecond in interface WAVEPCMDescriptor@MediaPropertySetter(value="AverageBytesPerSecond") public void setAverageBytesPerSecond(int bps) throws IllegalArgumentException
WAVEPCMDescriptorSets the average bytes per second of the essence stream described by this PCM descriptor. This property is required.
setAverageBytesPerSecond in interface WAVEPCMDescriptorbps - Average bytes per second of the essence stream.IllegalArgumentException - The given average bytes per second
value is negative.public static final int initializeAverageBytesPerSecond()
@MediaProperty(uuid1=67240706, uuid2=256, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="BlockAlign", typeName="UInt16", optional=false, uniqueIdentifier=false, pid=15626, symbol="BlockAlign") public short getBlockAlign()
WAVEPCMDescriptorReturns the number of bytes used to store one sample of all channels of data associated with this PCM descriptor. This property is required.
getBlockAlign in interface WAVEPCMDescriptor@MediaPropertySetter(value="BlockAlign") public void setBlockAlign(short blockAlign) throws IllegalArgumentException
WAVEPCMDescriptorSets the number of bytes used to store one sample of all channels of data associated with this PCM descriptor. This property is required.
setBlockAlign in interface WAVEPCMDescriptorblockAlign - The number of bytes used to store one sample of all
channels.IllegalArgumentException - The given block align value is negative.public static final short initializeBlockAlign()
@MediaProperty(uuid1=67240193, uuid2=1280, uuid3=0, uuid4={6,14,43,52,1,1,1,7}, definedName="ChannelAssignment", typeName="AUID", optional=true, uniqueIdentifier=false, pid=15666, symbol="ChannelAssignment") public AUID getChannelAssignment() throws PropertyNotPresentException
WAVEPCMDescriptorReturns the channel assignment scheme for this PCM descriptor. An example of this would be an AUID representing "SMPTE 320M-B". This property is optional and has a default value of "SMPTE 320M-B".
getChannelAssignment in interface WAVEPCMDescriptorPropertyNotPresentException@MediaPropertySetter(value="ChannelAssignment") public void setChannelAssignment(AUID channelAssignment)
WAVEPCMDescriptorSets the channel assignment scheme of this PCM descriptor. An
example of this would be an AUID
representing "SMPTE 320M-B". This
property is optional and set by default to the identifier for
"SMPTE 320M-B". Calling this method with null will
restore the default value.
setChannelAssignment in interface WAVEPCMDescriptorchannelAssignment - Channel assignment to use for this PCM descriptor.@MediaProperty(uuid1=67240705, uuid2=2560, uuid3=0, uuid4={6,14,43,52,1,1,1,8}, definedName="PeakChannels", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=15661, symbol="PeakChannels") public int getPeakChannelCount() throws PropertyNotPresentException
WAVEPCMDescriptorReturns the number of peak channels for this PCM descriptor. This property is optional.
getPeakChannelCount in interface WAVEPCMDescriptorPropertyNotPresentException - The optional peak channels property is not
present in this PCM descriptor.@MediaPropertySetter(value="PeakChannels") public void setPeakChannelCount(Integer channelCount) throws IllegalArgumentException
WAVEPCMDescriptorSets the number of peak channels for this PCM descriptor. Set this optional
property of null to omit it.
setPeakChannelCount in interface WAVEPCMDescriptorchannelCount - Number of peak channels for this PCM descriptor.IllegalArgumentException - Cannot set the peak channels property
of this PCM descriptor to a negative value.@MediaProperty(uuid1=67240705, uuid2=2304, uuid3=0, uuid4={6,14,43,52,1,1,1,8}, definedName="PeakEnvelopeBlockSize", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=15660, symbol="PeakEnvelopeBlockSize") public int getPeakEnvelopeBlockSize() throws PropertyNotPresentException
WAVEPCMDescriptorReturns the number of audio samples used to generate each peak frame for this PCM descriptor. This property is optional.
getPeakEnvelopeBlockSize in interface WAVEPCMDescriptorPropertyNotPresentException - The optional peak envelope block size property is not
present in this PCM descriptor.@MediaPropertySetter(value="PeakEnvelopeBlockSize") public void setPeakEnvelopeBlockSize(Integer blockSize) throws IllegalArgumentException
WAVEPCMDescriptorSets the number of audio samples used to generate each peak
frame for this PCM descriptor. Set this optional property to null
to omit it.
setPeakEnvelopeBlockSize in interface WAVEPCMDescriptorblockSize - Number of audio samples used to generate each peak
frame for this PCM descriptor.IllegalArgumentException - The given peak envelope block size is negative.public long getPeakEnvelopeDataPosition()
throws PropertyNotPresentException,
IOException
WAVEPCMDescriptorReturns the offset from the beginning of the peak envelope data
for this PCM descriptor. This transient property is used to define
the point at which peak envelope data is read or written.
getPeakEnvelopeDataPosition in interface WAVEPCMDescriptorPropertyNotPresentException - The optional peak envelope data
property is not present for this WAVE PCM descriptor.IOException - Error occurred when trying to get the position from
the underlying stream.WAVEPCMDescriptor.getPeakEnvelopeData(),
WAVEPCMDescriptor.setPeakEnvelopeDataPosition(long),
WAVEPCMDescriptor.readPeakEnvelopeData(int),
WAVEPCMDescriptor.writePeakEnvelopeData(ByteBuffer)public void setPeakEnvelopeDataPosition(long position)
throws PropertyNotPresentException,
IllegalArgumentException,
IOException
WAVEPCMDescriptorSets the offset from the beginning of the peak envelope data for this PCM descriptor. This property is optional and is used to define the point at which peak envelope data is read or written.
setPeakEnvelopeDataPosition in interface WAVEPCMDescriptorposition - Offset from the beginning of the peak envelope data
for this PCM descriptor.PropertyNotPresentException - The optional peak envelope data
property is not present for this WAVE PCM descriptor.IllegalArgumentException - The given position is outside the
acceptable range for the current stream.IOException - Error occurred when trying to set the position for the
underlying stream.WAVEPCMDescriptor.getPeakEnvelopeData(),
WAVEPCMDescriptor.getPeakEnvelopeDataPosition(),
WAVEPCMDescriptor.readPeakEnvelopeData(int),
WAVEPCMDescriptor.writePeakEnvelopeData(ByteBuffer)public long getPeakEnvelopeDataSize()
throws PropertyNotPresentException,
IOException
WAVEPCMDescriptorReturns the size of the peak envelope data of this PCM
descriptor. This peak envelope data property is optional. The value returned
can be useful when working out how many bytes to
read from the stream of peak
envelope data.
getPeakEnvelopeDataSize in interface WAVEPCMDescriptorPropertyNotPresentException - The optional peak envelope data property is not
present in this PCM descriptor.IOException - Cannot access the underlying stream to determine the size.WAVEPCMDescriptor.getPeakEnvelopeData()@MediaProperty(uuid1=67240705, uuid2=1792, uuid3=0, uuid4={6,14,43,52,1,1,1,8}, definedName="PeakEnvelopeFormat", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=15658, symbol="PeakEnvelopeFormat") public int getPeakEnvelopeFormat() throws PropertyNotPresentException
WAVEPCMDescriptorReturns the format of the peak point for this PCM descriptor. This property is optional.
getPeakEnvelopeFormat in interface WAVEPCMDescriptorPropertyNotPresentException - The optional peak envelope format property is not
present in this PCM descriptor.@MediaPropertySetter(value="PeakEnvelopeFormat") public void setPeakEnvelopeFormat(Integer format) throws IllegalArgumentException
WAVEPCMDescriptorSets the format of the peak point for this PCM descriptor.
Set this optional property to null to omit it.
setPeakEnvelopeFormat in interface WAVEPCMDescriptorformat - Format of the peak point for this PCM descriptor.IllegalArgumentException - The given peak envelope format is
negative.@MediaProperty(uuid1=67240705, uuid2=3328, uuid3=0, uuid4={6,14,43,52,1,1,1,8}, definedName="PeakEnvelopeTimestamp", typeName="TimeStamp", optional=true, uniqueIdentifier=false, pid=15664, symbol="PeakEnvelopeTimestamp") public TimeStamp getPeakEnvelopeTimestamp() throws PropertyNotPresentException
WAVEPCMDescriptorReturns the time stamp for the date and time of the creation of this peak data for this PCM descriptor. This property is optional.
getPeakEnvelopeTimestamp in interface WAVEPCMDescriptorPropertyNotPresentException - This optional property is not
present in this PCM descriptor.WAVEPCMDescriptor.areAllPeakEnvelopePropertiesPresent(),
TimeStamp.getTimeStamp()@MediaPropertySetter(value="PeakEnvelopeTimestamp") public void setPeakEnvelopeTimestamp(TimeStamp timeStamp)
WAVEPCMDescriptorSets the time stamp for the date and time of
the creation of the peak data for the PCM descriptor. Set this optional property to
null to omit it.
setPeakEnvelopeTimestamp in interface WAVEPCMDescriptortimeStamp - Time stamp of the creation of the peak data for the
PCM descriptor.Forge.makeTimeStamp(java.util.Calendar),
Forge.parseTimeStamp(String),
WAVEPCMDescriptor.areAllPeakEnvelopePropertiesPresent()@MediaProperty(uuid1=67240705, uuid2=1536, uuid3=0, uuid4={6,14,43,52,1,1,1,8}, definedName="PeakEnvelopeVersion", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=15657, symbol="PeakEnvelopeVersion") public int getPeakEnvelopeVersion() throws PropertyNotPresentException
WAVEPCMDescriptorReturns the version information of the peak envelope data of this PCM descriptor. This property is optional.
getPeakEnvelopeVersion in interface WAVEPCMDescriptorPropertyNotPresentException - The optional peak envelope version property is not
present in this PCM descriptor.@MediaPropertySetter(value="PeakEnvelopeVersion") public void setPeakEnvelopeVersion(Integer version) throws IllegalArgumentException
WAVEPCMDescriptorSets the version information of the peak envelope data of this PCM
descriptor. Set this optional property to null to omit it.
setPeakEnvelopeVersion in interface WAVEPCMDescriptorversion - Version information of the peak envelope data of this PCM
descriptor.IllegalArgumentException - Cannot set the peak envelope version
property of this PCM descriptor to a negative value.@MediaProperty(uuid1=67240705, uuid2=2816, uuid3=0, uuid4={6,14,43,52,1,1,1,8}, definedName="PeakFrames", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=15662, symbol="PeakFrames") public int getPeakFrameCount() throws PropertyNotPresentException
WAVEPCMDescriptorReturns the number of peak frames for this PCM descriptor. This property is optional.
getPeakFrameCount in interface WAVEPCMDescriptorPropertyNotPresentException - This optional peak of peaks property is not
present in this PCM descriptor.@MediaPropertySetter(value="PeakFrames") public void setPeakFrameCount(Integer frameCount) throws IllegalArgumentException
WAVEPCMDescriptorSets the number of peak frames for this PCM descriptor. Set this optional
property to null to omit it.
setPeakFrameCount in interface WAVEPCMDescriptorframeCount - Number of peak frames for this PCM descriptor.IllegalArgumentException - The given peak frames count is negative.@MediaProperty(uuid1=67240705, uuid2=3072, uuid3=0, uuid4={6,14,43,52,1,1,1,8}, definedName="PeakOfPeaksPosition", typeName="PositionType", optional=true, uniqueIdentifier=false, pid=15663, symbol="PeakOfPeaksPosition") public long getPeakOfPeaksPosition() throws PropertyNotPresentException
WAVEPCMDescriptorReturns the offset to the first audio sample whose absolute value is the maximum value of the entire audio file represented by this PCM descriptor. This property is optional.
getPeakOfPeaksPosition in interface WAVEPCMDescriptorPropertyNotPresentException - The optional peak of peaks position property
is not present in this PCM descriptor.@MediaPropertySetter(value="PeakOfPeaksPosition") public void setPeakOfPeaksPosition(Long position)
WAVEPCMDescriptorSets the offset to the first audio sample whose absolute
value is the maximum value of the entire audio file described by
this PCM descriptor. Set this optional property to null to
omit it.
setPeakOfPeaksPosition in interface WAVEPCMDescriptorposition - Peak of peaks position in the described audio essence.@MediaProperty(uuid1=67240705, uuid2=2048, uuid3=0, uuid4={6,14,43,52,1,1,1,8}, definedName="PointsPerPeakValue", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=15659, symbol="PointsPerPeakValue") public int getPointsPerPeakValue() throws PropertyNotPresentException
WAVEPCMDescriptorReturns the number of peak points per peak value for this PCM descriptor. This value is optional.
getPointsPerPeakValue in interface WAVEPCMDescriptorPropertyNotPresentException - The optional points per peak value property is not
present in this PCM descriptor.@MediaPropertySetter(value="PointsPerPeakValue") public void setPointsPerPeakValue(Integer pointCount) throws IllegalArgumentException
WAVEPCMDescriptorSets the number of peak points per peak value for this PCM
descriptor. Set this optional property to null to omit it.
setPointsPerPeakValue in interface WAVEPCMDescriptorpointCount - Number of peak points per peak value for this PCM
descriptor.IllegalArgumentException - The given number of peak points per peak
value is negative.@MediaProperty(uuid1=67240706, uuid2=512, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="SequenceOffset", typeName="UInt8", optional=true, uniqueIdentifier=false, pid=15627, symbol="SequenceOffset") public byte getSequenceOffset() throws PropertyNotPresentException
WAVEPCMDescriptorReturns the frame number of the beginning of the essence data within a five-frame sequence for this PCM descriptor. This property is optional and zero-based.
getSequenceOffset in interface WAVEPCMDescriptorPropertyNotPresentException - This optional property is not
present in this PCM descriptor.@MediaPropertySetter(value="SequenceOffset") public void setSequenceOffset(Byte offset) throws IllegalArgumentException
WAVEPCMDescriptorSets the frame number of the beginning of the essence data
within a five-frame sequence for this PCM descriptor. This property
is optional and zero-based. Set to null omit it.
setSequenceOffset in interface WAVEPCMDescriptoroffset - Frame number of the beginning of the essence data
within a five-frame sequence.IllegalArgumentException - The given sequence offset value is
negative.@MediaProperty(uuid1=67240705, uuid2=3584, uuid3=0, uuid4={6,14,43,52,1,1,1,8}, definedName="PeakEnvelopeData", typeName="Stream", optional=true, uniqueIdentifier=false, pid=15665, symbol="PeakEnvelopeData") public Stream getPeakEnvelopeData() throws PropertyNotPresentException
WAVEPCMDescriptorReturns the stream containing the peak envelope data for this PCM descriptor. This is an optional property.
getPeakEnvelopeData in interface WAVEPCMDescriptorPropertyNotPresentException - The optional peak envelope data
property is not present for this WAVE PCM descriptor.WAVEPCMDescriptor.getPeakEnvelopeDataPosition(),
WAVEPCMDescriptor.readPeakEnvelopeData(int),
WAVEPCMDescriptor.writePeakEnvelopeData(ByteBuffer),
WAVEPCMDescriptor.setPeakEnvelopeDataPosition(long)@MediaPropertySetter(value="PeakEnvelopeData") public void setPeakEnvelopeData(Stream peakEnvelopeData)
WAVEPCMDescriptorSet the peak envelope data stream of this PCM descriptor. Set this optional
property to null to omit it.
setPeakEnvelopeData in interface WAVEPCMDescriptorpeakEnvelopeData - Peak envelope data stream of this PCM descriptor.WAVEPCMDescriptor.readPeakEnvelopeData(int),
WAVEPCMDescriptor.writePeakEnvelopeData(ByteBuffer),
WAVEPCMDescriptor.getPeakEnvelopeDataPosition(),
WAVEPCMDescriptor.getPeakEnvelopeDataSize(),
WAVEPCMDescriptor.setPeakEnvelopeDataPosition(long)public ByteBuffer readPeakEnvelopeData(int bytes) throws EndOfDataException, PropertyNotPresentException, IOException
WAVEPCMDescriptorRead the given number of bytes of data from the peak envelope
data stream of this PCM descriptor at the WAVEPCMDescriptor.getPeakEnvelopeDataPosition()
current position.
readPeakEnvelopeData in interface WAVEPCMDescriptorbytes - Number of bytes to read.EndOfDataException - Attempt to read beyond the end of the
peak envelope data.PropertyNotPresentException - The optional peak envelope data property is not
present in this PCM descriptor.IOException - Error occurred when trying to read data from the underlying
stream.public int writePeakEnvelopeData(ByteBuffer bytes) throws PropertyNotPresentException, EndOfDataException, IOException
WAVEPCMDescriptorWrite the given bytes to the peak envelope data stream of the
PCM descriptor at the current position, as determined by calling
WAVEPCMDescriptor.getPeakEnvelopeDataPosition().
writePeakEnvelopeData in interface WAVEPCMDescriptorbytes - Data to write to the peak envelope data stream of this
PCM descriptor.PropertyNotPresentException - The optional peak envelope data property is not present in
this PCM descriptor and so cannot be written to.EndOfDataException - Cannot write beyond the end of the stream.IOException - Error occurred when trying to write to the underlying
stream.WAVEPCMDescriptor.getPeakEnvelopeData()public WAVEPCMDescriptor clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface AAFFileDescriptorclone in interface EssenceDescriptorclone in interface InterchangeObjectclone in interface SoundDescriptorclone in interface WAVEPCMDescriptorclone in class SoundDescriptorImpl@MediaProperty(uuid1=-1153455139, uuid2=-832, uuid3=17320, uuid4={-105,89,-57,39,119,31,-52,74}, definedName="DataOffset", typeName="Int32", optional=true, uniqueIdentifier=false, pid=0, symbol="DataOffset2", namespace="http://www.amwa.tv/is03/extensions/avid", prefix="avid") @Int32 public int getDataOffset() throws PropertyNotPresentException
PropertyNotPresentException@MediaPropertySetter(value="DataOffset") public void setDataOffset(@Int32 Integer dataOffset)
public String getChannelAssignmentString()
public void setChannelAssignmentString(String channelAssignment)
public String getPeakEnvelopeTimestampString()
public void setPeakEnvelopeTimestampString(String peakEnvelopeTimestampString)
(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.