IAAFWAVEDescriptor Interface Reference

The IAAFWaveDescriptor interface is implemented by objects which describe audio content data formatted according to the RIFF Waveform Audio File Format (WAVE). More...

List of all members.

Public Member Functions
HRESULT	Initialize ()
	Initializes a newly allocated, empty IAAFWaveDescriptor-supporting object.
HRESULT	GetSummary ([in] aafUInt32 size,[out, size_is(size)] aafDataValue_t pSummary)
	Gets a copy of the WAVE file information without the media.
HRESULT	GetSummaryBufferSize ([out] aafUInt32 *pSize)
	Returns the size of the buffer required for the GetSummary() method.
HRESULT	SetSummary ([in] aafUInt32 size,[in, size_is(size)] aafDataValue_t pSummary)
	Sets the WAVE file information.

---

Detailed Description

The IAAFWaveDescriptor interface is implemented by objects which describe audio content data formatted according to the RIFF Waveform Audio File Format (WAVE).

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 IAAFWAVEDescriptor also implement the following interfaces:

IAAFFileDescriptor

• IAAFFileDescriptor2
• IAAFEssenceDescriptor
• IAAFObject

Definition at line 34345 of file AAF.idl.

---

Member Function Documentation

HRESULT IAAFWAVEDescriptor::GetSummary	(	[in] aafUInt32	size,
		[out, size_is(size)] aafDataValue_t	pSummary
	)

Gets a copy of the WAVE file information without the media.

Succeeds if all of the following are true:

• pSummary is a valid pointer.
• The size of the buffer is large enough to hold the WAVE file information.

If this method fails pSummary will not be changed.

This method will return the following codes:

AAFRESULT_SUCCESS

• succeeded.

AAFRESULT_NULL_PARAM

• pSummary arg is NULL.

AAFRESULT_SMALLBUF

• The buffer is too small to hold the WAVE file information.

Parameters:

size	[in] Size of preallocated buffer
pSummary	[out, size_is(size)] Preallocated buffer to hold the WAVE file information

HRESULT IAAFWAVEDescriptor::GetSummaryBufferSize

(

[out] aafUInt32 *

pSize

)

Returns the size of the buffer required for the GetSummary() method.

The value is placed into the location specified by pSize.

Succeeds if all of the following are true:

• the pSize pointer is valid.

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

This method will return the following codes:

AAFRESULT_SUCCESS

• succeeded.

AAFRESULT_NULL_PARAM

• pSize arg is NULL.

Parameters:

pSize

[out] required buffer size

HRESULT IAAFWAVEDescriptor::Initialize

(

)

Initializes a newly allocated, empty IAAFWaveDescriptor-supporting object.

This method must be called after allocation, and before any other method can be called.

Succeeds if:

• Initialize() has not yet been called on this object.

This method will return the following codes. If more than one of the listed errors is in effect, it will return the first one encountered in the order given below:

AAFRESULT_SUCCESS

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

AAFRESULT_ALREADY_INITIALIZED

• Initialize() has already been called on this object.

HRESULT IAAFWAVEDescriptor::SetSummary	(	[in] aafUInt32	size,
		[in, size_is(size)] aafDataValue_t	pSummary
	)

Sets the WAVE file information.

Succeeds if all of the following are true:

• pSummary is a valid pointer

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

This method will return the following codes:

AAFRESULT_SUCCESS

• succeeded.

AAFRESULT_NULL_PARAM

• pSummary arg is NULL.

Parameters:

size	[in] Size of preallocated buffer
pSummary	[in, size_is(size)] buffer containing value