IAudioData Interface

The IAudioData interface provides methods that enable applications to set and get the underlying audio data that audio streams will reference. The audio data format is set in the WAVEFORMATEX structure.

Implement this interface on underlying audio data objects that audio stream sample objects will access.

Applications use this interface to set and retrieve information on underlying data objects that an audio stream will reference.

Methods in Vtable Order

IUnknown methods Description
QueryInterface Retrieves pointers to supported interfaces.
AddRef Increments the reference count.
Release Decrements the reference count.

IAudioData methods Description

GetFormat Retrieves the current data format.
SetFormat Sets the current data format.

IUnknown methods	Description
QueryInterface	Retrieves pointers to supported interfaces.
AddRef	Increments the reference count.
Release	Decrements the reference count.
IAudioData methods	Description
GetFormat	Retrieves the current data format.
SetFormat	Sets the current data format.

IAudioData::GetFormat

IAudioData Interface

Retrieves the current data format.

Syntax

HRESULT GetFormat(
    WAVEFORMATEX *pWaveFormatCurrent
    );

Parameters

pWaveFormatCurrent
[out] Pointer to a WAVEFORMATEX structure that contains the current data format.

Return Value

Returns S_OK if successful or E_POINTER if pointer is invalid.

Remarks

Currently, Microsoft® DirectShow® supports only PCM wave data.

IAudioData::SetFormat

IAudioData Interface

Sets the current data format.

Syntax

HRESULT SetFormat(
    const WAVEFORMATEX *lpWaveFormat
    );

Parameters

lpWaveFormat
[in] Pointer to a WAVEFORMATEX structure that will contain the current data format.

Return Value

Returns an HRESULT value, which can include the following values.

E_POINTER Invalid pointer argument.
E_INVALIDARG Invalid format.
S_OK Success.

E_POINTER	Invalid pointer argument.
E_INVALIDARG	Invalid format.
S_OK	Success.