summaryrefslogtreecommitdiff
path: root/core/java
diff options
context:
space:
mode:
authorRucha Katakwar <ruchamk@google.com>2021-10-21 06:01:37 +0000
committerRucha Katakwar <ruchamk@google.com>2021-11-02 18:48:30 +0000
commit3a01f25f01d8e36708830fa7d9a7cfefd635fd9c (patch)
treeaaf3165ce57b567c27bc5f920f6a3a0c3ca91930 /core/java
parentb19ab8a952c5eb1ef7caa1f15660caf70bec80b7 (diff)
Camera: Update torch strength control keys details.
1. Add a note that default level should be > 0. 2. Update value of the key for devices with no flash unit. bug: 203629711 Change-Id: Ib154470a0e1a94685078bd0bcb342adde1d38192
Diffstat (limited to 'core/java')
-rw-r--r--core/java/android/hardware/camera2/CameraCharacteristics.java9
1 files changed, 5 insertions, 4 deletions
diff --git a/core/java/android/hardware/camera2/CameraCharacteristics.java b/core/java/android/hardware/camera2/CameraCharacteristics.java
index afea4e5f35e3..96a18dcac92a 100644
--- a/core/java/android/hardware/camera2/CameraCharacteristics.java
+++ b/core/java/android/hardware/camera2/CameraCharacteristics.java
@@ -1325,7 +1325,7 @@ public final class CameraCharacteristics extends CameraMetadata<CameraCharacteri
* flashlight brightness level via
* {android.hardware.camera2.CameraManager#setTorchStrengthLevel}.
* If this value is equal to 1, flashlight brightness control is not supported.
- * This value will be -1 if the flash unit is not available.</p>
+ * The value for this key will be null for devices with no flash unit.</p>
* <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p>
*/
@PublicKey
@@ -1337,14 +1337,15 @@ public final class CameraCharacteristics extends CameraMetadata<CameraCharacteri
* <p>Default flashlight brightness level to be set via
* {android.hardware.camera2.CameraManager#setTorchStrengthLevel}.</p>
* <p>If flash unit is available this will be greater than or equal to 1 and less
- * or equal to <code>{@link CameraCharacteristics#FLASH_INFO_STRENGTH_MAXIMUM_LEVEL android.flash.info.strengthMaximumLevel}</code>.
- * If flash unit is not available this will be set to -1.</p>
+ * or equal to <code>{@link CameraCharacteristics#FLASH_INFO_STRENGTH_MAXIMUM_LEVEL android.flash.info.strengthMaximumLevel}</code>.</p>
* <p>Setting flashlight brightness above the default level
* (i.e.<code>{@link CameraCharacteristics#FLASH_INFO_STRENGTH_DEFAULT_LEVEL android.flash.info.strengthDefaultLevel}</code>) may make the device more
* likely to reach thermal throttling conditions and slow down, or drain the
* battery quicker than normal. To minimize such issues, it is recommended to
* start the flashlight at this default brightness until a user explicitly requests
- * a brighter level.</p>
+ * a brighter level.
+ * Note that the value for this key will be null for devices with no flash unit.
+ * The default level should always be &gt; 0.</p>
* <p><b>Optional</b> - The value for this key may be {@code null} on some devices.</p>
*
* @see CameraCharacteristics#FLASH_INFO_STRENGTH_DEFAULT_LEVEL