am bc4b6859: Merge "Camera2: Many docs updates" into lmp-preview-dev

 *

 * <p>Creating a session is an expensive operation and can take several hundred milliseconds, since

 * it requires configuring the camera device's internal pipelines and allocating memory buffers for

 * sending images to the desired targets. While

 * {@link CameraDevice#createCaptureSession createCaptureSession} will provide a

 * CameraCaptureSession object immediately, configuration won't be complete until the

 * {@link CameraCaptureSession.StateListener#onConfigured onConfigured} callback is called for the

 * first time. If configuration cannot be completed, then the

 * sending images to the desired targets. Therefore the setup is done asynchronously, and

 * {@link CameraDevice#createCaptureSession createCaptureSession} will send the ready-to-use

 * CameraCaptureSession to the provided listener's

 * {@link CameraCaptureSession.StateListener#onConfigured onConfigured} callback. If configuration

 * cannot be completed, then the

 * {@link CameraCaptureSession.StateListener#onConfigureFailed onConfigureFailed} is called, and the

 * session will not become active.</p>

 *

 *<!--

 * <p>Any capture requests (repeating or non-repeating) submitted before the session is ready will

 * be queued up and will begin capture once the session becomes ready. In case the session cannot be

 * configured and {@link StateListener#onConfigureFailed onConfigureFailed} is called, all queued

 * capture requests are discarded.</p>

 *

 *-->

 * <p>If a new session is created by the camera device, then the previous session is closed, and its

 * associated {@link StateListener#onClosed onClosed} callback will be invoked.  All

 * of the session methods will throw an IllegalStateException if called once the session is

     * capture request will be processed before any further repeating

     * requests are processed.<p>

     *

     * <p>Repeating requests are a simple way for an application to maintain a

     * preview or other continuous stream of frames, without having to submit

     * requests through {@link #capture} at video rates.</p>

     *

     * <p>To stop the repeating capture, call {@link #stopRepeating}. Calling

     * {@link #abortCaptures} will also clear the request.</p>

     *

     *

     * @see #setRepeatingRequest

     * @see #setRepeatingBurst

     * @see #configureOutputs

     * @see CameraDevice#createCaptureSession

     */

    public abstract void abortCaptures() throws CameraAccessException;

    /**

     * <p>List of frame rate ranges supported by the

     * AE algorithm/hardware</p>

     * auto-exposure (AE) algorithm/hardware</p>

     */

    public static final Key<android.util.Range<Integer>[]> CONTROL_AE_AVAILABLE_TARGET_FPS_RANGES =

            new Key<android.util.Range<Integer>[]>("android.control.aeAvailableTargetFpsRanges", new TypeReference<android.util.Range<Integer>[]>() {{ }});

            new Key<Rational>("android.control.aeCompensationStep", Rational.class);

    /**

     * <p>List of AF modes that can be

     * <p>List of auto-focus (AF) modes that can be

     * selected with {@link CaptureRequest#CONTROL_AF_MODE android.control.afMode}.</p>

     * <p>Not all the auto-focus modes may be supported by a

     * given camera device. This entry lists the valid modes for

            new Key<int[]>("android.hotPixel.availableHotPixelModes", int[].class);

    /**

     * <p>Supported resolutions for the JPEG thumbnail</p>

     * <p>Supported resolutions for the JPEG thumbnail.</p>

     * <p>Below condiditions will be satisfied for this size list:</p>

     * <ul>

     * <li>The sizes will be sorted by increasing pixel area (width x height).

     * may be delivered to the application layer from the camera device as

     * soon as they are available.</p>

     * <p>A value of 1 means that partial results are not supported.</p>

     * <p>A typical use case for this might be: after requesting an AF lock the

     * new AF state might be available 50% of the way through the pipeline.

     * The camera device could then immediately dispatch this state via a

     * partial result to the framework/application layer, and the rest of

     * the metadata via later partial results.</p>

     * <p>A typical use case for this might be: after requesting an

     * auto-focus (AF) lock the new AF state might be available 50%

     * of the way through the pipeline.  The camera device could

     * then immediately dispatch this state via a partial result to

     * the framework/application layer, and the rest of the

     * metadata via later partial results.</p>

     */

    public static final Key<Integer> REQUEST_PARTIAL_RESULT_COUNT =

            new Key<Integer>("android.request.partialResultCount", int.class);

            new Key<android.graphics.Rect>("android.sensor.info.activeArraySize", android.graphics.Rect.class);

    /**

     * <p>Range of valid sensitivities</p>

     * <p>Range of valid sensitivities.</p>

     * <p>The minimum and maximum valid values for the

     * {@link CaptureRequest#SENSOR_SENSITIVITY android.sensor.sensitivity} control.</p>

     * <p>The values are the standard ISO sensitivity values,

     * as defined in ISO 12232:2006.</p>

     *

     * @see CaptureRequest#SENSOR_SENSITIVITY

     */

    public static final Key<android.util.Range<Integer>> SENSOR_INFO_SENSITIVITY_RANGE =

            new Key<android.util.Range<Integer>>("android.sensor.info.sensitivityRange", new TypeReference<android.util.Range<Integer>>() {{ }});

    /**

     * <p>The physical dimensions of the full pixel

     * array</p>

     * <p>Needed for FOV calculation for old API</p>

     * array.</p>

     * <p>This is the physical size of the sensor pixel

     * array defined by {@link CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE android.sensor.info.pixelArraySize}.</p>

     *

     * @see CameraCharacteristics#SENSOR_INFO_PIXEL_ARRAY_SIZE

     */

    public static final Key<android.util.SizeF> SENSOR_INFO_PHYSICAL_SIZE =

            new Key<android.util.SizeF>("android.sensor.info.physicalSize", android.util.SizeF.class);

    /**

     * <p>Dimensions of full pixel array, possibly

     * including black calibration pixels.</p>

     * <p>Maximum output resolution for raw format must

     * match this in

     * android.scaler.availableStreamConfigurations.</p>

     * <p>The pixel count of the full pixel array,

     * which covers {@link CameraCharacteristics#SENSOR_INFO_PHYSICAL_SIZE android.sensor.info.physicalSize} area.</p>

     * <p>If a camera device supports raw sensor formats, either this

     * or {@link CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE android.sensor.info.activeArraySize} is the maximum output

     * raw size listed in {@link CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP android.scaler.streamConfigurationMap}.

     * If a size corresponding to pixelArraySize is listed, the resulting

     * raw sensor image will include black pixels.</p>

     *

     * @see CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP

     * @see CameraCharacteristics#SENSOR_INFO_ACTIVE_ARRAY_SIZE

     * @see CameraCharacteristics#SENSOR_INFO_PHYSICAL_SIZE

     */

    public static final Key<android.util.Size> SENSOR_INFO_PIXEL_ARRAY_SIZE =

            new Key<android.util.Size>("android.sensor.info.pixelArraySize", android.util.Size.class);

            new Key<Integer>("android.sensor.orientation", int.class);

    /**

     * <p>Optional. Defaults to [OFF]. Lists the supported test

     * pattern modes for {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode}.</p>

     * <p>Lists the supported sensor test pattern modes for {@link CaptureRequest#SENSOR_TEST_PATTERN_MODE android.sensor.testPatternMode}.</p>

     * <p>Optional. Defaults to [OFF].</p>

     * <p><b>Optional</b> - This value may be {@code null} on some devices.</p>

     *

     * @see CaptureRequest#SENSOR_TEST_PATTERN_MODE

    /**

     * <p>Which face detection modes are available,

     * if any</p>

     * if any.</p>

     * <p>OFF means face detection is disabled, it must

     * be included in the list.</p>

     * <p>SIMPLE means the device supports the