CXAPOBase::IsInputFormatSupported Method

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

Syntax

public:
HRESULT IsInputFormatSupported(
         const WAVEFORMATEX *pOutputFormat,
         const WAVEFORMATEX *pRequestedInputFormat,
         WAVEFORMATEX **ppSupportedInputFormat
)

Parameters

pOutputFormat
Type: WAVEFORMATEX *

Output format.

pRequestedInputFormat
Type: WAVEFORMATEX *

Input format to check for being supported.

ppSupportedInputFormat
Type: WAVEFORMATEX **

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

Return value

Type: HRESULT

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

Remarks

The IXAPO::IsOutputFormatSupported and IsInputFormatSupported 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 IsInputFormatSupported 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.

Requirements

Header: Declared in xapobase.h.