Flash​Control Flash​Control Flash​Control Class

Definition

Provides functionality for controlling the flash settings on a capture device.

public : sealed class FlashControl : IFlashControl, IFlashControl2public sealed class FlashControl : IFlashControl, IFlashControl2Public NotInheritable Class FlashControl Implements IFlashControl, IFlashControl2
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The FlashControl enable apps to manage the flash on a device. This can be used in a photo app to handle low-light conditions or for RedEyeReduction.

You can find out if a device supports this control by checking FlashControl.Supported.

You can access the FlashControl for the capture device through MediaCapture.VideoDeviceController.

For how-to guidance for using the FlashControl, see Manual camera controls for photo and video capture.

Properties

AssistantLightEnabled AssistantLightEnabled AssistantLightEnabled

Gets or sets a value indicating whether focus assist light is enabled on the capture device.

public : PlatForm::Boolean AssistantLightEnabled { get; set; }public bool AssistantLightEnabled { get; set; }Public ReadWrite Property AssistantLightEnabled As bool
Value
PlatForm::Boolean bool bool

A value indicating whether focus assist light is enabled on the capture device.

Attributes

AssistantLightSupported AssistantLightSupported AssistantLightSupported

Gets a value indicating whether focus assist light is supported by the capture device.

public : PlatForm::Boolean AssistantLightSupported { get; }public bool AssistantLightSupported { get; }Public ReadOnly Property AssistantLightSupported As bool
Value
PlatForm::Boolean bool bool

A value indicating whether focus assist light is supported by the capture device.

Attributes

Auto Auto Auto

Gets or sets a value that specifies if flash is automatically set.

public : PlatForm::Boolean Auto { get; set; }public bool Auto { get; set; }Public ReadWrite Property Auto As bool
Value
PlatForm::Boolean bool bool

true if auto flash is set; otherwise, false.

Attributes

Remarks

You should check the value of the FlashControl object's Supported property before attempting to access this property. If Supported is false, attempting to access this property will throw an exception.

Enabled Enabled Enabled

Gets a value that specifies if the flash on the capture device is enabled or disabled.

public : PlatForm::Boolean Enabled { get; set; }public bool Enabled { get; set; }Public ReadWrite Property Enabled As bool
Value
PlatForm::Boolean bool bool

true if the flash is enabled; otherwise, false.

Attributes

Remarks

You should check the value of the FlashControl object's Supported property before attempting to access this property. If Supported is false, attempting to access this property will throw an exception.

PowerPercent PowerPercent PowerPercent

Gets or sets the intensity of the flash.

public : float PowerPercent { get; set; }public float PowerPercent { get; set; }Public ReadWrite Property PowerPercent As float
Value
float float float

The power percent the torch LED is set to.

Attributes

Remarks

You should check the value of the FlashControl object's PowerSupported property before attempting to access this property. If PowerSupported is false, attempting to access this property will throw an exception.

PowerSupported PowerSupported PowerSupported

Gets a value that specifics if the device allows the torch LED power settings to be changed.

public : PlatForm::Boolean PowerSupported { get; }public bool PowerSupported { get; }Public ReadOnly Property PowerSupported As bool
Value
PlatForm::Boolean bool bool

true if the device allows the torch LED power settings to be changed; otherwise, false.

Attributes

Remarks

You should check the value of the FlashControl object's Supported property before attempting to access this property. If Supported is false, attempting to access this property will throw an exception.

RedEyeReduction RedEyeReduction RedEyeReduction

Gets a value that specifies if the red eye reduction is enabled or disabled.

public : PlatForm::Boolean RedEyeReduction { get; set; }public bool RedEyeReduction { get; set; }Public ReadWrite Property RedEyeReduction As bool
Value
PlatForm::Boolean bool bool

true if red eye reduction is enabled; otherwise, false.

Attributes

Remarks

You should check the value of the FlashControl object's RedEyeReductionSupported property before attempting to access this property. If RedEyeReductionSupported is false, attempting to access this property will throw an exception.

RedEyeReductionSupported RedEyeReductionSupported RedEyeReductionSupported

Gets a value that specifies if the capture device supports red eye reduction.

public : PlatForm::Boolean RedEyeReductionSupported { get; }public bool RedEyeReductionSupported { get; }Public ReadOnly Property RedEyeReductionSupported As bool
Value
PlatForm::Boolean bool bool

true if the capture device supports red eye reduction; otherwise, false.

Attributes

Remarks

You should check the value of the FlashControl object's Supported property before attempting to access this property. If Supported is false, attempting to access this property will throw an exception.

Supported Supported Supported

Gets a value that specifies if the capture device supports the flash control.

public : PlatForm::Boolean Supported { get; }public bool Supported { get; }Public ReadOnly Property Supported As bool
Value
PlatForm::Boolean bool bool

true if the capture device supports the FlashControl; otherwise, false.

Attributes

See Also