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

Commit f3537421 authored by Zhijun He's avatar Zhijun He
Browse files

camera2: update java docs for metadata tag spec update 

Below tag spec java docs are updated:
- android.control.mode
- android.control.aeMode
- android.control.afMode
- android.control.awbMode

Bug: 12135317
Change-Id: I83f24c1816dfba1cc042e120fba43c5beb1bd2ae
parent 0b5bf001

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

+8 −9
Original line number Diff line number Diff line
@@ -312,7 +312,7 @@ public abstract class CameraMetadata { 
    public static final int CONTROL_AE_MODE_ON = 1;



    /**

     * <p>if flash exists Autoexposure is active, auto

     * <p>If autoexposure is active and flash exists, auto

     * flash control; flash may be fired when precapture

     * trigger is activated, and for captures for which

     * captureIntent = STILL_CAPTURE</p>
@@ -321,7 +321,7 @@ public abstract class CameraMetadata { 
    public static final int CONTROL_AE_MODE_ON_AUTO_FLASH = 2;



    /**

     * <p>if flash exists Autoexposure is active, auto

     * <p>If autoexposure is active and flash exists, auto

     * flash control for precapture trigger and always flash

     * when captureIntent = STILL_CAPTURE</p>

     * @see CaptureRequest#CONTROL_AE_MODE
@@ -329,7 +329,7 @@ public abstract class CameraMetadata { 
    public static final int CONTROL_AE_MODE_ON_ALWAYS_FLASH = 3;



    /**

     * <p>optional Automatic red eye reduction with flash.

     * <p>Optional. Automatic red eye reduction with flash.

     * If deemed necessary, red eye reduction sequence should

     * fire when precapture trigger is activated, and final

     * flash should fire when captureIntent =
@@ -362,7 +362,7 @@ public abstract class CameraMetadata { 
    //



    /**

     * <p>The 3A routines do not control the lens;

     * <p>The auto-focus routine does not control the lens;

     * android.lens.focusDistance is controlled by the

     * application</p>

     * @see CaptureRequest#CONTROL_AF_MODE
@@ -371,13 +371,12 @@ public abstract class CameraMetadata { 


    /**

     * <p>If lens is not fixed focus.</p>

     * <p>Use android.lens.minimumFocusDistance to determine if lens

     * is fixed focus In this mode, the lens does not move unless

     * <p>Use android.lens.info.minimumFocusDistance to determine if lens

     * is fixed-focus. In this mode, the lens does not move unless

     * the autofocus trigger action is called. When that trigger

     * is activated, AF must transition to ACTIVE_SCAN, then to

     * the outcome of the scan (FOCUSED or

     * NOT_FOCUSED).</p>

     * <p>Triggering cancel AF resets the lens position to default,

     * the outcome of the scan (FOCUSED or NOT_FOCUSED).</p>

     * <p>Triggering AF_CANCEL resets the lens position to default,

     * and sets the AF state to INACTIVE.</p>

     * @see CaptureRequest#CONTROL_AF_MODE

     */

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

+24 −2
Original line number Diff line number Diff line
@@ -395,8 +395,15 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { 
    /**

     * <p>Whether AE is currently updating the sensor

     * exposure and sensitivity fields</p>

     * <p>Only effective if android.control.mode =

     * AUTO</p>

     * <p>Only effective if android.control.mode = AUTO.</p>

     * <p>If auto-exposure is active, HAL auto-focus routine is enabled,

     * then HAL auto-exposure routine overrides the control variables

     * that relate to auto-exposure routine, and these override values

     * are then available in the result metadata for that capture.</p>

     * <p>For example, if auto-exposure is enabled in a request, the HAL should

     * overwrite the exposure, gain, and frame duration fields (and potentially

     * the flash fields, depending on AE mode) of the request.  The overridden

     * values are then provided back to the user in the corresponding result.</p>

     * @see #CONTROL_AE_MODE_OFF

     * @see #CONTROL_AE_MODE_ON

     * @see #CONTROL_AE_MODE_ON_AUTO_FLASH
@@ -455,6 +462,10 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { 
    /**

     * <p>Whether AF is currently enabled, and what

     * mode it is set to</p>

     * <p>Only effective if android.control.mode = AUTO.</p>

     * <p>If lens is controlled by HAL auto-focus algorithm, the HAL should

     * report the current AF status in android.control.afState in

     * result metadata.</p>

     * @see #CONTROL_AF_MODE_OFF

     * @see #CONTROL_AF_MODE_AUTO

     * @see #CONTROL_AF_MODE_MACRO
@@ -517,6 +528,7 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { 
     * transform fields, and what its illumination target

     * is</p>

     * <p>[BC - AWB lock,AWB modes]</p>

     * <p>Only effective if android.control.mode = AUTO.</p>

     * @see #CONTROL_AWB_MODE_OFF

     * @see #CONTROL_AWB_MODE_AUTO

     * @see #CONTROL_AWB_MODE_INCANDESCENT
@@ -586,6 +598,16 @@ public final class CaptureRequest extends CameraMetadata implements Parcelable { 
    /**

     * <p>Overall mode of 3A control

     * routines</p>

     * <p>High-level 3A control. When set to OFF, all 3A control

     * by the HAL is disabled. The application must set the fields for

     * capture parameters itself.</p>

     * <p>When set to AUTO, the individual algorithm controls in

     * android.control.* are in effect, such as android.control.afMode.</p>

     * <p>When set to USE_SCENE_MODE, the individual controls in

     * android.control.* are mostly disabled, and the HAL implements

     * one of the scene mode settings (such as ACTION, SUNSET, or PARTY)

     * as it wishes. The HAL scene mode 3A settings are provided by

     * android.control.sceneModeOverrides.</p>

     * @see #CONTROL_MODE_OFF

     * @see #CONTROL_MODE_AUTO

     * @see #CONTROL_MODE_USE_SCENE_MODE

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

+15 −0
Original line number Diff line number Diff line
@@ -208,6 +208,10 @@ public final class CaptureResult extends CameraMetadata { 
    /**

     * <p>Whether AF is currently enabled, and what

     * mode it is set to</p>

     * <p>Only effective if android.control.mode = AUTO.</p>

     * <p>If lens is controlled by HAL auto-focus algorithm, the HAL should

     * report the current AF status in android.control.afState in

     * result metadata.</p>

     * @see #CONTROL_AF_MODE_OFF

     * @see #CONTROL_AF_MODE_AUTO

     * @see #CONTROL_AF_MODE_MACRO
@@ -272,6 +276,7 @@ public final class CaptureResult extends CameraMetadata { 
     * transform fields, and what its illumination target

     * is</p>

     * <p>[BC - AWB lock,AWB modes]</p>

     * <p>Only effective if android.control.mode = AUTO.</p>

     * @see #CONTROL_AWB_MODE_OFF

     * @see #CONTROL_AWB_MODE_AUTO

     * @see #CONTROL_AWB_MODE_INCANDESCENT
@@ -323,6 +328,16 @@ public final class CaptureResult extends CameraMetadata { 
    /**

     * <p>Overall mode of 3A control

     * routines</p>

     * <p>High-level 3A control. When set to OFF, all 3A control

     * by the HAL is disabled. The application must set the fields for

     * capture parameters itself.</p>

     * <p>When set to AUTO, the individual algorithm controls in

     * android.control.* are in effect, such as android.control.afMode.</p>

     * <p>When set to USE_SCENE_MODE, the individual controls in

     * android.control.* are mostly disabled, and the HAL implements

     * one of the scene mode settings (such as ACTION, SUNSET, or PARTY)

     * as it wishes. The HAL scene mode 3A settings are provided by

     * android.control.sceneModeOverrides.</p>

     * @see #CONTROL_MODE_OFF

     * @see #CONTROL_MODE_AUTO

     * @see #CONTROL_MODE_USE_SCENE_MODE