IXAPO::IsOutputFormatSupported method (xapo.h)

Article
02/22/2024

Queries if a specific output format is supported for a given input format.

Syntax

HRESULT IsOutputFormatSupported(
  [in]  const WAVEFORMATEX *pInputFormat,
  [in]  const WAVEFORMATEX *pRequestedOutputFormat,
  [out] WAVEFORMATEX       **ppSupportedOutputFormat
);

Parameters

[in] pInputFormat

Input format.

[in] pRequestedOutputFormat

Output format to check for being supported.

[out] ppSupportedOutputFormat

If not NULL and the output format is not supported for the given input format, ppSupportedOutputFormat returns a pointer to the closest output format that is supported. Use XAPOFree to free the returned structure.

Return value

Returns S_OK if the format pair is supported. Returns XAPO_E_FORMAT_UNSUPPORTED if the format pair is not supported.

Remarks

The IXAPO::IsInputFormatSupported and IsOutputFormatSupported methods allow an XAPO to indicate which audio formats it is capable of processing. If a requested format is not supported, the XAPO should return the closest format that it does support. The closest format should be determined based on frame rate, bit depth, and channel count, in that order of importance. The behavior of IsOutputFormatSupported is allowed to change, based on the internal state of the XAPO, but its behavior should remain constant between calls to the IXAPO::LockForProcess and IXAPO::UnlockForProcess methods.

Platform Requirements

Windows 10 (XAudio2.9); Windows 8, Windows Phone 8 (XAudio 2.8); DirectX SDK (XAudio 2.7)

Requirements

Requirement	Value
Target Platform	Windows
Header	xapo.h