KSPROPERTY_TUNER_SCAN_STATUS

The KSPROPERTY_TUNER_SCAN_STATUS property describes the status of a scanning operation. This property can be implemented optionally.

Usage Summary Table

GetSetTargetProperty descriptor typeProperty value type

Yes

No

Pin

KSPROPERTY_TUNER_SCAN_STATUS_S

KSPROPERTY_TUNER_SCAN_STATUS_S

 

The property value (operation data) is a KSPROPERTY_TUNER_SCAN_STATUS_S structure that specifies the status of a scanning operation.

Remarks

The KsTvTune.ax module can call the driver's KSPROPERTY_TUNER_SCAN_STATUS property at any time. However, KsTvTune.ax typically calls KSPROPERTY_TUNER_SCAN_STATUS after it calls the KSEVENT_TUNER_INITIATE_SCAN event to set up a scan operation and to set up notification for when the scan completes. KsTvTune.ax then waits for the scan-completion notification to occur. As the worst case scenario, KsTvTune.ax waits for the amount of time that is specified in the SettlingTime member of the TUNER_ANALOG_CAPS_S structure. The driver should have returned a populated TUNER_ANALOG_CAPS_S from a call to its KSPROPERTY_TUNER_NETWORKTYPE_SCAN_CAPS property with the ANALOG_TV_NETWORK_TYPE value set in the NetworkType member of the KSPROPERTY_TUNER_NETWORKTYPE_SCAN_CAPS_S structure. However, the tuner should typically determine the status of the signal quicker than the amount of time that is specified in SettlingTime and should then notify KsTvTune.ax that the scan completed by signaling the event.

The driver returns scan status only if the tuning device supports hardware-assisted scanning. The driver indicates such support by setting the fSupportsHardwareAssistedScanning member of the KSPROPERTY_TUNER_SCAN_CAPS_S structure to TRUE in a call to its KSPROPERTY_TUNER_SCAN_CAPS property. The driver should signal an event and return one of the following lock types in the LockStatus member of the KSPROPERTY_TUNER_SCAN_STATUS_S structure:

  • Tuner_LockType_None if the tuning device could not find any signal at all.

  • Tuner_LockType_Locked if the tuning device locked onto the exact frequency.

Requirements

Version

Available in Windows Vista and later versions of the operating system.

Header

Ksmedia.h (include Ksmedia.h)

See also

KSEVENT_TUNER_INITIATE_SCAN
KSPROPERTY_TUNER_NETWORKTYPE_SCAN_CAPS
KSPROPERTY_TUNER_NETWORKTYPE_SCAN_CAPS_S
KSPROPERTY_TUNER_SCAN_CAPS
KSPROPERTY_TUNER_SCAN_CAPS_S
KSPROPERTY_TUNER_SCAN_STATUS_S
TUNER_ANALOG_CAPS_S

 

 

Send comments about this topic to Microsoft

Show: