Edit

ISpatialAudioObject interface (spatialaudioclient.h)

  • Article

Represents an object that provides audio data to be rendered from a position in 3D space, relative to the user. Spatial audio objects can be static or dynamic, which you specify with the type parameter to the ISpatialAudioObjectRenderStream::ActivateSpatialAudioObject method. Dynamic audio objects can be placed in an arbitrary position in space and can be moved over time. Static audio objects are assigned to one or more channels, defined in the AudioObjectType enumeration, that each correlate to a fixed speaker location that may be a physical or a virtualized speaker.

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 ISpatialAudioObject interface inherits from ISpatialAudioObjectBase. ISpatialAudioObject also has these types of members:

Methods

The ISpatialAudioObject interface has these methods.

 
ISpatialAudioObject::SetPosition

Sets the position in 3D space, relative to the listener, from which the ISpatialAudioObject audio data will be rendered.
ISpatialAudioObject::SetVolume

Sets an audio amplitude multiplier that will be applied to the audio data provided by the ISpatialAudioObject before it is submitted to the audio rendering engine.

Remarks

Note  Many of the methods provided by this interface are implemented in the inherited ISpatialAudioObjectBase interface.
 

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 spatialaudioclient.h

See also

ISpatialAudioObjectBase