ISpatialAudioObjectRenderStreamNotify::OnAvailableDynamicObjectCountChange method (spatialaudioclient.h)

Article
02/22/2024

Notifies the spatial audio client when the rendering capacity for an ISpatialAudioObjectRenderStream is about to change, specifies the time after which the change will occur, and specifies the number of dynamic audio objects that will be available after the change.

Syntax

HRESULT OnAvailableDynamicObjectCountChange(
  [in] ISpatialAudioObjectRenderStreamBase *sender,
  [in] LONGLONG                            hnsComplianceDeadlineTime,
  [in] UINT32                              availableDynamicObjectCountChange
);

Parameters

[in] sender

The spatial audio render stream for which the available dynamic object count is changing.

[in] hnsComplianceDeadlineTime

The time after which the spatial resource limit will change, in 100-nanosecond units. A value of 0 means that the change will occur immediately.

[in] availableDynamicObjectCountChange

The number of dynamic spatial audio objects that will be available to the stream after hnsComplianceDeadlineTime.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

A dynamic ISpatialAudioObject is one that was activated by setting the type parameter to the ISpatialAudioObjectRenderStream::ActivateSpatialAudioObject method to AudioObjectType_Dynamic. The client has a limit of the maximum number of dynamic spatial audio objects that can be activated at one time. When the capacity of the audio rendering pipeline changes, the system will dynamically adjust the maximum number of concurrent dynamic spatial audio objects. Before doing so, the system will call OnAvailableDynamicObjectCountChange to notify clients of the resource limit change.

Call Release on an ISpatialAudioObject when it is no longer being used to free up the resource to create new dynamic spatial audio objects.

Requirements

Requirement	Value
Target Platform	Windows
Header	spatialaudioclient.h