Edit

Share via

ISpatialAudioClient2::IsOffloadCapable method (spatialaudioclient.h)

  • Article

Queries whether the audio rendering endpoint that the ISpatialAudioClient2 was created on supports hardware offloaded audio processing. The method also considers the capabilities of the AUDIO_STREAM_CATEGORY value that will be used, as use of offload is restricted to only certain AUDIO_STREAM_CATEGORY values.

Syntax

HRESULT IsOffloadCapable(
  [in]  AUDIO_STREAM_CATEGORY category,
  [out] BOOL                  *isOffloadCapable
);

Parameters

[in] category

A value from the AUDIO_STREAM_CATEGORY enumeration specifying the category of audio for which offload support is queried.

[out] isOffloadCapable

Receives a boolean value indicating if offloaded audio processing is supported by the audio rendering endpoint.

Return value

An HRESULT including the following values.

Value Description
S_OK Success
AUDCLNT_E_DEVICE_INVALIDATED The audio device associated with the audio client has been invalidated.
E_INVALIDARG The value supplied in the category parameter is not valid.

Requirements

Requirement Value
Minimum supported client Windows Build 22000
Header spatialaudioclient.h