IAudioSystemEffectsCustomFormats interface (audioenginebaseapo.h)

The IAudioSystemEffectsCustomFormats interface is supported in Windows Vista and later versions of Windows. When you develop an audio processing object (APO) to drive an audio adapter with an atypical format, the APO must support the IAudioSystemEffectsCustomFormats interface.

The Windows operating system can instantiate your APO outside the audio engine and use the IAudioSystemEffectsCustomFormats interface to retrieve information about the atypical format. The associated user interface displays the data that is retrieved.

Important  Although the IAudioSystemEffectsCustomFormats interface continues to be supported in Windows, note that the type of APO to which you can apply this interface depends on the version of Windows you are targeting. The following table provides more information:

 

Target OS	Target APO type
Windows Vista	Global effects (GFX)
Windows 7	Global effects (GFX)
Windows 8	Global effects (GFX)
Windows 8.1	Endpoint effects (EFX)

 

The IAudioSystemEffectsCustomFormats interface inherits from IUnknown and also supports the following methods:

IAudioSystemEffectsCustomFormats::GetFormat

IAudioSystemEffectsCustomFormats::GetFormatCount

IAudioSystemEffectsCustomFormats::GetFormatRepresentation

Inheritance

The IAudioSystemEffectsCustomFormats interface inherits from the IUnknown interface.

Methods

The IAudioSystemEffectsCustomFormats interface has these methods.

IAudioSystemEffectsCustomFormats::GetFormat The GetFormat method retrieves an IAudioMediaType representation of a custom format.
IAudioSystemEffectsCustomFormats::GetFormatCount The GetFormatCount method retrieves the number of custom formats supported by the system effects audio processing object (sAPO).
IAudioSystemEffectsCustomFormats::GetFormatRepresentation The GetFormatRepresentation method retrieves a string representation of the custom format so that it can be displayed on a user-interface.

Requirements

Requirement	Value
Target Platform	Windows
Header	audioenginebaseapo.h