Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a94d2c26 authored by Emilian Peev's avatar Emilian Peev
Browse files

Camera: Update LowLightBoost Documentation 

Low light boost state capture result is expected
to be always present.

Test: Successful build
Bug: 346182281
Change-Id: Iab7d7f05a9263f1cf094532d6cb5bbd070f021d9
parent af52873b

core/java/android/hardware/camera2/CameraMetadata.java

+2 −5
Original line number Diff line number Diff line
@@ -2360,11 +2360,8 @@ public abstract class CameraMetadata<TKey> { 
     * <p>If the session configuration is not supported, the AE mode reported in the

     * CaptureResult will be 'ON' instead of 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY'.</p>

     * <p>When this AE mode is enabled, the CaptureResult field

     * {@link CaptureResult#CONTROL_LOW_LIGHT_BOOST_STATE android.control.lowLightBoostState} will be present and not null. Otherwise, the

     * {@link CaptureResult#CONTROL_LOW_LIGHT_BOOST_STATE android.control.lowLightBoostState} field will not be present in the CaptureResult.</p>

     * <p>The application can observe the CaptureResult field

     * {@link CaptureResult#CONTROL_LOW_LIGHT_BOOST_STATE android.control.lowLightBoostState} to determine when low light boost is 'ACTIVE' or

     * 'INACTIVE'.</p>

     * {@link CaptureResult#CONTROL_LOW_LIGHT_BOOST_STATE android.control.lowLightBoostState} will indicate when low light boost is 'ACTIVE'

     * or 'INACTIVE'. By default {@link CaptureResult#CONTROL_LOW_LIGHT_BOOST_STATE android.control.lowLightBoostState} will be 'INACTIVE'.</p>

     * <p>The low light boost is 'ACTIVE' once the scene lighting condition is less than the

     * upper bound lux value defined by {@link CameraCharacteristics#CONTROL_LOW_LIGHT_BOOST_INFO_LUMINANCE_RANGE android.control.lowLightBoostInfoLuminanceRange}.

     * This mode will be 'INACTIVE' once the scene lighting condition is greater than the

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

+1 −2
Original line number Diff line number Diff line
@@ -2819,12 +2819,11 @@ public class CaptureResult extends CameraMetadata<CaptureResult.Key<?>> { 
     * <p>When low light boost is enabled by setting the AE mode to

     * 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY', it can dynamically apply a low light

     * boost when the light level threshold is exceeded.</p>

     * <p>This field is present in the CaptureResult when the AE mode is set to

     * 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY'. Otherwise, the field is not present.</p>

     * <p>This state indicates when low light boost is 'ACTIVE' and applied. Similarly, it can

     * indicate when it is not being applied by returning 'INACTIVE'.</p>

     * <p>This key will be absent from the CaptureResult if AE mode is not set to

     * 'ON_LOW_LIGHT_BOOST_BRIGHTNESS_PRIORITY.</p>

     * <p>The default value will always be 'INACTIVE'.</p>

     * <p><b>Possible values:</b></p>

     * <ul>

     *   <li>{@link #CONTROL_LOW_LIGHT_BOOST_STATE_INACTIVE INACTIVE}</li>