FlashControl FlashControl FlashControl FlashControl Class

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

Syntax

Declaration

public sealed class FlashControlpublic sealed class FlashControlPublic NotInheritable Class FlashControl

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 Supported.

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

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

Properties summary

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

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

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

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

Gets or sets the intensity of the flash.

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

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

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

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

Properties

  • AssistantLightEnabled
    AssistantLightEnabled
    AssistantLightEnabled
    AssistantLightEnabled

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

    public bool AssistantLightEnabled { get; set; }public bool AssistantLightEnabled { get; set; }Public ReadWrite Property AssistantLightEnabled As bool

    Property Value

    • bool
      bool
      bool
      bool

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

  • AssistantLightSupported
    AssistantLightSupported
    AssistantLightSupported
    AssistantLightSupported

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

    public bool AssistantLightSupported { get; }public bool AssistantLightSupported { get; }Public ReadOnly Property AssistantLightSupported As bool

    Property Value

    • bool
      bool
      bool
      bool

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

  • Auto
    Auto
    Auto
    Auto

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

    public bool Auto { get; set; }public bool Auto { get; set; }Public ReadWrite Property Auto As bool

    Property Value

    • bool
      bool
      bool
      bool

      true if auto flash is set; otherwise, false.

    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
    Enabled

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

    public bool Enabled { get; set; }public bool Enabled { get; set; }Public ReadWrite Property Enabled As bool

    Property Value

    • bool
      bool
      bool
      bool

      true if the flash is enabled; otherwise, false.

    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
    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

    Property Value

    • float
      float
      float
      float

      The power percent the torch LED is set to.

    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
    PowerSupported

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

    public bool PowerSupported { get; }public bool PowerSupported { get; }Public ReadOnly Property PowerSupported As bool

    Property Value

    • bool
      bool
      bool
      bool

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

    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
    RedEyeReduction

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

    public bool RedEyeReduction { get; set; }public bool RedEyeReduction { get; set; }Public ReadWrite Property RedEyeReduction As bool

    Property Value

    • bool
      bool
      bool
      bool

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

    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
    RedEyeReductionSupported

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

    public bool RedEyeReductionSupported { get; }public bool RedEyeReductionSupported { get; }Public ReadOnly Property RedEyeReductionSupported As bool

    Property Value

    • bool
      bool
      bool
      bool

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

    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
    Supported

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

    public bool Supported { get; }public bool Supported { get; }Public ReadOnly Property Supported As bool

    Property Value

    • bool
      bool
      bool
      bool

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

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.DualApiPartitionAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.ThreadingAttribute

Details

Assembly

Windows.Media.Devices.dll