@MediaClass(uuid1=218169601, uuid2=257, uuid3=16896, uuid4={6,14,43,52,2,6,1,1}, definedName="SoundDescriptor", description="The SoundDescriptor class specifies that a File SourcePackage is associated with audio essence.", symbol="SoundDescriptor") public class SoundDescriptorImpl extends AAFFileDescriptorImpl implements SoundDescriptor, Serializable, Cloneable
Implements the description of a file source package that is associated with audio essence.
ObjectClassPropertyID| Constructor and Description |
|---|
SoundDescriptorImpl()
Default constructor is not public to avoid unset required fields.
|
SoundDescriptorImpl(ContainerDefinition containerFormat,
Rational audioSampleRate,
int channels,
int quantizationBits)
Creates and initializes a new sound descriptor, which specifies that a
file source package is associated with audio essence. |
| Modifier and Type | Method and Description |
|---|---|
SoundDescriptor |
clone()
Create a cloned copy of this interchange object.
|
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.
|
String |
getAudioSampleRateString() |
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.
|
String |
getSoundCompressionString() |
static Rational |
initializeAudioSampleRate() |
static int |
initializeChannelCount() |
static int |
initializeQuantizationBits() |
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 audioReferenceLevel)
Sets the audio reference level of the audio essence described by this sound descriptor.
|
void |
setAudioSampleRate(Rational rate)
Sets the audio sampling rate of audio essence described by this sound
descriptor.
|
void |
setAudioSampleRateString(String audioSampleRate) |
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 soundCompression)
Sets the kind of compression and format of compression
information of this sound essence data.
|
void |
setSoundCompressionString(String soundCompression) |
describesStaticEssence, 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, toStringgetCodec, 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 SoundDescriptorImpl()
public SoundDescriptorImpl(ContainerDefinition containerFormat, Rational audioSampleRate, @UInt32 int channels, @UInt32 int quantizationBits) throws NullPointerException, IllegalArgumentException
Creates and initializes a new sound descriptor, which specifies that a
file source package is associated with audio essence.
containerFormat - Identifies the container mechanism used to store the essence.audioSampleRate - Sampling rate of the audio essence.channels - Number of audio channels.quantizationBits - Number of quantization bits.NullPointerException - One or both of the container format and/or sampling rate
is null.IllegalArgumentException - The channels and/or quantization bit values are negative.@MediaProperty(uuid1=67240193, uuid2=768, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="AudioReferenceLevel", aliases="AudioRefLevel", typeName="Int8", optional=true, uniqueIdentifier=false, pid=15620, symbol="AudioReferenceLevel") public byte getAudioReferenceLevel() throws PropertyNotPresentException
SoundDescriptorReturns the audio reference level of this sound descriptor. This specifies the number of dBm for 0VU. This property is optional.
getAudioReferenceLevel in interface SoundDescriptorPropertyNotPresentException - The optional audio reference level property is not
present in this sound descriptor.@MediaPropertySetter(value="AudioReferenceLevel") public void setAudioReferenceLevel(Byte audioReferenceLevel)
SoundDescriptorSets 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.
setAudioReferenceLevel in interface SoundDescriptoraudioReferenceLevel - Audio reference level property of this sound descriptor.@MediaProperty(uuid1=67240705, uuid2=257, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="AudioSampleRate", aliases="AudioSamplingRate", typeName="Rational", optional=false, uniqueIdentifier=false, pid=15619, symbol="AudioSampleRate") public Rational getAudioSampleRate()
SoundDescriptorReturns the audio sampling rate of audio essence described by this sound descriptor.
getAudioSampleRate in interface SoundDescriptor@MediaPropertySetter(value="AudioSampleRate") public void setAudioSampleRate(Rational rate) throws NullPointerException
SoundDescriptorSets the audio sampling rate of audio essence described by this sound descriptor.
setAudioSampleRate in interface SoundDescriptorrate - Audio sampling rate of the audio essence described by this
sound descriptor.NullPointerException - The given audio sampling rate is null.public static final Rational initializeAudioSampleRate()
@MediaProperty(uuid1=67240193, uuid2=1024, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="ChannelCount", aliases="Channels", typeName="UInt32", optional=false, uniqueIdentifier=false, pid=15623, symbol="ChannelCount") public int getChannelCount()
SoundDescriptorReturns the number of audio channels described by this sound descriptor.
getChannelCount in interface SoundDescriptor@MediaPropertySetter(value="ChannelCount") public void setChannelCount(int channelCount) throws IllegalArgumentException
SoundDescriptorSets the number of audio channels described by this sound descriptor.
setChannelCount in interface SoundDescriptorchannelCount - Number of audio channels described
by this sound descriptor.IllegalArgumentException - The given channel count is negative.public static final int initializeChannelCount()
@MediaProperty(uuid1=67240962, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="SoundCompression", aliases={"Compression","SoundDescriptorCompression"}, typeName="AUID", optional=true, uniqueIdentifier=false, pid=15622, symbol="SoundCompression") public AUID getSoundCompression() throws PropertyNotPresentException
SoundDescriptorReturns he kind of compression and format of compression information of this sound essence data. This property is optional.
getSoundCompression in interface SoundDescriptorPropertyNotPresentException - The optional property is not present in
the sound descriptor, indicating that the described sound essence is not
compressed.@MediaPropertySetter(value="SoundCompression") public void setSoundCompression(AUID soundCompression)
SoundDescriptorSets 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.
setSoundCompression in interface SoundDescriptorsoundCompression - Kind of compression and format of the
compression for this sound essence data.@MediaProperty(uuid1=67241729, uuid2=0, uuid3=0, uuid4={6,14,43,52,1,1,1,5}, definedName="DialNorm", typeName="Int8", optional=true, uniqueIdentifier=false, pid=15628, symbol="DialNorm") public byte getDialNorm() throws PropertyNotPresentException
SoundDescriptorReturns 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.
getDialNorm in interface SoundDescriptorPropertyNotPresentException - This optional dial norm property is not
present in this sound descriptor.@MediaPropertySetter(value="DialNorm") public void setDialNorm(Byte dialNorm)
SoundDescriptorSets 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.
setDialNorm in interface SoundDescriptordialNorm - Dial norm property of the sound descriptor.@MediaProperty(uuid1=67240193, uuid2=256, uuid3=0, uuid4={6,14,43,52,1,1,1,1}, definedName="ElectrospatialFormulation", aliases={"ElectroSpatial","ElectroSpatialFormulation"}, typeName="ElectroSpatialFormulation", optional=true, uniqueIdentifier=false, pid=15621, symbol="ElectrospatialFormulation") public ElectroSpatialFormulation getElectrospatialFormulation() throws PropertyNotPresentException
SoundDescriptorReturns the electro-spatial formulation of the signal described by this sound descriptor. This property is optional.
Possible values for the electo-spatial formulation include:
getElectrospatialFormulation in interface SoundDescriptorPropertyNotPresentException - The optional electro-spatial formulation property is not
present in this sound descriptor.@MediaPropertySetter(value="ElectrospatialFormulation") public void setElectrospatialFormulation(ElectroSpatialFormulation formulation)
SoundDescriptorSets 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:
setElectrospatialFormulation in interface SoundDescriptorformulation - Electro-spatial formulation of the signal
described by this sound descriptor.@MediaProperty(uuid1=67240707, uuid2=1024, uuid3=0, uuid4={6,14,43,52,1,1,1,4}, definedName="QuantizationBits", typeName="UInt32", optional=false, uniqueIdentifier=false, pid=15617, symbol="QuantizationBits") public int getQuantizationBits()
SoundDescriptorReturns the number of quantization bits used for the audio essence described by this sound descriptor.
getQuantizationBits in interface SoundDescriptor@MediaPropertySetter(value="QuantizationBits") public void setQuantizationBits(int bitsCount) throws IllegalArgumentException
SoundDescriptorSets the number of quantization bits used for the audio essence described by this sound descriptor.
setQuantizationBits in interface SoundDescriptorbitsCount - Number of quantization bits of this sound descriptor.IllegalArgumentException - The given quantization bits value is negative.public static final int initializeQuantizationBits()
public boolean isLocked()
throws PropertyNotPresentException
SoundDescriptorReturns 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.
isLocked in interface SoundDescriptorPropertyNotPresentException - The optional locked property is not
present in this sound descriptor.SoundDescriptor.getLocked()@MediaProperty(uuid1=67240705, uuid2=1024, uuid3=0, uuid4={6,14,43,52,1,1,1,4}, definedName="Locked", typeName="Boolean", optional=true, uniqueIdentifier=false, pid=15618, symbol="Locked") public boolean getLocked() throws PropertyNotPresentException
SoundDescriptorReturns 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.
getLocked in interface SoundDescriptorPropertyNotPresentException - The optional locked property is not
present in this sound descriptor.SoundDescriptor.isLocked()@MediaPropertySetter(value="Locked") public void setIsLocked(Boolean locked)
SoundDescriptorSets 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.
setIsLocked in interface SoundDescriptorlocked - Are the number of samples per frame locked?public SoundDescriptor 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 class AAFFileDescriptorImplpublic String getAudioSampleRateString()
public void setAudioSampleRateString(String audioSampleRate)
public String getSoundCompressionString()
public void setSoundCompressionString(String soundCompression)
(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.