Edit

Share via

IAudioSystemEffectsCustomFormats::GetFormatCount method (audioenginebaseapo.h)

  • Article

The GetFormatCount method retrieves the number of custom formats supported by the system effects audio processing object (sAPO).

Syntax

HRESULT GetFormatCount(
  [out] UINT *pcFormats
);

Parameters

[out] pcFormats

Specifies a pointer to an unsigned integer. The unsigned integer represents the number of formats supported by the sAPO.

Return value

The GetFormatCount method returns S_OK when the call is successful. Otherwise, it returns E_POINTER to indicate that an invalid pointer was passed to the function.

Remarks

For more information about sAPOs, see System Effects Audio Processing Objects.

Requirements

Requirement Value
Minimum supported client Available in Windows Vista and later versions of Windows.
Target Platform Desktop
Header audioenginebaseapo.h (include Audioenginebaseapo.h)
IRQL All levels.

See also

System Effects Audio Processing Objects