Skip to content

Latest commit

 

History

History
148 lines (115 loc) · 5.43 KB

nf-spatialaudioclient-ispatialaudioobjectrenderstreambase-getavailabledynamicobjectcount.md

File metadata and controls

148 lines (115 loc) · 5.43 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.ISpatialAudioObjectRenderStreamBase.GetAvailableDynamicObjectCount
ISpatialAudioObjectRenderStreamBase::GetAvailableDynamicObjectCount (spatialaudioclient.h)
Gets the number of dynamic spatial audio objects that are currently available.
GetAvailableDynamicObjectCount
GetAvailableDynamicObjectCount method [Core Audio]
GetAvailableDynamicObjectCount method [Core Audio]
ISpatialAudioObjectRenderStreamBase interface
ISpatialAudioObjectRenderStreamBase interface [Core Audio]
GetAvailableDynamicObjectCount method
ISpatialAudioObjectRenderStreamBase.GetAvailableDynamicObjectCount
ISpatialAudioObjectRenderStreamBase::GetAvailableDynamicObjectCount
coreaudio.ispatialaudioobjectrenderstream_getavailabledynamicobjectcount
spatialaudioclient/ISpatialAudioObjectRenderStreamBase::GetAvailableDynamicObjectCount
coreaudio\ispatialaudioobjectrenderstream_getavailabledynamicobjectcount.htm
CoreAudio
5E17B53A-B999-4B08-9DFB-96D55E7F9CF7
12/05/2018
GetAvailableDynamicObjectCount, GetAvailableDynamicObjectCount method [Core Audio], GetAvailableDynamicObjectCount method [Core Audio],ISpatialAudioObjectRenderStreamBase interface, ISpatialAudioObjectRenderStreamBase interface [Core Audio],GetAvailableDynamicObjectCount method, ISpatialAudioObjectRenderStreamBase.GetAvailableDynamicObjectCount, ISpatialAudioObjectRenderStreamBase::GetAvailableDynamicObjectCount, coreaudio.ispatialaudioobjectrenderstream_getavailabledynamicobjectcount, spatialaudioclient/ISpatialAudioObjectRenderStreamBase::GetAvailableDynamicObjectCount
spatialaudioclient.h
Windows
Windows
19H1
ISpatialAudioObjectRenderStreamBase::GetAvailableDynamicObjectCount
spatialaudioclient/ISpatialAudioObjectRenderStreamBase::GetAvailableDynamicObjectCount
c++
APIRef
kbSyntax
COM
spatialaudioclient.h
ISpatialAudioObjectRenderStreamBase.GetAvailableDynamicObjectCount

ISpatialAudioObjectRenderStreamBase::GetAvailableDynamicObjectCount

-description

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

-parameters

-param value [out]

The number of dynamic spatial audio objects that are currently available.

-returns

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

-remarks

A dynamic ISpatialAudioObject is one that was activated by setting the type parameter to the ActivateSpatialAudioObject method to AudioObjectType_Dynamic. The system has a limit of the maximum number of dynamic spatial audio objects that can be activated at one time. Call Release on an ISpatialAudioObject when it is no longer being used to free up the resource to create new dynamic spatial audio objects.

You should not call this method after streaming has started, as the value is already provided by ISpatialAudioObjectRenderStreamBase::BeginUpdatingAudioObjects. This method should only be called before streaming has started, which occurs after ISpatialAudioObjectRenderStreamBase::Start is called.

-see-also

ISpatialAudioObjectRenderStream

ISpatialAudioObjectRenderStreamBase

Return code Description
SPTLAUDCLNT_E_DESTROYED
The ISpatialAudioClient associated with the spatial audio stream has been destroyed.
AUDCLNT_E_DEVICE_INVALIDATED
The audio device associated with the spatial audio stream is no longer valid.
AUDCLNT_E_DEVICE_INVALIDATED
The audio endpoint device has been unplugged, or the audio hardware or associated hardware resources have been reconfigured, disabled, removed, or otherwise made unavailable for use.
SPTLAUDCLNT_E_INTERNAL
An internal error has occurred.
AUDCLNT_E_UNSUPPORTED_FORMAT
The media associated with the spatial audio stream uses an unsupported format.