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

GetSetTargetProperty Descriptor TypeProperty Value Type

Yes

Yes

Filter

KSP_PIN

KSDATAFORMAT

 

Remarks

KSPROPERTY_TYPE_GET is only supported in Windows 7 and later versions of Windows. This function allows the audio driver to provide information about the default data format on a pin. In Windows Vista KSPROPERTY_TYPE_GET is not supported.

Specify this property using KSP_PIN, where the member specifies the relevant pin factory.

KSPROPERTY_PIN_PROPOSEDATAFORMAT includes a structure of type KSDATAFORMAT, specifying the proposed data format.

The KS filter returns STATUS_SUCCESS if pins can be reset to the proposed data format, or an error code otherwise.

Stream minidrivers do not need to handle this property directly; the stream class driver handles this property using stream request blocks to query for more information.

This property does not actually change the data format. Clients use KSPROPERTY_CONNECTION_DATAFORMAT to change the data format.

Requirements

Header

Ks.h (include Ks.h)

See also

KSP_PIN
KSDATAFORMAT

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft. All rights reserved.