ISpatialAudioObjectRenderStreamBase::EndUpdatingAudioObjects method (spatialaudioclient.h)

Notifies the system that the app has finished supplying audio data for the spatial audio objects activated with ActivateSpatialAudioObject.

Syntax

HRESULT EndUpdatingAudioObjects();

Return value

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.

Return code Description
SPTLAUDCLNT_E_OUT_OF_ORDER
EndUpdatingAudioObjects was called before BeginUpdatingAudioObjects.
SPTLAUDCLNT_E_DESTROYED
The ISpatialAudioClient associated with the spatial audio stream has been destroyed.
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.
AUDCLNT_E_RESOURCES_INVALIDATED
A resource associated with the spatial audio stream is no longer valid.
SPTLAUDCLNT_E_INTERNAL
An internal error has occurred.
AUDCLNT_E_UNSUPPORTED_FORMAT
The media associated with the spatial audio stream uses an unsupported format.

Remarks

The pointers retrieved with ISpatialAudioObjectBase::GetBuffer can no longer be used after this method is called.

Requirements

Requirement Value
Target Platform Windows
Header spatialaudioclient.h

See also

ISpatialAudioObjectRenderStream

ISpatialAudioObjectRenderStreamBase