IMFSpatialAudioObjectBuffer::GetMetadataItems method

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

Syntax


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

Parameters

ppMetadataItems [out]

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 codeDescription
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

Minimum supported client

Windows 10, version 1703 [desktop apps only]

Minimum supported server

None supported

Header

Mfobjects.h

Library

Mfobjects.lib

See also

IMFSpatialAudioObjectBuffer

 

 

Show: