IMFSpatialAudioObjectBuffer::GetMetadataItems method (mfspatialaudio.h)

  • Article

Retrieves a pointer to a buffer that may contain spatial audio metadata.

Syntax

HRESULT GetMetadataItems(
  [out] ISpatialAudioMetadataItems **ppMetadataItems
);

Parameters

[out] ppMetadataItems

A pointer to an ISpatialAudioMetadataItems object in which the collection of metadata items 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.

Remarks

The metadata is written to the ISpatialAudioMetadataItems collection in a format identified by the MF_MT_SPATIAL_AUDIO_OBJECT_METADATA_FORMAT_ID media type attribute specified during media type negotiation phase of Media Foundation topology construction.

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