Merge "camera2: Fix broken doc links for flash strength apis" into main (328a9f17) · Commits · e / os / android_frameworks_base

core/java/android/hardware/camera2/CameraCharacteristics.java

+11 −5

Original line number	Diff line number	Diff line
		@@ -1492,10 +1492,12 @@ public final class CameraCharacteristics extends CameraMetadata<CameraCharacteri
		/**
		* <p>Default flash brightness level for manual flash control in SINGLE mode.</p>
		* <p>If flash unit is available this will be greater than or equal to 1 and less
		* or equal to <code>android.flash.info.singleStrengthMaxLevel</code>.
		* or equal to {@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL android.flash.singleStrengthMaxLevel}.
		* Note for devices that do not support the manual flash strength control
		* feature, this level will always be equal to 1.</p>
		* <p>This key is available on all devices.</p>
		*
		* @see CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL
		*/
		@PublicKey
		@NonNull
		@@ -1511,13 +1513,15 @@ public final class CameraCharacteristics extends CameraMetadata<CameraCharacteri
		* otherwise the value will be equal to 1.</p>
		* <p>Note that this level is just a number of supported levels(the granularity of control).
		* There is no actual physical power units tied to this level.
		* There is no relation between android.flash.info.torchStrengthMaxLevel and
		* android.flash.info.singleStrengthMaxLevel i.e. the ratio of
		* android.flash.info.torchStrengthMaxLevel:android.flash.info.singleStrengthMaxLevel
		* There is no relation between {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel} and
		* {@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL android.flash.singleStrengthMaxLevel} i.e. the ratio of
		* {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel}:{@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL android.flash.singleStrengthMaxLevel}
		* is not guaranteed to be the ratio of actual brightness.</p>
		* <p>This key is available on all devices.</p>
		*
		* @see CaptureRequest#FLASH_MODE
		* @see CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL
		* @see CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL
		*/
		@PublicKey
		@NonNull
		@@ -1528,10 +1532,12 @@ public final class CameraCharacteristics extends CameraMetadata<CameraCharacteri
		/**
		* <p>Default flash brightness level for manual flash control in TORCH mode</p>
		* <p>If flash unit is available this will be greater than or equal to 1 and less
		* or equal to android.flash.info.torchStrengthMaxLevel.
		* or equal to {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel}.
		* Note for the devices that do not support the manual flash strength control feature,
		* this level will always be equal to 1.</p>
		* <p>This key is available on all devices.</p>
		*
		* @see CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL
		*/
		@PublicKey
		@NonNull

core/java/android/hardware/camera2/CaptureRequest.java

+15 −11

