ISpatialAudioObjectRenderStreamBase interface (spatialaudioclient.h)

  • Article

Base interface that provides methods for controlling a spatial audio object render stream, including starting, stopping, and resetting the stream. Also provides methods for activating new ISpatialAudioObject instances and notifying the system when you are beginning and ending the process of updating activated spatial audio objects and data.

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

Methods

The ISpatialAudioObjectRenderStreamBase interface has these methods.

 
ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects

Puts the system into the state where audio object data can be submitted for processing and the ISpatialAudioObject state can be modified.
ISpatialAudioObjectRenderStreamBase::EndUpdatingAudioObjects

Notifies the system that the app has finished supplying audio data for the spatial audio objects activated with ActivateSpatialAudioObject.
ISpatialAudioObjectRenderStreamBase::GetAvailableDynamicObjectCount

Gets the number of dynamic spatial audio objects that are currently available.
ISpatialAudioObjectRenderStreamBase::GetService

Gets additional services from the ISpatialAudioObjectRenderStream.
ISpatialAudioObjectRenderStreamBase::Reset

Reset a stopped audio stream.
ISpatialAudioObjectRenderStreamBase::Start

Starts the spatial audio stream.
ISpatialAudioObjectRenderStreamBase::Stop

Stops a running audio stream.

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