The IAAFWaveDescriptor interface is implemented by objects which describe audio content data formatted according to the RIFF Waveform Audio File Format (WAVE). More...
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. |
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
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:
If this method fails pSummary will not be changed.
This method will return the following codes:
AAFRESULT_SUCCESS
AAFRESULT_NULL_PARAM
AAFRESULT_SMALLBUF
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:
If this method fails nothing will be written to *pSize.
This method will return the following codes:
AAFRESULT_SUCCESS
AAFRESULT_NULL_PARAM
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:
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
AAFRESULT_ALREADY_INITIALIZED
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:
If this method fails the summary property will not be changed.
This method will return the following codes:
AAFRESULT_SUCCESS
AAFRESULT_NULL_PARAM
size | [in] Size of preallocated buffer |
pSummary | [in, size_is(size)] buffer containing value |