IAudioClient2::IsOffloadCapable Method

The IsOffloadCapable method retrieves information about whether or not the endpoint on which a stream is created is capable of supporting an offloaded audio stream.

Syntax

public:
HRESULT IsOffloadCapable(
         AUDIO_STREAM_CATEGORY Category,
         BOOL *pbOffloadCapable
)  

Parameters

Category
Type: AUDIO_STREAM_CATEGORY 

[in] An enumeration that specifies the category of an audio stream.

pbOffloadCapable
Type: BOOL *

[out] A pointer to a Boolean value. TRUE indicates that the endpoint is offload-capable. FALSE indicates that the endpoint is not offload-capable.

Return value

Type: HRESULT 

The IsOffloadCapable method returns S_OK to indicate that it has completed successfully. Otherwise it returns an appropriate error code.

Refer to WASAPI error codes.

Requirements

Header: Declared in audioclient.h.

Library: Use mmdevapi.lib.

See also

IAudioClient2

IAudioClient2 Members