KSPROPERTY_PIN_PROPOSEDATAFORMAT2

KSPROPERTY_PIN_PROPOSEDATAFORMAT2

The OS uses the KSPROPERTY_PIN_PROPOSEDATAFORMAT2 property to determine if pins instantiated by the pin factory support specific data formats.

Usage Summary Table

GetSetTargetProperty Descriptor TypeProperty Value Type

Yes

No

Filter

See remarks

KSMULTIPLE_ITEM

 

Remarks

The property descriptor is a KSP_PIN followed by a KSMULTIPLE_ITEM specifying a count of variable size attributes that follow the KSMULTIPLE_ITEM. Each attribute starts with a KSATTRIBUTE header followed by data specific to the attribute. The attributes act as parameters for the property request, specifying the proposed data formats.

KSPROPERTY_PIN_PROPOSEDATAFORMAT2 includes a structure of type KSMULTIPLE_ITEM,

Although the attributes provide a highly extensible mechanism to parameterize the property request, Windows defines only a single attribute passed with the property request- the audio signal processing mode. The attribute ID is KSATTRIBUTEID_AUDIOSIGNALPROCESSING_MODE and is specified using the KSATTRIBUTE_AUDIOSIGNALPROCESSING_MODE structure. Note that the KSATTRIBUTE_AUDIOSIGNALPROCESSING_MODE structure starts with a KSATTRIBUTE member.

KSPROPERTY_TYPE_GET is only supported if the pin has proposed formats. This function allows the audio driver to provide information about the default data format on a pin given the specified attributes.

The KS filter returns STATUS_SUCCESS, when the OS accepts the information about the pins instantiated by the pin factory supporting specific data formats, or an error code otherwise.

Requirements

Version

Available starting with Windows 8.1.

See also

KSP_PIN
KSDATAFORMAT

 

 

Send comments about this topic to Microsoft

Show:
© 2016 Microsoft