ISpatialAudioObjectBase::IsActive method (spatialaudioclient.h)
Gets a boolean value indicating whether the ISpatialAudioObject is valid.
Syntax
HRESULT IsActive(
[out] BOOL *isActive
);
Parameters
[out] isActive
TRUE if the audio object is currently valid; otherwise, FALSE.
Return value
If the method succeeds, it returns S_OK.
Remarks
If this value is false, you should call Release to make the audio object resource available in the future.
IsActive will be set to false after SetEndOfStream is called implicitly or explicitly. SetEndOfStream is called implicitly by the system if GetBuffer is not called within an audio processing pass (between calls to ISpatialAudioObjectRenderStream::BeginUpdatingAudioObjects and ISpatialAudioObjectRenderStream::EndUpdatingAudioObjects).
The rendering engine will also deactivate the audio object, setting IsActive to false, when audio object resources become unavailable. In this case, a notification is sent via ISpatialAudioObjectRenderStreamNotify before the object is deactivated. The value returned in the availableDynamicObjectCount parameter to ISpatialAudioObjectRenderStream::BeginUpdatingAudioObjects indicates how many objects will be processed for each pass.
Requirements
| Requirement | Value |
|---|---|
| Target Platform | Windows |
| Header | spatialaudioclient.h |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for