Edit

IMFSpatialAudioSample::GetSpatialAudioObjectByIndex method (mfspatialaudio.h)

  • Article

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

Syntax

HRESULT GetSpatialAudioObjectByIndex(
  DWORD                       dwIndex,
  IMFSpatialAudioObjectBuffer **ppAudioObjBuffer
);

Parameters

dwIndex

A 32 bit variable with the 0-based index of the requested audio object.

ppAudioObjBuffer

A pointer to an IMFSpatialAudioObjectBuffer object in which the spatial audio object corresponding with the specified index will be stored.

Return value

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.

Requirements

Requirement Value
Minimum supported client Windows 10, version 1703 [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header mfspatialaudio.h (include Mfobjects.h)
Library Mfobjects.lib

See also

IMFSpatialAudioSample