ISpatialAudioObject interface
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.
Members
The ISpatialAudioObject interface inherits from the IUnknown interface. ISpatialAudioObject also has these types of members:
Methods
The ISpatialAudioObject interface has these methods.
| Method | Description |
|---|---|
| GetAudioObjectType |
Gets a value specifying the type of audio object that is represented by the ISpatialAudioObject. 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 ISpatialAudioObject. |
| IsActive |
Gets a boolean value indicating whether the ISpatialAudioObject is valid. |
| SetEndOfStream |
Instructs the system that the final block of audio data has been submitted for the ISpatialAudioObject so that the object can be deactivated and it's resources reused. |
| SetPosition |
Sets the position in 3D space, relative to the listener, from which the ISpatialAudioObject audio data will be rendered. |
| 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. |
Requirements
|
Minimum supported client |
Windows 10, version 1703 [desktop apps only] |
|---|---|
|
Minimum supported server |
Windows Server 2016 [desktop apps only] |
|
Header |
|