The IAAFSoundDescriptor interface is implemented by objects which describe the basic parameters of Sound used by all compression or coding schemes. More...

Public Member Functions
HRESULT	SetCompression ([in] aafUID_constref compression)
	Sets the kind of compression and format of compression information of the sound essence data.
HRESULT	GetCompression ([out] aafUID_t *pCompression)
	Gets the kind of compression and format of compression information of the sound essence data.
HRESULT	SetChannelCount ([in] aafUInt32 channelCount)
	Sets the number of channels of sound represented by this descriptor.
HRESULT	GetChannelCount ([out] aafUInt32 *pChannelCount)
	Gets the number of channels of sound represented by this descriptor.
HRESULT	SetAudioSamplingRate ([in] aafRational_t rate)
	Sets the sample rate of audio represented by this descriptor.
HRESULT	GetAudioSamplingRate ([out] aafRational_t *pRate)
	Gets the sample rate of audio represented by this descriptor.
HRESULT	SetIsLocked ([in] aafBoolean_t locked)
	Sets the Locked flag which indicates whether the number of samples per frame is locked or unlocked.
HRESULT	IsLocked ([out] aafBoolean_t *pLocked)
	Gets the Locked flag which indicates whether the number of samples per frame is locked or unlocked.
HRESULT	SetElectroSpatialFormulation ([in] aafElectroSpatialFormulation_t formulation)
	Sets the electro-spatial form of the signal.
HRESULT	GetElectroSpatialFormulation ([out] aafElectroSpatialFormulation_t *pFormulation)
	Gets the electro-spatial form of the signal.
HRESULT	SetAudioRefLevel ([in] aafInt8 level)
	Sets the audio reference level.
HRESULT	GetAudioRefLevel ([out] aafInt8 *pLevel)
	Gets the audio reference level.
HRESULT	SetDialNorm ([in] aafInt8 dialNorm)
	Sets the dial norm.
HRESULT	GetDialNorm ([out] aafInt8 *pDialNorm)
	Gets the dial norm.
HRESULT	SetQuantizationBits ([in] aafUInt32 bitsCount)
	Sets the number of quantization bits.
HRESULT	GetQuantizationBits ([out] aafUInt32 *pBitsCount)
	Gets the number of quantization bits.

Detailed Description

The IAAFSoundDescriptor interface is implemented by objects which describe the basic parameters of Sound used by all compression or coding schemes.

In addition to the specific error results listed for each method, all methods in this interface may also return one of the following values:

AAFRESULT_NOMEMORY

insufficient system memory is available to perform the operation. Objects that implement IAAFSoundDescriptor also implement the following interfaces:

IAAFFileDescriptor

Definition at line 24991 of file AAF.idl.

Member Function Documentation

HRESULT IAAFSoundDescriptor::GetAudioRefLevel ( [out] aafInt8 * pLevel )

Gets the audio reference level.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.
the pLevel pointer is valid.
the property is present.

If this method fails nothing will be written to *pLevel.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pLevel arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pLevel [out] Audio reference level.

HRESULT IAAFSoundDescriptor::GetAudioSamplingRate ( [out] aafRational_t * pRate )

Gets the sample rate of audio represented by this descriptor.

This property is required.

Succeeds if all of the following are true:

the object is initialized.
the pRate pointer is valid.

If this method fails nothing will be written to *pRate.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pRate arg is NULL.

Parameters:

pRate [out] Sample rate of audio essence.

HRESULT IAAFSoundDescriptor::GetChannelCount ( [out] aafUInt32 * pChannelCount )

Gets the number of channels of sound represented by this descriptor.

This property is required.

Succeeds if all of the following are true:

the object is initialized.
the pChannelCount pointer is valid.

If this method fails nothing will be written to *pChannelCount.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pChannelCount arg is NULL.

Parameters:

pChannelCount [out] The number of channels of sound represented by this descriptor.

HRESULT IAAFSoundDescriptor::GetCompression ( [out] aafUID_t * pCompression )

Gets the kind of compression and format of compression information of the sound essence data.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.
the pCompression pointer is valid.
the property is present.

