KSPROPERTY_CAMERACONTROL_EXTENDED_SCENEMODE (driver defined mode)

The scene mode property selects a driver defined mode which represents a collection of preset controls. The driver determines the presets assigned to a scene mode and enables those control settings when a scene is selected.

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_VALUE structure. The KSCAMERA_EXTENDEDPROP_VALUE is required but the Value member is ignored.

The total property data size is sizeof(KSCAMERA_EXTENDEDPROP_HEADER) + sizeof(KSCAMERA_EXTENDEDPROP_VALUE). 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 scene modes that are supported by the driver.

Scene mode Description
KSCAMERA_EXTENDEDPROP_SCENEMODE_AUTO Automatic scent mode. Controls are at their auto settings.
KSCAMERA_EXTENDEDPROP_SCENEMODE_MACRO Macro scene mode (driver defined).
KSCAMERA_EXTENDEDPROP_SCENEMODE_PORTRAIT Portrait scene mode (driver defined).
KSCAMERA_EXTENDEDPROP_SCENEMODE_SPORT Sport scene mode (driver defined).
KSCAMERA_EXTENDEDPROP_SCENEMODE_SNOW Snow scene mode (driver defined).
KSCAMERA_EXTENDEDPROP_SCENEMODE_NIGHT Night scene mode (driver defined).
KSCAMERA_EXTENDEDPROP_SCENEMODE_BEACH Beach scene mode (driver defined).
KSCAMERA_EXTENDEDPROP_SCENEMODE_SUNSET Sunset scene mode (driver defined).
KSCAMERA_EXTENDEDPROP_SCENEMODE_CANDLELIGHT Candlelight scene mode (driver defined).
KSCAMERA_EXTENDEDPROP_SCENEMODE_LANDSCAPE Landscape scene mode (driver defined).
KSCAMERA_EXTENDEDPROP_SCENEMODE_NIGHTPORTRAIT Night portrait scene mode (driver defined).
KSCAMERA_EXTENDEDPROP_SCENEMODE_BACKLIT Backlit scene mode (driver defined).
KSCAMERA_EXTENDEDPROP_SCENEMODE_MANUAL Controls are manually changed and no pre-defined scene modes are set.

The Flags member of KSCAMERA_EXTENDEDPROP_HEADER contains the scene mode currently set for the camera. The default scene mode for a camera is always KSCAMERA_EXTENDEDPROP_SCENEMODE_AUTO.

This property control is asynchronous and not cancelable.

Remarks

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_VALUE)
Result 0
Capability KSCAMERA_EXTENDEDPROP_CAPS_ASYNCCONTROL | (scene mode values supported)
Flags The current scene mode value setting (only one value)

If no scene mode was previously set, then Flags is set to KSCAMERA_EXTENDEDPROP_SCENEMODE_AUTO (default).

Setting the property

When the property is set, a KSPROPERTY_TYPE_SET request, the Flags member of KSCAMERA_EXTENDEDPROP_HEADER will contain the scene mode to enable.

Requirements

Version: Available starting with Windows 8.1

Header: Ksmedia.h (include Ksmedia.h)

See also

KSCAMERA_EXTENDEDPROP_HEADER

KSCAMERA_EXTENDEDPROP_VALUE