public interface SoundDescriptor extends AAFFileDescriptor
Specifies the description of a file source package that is associated with audio essence.
| Modifier and Type | Method and Description |
|---|---|
SoundDescriptor |
clone()
Create a cloned copy of this sound descriptor.
|
byte |
getAudioReferenceLevel()
Returns the audio reference level of this sound descriptor.
|
Rational |
getAudioSampleRate()
Returns the audio sampling rate of audio essence described by this sound
descriptor.
|
int |
getChannelCount()
Returns the number of audio channels described by this
sound descriptor.
|
byte |
getDialNorm()
Returns the dial norm property of this sound descriptor, which
specifies the gain to be applied to normalize perceived loudness
of the sound, as defined by ITU-R Recommendation BS.1196 (1dB
per step).
|
ElectroSpatialFormulation |
getElectrospatialFormulation()
Returns the electro-spatial formulation of the signal described by this
sound descriptor.
|
boolean |
getLocked()
Returns the locked flag for the audio essence described by this
sound descriptor, which indicates whether the number of
samples per frame is locked.
|
int |
getQuantizationBits()
Returns the number of quantization bits used for the audio essence described
by this sound descriptor.
|
AUID |
getSoundCompression()
Returns he kind of compression and format of compression
information of this sound essence data.
|
boolean |
isLocked()
Returns the locked flag for the audio essence described by this
sound descriptor, which indicates whether the number of
samples per frame is locked.
|
void |
setAudioReferenceLevel(Byte level)
Sets the audio reference level of the audio essence described by this sound descriptor.
|
void |
setAudioSampleRate(Rational audioSamplingRate)
Sets the audio sampling rate of audio essence described by this sound
descriptor.
|
void |
setChannelCount(int channelCount)
Sets the number of audio channels described by this
sound descriptor.
|
void |
setDialNorm(Byte dialNorm)
Sets the dial norm of this sound descriptor, which specifies the gain to be applied
to normalize perceived loudness of the sound, as defined by ITU-R Recommendation BS.1196 (1dB
per step).
|
void |
setElectrospatialFormulation(ElectroSpatialFormulation formulation)
Sets the electro-spatial formulation of the signal of the audio essence
described by this sound descriptor.
|
void |
setIsLocked(Boolean locked)
Sets the locked flag for the audio essence described this
sound descriptor, which indicates whether the number of
samples per frame is locked.
|
void |
setQuantizationBits(int bitsCount)
Sets the number of quantization bits used for the audio essence described
by this sound descriptor.
|
void |
setSoundCompression(AUID compression)
Sets the kind of compression and format of compression
information of this sound essence data.
|
getCodec, 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, setPersistentIndexvoid setSoundCompression(AUID compression)
Sets the kind of compression and format of compression
information of this sound essence data. This property is
optional and if the property is not present then the described
audio essence is not compressed. Set to null
to indicate that the described audio essence is not compressed.
compression - Kind of compression and format of the
compression for this sound essence data.AUID getSoundCompression() throws PropertyNotPresentException
Returns he kind of compression and format of compression information of this sound essence data. This property is optional.
PropertyNotPresentException - The optional property is not present in
the sound descriptor, indicating that the described sound essence is not
compressed.void setChannelCount(@UInt32 int channelCount) throws IllegalArgumentException
Sets the number of audio channels described by this sound descriptor.
channelCount - Number of audio channels described
by this sound descriptor.IllegalArgumentException - The given channel count is negative.@UInt32 int getChannelCount()
Returns the number of audio channels described by this sound descriptor.
void setAudioSampleRate(Rational audioSamplingRate) throws NullPointerException
Sets the audio sampling rate of audio essence described by this sound descriptor.
audioSamplingRate - Audio sampling rate of the audio essence described by this
sound descriptor.NullPointerException - The given audio sampling rate is null.Rational getAudioSampleRate()
Returns the audio sampling rate of audio essence described by this sound descriptor.
void setIsLocked(@Bool Boolean locked)
Sets the locked flag for the audio essence described this
sound descriptor, which indicates whether the number of
samples per frame is locked. Set this optional property to null to
omit it.
locked - Are the number of samples per frame locked?@Bool boolean isLocked() throws PropertyNotPresentException
Returns the locked flag for the audio essence described by this sound descriptor, which indicates whether the number of samples per frame is locked. This property is optional.
PropertyNotPresentException - The optional locked property is not
present in this sound descriptor.getLocked()@Bool boolean getLocked() throws PropertyNotPresentException
Returns the locked flag for the audio essence described by this sound descriptor, which indicates whether the number of samples per frame is locked. This property is optional.
PropertyNotPresentException - The optional locked property is not
present in this sound descriptor.isLocked()void setElectrospatialFormulation(ElectroSpatialFormulation formulation)
Sets the electro-spatial formulation of the signal of the audio essence
described by this sound descriptor. Set this optional property to null
to omit it.
Possible values for the electo-spatial formulation include:
formulation - Electro-spatial formulation of the signal
described by this sound descriptor.ElectroSpatialFormulation getElectrospatialFormulation() throws PropertyNotPresentException
Returns the electro-spatial formulation of the signal described by this sound descriptor. This property is optional.
Possible values for the electo-spatial formulation include:
PropertyNotPresentException - The optional electro-spatial formulation property is not
present in this sound descriptor.void setAudioReferenceLevel(@Int8 Byte level)
Sets the audio reference level of the audio essence described by this sound descriptor. This
property specifies the number of dBm for 0VU. Set this optional property to null to
omit it.
level - Audio reference level property of this sound descriptor.@Int8 byte getAudioReferenceLevel() throws PropertyNotPresentException
Returns the audio reference level of this sound descriptor. This specifies the number of dBm for 0VU. This property is optional.
PropertyNotPresentException - The optional audio reference level property is not
present in this sound descriptor.void setDialNorm(@Int8 Byte dialNorm)
Sets the dial norm of this sound descriptor, which specifies the gain to be applied
to normalize perceived loudness of the sound, as defined by ITU-R Recommendation BS.1196 (1dB
per step). Set this optional property to null to omit it.
dialNorm - Dial norm property of the sound descriptor.@Int8 byte getDialNorm() throws PropertyNotPresentException
Returns the dial norm property of this sound descriptor, which specifies the gain to be applied to normalize perceived loudness of the sound, as defined by ITU-R Recommendation BS.1196 (1dB per step). This property is optional.
PropertyNotPresentException - This optional dial norm property is not
present in this sound descriptor.void setQuantizationBits(@UInt32 int bitsCount) throws IllegalArgumentException
Sets the number of quantization bits used for the audio essence described by this sound descriptor.
bitsCount - Number of quantization bits of this sound descriptor.IllegalArgumentException - The given quantization bits value is negative.@UInt32 int getQuantizationBits()
Returns the number of quantization bits used for the audio essence described by this sound descriptor.
SoundDescriptor clone()
Create a cloned copy of this sound descriptor.
clone in interface AAFFileDescriptorclone in interface EssenceDescriptorclone in interface InterchangeObjectclone in interface MediaEntity(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.