Media Authoring
with Java API

tv.amwa.maj.iface
Interface SoundDescriptor

All Superinterfaces:
AAFFileDescriptor, EssenceDescriptor, InterchangeObject
All Known Subinterfaces:
AES3PCMDescriptor, PCMDescriptor
All Known Implementing Classes:
AES3PCMDescriptor, PCMDescriptor, SoundDescriptor

public interface SoundDescriptor
extends AAFFileDescriptor

Specifies the description of a file source mob that is associated with audio essence.

Author:
Richard Cartwright
See Also:
makeSoundDescriptor(), DataDefinitionConstant.Sound, SourceMob.getEssenceDescriptor()

Method Summary
 byte getAudioRefLevel()
          Returns the audio reference level of this sound descriptor.
 Rational getAudioSamplingRate()
          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.
 AUID getCompression()
          Returns he kind of compression and format of compression information of this sound essence data.
 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.
 int getQuantizationBits()
          Returns the number of quantization bits used for the audio essence described by this sound descriptor.
 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 setAudioRefLevel(Byte level)
          Sets the audio reference level of the audio essence described by this sound descriptor.
 void setAudioSamplingRate(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 setCompression(AUID compression)
          Sets the kind of compression and format of compression information of this sound essence data.
 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.
 
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

setCompression

void setCompression(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.

Parameters:
compression - Kind of compression and format of the compression for this sound essence data.

getCompression

AUID getCompression()
                    throws PropertyNotPresentException

Returns he kind of compression and format of compression information of this sound essence data. This property is optional.

Returns:
The kind of compression and format of compression for the sound essence data.
Throws:
PropertyNotPresentException - The optional property is not present in the sound descriptor, indicating that the described sound essence is not compressed.

setChannelCount

void setChannelCount(@UInt32
                     int channelCount)
                     throws IllegalArgumentException

Sets the number of audio channels described by this sound descriptor.

Parameters:
channelCount - Number of audio channels described by this sound descriptor.
Throws:
IllegalArgumentException - The given channel count is negative.

getChannelCount

@UInt32
int getChannelCount()

Returns the number of audio channels described by this sound descriptor.

Returns:
Number of audio channels described by this sound descriptor.

setAudioSamplingRate

void setAudioSamplingRate(Rational audioSamplingRate)
                          throws NullPointerException

Sets the audio sampling rate of audio essence described by this sound descriptor.

Parameters:
audioSamplingRate - Audio sampling rate of the audio essence described by this sound descriptor.
Throws:
NullPointerException - The given audio sampling rate is null.

getAudioSamplingRate

Rational getAudioSamplingRate()

Returns the audio sampling rate of audio essence described by this sound descriptor.

Returns:
Audio sampling rate of audio essence described by this sound descriptor.

setIsLocked

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.

Parameters:
locked - Are the number of samples per frame locked?

isLocked

@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.

Returns:
Are the number of samples per frame locked?
Throws:
PropertyNotPresentException - The optional locked property is not present in this sound descriptor.

setElectroSpatialFormulation

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:

Parameters:
formulation - Electro-spatial formulation of the signal described by this sound descriptor.

getElectroSpatialFormulation

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:

Returns:
Electro-spatial formulation of the signal of this sound descriptor.
Throws:
PropertyNotPresentException - The optional electro-spatial formulation property is not present in this sound descriptor.

setAudioRefLevel

void setAudioRefLevel(@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.

Parameters:
level - Audio reference level property of this sound descriptor.

getAudioRefLevel

@Int8
byte getAudioRefLevel()
                      throws PropertyNotPresentException

Returns the audio reference level of this sound descriptor. This specifies the number of dBm for 0VU. This property is optional.

Returns:
Audio reference level property of this sound descriptor.
Throws:
PropertyNotPresentException - The optional audio reference level property is not present in this sound descriptor.

setDialNorm

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.

Parameters:
dialNorm - Dial norm property of the sound descriptor.

getDialNorm

@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.

Returns:
Dial norm property of this sound descriptor.
Throws:
PropertyNotPresentException - This optional dial norm property is not present in this sound descriptor.

setQuantizationBits

void setQuantizationBits(@UInt32
                         int bitsCount)
                         throws IllegalArgumentException

Sets the number of quantization bits used for the audio essence described by this sound descriptor.

Parameters:
bitsCount - Number of quantization bits of this sound descriptor.
Throws:
IllegalArgumentException - The given quantization bits value is negative.

getQuantizationBits

@UInt32
int getQuantizationBits()

Returns the number of quantization bits used for the audio essence described by this sound descriptor.

Returns:
Number of quantization bits of this sound descriptor.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.