Stay organized with collectionsSave and categorize content based on your preferences.
public static final enumConfig.FlashMode
Selects the desired behavior of the camera flash subsystem. By default, the flash mode is set
toOFF. See thedocumentation pagefor
more information on using the device's flash.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eConfig.FlashMode\u003c/code\u003e is an enum that controls the behavior of the camera flash in ARCore.\u003c/p\u003e\n"],["\u003cp\u003eThe default flash mode is OFF.\u003c/p\u003e\n"],["\u003cp\u003eThere are two modes: OFF which disables the flash, and TORCH which enables the flash (if supported by the device).\u003c/p\u003e\n"],["\u003cp\u003eFurther information on using the flash in ARCore is available in the linked documentation.\u003c/p\u003e\n"]]],["`Config.FlashMode` controls the camera flash behavior, defaulting to `OFF`. The document details available modes, including `OFF` (flash disabled) and `TORCH` (flash constantly on). It also outlines inherited methods from `java.lang.Enum`, `java.lang.Object`, `java.lang.constant.Constable`, and `java.lang.Comparable` classes. These methods enable actions like comparing, cloning, describing, and managing object properties, as well as determining the current state of the flash.\n"],null,["# Config.FlashMode\n\n`\npublic static final enum\n`**Config.FlashMode**`\n` \nSelects the desired behavior of the camera flash subsystem. By default, the flash mode is set\nto [OFF](/ar/reference/java/com/google/ar/core/Config.FlashMode#OFF). See the [documentation page](https://developers.google.com/ar/develop/camera/flash/java) for\nmore information on using the device's flash. \n\nInherited Methods\n-----------------\n\nFrom `class\njava.lang.Enum` \n\n|------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` final `[Object](https://developer.android.com/reference/java/lang/Object)` ` | clone`()` |\n| ` final int ` | compareTo`(`[Config.FlashMode](/ar/reference/java/com/google/ar/core/Config.FlashMode)` arg0)` |\n| ` int ` | compareTo`(`[Object](https://developer.android.com/reference/java/lang/Object)` arg0)` |\n| ` final Optional\u003cEnumDesc\u003c`[Config.FlashMode](/ar/reference/java/com/google/ar/core/Config.FlashMode)`\u003e\u003e ` | describeConstable`()` |\n| ` final boolean ` | equals`(`[Object](https://developer.android.com/reference/java/lang/Object)` arg0)` |\n| ` final void ` | finalize`()` |\n| ` final `[Class](https://developer.android.com/reference/java/lang/Class)`\u003c`[Config.FlashMode](/ar/reference/java/com/google/ar/core/Config.FlashMode)`\u003e ` | getDeclaringClass`()` |\n| ` final int ` | hashCode`()` |\n| ` final `[String](https://developer.android.com/reference/java/lang/String)` ` | name`()` |\n| ` final int ` | ordinal`()` |\n| ` `[String](https://developer.android.com/reference/java/lang/String)` ` | toString`()` |\n| ` static \u003cT extends `[Enum](https://developer.android.com/reference/java/lang/Enum)`\u003cT\u003e\u003e T ` | valueOf`(`[Class](https://developer.android.com/reference/java/lang/Class)`\u003cT\u003e arg0, `[String](https://developer.android.com/reference/java/lang/String)` arg1)` |\n\nFrom `class\njava.lang.Object` \n\n|---------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|\n| ` `[Object](https://developer.android.com/reference/java/lang/Object)` ` | clone`()` |\n| ` boolean ` | equals`(`[Object](https://developer.android.com/reference/java/lang/Object)` arg0)` |\n| ` void ` | finalize`()` |\n| ` final `[Class](https://developer.android.com/reference/java/lang/Class)`\u003c?\u003e ` | getClass`()` |\n| ` int ` | hashCode`()` |\n| ` final void ` | notify`()` |\n| ` final void ` | notifyAll`()` |\n| ` `[String](https://developer.android.com/reference/java/lang/String)` ` | toString`()` |\n| ` final void ` | wait`(long arg0, int arg1)` |\n| ` final void ` | wait`(long arg0)` |\n| ` final void ` | wait`()` |\n\nFrom `interface\njava.lang.constant.Constable` \n\n|-----------------------------------------------|-----------------------|\n| ` abstract Optional\u003c? extends ConstantDesc\u003e ` | describeConstable`()` |\n\nFrom `interface\njava.lang.Comparable` \n\n|------------------|------------------------------------------------------------------------------------------------|\n| ` abstract int ` | compareTo`(`[Config.FlashMode](/ar/reference/java/com/google/ar/core/Config.FlashMode)` arg0)` |\n\nEnum Values\n-----------\n\n#### public\nstatic\nfinal\nConfig.FlashMode\nOFF\n\n### OFF\n\n```java\npublic static final Config.FlashMode OFF\n``` \nFlash is off.\n\nThis is the default mode.\n\n#### public\nstatic\nfinal\nConfig.FlashMode\nTORCH\n\n### TORCH\n\n```java\npublic static final Config.FlashMode TORCH\n``` \nFlash is on.\n\nNote, this mode has no effect if the device does not support flash."]]