IMFSpatialAudioSample::GetSpatialAudioObjectByIndex method

Returns the spatial audio object, represented by an IMFSpatialAudioObjectBuffer object, corresponding to the specified index.

Syntax


HRESULT GetSpatialAudioObjectByIndex(
   DWORD                       dwIndex,
   IMFSpatialAudioObjectBuffer ppSpatialAudioObjectBuffer
);

dwIndex: A 32 bit variable with the 0-based index of the requested audio object.
ppSpatialAudioObjectBuffer: A pointer to an IMFSpatialAudioObjectBuffer object in which the spatial audio object corresponding with the specified index will be stored.

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code	Description
S_OK	The method succeeded.
E_POINTER	The supplied pointer is invalid.

Minimum supported client	Windows 10, version 1703 [desktop apps only]
Minimum supported server	None supported
Header	Mfobjects.h
Library	Mfobjects.lib