KSPROPERTY_CAMERACONTROL_EXTENDED_EXPOSUREMODE

Article
02/27/2023

The exposure control property specifies the whether auto processing occurs for exposure or a manual time value is used instead.

Usage Summary Table

Get	Set	Target	Property descriptor type	Property value type
Yes	Yes	Filter	KSPROPERTY	KSCAMERA_EXTENDEDPROP_HEADER

The property value (operation data) contains a KSCAMERA_EXTENDEDPROP_HEADER structure and a KSCAMERA_EXTENDEDPROP_VIDEOPROCSETTING structure.

The total property data size is sizeof(KSCAMERA_EXTENDEDPROP_HEADER) + sizeof(KSCAMERA_EXTENDEDPROP_VIDEOPROCSETTING). The Size member of KSCAMERA_EXTENDEDPROP_HEADER is set to this total property data size.

The Capability member of KSCAMERA_EXTENDEDPROP_HEADER contains a bitwise OR combination of one or more of the following video processing options.

Processing mode	Description
KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_AUTO	Camera driver uses its own processing logic for video.
KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_MANUAL	Camera driver uses a preset processing method.
KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_LOCK	The current video processing method is locked.

The Flags member of KSCAMERA_EXTENDEDPROP_HEADER contains the video processing flag currently set for the camera. The KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_AUTO setting may be combined with KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_LOCK.

This property control is asynchronous and cancelable.

Remarks

Processing modes

KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_AUTO

This indicates that auto processing is supported. The driver will use its internal logic to optimize the video processing. For a KSPROPERTY_TYPE_GET request, the VideoProc member of KSCAMERA_EXTENDEDPROP_VIDEOPROCSETTING must contain the current driver determined value for the video processing.

This flag may be combined with KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_LOCK as a bitwise OR value.

Locking, without combining Auto mode, an already locked control should be treated as a no-op by the camera driver. Locking, in combination with Auto mode, an already locked control should trigger a new convergence.

This flag must not be combined with KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_MANUAL.

KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_MANUAL

Manual indicates that for this video processing, the specific values are provided. Specific values are provided to the driver.

This flag must not be combined with KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_AUTO or KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_LOCK.

KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_LOCK

The lock option flag indicates that the current video processing is locked to whatever value is currently programmed. For example, an application may request auto mode until a specific exposure is determined. At that point the application will decide to take a sequence of photos all with the same exposure. In such a case, the application may specify the KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_LOCK flag.

This flag must not be combined with KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_MANUAL.

Getting the property

When responding to a KSPROPERTY_TYPE_GET request, the driver sets the members of the KSCAMERA_EXTENDEDPROP_HEADER to the following.

Member	Value
Version	1
PinId	KSCAMERA_EXTENDEDPROP_FILTERSCOPE (0xFFFFFFFF)
Size	sizeof(KSCAMERA_EXTENDEDPROP_HEADER) + sizeof(KSCAMERA_EXTENDEDPROP_VIDEOPROCSETTING)
Result	0
Capability	KSCAMERA_EXTENDEDPROP_CAPS_ASYNCCONTROL bitwise OR with (Video processing mode supported)
Flags	The current video processing mode

If no exposure mode was previously set, then the driver sets Flags to KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_AUTO (default). The members of the KSCAMERA_EXTENDEDPROP_VIDEOPROCSETTING structure that follows KSCAMERA_EXTENDEDPROP_HEADER are set according to the requirements of the processing mode.

The VideoProp.Value.ull value must contain the current exposure setting when the mode is KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_AUTO.

Setting the property

When the property is set, a KSPROPERTY_TYPE_SET request, the Flags member of KSCAMERA_EXTENDEDPROP_HEADER will contain the exposure mode to set. The VideoProc.Value member of KSCAMERA_EXTENDEDPROP_VIDEOPROCSETTING must be ignored when Flags contains the KSCAMERA_EXTENDEDPROP_VIDEOPROCFLAG_AUTO mode flag.

Requirements

Version: Available starting with Windows 8.1

Header: ksmedia.h (include Ksmedia.h)