ISpatialAudioObjectForMetadataCommands interface

Used to write metadata commands for spatial audio. Valid commands and value lengths are defined by the metadata format specified in the SpatialAudioObjectRenderStreamForMetadataActivationParams when the ISpatialAudioObjectRenderStreamForMetadata was created.

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 ISpatialAudioObjectForMetadataCommands interface inherits from the IUnknown interface. ISpatialAudioObjectForMetadataCommands also has these types of members:

Methods

The ISpatialAudioObjectForMetadataCommands interface has these methods.

MethodDescription
GetAudioObjectType

Gets a value specifying the type of audio object that is represented by the ISpatialAudioObjectForMetadataCommands. This value indicates if the object is dynamic or static. If the object is static, one and only one of the static audio channel values to which the object is assigned is returned.

GetBuffer

Gets a buffer that is used to supply the audio data for the ISpatialAudioObjectForMetadataCommands.

IsActive

Gets a value indicating whether the ISpatialAudioObjectForMetadataCommands is valid.

SetEndOfStream

Instructs the system that the final block of audio data has been submitted for the ISpatialAudioObjectForMetadataCommands so that the object can be deactivated and it's resources reused.

WriteNextMetadataCommand

Writes a metadata command to the spatial audio object, each command may only be added once per object per processing cycle. Valid commands and value lengths are defined by the metadata format specified in the SpatialAudioObjectRenderStreamForMetadataActivationParams when the ISpatialAudioObjectRenderStreamForMetadata was created.

 

Requirements

Minimum supported client

Windows 10, version 1703 [desktop apps only]

Minimum supported server

Windows Server 2016 [desktop apps only]

Header

Spatialaudioclient.h

 

 

Show: