KSPROPERTY_PIN_PROPOSEDATAFORMAT
Clients use the KSPROPERTY_PIN_PROPOSEDATAFORMAT property to determine if pins instantiated by the pin factory support a specific data format.
Usage Summary Table
| Get | Set | Target | Property descriptor type | Property value type |
|---|---|---|---|---|
| Yes | Yes | Filter | KSP_PIN | KSDATAFORMAT |
Remarks
KSPROPERTY_PIN_PROPOSEDATAFORMAT includes a structure of type KSDATAFORMAT, specifying the proposed data format. Specify this property using KSP_PIN, where the member specifies the relevant pin factory.
Using KSPROPERTY_TYPE_GET with this property allows the audio driver to provide information about the default data format on a pin. KSPROPERTY_TYPE_GET is optional to implement for this property unless the driver supports KSEVENT_PINCAPS_FORMATCHANGE.
The KS filter returns STATUS_SUCCESS when using this property with KSPROPERTY_TYPE_SET if pins can be set to or opened with the proposed data format. If the pin cannot be set to the proposed data format, then it returns STATUS_NO_MATCH. For any other failures, an appropriate error is returned. If the driver supports KSPROPERTY_AUDIOSIGNALPROCESSING_MODES, this property should return STATUS_SUCCESS if the format is supported by any of the audio signal processing modes.
Using KSPROPERTY_TYPE_SET with this property does not actually change the data format. Clients use KSPROPERTY_CONNECTION_DATAFORMAT to change the data format. KSPROPERTY_TYPE_SET is optional to implement for this property.
Requirements
Header: ks.h (include Ks.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