From 0c227d47cccc8e9994e5c3a3cbcd3348ee7a675d Mon Sep 17 00:00:00 2001 From: Emilian Peev Date: Fri, 4 May 2018 10:08:03 +0100 Subject: [PATCH] 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 --- .../hardware/camera2/params/SessionConfiguration.java | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/core/java/android/hardware/camera2/params/SessionConfiguration.java b/core/java/android/hardware/camera2/params/SessionConfiguration.java index 7bdb4a2f13397..8a8afb24b3f86 100644 --- a/core/java/android/hardware/camera2/params/SessionConfiguration.java +++ b/core/java/android/hardware/camera2/params/SessionConfiguration.java @@ -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;