Edit

Share via

KSPROPERTY_CAMERACONTROL_EXTENDED_FOCUSPRIORITY

  • Article

The KSPROPERTY_CAMERACONTROL_EXTENDED_FOCUSPRIORITY property ID defined in the KSPROPERTY_CAMERACONTROL_EXTENDED_PROPERTY enumeration is used to configure the focus priority. When focus priority is set, focusing will take priority over the picture taken to ensure that the picture taken is always in focus. Otherwise, the picture will be taken immediately regardless of whether the picture is in focus . The behavior in handling a failed focus and whether timeout is required is internal to the driver and up to the OEM.

Usage summary table

Scope Control Type

Version 1

Filter

Synchronous

To configure the focus priority, the KSPROPERTY_CAMERACONTROL_EXTENDED_FOCUSPRIORITY property ID must be used. When focus priority is set, focusing will take priority over picture taken to ensure that the picture taken is always in focus. If focus priority is not set, the picture will be taken immediately regardless of whether the picture was in focus. The behavior in handling a failed focus failed and timeouts are determined by the OEM and is internal to the driver.

For the KSCAMERA_EXTENDEDPROP_HEADER, the following flags are defined as values. In a get call, the camera driver returns its current focus priority configuration using one of these flags. In a set call, the camera driver sets the new focus priority configuration using one of these flags.

#define KSCAMERA_EXTENDEDPROP_FOCUSPRIORITY_OFF     0x0000000000000000
#define KSCAMERA_EXTENDEDPROP_FOCUSPRIORITY_ON      0x0000000000000001

Note   This is a synchronous control and there are no capabilities defined for this control.

The table below contains the descriptions and requirements for the KSCAMERA_EXTENDEDPROP_HEADER structure fields when using the focus priority control.

Member Description

Version

This must be 1,

PinId

This must be KSCAMERA_EXTENDEDPROP_FILTERSCOPE (0xFFFFFFFF),

Size

This must be sizeof(KSCAMERA_EXTENDEDPROP_HEADER)+sizeof(KSCAMERA_EXTENDEDPROP_VALUE),

Result

This indicates the error results,

Capability

This must be 0,

Flags

This is a read/write field. This can be any one of the KSCAMERA_EXTENDEDPROP_FOCUSPRIORITY_Xxx flags defined above.

Requirements

Header

 Ksmedia.h