IKsJackDescription2 interface (devicetopology.h)
The IKsJackDescription2 interface provides information about the jacks or internal connectors that provide a physical connection between a device on an audio adapter and an external or internal endpoint device (for example, a microphone or CD player).
In addition to getting jack information such as type of connection, the IKsJackDescription is primarily used to report whether the jack was connected to the device. In Windows 7, if the connected device driver supports IKsJackDescription2, the audio stack or an application can use this interface to get information additional jack information. This includes the jack's detection capability and if the format of the device has changed dynamically.
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 IKsJackDescription2 interface provides convenient access to the KSPROPERTY_JACK_DESCRIPTION2 property of a connector to an endpoint device. For more information about KS properties and KS pins, see the Windows DDK documentation.
An application obtains a reference to the IKsJackDescription2 interface of a part by calling the IPart::Activate method with parameter refiid set to REFIIDIID_IKsJackDescription2. The call to IPart::Activate succeeds only if the part supports the IKsJackDescription2 interface. Only a part object that represents a bridge pin connector on a KS filter device topology object supports this interface.
For a code example, see IKsJackDescription.
Inheritance
The IKsJackDescription2 interface inherits from the IUnknown interface. IKsJackDescription2 also has these types of members:
Methods
The IKsJackDescription2 interface has these methods.
| IKsJackDescription2::GetJackCount The GetJackCount method gets the number of jacks on the connector, which are required to connect to an endpoint device. |
| IKsJackDescription2::GetJackDescription2 The GetJackDescription2 method gets the description of a specified audio jack. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 7 [desktop apps only] |
| Minimum supported server | Windows Server 2008 R2 [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