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

Commit 7437796e authored by Shuzhen Wang's avatar Shuzhen Wang
Browse files

Camera: Document concurrent capture behavior for stream combination 

Flag: Flag: DOCS_ONLY
Test: m -j ds-docs-java and read docs
Bug: 338137179
Change-Id: I3e18a0a38786c7798b5f5388f99b5792823cf91a
parent fb8ceebd

core/java/android/hardware/camera2/CameraDevice.java

+31 −6
Original line number Diff line number Diff line
@@ -1406,18 +1406,31 @@ public abstract class CameraDevice implements AutoCloseable { 
     * {@link android.hardware.camera2.params.MandatoryStreamCombination} are better suited for this

     * purpose.</p>

     *

     * <p><b>NOTE:</b>

     * For apps targeting {@link android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM} and above,

     * <p>If this function returns {@code true} for a particular stream combination, the camera

     * device supports concurrent captures on all of the streams in the same CaptureRequest, with

     * two exceptions below where concurrent captures are not supported: </p>

     * <ul>

     * <li>Supported stream combinations with exclusive dynamic range profiles as specified by

     * {@link android.hardware.camera2.params.DynamicRangeProfiles#getProfileCaptureRequestConstraints}.</li>

     * <li>Supported combinations of 'default' mode and 'max resolution' mode streams for devices

     * with ULTRA_HIGH_RESOLUTION_SENSOR capability.</li>

     * </ul>

     * <p>For other cases where concurrent captures of a stream combination are not supported,

     * this function returns {@code false}.</p>

     *

     * <p><b>NOTE:</b></p>

     * <ul>

     * <li>For apps targeting {@link android.os.Build.VERSION_CODES#VANILLA_ICE_CREAM} and above,

     * this method will automatically delegate to

     * {@link CameraDeviceSetup#isSessionConfigurationSupported} whenever possible. This

     * means that the output of this method will consider parameters set through

     * {@link SessionConfiguration#setSessionParameters} as well.

     * </p>

     * {@link SessionConfiguration#setSessionParameters} as well.</li>

     *

     * <p>Session Parameters will be ignored for apps targeting <=

     * <li>Session Parameters will be ignored for apps targeting <=

     * {@link android.os.Build.VERSION_CODES#UPSIDE_DOWN_CAKE}, or if

     * {@link CameraManager#isCameraDeviceSetupSupported} returns false for the camera id

     * associated with this {@code CameraDevice}.</p>

     * associated with this {@code CameraDevice}.</li>

     * </ul>

     *

     * @return {@code true} if the given session configuration is supported by the camera device

     *         {@code false} otherwise.
@@ -1691,6 +1704,18 @@ public abstract class CameraDevice implements AutoCloseable { 
         * CameraCharacteristics#INFO_SESSION_CONFIGURATION_QUERY_VERSION} provides the list of

         * feature combinations the camera device will reliably report.</p>

         *

         * <p>If this function returns {@code true} for a particular stream combination, the camera

         * device supports concurrent captures on all of the streams in the same CaptureRequest,

         * with two exceptions below where concurrent captures are not supported: </p>

         * <ul>

         * <li>Supported stream combinations with exclusive dynamic range profiles as specified by

         * {@link android.hardware.camera2.params.DynamicRangeProfiles#getProfileCaptureRequestConstraints}.</li>

         * <li>Supported combinations of 'default' mode and 'max resolution' mode streams for

         * devices with ULTRA_HIGH_RESOLUTION_SENSOR capability.</li>

         * </ul>

         * <p>For other cases where concurrent captures of a stream combination are not supported,

         * this function returns {@code false}.</p>

         *

         * <p><b>IMPORTANT:</b></p>

         * <ul>

         * <li>If feature support can be queried via {@link CameraCharacteristics}, applications