ISpatialAudioObjectRenderStreamForMetadata::GetAvailableDynamicObjectCount method

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

Syntax

c++

HRESULT GetAvailableDynamicObjectCount(
  [out] UINT32 *value
);

Parameters

• value [out]
  The number of dynamic spatial audio objects that are currently available.

Return value

If the method succeeds, it returns S_OK.

Remarks

A dynamic ISpatialAudioObjectForMetadataCommands or ISpatialAudioObjectForMetadataItems is one that was activated by setting the type parameter to the ActivateSpatialAudioObjectForMetadataCommands or ActivateSpatialAudioObjectForMetadataItems 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 ISpatialAudioObjectForMetadataCommands or ISpatialAudioObjectForMetadataItems when it is no longer being used to free up the resource to create new dynamic spatial audio objects.

Requirements

Header

Spatialaudioclient.h

See also

ISpatialAudioObjectRenderStreamForMetadata