IKsFormatSupport interface (devicetopology.h)
The IKsFormatSupport interface provides information about the audio data formats that are supported by a software-configured I/O connection (typically a DMA channel) between an audio adapter device and system memory. The client obtains a reference to the IKsFormatSupport interface of a part by calling the IPart::Activate method with parameter refiid set to REFIID IID_IKsFormatSupport. The call to IPart::Activate succeeds only if the part supports the IKsFormatSupport interface. Only a part object that represents a connector with a Software_IO connection type will support this interface. For more information about Software_IO, see ConnectorType Enumeration.
Most Windows audio adapter drivers support the Windows Driver Model (WDM) and use kernel-streaming (KS) properties to represent the hardware description parameters in connectors (referred to as KS pins). The IKsFormatSupport interface provides convenient access to the KSPROPERTY_PIN_DATAINTERSECTION and KSPROPERTY_PIN_PROPOSEDDATAFORMAT properties of a connector to a system bus (typically, PCI or PCI Express) or an external bus (for example, USB). Not all drivers support the KSPROPERTY_PIN_PROPOSEDDATAFORMAT property. If a driver does not support this property, IKsFormatSupport uses the information in the KS data ranges for the connector to determine whether the connector supports the proposed format. For more information about KS properties, KS pins, and KS data ranges, see the Windows DDK documentation.
Inheritance
The IKsFormatSupport interface inherits from the IUnknown interface. IKsFormatSupport also has these types of members:
Methods
The IKsFormatSupport interface has these methods.
| IKsFormatSupport::GetDevicePreferredFormat The GetDevicePreferredFormat method gets the preferred audio stream format for the connection. |
| IKsFormatSupport::IsFormatSupported The IsFormatSupported method indicates whether the audio endpoint device supports the specified audio stream format. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Vista [desktop apps only] |
| Minimum supported server | Windows Server 2008 [desktop apps only] |
| Target Platform | Windows |
| Header | devicetopology.h |
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for