Camera: Clarify targetFpsRange interaction with minFrameDuration am: d2dbdcbff9
Original change: https://googleplex-android-review.googlesource.com/c/platform/system/media/+/24865475
Change-Id: I487fa4a9091e97b8ba32d815cfa8bfae59c571be
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
diff --git a/camera/docs/docs.html b/camera/docs/docs.html
index 6e0e9a7..ca2c4a2 100644
--- a/camera/docs/docs.html
+++ b/camera/docs/docs.html
@@ -3021,6 +3021,12 @@
<p>Only constrains auto-exposure (AE) algorithm,<wbr/> not
manual control of <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a> and
<a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>.<wbr/></p>
+<p>Note that the actual achievable max framerate also depends on the minimum frame
+duration of the output streams.<wbr/> The max frame rate will be
+<code>min(aeTargetFpsRange.<wbr/>maxFps,<wbr/> 1 /<wbr/> max(individual stream min durations)</code>.<wbr/> For example,<wbr/>
+if the application sets this key to <code>{60,<wbr/> 60}</code>,<wbr/> but the maximum minFrameDuration among
+all configured streams is 33ms,<wbr/> the maximum framerate won't be 60fps,<wbr/> but will be
+30fps.<wbr/></p>
<p>To start a CaptureSession with a target FPS range different from the
capture request template's default value,<wbr/> the application
is strongly recommended to call
@@ -8297,6 +8303,12 @@
<p>Only constrains auto-exposure (AE) algorithm,<wbr/> not
manual control of <a href="#controls_android.sensor.exposureTime">android.<wbr/>sensor.<wbr/>exposure<wbr/>Time</a> and
<a href="#controls_android.sensor.frameDuration">android.<wbr/>sensor.<wbr/>frame<wbr/>Duration</a>.<wbr/></p>
+<p>Note that the actual achievable max framerate also depends on the minimum frame
+duration of the output streams.<wbr/> The max frame rate will be
+<code>min(aeTargetFpsRange.<wbr/>maxFps,<wbr/> 1 /<wbr/> max(individual stream min durations)</code>.<wbr/> For example,<wbr/>
+if the application sets this key to <code>{60,<wbr/> 60}</code>,<wbr/> but the maximum minFrameDuration among
+all configured streams is 33ms,<wbr/> the maximum framerate won't be 60fps,<wbr/> but will be
+30fps.<wbr/></p>
<p>To start a CaptureSession with a target FPS range different from the
capture request template's default value,<wbr/> the application
is strongly recommended to call
diff --git a/camera/docs/metadata_definitions.xml b/camera/docs/metadata_definitions.xml
index c401dc0..533c1d2 100644
--- a/camera/docs/metadata_definitions.xml
+++ b/camera/docs/metadata_definitions.xml
@@ -827,6 +827,13 @@
manual control of android.sensor.exposureTime and
android.sensor.frameDuration.
+ Note that the actual achievable max framerate also depends on the minimum frame
+ duration of the output streams. The max frame rate will be
+ `min(aeTargetFpsRange.maxFps, 1 / max(individual stream min durations)`. For example,
+ if the application sets this key to `{60, 60}`, but the maximum minFrameDuration among
+ all configured streams is 33ms, the maximum framerate won't be 60fps, but will be
+ 30fps.
+
To start a CaptureSession with a target FPS range different from the
capture request template's default value, the application
is strongly recommended to call
