Edit

IMFSpatialAudioObjectBuffer::SetID method (mfspatialaudio.h)

  • Article

Sets the ID of the spatial audio object represented by the buffer.

Syntax

HRESULT SetID(
  UINT32 u32ID
);

Parameters

u32ID

A 32-bit unsigned unique ID of the audio object.

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.

Remarks

The object ID must be unique for each spatial audio sample. Subsequent samples can contain spatial audio objects with the same IDs to represent moving dynamic objects or constant static objects.

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

IMFSpatialAudioObjectBuffer