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

Commit 0c227d47 authored by Emilian Peev's avatar Emilian Peev
Browse files

Camera: Specify session parameter build requirements 

Session parameters are subset of the supported capture
request parameters. They are passed as part of the capture
session intitialization and only require the initial session
parameter values. Update the documentation and make clear that
additional outputs, tags etc. should not be passed when building
the session parameter capture request object.

Bug: 79225608
Test: Documentation builds
Change-Id: Id2651ea1d8dc8e3ebd9ebfca84eca2bb67694bf4
parent dc617e0f

core/java/android/hardware/camera2/params/SessionConfiguration.java

+7 −1
Original line number Diff line number Diff line
@@ -181,7 +181,13 @@ public final class SessionConfiguration { 
     * to pass their initial values as part of this method.

     *

     * @param params A capture request that includes the initial values for any available

     *               session wide capture keys.

     *               session wide capture keys. Tags (see {@link CaptureRequest.Builder#setTag}) and

     *               output targets (see {@link CaptureRequest.Builder#addTarget}) are ignored if

     *               set. Parameter values not part of

     *               {@link CameraCharacteristics#getAvailableSessionKeys} will also be ignored. It

     *               is recommended to build the session parameters using the same template type as

     *               the initial capture request, so that the session and initial request parameters

     *               match as much as possible.

     */

    public void setSessionParameters(CaptureRequest params) {

        mSessionParameters = params;