@MediaClass(uuid1=218169601, uuid2=257, uuid3=18176, uuid4={6,14,43,52,2,6,1,1}, definedName="AES3PCMDescriptor", description="Describes audio essence in the AES3 audio file format.", symbol="AES3PCMDescriptor") public class AES3PCMDescriptorImpl extends WAVEPCMDescriptorImpl implements AES3PCMDescriptor, Serializable, XMLSerializable, Cloneable
Implements an AES3 PCM descriptor that describes audio essence in the AES/EBU audio file format, as defined in the EBU/AES digital audio interface specification.
ObjectClassPropertyIDAES3DefaultUserData, AES3Minimum, AUXBITSMODE_DEFAULT, BLOCKSTARTOFFSET_DEFAULT, EMPHASIS_DEFAULT| Constructor and Description |
|---|
AES3PCMDescriptorImpl() |
AES3PCMDescriptorImpl(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 |
|---|---|
void |
clearChannelStatusMode() |
void |
clearFixedChannelStatusData() |
void |
clearFixedUserData() |
void |
clearUserDataMode() |
AES3PCMDescriptor |
clone()
Create a cloned copy of this interchange object.
|
int |
countChannelStatusMode() |
AuxBitsModeType |
getAuxBitsMode()
Returns the AES3 use of auxiliary bits in the associated audio
essence.
|
short |
getBlockStartOffset()
Returns the AES3 position of the first Z preamble in the associated sound
essence stream.
|
ChannelStatusModeType[] |
getChannelStatusMode()
Returns the AES3 enumerated mode of carriage of channel status data for all
channels of the associated audio essence.
|
ChannelStatusModeType |
getChannelStatusModeAt(int index)
Returns the AES3 enumerated mode of carriage of channel status data for the
associated audio essence for the given channel number.
|
String |
getComment()
Include a comment when serializing a value to XML.
|
EmphasisType |
getEmphasis()
Returns the AES3 emphasis of the associated sound essence.
|
byte[] |
getFixedChannelStatusData()
Returns the AES3 fixed channel status data for all channels in the associated audio
essence.
|
byte[] |
getFixedChannelStatusDataAt(int index)
Returns the AES3 fixed channel status data for the channel referenced by the given
index in the associated audio essence.
|
byte[] |
getFixedUserData()
Returns the AES3 fixed user data for all channels in the associated audio
essence.
|
byte[] |
getFixedUserDataAt(int index)
Returns the AES3 fixed user data for the given channel in the associated audio
essence.
|
UserDataModeType[] |
getUserDataMode()
Returns the user data mode for all the channels in the associated audio essence.
|
UserDataModeType |
getUserDataModeAt(int index)
Returns the user data mode for the channel of the associated audio essence
referenced by the given channel index.
|
void |
omitChannelStatusData()
Omits the optional fixed channel status data and channel status mode properties from this
AES3 PCM descriptor.
|
void |
omitUserData()
Omit the optional fixed user data and user data mode properties from this AES3 PCM descriptor.
|
void |
setAuxBitsMode(AuxBitsModeType auxBitsMode)
Sets the AES3 use of auxiliary bits in the associated audio
essence.
|
void |
setBlockStartOffset(Short blockStartOffset)
Sets the AES3 position of the first Z preamble in the associated sound
essence stream.
|
void |
setChannelStatusMode(ChannelStatusModeType[] channelStatusMode) |
void |
setChannelStatusModeAt(int index,
ChannelStatusModeType channelStatusMode)
Sets the AES3 enumerated mode of carriage of channel status data for the
associated audio essence at the given channel number.
|
void |
setEmphasis(EmphasisType emphasisType)
Sets the AES3 emphasis property of the associated sound essence.
|
void |
setFixedChannelStatusData(byte[] fixedChannelStatusData) |
void |
setFixedChannelStatusDataAt(int index,
byte[] fixedChannelStatusData)
Sets the AES3 fixed channel status data for the channel referenced by the given
index in the associated audio essence.
|
void |
setFixedUserData(byte[] fixedUserData) |
void |
setFixedUserDataAt(int index,
byte[] fixedUserData)
Sets the AES3 fixed user data for the given channel in the associated audio
essence.
|
void |
setUserDataMode(UserDataModeType[] userDataMode) |
void |
setUserDataModeAt(int index,
UserDataModeType userDataMode)
Sets the user data mode for the channel of the associated audio essence
referenced by the given channel index.
|
areAllPeakEnvelopePropertiesPresent, getAverageBytesPerSecond, getBlockAlign, getChannelAssignment, getChannelAssignmentString, getDataOffset, getPeakChannelCount, getPeakEnvelopeBlockSize, getPeakEnvelopeData, getPeakEnvelopeDataPosition, getPeakEnvelopeDataSize, getPeakEnvelopeFormat, getPeakEnvelopeTimestamp, getPeakEnvelopeTimestampString, getPeakEnvelopeVersion, getPeakFrameCount, getPeakOfPeaksPosition, getPointsPerPeakValue, getSequenceOffset, initializeAverageBytesPerSecond, initializeBlockAlign, readPeakEnvelopeData, setAverageBytesPerSecond, setBlockAlign, setChannelAssignment, setChannelAssignmentString, setDataOffset, setPeakChannelCount, setPeakEnvelopeBlockSize, setPeakEnvelopeData, setPeakEnvelopeDataPosition, setPeakEnvelopeFormat, setPeakEnvelopeTimestamp, setPeakEnvelopeTimestampString, setPeakEnvelopeVersion, setPeakFrameCount, setPeakOfPeaksPosition, setPointsPerPeakValue, setSequenceOffset, writePeakEnvelopeDatagetAudioReferenceLevel, 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, 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, toStringareAllPeakEnvelopePropertiesPresent, getAverageBytesPerSecond, getBlockAlign, getChannelAssignment, getPeakChannelCount, getPeakEnvelopeBlockSize, getPeakEnvelopeData, getPeakEnvelopeDataPosition, getPeakEnvelopeDataSize, getPeakEnvelopeFormat, getPeakEnvelopeTimestamp, getPeakEnvelopeVersion, getPeakFrameCount, getPeakOfPeaksPosition, getPointsPerPeakValue, getSequenceOffset, readPeakEnvelopeData, setAverageBytesPerSecond, setBlockAlign, setChannelAssignment, setPeakChannelCount, setPeakEnvelopeBlockSize, setPeakEnvelopeData, setPeakEnvelopeDataPosition, setPeakEnvelopeFormat, setPeakEnvelopeTimestamp, setPeakEnvelopeVersion, setPeakFrameCount, setPeakOfPeaksPosition, setPointsPerPeakValue, setSequenceOffset, writePeakEnvelopeDatagetAudioReferenceLevel, 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, setPersistentIndexappendXMLChildrenpublic AES3PCMDescriptorImpl()
public AES3PCMDescriptorImpl(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.@MediaProperty(uuid1=67241217, uuid2=256, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="AuxBitsMode", typeName="AuxBitsModeType", optional=true, uniqueIdentifier=false, pid=15624, symbol="AuxBitsMode") public AuxBitsModeType getAuxBitsMode()
AES3PCMDescriptorReturns the AES3 use of auxiliary bits in the associated audio
essence. If this optional property is not present, the default value of
AuxBitsModeType.NotDefined is returned.
getAuxBitsMode in interface AES3PCMDescriptorAES3PCMDescriptor.AUXBITSMODE_DEFAULT@MediaPropertySetter(value="AuxBitsMode") public void setAuxBitsMode(AuxBitsModeType auxBitsMode)
AES3PCMDescriptorSets the AES3 use of auxiliary bits in the associated audio
essence. To omit this optional property, call this method with
null.
setAuxBitsMode in interface AES3PCMDescriptorauxBitsMode - AES3 use of auxiliary bits in the associated audio
essence.AES3PCMDescriptor.AUXBITSMODE_DEFAULT@MediaProperty(uuid1=67240706, uuid2=768, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="BlockStartOffset", typeName="UInt16", optional=true, uniqueIdentifier=false, pid=15631, symbol="BlockStartOffset") public short getBlockStartOffset()
AES3PCMDescriptorReturns the AES3 position of the first Z preamble in the associated sound essence stream. If this optional property is not present, the default value of 0 is returned.
getBlockStartOffset in interface AES3PCMDescriptorAES3PCMDescriptor.BLOCKSTARTOFFSET_DEFAULT@MediaPropertySetter(value="BlockStartOffset") public void setBlockStartOffset(Short blockStartOffset) throws IllegalArgumentException
AES3PCMDescriptorSets the AES3 position of the first Z preamble in the associated sound
essence stream. The default value of this optional property is 0.
To omit this optional property, call this method with null.
setBlockStartOffset in interface AES3PCMDescriptorblockStartOffset - AES3 position of the first Z preamble in the associated sound
essence stream.IllegalArgumentException - The block start offset is negative.AES3PCMDescriptor.BLOCKSTARTOFFSET_DEFAULT@MediaProperty(uuid1=67241217, uuid2=512, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="ChannelStatusMode", typeName="ChannelStatusModeArray", optional=true, uniqueIdentifier=false, pid=15632, symbol="ChannelStatusMode") public ChannelStatusModeType[] getChannelStatusMode()
AES3PCMDescriptorReturns the AES3 enumerated mode of carriage of channel status data for all channels of the associated audio essence.
getChannelStatusMode in interface AES3PCMDescriptorAES3PCMDescriptor.getChannelStatusModeAt(int)@MediaPropertySetter(value="ChannelStatusMode") public void setChannelStatusMode(ChannelStatusModeType[] channelStatusMode) throws NullPointerException, BadSizeException
NullPointerExceptionBadSizeException@MediaListGetAt(value="ChannelStatusMode") public ChannelStatusModeType getChannelStatusModeAt(int index) throws IndexOutOfBoundsException
AES3PCMDescriptorReturns the AES3 enumerated mode of carriage of channel status data for the
associated audio essence for the given channel number. If the channel status
mode property is not present, the default value of ChannelStatusModeType.None
is returned.
getChannelStatusModeAt in interface AES3PCMDescriptorindex - Index into the AES3 channel status mode array.IndexOutOfBoundsException - The given index is outside the acceptable range
for the current channel status mode array.AES3PCMDescriptor.getChannelStatusMode(),
SoundDescriptor.getChannelCount()public void setChannelStatusModeAt(int index,
ChannelStatusModeType channelStatusMode)
throws IndexOutOfBoundsException
AES3PCMDescriptorSets the AES3 enumerated mode of carriage of channel status data for the associated audio essence at the given channel number.
If the channel status mode property is not present at the time of calling
the method, after completion of the method the property becomes
present and properties at other indexes are initialized to
ChannelStatusModeType.None.
setChannelStatusModeAt in interface AES3PCMDescriptorindex - Index of the channel status mode array to set the channel status for.channelStatusMode - Channel status for the given index.IndexOutOfBoundsException - The given index is outside the acceptable range
for the current channel status mode array.SoundDescriptor.getChannelCount()@MediaPropertyCount(value="ChannelStatusMode") public int countChannelStatusMode()
@MediaPropertyClear(value="ChannelStatusMode") public void clearChannelStatusMode()
@MediaProperty(uuid1=67241217, uuid2=1536, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="Emphasis", typeName="EmphasisType", optional=true, uniqueIdentifier=false, pid=15629, symbol="Emphasis") public EmphasisType getEmphasis()
AES3PCMDescriptorReturns the AES3 emphasis of the associated sound essence. If this optional property is not present, the default value of this property is returned.
getEmphasis in interface AES3PCMDescriptorAES3PCMDescriptor.EMPHASIS_DEFAULT@MediaPropertySetter(value="Emphasis") public void setEmphasis(EmphasisType emphasisType)
AES3PCMDescriptorSets the AES3 emphasis property of the associated sound essence. Calling
this method with null will omit this optional property.
setEmphasis in interface AES3PCMDescriptoremphasisType - AES3 emphasis property of the associated sound essence.AES3PCMDescriptor.EMPHASIS_DEFAULT@MediaProperty(uuid1=67241217, uuid2=768, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="FixedChannelStatusData", typeName="UInt8Array", optional=true, uniqueIdentifier=false, pid=15633, symbol="FixedChannelStatusData") public byte[] getFixedChannelStatusData()
AES3PCMDescriptorReturns the AES3 fixed channel status data for all channels in the associated audio essence.
getFixedChannelStatusData in interface AES3PCMDescriptorAES3PCMDescriptor.getFixedChannelStatusDataAt(int)@MediaPropertySetter(value="FixedChannelStatusData") public void setFixedChannelStatusData(byte[] fixedChannelStatusData) throws BadSizeException
BadSizeException@MediaPropertyClear(value="FixedChannelStatusData") public void clearFixedChannelStatusData()
public byte[] getFixedChannelStatusDataAt(int index)
throws IndexOutOfBoundsException
AES3PCMDescriptorReturns the AES3 fixed channel status data for the channel referenced by the given index in the associated audio essence. The value returned is a 24-byte array.
The default value is the AES3 minimum, which codes the most significant
bit of the first byte as 1 and all other bits as 0. If this
optional property is omitted, the default value will be returned.
getFixedChannelStatusDataAt in interface AES3PCMDescriptorindex - Channel index to retrieve the fixed channel status data for.IndexOutOfBoundsException - The given index is outside the acceptable range
for the current range of channels for which fixed status data is represented.AES3PCMDescriptor.getFixedChannelStatusData(),
SoundDescriptor.getChannelCount()public void setFixedChannelStatusDataAt(int index,
byte[] fixedChannelStatusData)
throws NullPointerException,
IndexOutOfBoundsException,
BadSizeException
AES3PCMDescriptorSets the AES3 fixed channel status data for the channel referenced by the given index in the associated audio essence. The data must take the form of a 24-byte array.
setFixedChannelStatusDataAt in interface AES3PCMDescriptorindex - Channel number to set the AES3 fixed channel status data for.fixedChannelStatusData - Fixed channel status array.NullPointerException - The fixed channel status data argument is null.IndexOutOfBoundsException - The given channel index is outside the acceptable
range for the associated audio essence.BadSizeException - The fixed channel status data must be an array of 24-bytes
exactly.SoundDescriptor.getChannelCount()public void omitChannelStatusData()
AES3PCMDescriptorOmits the optional fixed channel status data and channel status mode properties from this
AES3 PCM descriptor. To make them present again, call AES3PCMDescriptor.setFixedChannelStatusDataAt(int, byte[])
and AES3PCMDescriptor.setChannelStatusModeAt(int, ChannelStatusModeType).
omitChannelStatusData in interface AES3PCMDescriptor@MediaProperty(uuid1=67241217, uuid2=1280, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="FixedUserData", typeName="UInt8Array", optional=true, uniqueIdentifier=false, pid=15635, symbol="FixedUserData") public byte[] getFixedUserData()
AES3PCMDescriptorReturns the AES3 fixed user data for all channels in the associated audio essence. The value is always the number of channels multiplied by 24.
getFixedUserData in interface AES3PCMDescriptorAES3PCMDescriptor.getFixedUserDataAt(int)@MediaPropertySetter(value="FixedUserData") public void setFixedUserData(byte[] fixedUserData) throws BadSizeException
BadSizeException@MediaPropertyClear(value="FixedUserData") public void clearFixedUserData()
public byte[] getFixedUserDataAt(int index)
throws IndexOutOfBoundsException
AES3PCMDescriptorReturns the AES3 fixed user data for the given channel in the associated audio essence. The value is always a 24-byte array.
The default value for fixed user data on a channel is all zero values, as
represented by AES3PCMDescriptor.AES3DefaultUserData. If this optional property is not
present, the default value will be returned.
getFixedUserDataAt in interface AES3PCMDescriptorindex - Channel index of the fixed user data to retrieve.IndexOutOfBoundsException - The channel number is outside the acceptable range
for the associated audio essence.AES3PCMDescriptor.getFixedUserData(),
SoundDescriptor.getChannelCount()public void setFixedUserDataAt(int index,
byte[] fixedUserData)
throws NullPointerException,
IndexOutOfBoundsException,
BadSizeException
AES3PCMDescriptorSets the AES3 fixed user data for the given channel in the associated audio essence. The value is always a 24-byte array.
setFixedUserDataAt in interface AES3PCMDescriptorindex - Channel index of the fixed user data to set.fixedUserData - Fixed user data for the given channel number of the associated
audio essence.NullPointerException - Cannot set fixed user data to null.IndexOutOfBoundsException - The channel number is outside the acceptable range
for the associated audio essence.BadSizeException - The fixed user data value must by a 24-byte array.SoundDescriptor.getChannelCount()@MediaProperty(uuid1=67241217, uuid2=1024, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="UserDataMode", typeName="UserDataModeArray", optional=true, uniqueIdentifier=false, pid=15634, symbol="UserDataMode") public UserDataModeType[] getUserDataMode()
AES3PCMDescriptorReturns the user data mode for all the channels in the associated audio essence.
getUserDataMode in interface AES3PCMDescriptorAES3PCMDescriptor.getUserDataModeAt(int)@MediaPropertySetter(value="UserDataMode") public void setUserDataMode(UserDataModeType[] userDataMode) throws NullPointerException, BadSizeException
NullPointerExceptionBadSizeException@MediaPropertyClear(value="UserDataMode") public void clearUserDataMode()
public UserDataModeType getUserDataModeAt(int index) throws IndexOutOfBoundsException
AES3PCMDescriptorReturns the user data mode for the channel of the associated audio essence referenced by the given channel index.
The default value for each element of this property is
UserDataModeType.NotDefined. If this optional property is omitted, the default
value will be returned.
getUserDataModeAt in interface AES3PCMDescriptorindex - Channel index to identify the channel to retrieve the user data mode for.IndexOutOfBoundsException - The given channel index is outside the acceptable
range for the associated audio essence.AES3PCMDescriptor.getUserDataMode(),
SoundDescriptor.getChannelCount()public void setUserDataModeAt(int index,
UserDataModeType userDataMode)
throws NullPointerException,
IndexOutOfBoundsException
AES3PCMDescriptorSets the user data mode for the channel of the associated audio essence referenced by the given channel index.
setUserDataModeAt in interface AES3PCMDescriptorindex - Channel index to identify the channel to set the user data mode for.userDataMode - Type of user data for the given channel.NullPointerException - Cannot set the user data mode for a channel to
null.IndexOutOfBoundsException - The given channel index is outside the acceptable
range for the associated audio essence.SoundDescriptor.getChannelCount()public void omitUserData()
AES3PCMDescriptorOmit the optional fixed user data and user data mode properties from this AES3 PCM descriptor. To make them
present again, call AES3PCMDescriptor.setFixedUserDataAt(int, byte[]) and AES3PCMDescriptor.setUserDataModeAt(int, UserDataModeType).
omitUserData in interface AES3PCMDescriptorpublic AES3PCMDescriptor clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface AAFFileDescriptorclone in interface AES3PCMDescriptorclone in interface EssenceDescriptorclone in interface InterchangeObjectclone in interface SoundDescriptorclone in interface WAVEPCMDescriptorclone in class WAVEPCMDescriptorImplpublic String getComment()
XMLSerializableInclude a comment when serializing a value to XML. The comment will be inserted as the first child node of the element representing the class.
getComment in interface XMLSerializablegetComment in class EssenceDescriptorImpl(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.