KSPROPERTY_CAMERACONTROL_EXTENDED_TORCHMODE

Article
02/27/2023

Torch mode determines how a camera's flash is used in low light conditions. A lower intensity light source is continually provided by the flash to allow for sufficient light for operations such as auto-focus.

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 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 torch modes that are supported by the driver.

Torch mode	Description
KSCAMERA_EXTENDEDPROP_VIDEOTORCH_OFF	Torchlight is off.
KSCAMERA_EXTENDEDPROP_VIDEOTORCH_ON	Torchlight is on at the default intensity level.
KSCAMERA_EXTENDEDPROP_VIDEOTORCH_ON_ADJUSTABLEPOWER	Torchlight is on at a specific power level.

The Flags member of KSCAMERA_EXTENDEDPROP_HEADER contains the torch mode currently set for the camera. The default torch mode for a camera is KSCAMERA_EXTENDEDPROP_VIDEOTORCH_OFF and the driver must support this torch mode.

This property control is synchronous 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	Torch mode values supported.
Flags	The current torch mode value setting (only one value).

When the torch mode is KSCAMERA_EXTENDEDPROP_VIDEOTORCH_ON_ADJUSTABLEPOWER, the Value.ull member of KSCAMERA_EXTENDEDPROP_VALUE contains an intensity level value between 0 - 100. An intensity of 0 indicates a minimum level and an intensity of 100 indicates a maximum intensity level.

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

Setting the property

When the property is set, a KSPROPERTY_TYPE_SET request, the Flags member of KSCAMERA_EXTENDEDPROP_HEADER will contain the torch mode to set. The Value.ull member of KSCAMERA_EXTENDEDPROP_VALUE will contain the intensity level to set if Flags is KSCAMERA_EXTENDEDPROP_VIDEOTORCH_ON_ADJUSTABLEPOWER.

Requirements

Version	Available starting with Windows 8.1.
Header	Ksmedia.h (include Ksmedia.h)