Original line number	Diff line number	Diff line
		@@ -2684,35 +2684,39 @@ public final class CaptureRequest extends CameraMetadata<CaptureRequest.Key<?>>
		* <p>Flash strength level to be used when manual flash control is active.</p>
		* <p>Flash strength level to use in capture mode i.e. when the applications control
		* flash with either SINGLE or TORCH mode.</p>
		* <p>Use android.flash.info.singleStrengthMaxLevel and
		* android.flash.info.torchStrengthMaxLevel to check whether the device supports
		* <p>Use {@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL android.flash.singleStrengthMaxLevel} and
		* {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel} to check whether the device supports
		* flash strength control or not.
		* If the values of android.flash.info.singleStrengthMaxLevel and
		* android.flash.info.torchStrengthMaxLevel are greater than 1,
		* {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel} are greater than 1,
		* then the device supports manual flash strength control.</p>
		* <p>If the {@link CaptureRequest#FLASH_MODE android.flash.mode} <code>==</code> TORCH the value must be >= 1
		* and <= android.flash.info.torchStrengthMaxLevel.
		* and <= {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel}.
		* If the application doesn't set the key and
		* android.flash.info.torchStrengthMaxLevel > 1,
		* {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel} > 1,
		* then the flash will be fired at the default level set by HAL in
		* android.flash.info.torchStrengthDefaultLevel.
		* {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_DEFAULT_LEVEL android.flash.torchStrengthDefaultLevel}.
		* If the {@link CaptureRequest#FLASH_MODE android.flash.mode} <code>==</code> SINGLE, then the value must be >= 1
		* and <= android.flash.info.singleStrengthMaxLevel.
		* and <= {@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL android.flash.singleStrengthMaxLevel}.
		* If the application does not set this key and
		* android.flash.info.singleStrengthMaxLevel > 1,
		* {@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL android.flash.singleStrengthMaxLevel} > 1,
		* then the flash will be fired at the default level set by HAL
		* in android.flash.info.singleStrengthDefaultLevel.
		* in {@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_DEFAULT_LEVEL android.flash.singleStrengthDefaultLevel}.
		* If {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is set to any of ON_AUTO_FLASH, ON_ALWAYS_FLASH,
		* ON_AUTO_FLASH_REDEYE, ON_EXTERNAL_FLASH values, then the strengthLevel will be ignored.</p>
		* <p><b>Range of valid values:</b><br>
		* <code>[1-android.flash.info.torchStrengthMaxLevel]</code> when the {@link CaptureRequest#FLASH_MODE android.flash.mode} is
		* <code>[1-{@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel}]</code> when the {@link CaptureRequest#FLASH_MODE android.flash.mode} is
		* set to TORCH;
		* <code>[1-android.flash.info.singleStrengthMaxLevel]</code> when the {@link CaptureRequest#FLASH_MODE android.flash.mode} is
		* <code>[1-{@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL android.flash.singleStrengthMaxLevel}]</code> when the {@link CaptureRequest#FLASH_MODE android.flash.mode} is
		* set to SINGLE</p>
		* <p>This key is available on all devices.</p>
		*
		* @see CaptureRequest#CONTROL_AE_MODE
		* @see CaptureRequest#FLASH_MODE
		* @see CameraCharacteristics#FLASH_SINGLE_STRENGTH_DEFAULT_LEVEL
		* @see CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL
		* @see CameraCharacteristics#FLASH_TORCH_STRENGTH_DEFAULT_LEVEL
		* @see CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL
		*/
		@PublicKey
		@NonNull

core/java/android/hardware/camera2/CaptureResult.java

+15 −11

Original line number	Diff line number	Diff line
		@@ -2977,35 +2977,39 @@ public class CaptureResult extends CameraMetadata<CaptureResult.Key<?>> {
		* <p>Flash strength level to be used when manual flash control is active.</p>
		* <p>Flash strength level to use in capture mode i.e. when the applications control
		* flash with either SINGLE or TORCH mode.</p>
		* <p>Use android.flash.info.singleStrengthMaxLevel and
		* android.flash.info.torchStrengthMaxLevel to check whether the device supports
		* <p>Use {@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL android.flash.singleStrengthMaxLevel} and
		* {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel} to check whether the device supports
		* flash strength control or not.
		* If the values of android.flash.info.singleStrengthMaxLevel and
		* android.flash.info.torchStrengthMaxLevel are greater than 1,
		* {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel} are greater than 1,
		* then the device supports manual flash strength control.</p>
		* <p>If the {@link CaptureRequest#FLASH_MODE android.flash.mode} <code>==</code> TORCH the value must be >= 1
		* and <= android.flash.info.torchStrengthMaxLevel.
		* and <= {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel}.
		* If the application doesn't set the key and
		* android.flash.info.torchStrengthMaxLevel > 1,
		* {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel} > 1,
		* then the flash will be fired at the default level set by HAL in
		* android.flash.info.torchStrengthDefaultLevel.
		* {@link CameraCharacteristics#FLASH_TORCH_STRENGTH_DEFAULT_LEVEL android.flash.torchStrengthDefaultLevel}.
		* If the {@link CaptureRequest#FLASH_MODE android.flash.mode} <code>==</code> SINGLE, then the value must be >= 1
		* and <= android.flash.info.singleStrengthMaxLevel.
		* and <= {@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL android.flash.singleStrengthMaxLevel}.
		* If the application does not set this key and
		* android.flash.info.singleStrengthMaxLevel > 1,
		* {@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL android.flash.singleStrengthMaxLevel} > 1,
		* then the flash will be fired at the default level set by HAL
		* in android.flash.info.singleStrengthDefaultLevel.
		* in {@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_DEFAULT_LEVEL android.flash.singleStrengthDefaultLevel}.
		* If {@link CaptureRequest#CONTROL_AE_MODE android.control.aeMode} is set to any of ON_AUTO_FLASH, ON_ALWAYS_FLASH,
		* ON_AUTO_FLASH_REDEYE, ON_EXTERNAL_FLASH values, then the strengthLevel will be ignored.</p>
		* <p><b>Range of valid values:</b><br>
		* <code>[1-android.flash.info.torchStrengthMaxLevel]</code> when the {@link CaptureRequest#FLASH_MODE android.flash.mode} is
		* <code>[1-{@link CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL android.flash.torchStrengthMaxLevel}]</code> when the {@link CaptureRequest#FLASH_MODE android.flash.mode} is
		* set to TORCH;
		* <code>[1-android.flash.info.singleStrengthMaxLevel]</code> when the {@link CaptureRequest#FLASH_MODE android.flash.mode} is
		* <code>[1-{@link CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL android.flash.singleStrengthMaxLevel}]</code> when the {@link CaptureRequest#FLASH_MODE android.flash.mode} is
		* set to SINGLE</p>
		* <p>This key is available on all devices.</p>
		*
		* @see CaptureRequest#CONTROL_AE_MODE
		* @see CaptureRequest#FLASH_MODE
		* @see CameraCharacteristics#FLASH_SINGLE_STRENGTH_DEFAULT_LEVEL
		* @see CameraCharacteristics#FLASH_SINGLE_STRENGTH_MAX_LEVEL
		* @see CameraCharacteristics#FLASH_TORCH_STRENGTH_DEFAULT_LEVEL
		* @see CameraCharacteristics#FLASH_TORCH_STRENGTH_MAX_LEVEL
		*/
		@PublicKey
		@NonNull