ISpatialAudioMetadataReader interface (spatialaudiometadata.h)

Provides methods for extracting spatial audio metadata items and item command value pairs from an ISpatialAudioMetadataItems object. The SpatialAudioMetadataItems object, which is populated using an ISpatialAudioMetadataWriter or ISpatialAudioMetadataCopier, has a frame count, specified with the frameCount parameter to ActivateSpatialAudioMetadataItems, that represents the valid range of metadata item offsets. ISpatialAudioMetadataReader enables reading back groups of items within a subrange of the total frame count. The object maintains an internal read position, which is advanced by the number of frames specified when read operation is performed.

This interface is a part of Windows Sonic, Microsoft’s audio platform for more immersive audio which includes integrated spatial sound on Xbox and Windows.


The ISpatialAudioMetadataReader interface inherits from the IUnknown interface. ISpatialAudioMetadataReader also has these types of members:


The ISpatialAudioMetadataReader interface has these methods.


Completes any necessary operations on the SpatialAudioMetadataItems object and releases the object. (ISpatialAudioMetadataReader.Close)

Opens an ISpatialAudioMetadataItems object for reading.

Gets the number of commands and the sample offset for the metadata item being read.

Reads metadata commands and value data for the current item.


Minimum supported client Windows 10, version 1703 [desktop apps only]
Minimum supported server Windows Server 2016 [desktop apps only]
Target Platform Windows
Header spatialaudiometadata.h