Skip to content

Latest commit

 

History

History
75 lines (60 loc) · 3.84 KB

nf-spatialaudioclient-ispatialaudioclient-getmaxdynamicobjectcount.md

File metadata and controls

75 lines (60 loc) · 3.84 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:spatialaudioclient.ISpatialAudioClient.GetMaxDynamicObjectCount
ISpatialAudioClient::GetMaxDynamicObjectCount (spatialaudioclient.h)
Gets the maximum number of dynamic audio objects for the spatial audio client.
GetMaxDynamicObjectCount
GetMaxDynamicObjectCount method [Core Audio]
GetMaxDynamicObjectCount method [Core Audio]
ISpatialAudioClient interface
ISpatialAudioClient interface [Core Audio]
GetMaxDynamicObjectCount method
ISpatialAudioClient.GetMaxDynamicObjectCount
ISpatialAudioClient::GetMaxDynamicObjectCount
coreaudio.ispatialaudioclient_getmaxdynamicobjectcount
spatialaudioclient/ISpatialAudioClient::GetMaxDynamicObjectCount
coreaudio\ispatialaudioclient_getmaxdynamicobjectcount.htm
CoreAudio
0185D09E-0009-41BF-A0BB-3C3CE0A69BA8
12/05/2018
GetMaxDynamicObjectCount, GetMaxDynamicObjectCount method [Core Audio], GetMaxDynamicObjectCount method [Core Audio],ISpatialAudioClient interface, ISpatialAudioClient interface [Core Audio],GetMaxDynamicObjectCount method, ISpatialAudioClient.GetMaxDynamicObjectCount, ISpatialAudioClient::GetMaxDynamicObjectCount, coreaudio.ispatialaudioclient_getmaxdynamicobjectcount, spatialaudioclient/ISpatialAudioClient::GetMaxDynamicObjectCount
spatialaudioclient.h
Windows
Windows
19H1
ISpatialAudioClient::GetMaxDynamicObjectCount
spatialaudioclient/ISpatialAudioClient::GetMaxDynamicObjectCount
c++
APIRef
kbSyntax
COM
spatialaudioclient.h
ISpatialAudioClient.GetMaxDynamicObjectCount

ISpatialAudioClient::GetMaxDynamicObjectCount

-description

Gets the maximum number of dynamic audio objects for the spatial audio client.

-parameters

-param value [out]

Gets the maximum dynamic object count for this client.

-returns

If the method succeeds, it returns S_OK.

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

When Windows Sonic is not available (for instance, when playing to embedded laptop stereo speakers, or if the user has not explicitly enabled Windows Sonic on the device), the number of available dynamic objects returned by GetMaxDynamicObjectCount to an application will be 0.

-see-also

ISpatialAudioClient