ISpatialAudioMetadataClient interface

Provides a class factory for creating ISpatialAudioMetadataItems, ISpatialAudioMetadataWriter, ISpatialAudioMetadataReader, and ISpatialAudioMetadataCopier objects. When an ISpatialAudioMetadataItems is activated, a metadata format ID is specified, which defines the metadata format enforced for all objects created from this factory. If the specified format is not supported by the current audio render endpoint, the class factory will not successfully activate the interface and will return an error.

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.

Members

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

Methods

The ISpatialAudioMetadataClient interface has these methods.

MethodDescription
ActivateSpatialAudioMetadataCopier

Creates an ISpatialAudioMetadataWriter object for copying spatial audio metadata items from one ISpatialAudioMetadataItems object to another.

ActivateSpatialAudioMetadataItems

Creates an ISpatialAudioMetadataItems object for storing spatial audio metadata items.

ActivateSpatialAudioMetadataReader

Creates an ISpatialAudioMetadataWriter object for reading spatial audio metadata items from an ISpatialAudioMetadataItems object.

ActivateSpatialAudioMetadataWriter

Creates an ISpatialAudioMetadataWriter object for writing spatial audio metadata items to an ISpatialAudioMetadataItems object.

GetSpatialAudioMetadataItemsBufferLength

Gets the length of the buffer required to store the specified number of spatial audio metadata items. Use this method to determine the correct buffer size to use when attaching caller-provided memory through the ISpatialAudioMetadataItemsBuffer interface.

 

Requirements

Minimum supported client

Windows 10, version 1703 [desktop apps only]

Minimum supported server

Windows Server 2016 [desktop apps only]

Header

SpatialAudioMetadata.h

 

 

Show: