Android.Hardware.Camera2.CaptureResult.FlashMode Property

Syntax

[Android.Runtime.Register("FLASH_MODE")]
public static CaptureResult.Key FlashMode { get; }

See Also

CaptureRequest.ControlAeMode
CaptureRequest.ControlAePrecaptureTrigger
CameraCharacteristics.FlashInfoAvailable
CaptureResult.FlashState

Value

Documentation for this section has not yet been entered.

Remarks

The desired mode for for the camera device's flash control.

This control is only effective when flash unit is available (CameraCharacteristics.FlashInfoAvailable == true).

When this control is used, the CaptureRequest.ControlAeMode must be set to ON or OFF. Otherwise, the camera device auto-exposure related flash control (ON_AUTO_FLASH, ON_ALWAYS_FLASH, or ON_AUTO_FLASH_REDEYE) will override this control.

When set to OFF, the camera device will not fire flash for this capture.

When set to SINGLE, the camera device will fire flash regardless of the camera device's auto-exposure routine's result. When used in still capture case, this control should be used along with auto-exposure (AE) precapture metering sequence (CaptureRequest.ControlAePrecaptureTrigger), otherwise, the image may be incorrectly exposed.

When set to TORCH, the flash will be on continuously. This mode can be used for use cases such as preview, auto-focus assist, still capture, or video recording.

The flash status will be reported by CaptureResult.FlashState in the capture result metadata.

Possible values:

This key is available on all devices.

[Android Documentation]

Requirements

Namespace: Android.Hardware.Camera2
Assembly: Mono.Android (in Mono.Android.dll)
Assembly Versions: 0.0.0.0