If this method fails nothing will be written to *pCompression.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pCompression arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pCompression [out] Compression of the sound essence data.

HRESULT IAAFSoundDescriptor::GetDialNorm ( [out] aafInt8 * pDialNorm )

Gets the dial norm.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.
the pDialNorm pointer is valid.
the property is present.

If this method fails nothing will be written to *pDialNorm.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pDialNorm arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pDialNorm [out] Dial norm.

HRESULT IAAFSoundDescriptor::GetElectroSpatialFormulation ( [out] aafElectroSpatialFormulation_t * pFormulation )

Gets the electro-spatial form of the signal.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.
the pFormulation pointer is valid.
the property is present.

If this method fails nothing will be written to *pFormulation.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pFormulation arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pFormulation [out] Electro-spatial form of the signal.

HRESULT IAAFSoundDescriptor::GetQuantizationBits ( [out] aafUInt32 * pBitsCount )

Gets the number of quantization bits.

This property is required.

Succeeds if all of the following are true:

the object is initialized.
the pBitsCount pointer is valid.

If this method fails nothing will be written to *pBitsCount.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pBitsCount arg is NULL.

Parameters:

pBitsCount [out] Number of quantization bits.

HRESULT IAAFSoundDescriptor::IsLocked ( [out] aafBoolean_t * pLocked )

Gets the Locked flag which indicates whether the number of samples per frame is locked or unlocked.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.
the pLocked pointer is valid.
the property is present.

If this method fails nothing will be written to *pLocked.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

AAFRESULT_NULL_PARAM

pLocked arg is NULL.

AAFRESULT_PROP_NOT_PRESENT

the property is not present.

Parameters:

pLocked [out] Is number of samples per frame locked to video?

HRESULT IAAFSoundDescriptor::SetAudioRefLevel ( [in] aafInt8 level )

Sets the audio reference level.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.

If this method fails the AudioRefLevel property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

level [in] Audio reference level.

HRESULT IAAFSoundDescriptor::SetAudioSamplingRate ( [in] aafRational_t rate )

Sets the sample rate of audio represented by this descriptor.

This property is required.

Succeeds if all of the following are true:

the object is initialized.

If this method fails the AudioSamplingRate property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

rate	[in] Sample rate of audio essence.

HRESULT IAAFSoundDescriptor::SetChannelCount ( [in] aafUInt32 channelCount )

Sets the number of channels of sound represented by this descriptor.

This property is required.

Succeeds if all of the following are true:

the object is initialized.

If this method fails the Channels property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

channelCount [in] The number of channels of sound represented by this descriptor.

HRESULT IAAFSoundDescriptor::SetCompression ( [in] aafUID_constref compression )

Sets the kind of compression and format of compression information of the sound essence data.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.

If this method fails the Compression property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

compression [in] Identifies kind of compression and format of compression information.

HRESULT IAAFSoundDescriptor::SetDialNorm ( [in] aafInt8 dialNorm )

Sets the dial norm.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.

If this method fails the DialNorm property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

dialNorm [in] Dial norm.

HRESULT IAAFSoundDescriptor::SetElectroSpatialFormulation ( [in] aafElectroSpatialFormulation_t formulation )

Sets the electro-spatial form of the signal.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.

If this method fails the ElectroSpatial property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

formulation [in] Electro-spatial form of the signal.

HRESULT IAAFSoundDescriptor::SetIsLocked ( [in] aafBoolean_t locked )

Sets the Locked flag which indicates whether the number of samples per frame is locked or unlocked.

This property is optional.

Succeeds if all of the following are true:

the object is initialized.

If this method fails the Locked property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

locked [in] Is number of samples per frame locked to video?

HRESULT IAAFSoundDescriptor::SetQuantizationBits ( [in] aafUInt32 bitsCount )

Sets the number of quantization bits.

This property is required.

Succeeds if all of the following are true:

the object is initialized.

If this method fails the QuantizationBits property will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

succeeded. (This is the only code indicating success.)

Parameters:

bitsCount [in] Number of quantization bits.

Public Member Functions

Detailed Description

Member Function Documentation