Edit

Share via

ISpatialAudioMetadataItems interface (spatialaudiometadata.h)

  • Article

Represents a buffer of spatial audio metadata items. Metadata commands and values can be written to, read from, and copied between ISpatialAudioMetadataItems using the ISpatialAudioMetadataWriter, ISpatialAudioMetadataReader, and ISpatialAudioMetadataCopier interfaces. Use caller-allocated memory to store metadata items by creating an ISpatialAudioMetadataItemsBuffer.

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.

Inheritance

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

Methods

The ISpatialAudioMetadataItems interface has these methods.

 
ISpatialAudioMetadataItems::GetFrameCount

Gets the total frame count of the ISpatialAudioMetadataItems, which defines valid item offsets.
ISpatialAudioMetadataItems::GetInfo

Gets the total frame count for the ISpatialAudioMetadataItems, which defines valid item offsets.
ISpatialAudioMetadataItems::GetItemCount

The current number of items stored by the ISpatialAudioMetadataItems.
ISpatialAudioMetadataItems::GetMaxItemCount

The maximum number of items allowed by the ISpatialAudioMetadataItems, defined when the object is created.
ISpatialAudioMetadataItems::GetMaxValueBufferLength

The size of the largest command value defined by the metadata format for the ISpatialAudioMetadataItems.

Remarks

Get an instance of this interface by calling ISpatialAudioMetadataClient::ActivateSpatialAudioMetadataItems.

Requirements

Requirement Value
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