camera_metadata: Deprecate android.quirks.*partial*
Change-Id: I54ccc7a429a8510c6848e05903426a57ea60088f
diff --git a/camera/docs/docs.html b/camera/docs/docs.html
index d1849ec..2cb99e9 100644
--- a/camera/docs/docs.html
+++ b/camera/docs/docs.html
@@ -8625,7 +8625,7 @@
<tr class="entry" id="static_android.quirks.usePartialResult">
- <td class="entry_name" rowspan="3">
+ <td class="entry_name" rowspan="5">
android.<wbr/>quirks.<wbr/>use<wbr/>Partial<wbr/>Result
</td>
<td class="entry_type">
@@ -8646,6 +8646,7 @@
</td>
<td class="entry_range">
+ <p><strong>Deprecated</strong>.<wbr/> Do not use.<wbr/></p>
</td>
<td class="entry_tags">
@@ -8665,6 +8666,15 @@
</td>
</tr>
+ <tr class="entries_header">
+ <th class="th_details" colspan="5">HAL Implementation Details</th>
+ </tr>
+ <tr class="entry_cont">
+ <td class="entry_details" colspan="5">
+ <p>Refer to <code>camera3_<wbr/>capture_<wbr/>result::partial_<wbr/>result</code>
+for information on how to implement partial results.<wbr/></p>
+ </td>
+ </tr>
<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
<!-- end of entry -->
@@ -8698,7 +8708,7 @@
<tr class="entry" id="dynamic_android.quirks.partialResult">
- <td class="entry_name" rowspan="3">
+ <td class="entry_name" rowspan="5">
android.<wbr/>quirks.<wbr/>partial<wbr/>Result
</td>
<td class="entry_type">
@@ -8734,7 +8744,7 @@
</td>
<td class="entry_range">
- <p>Optional.<wbr/> Default value is FINAL.<wbr/></p>
+ <p><strong>Deprecated</strong>.<wbr/> Do not use.<wbr/> Optional.<wbr/> Default value is FINAL.<wbr/></p>
</td>
<td class="entry_tags">
@@ -8758,6 +8768,15 @@
</td>
</tr>
+ <tr class="entries_header">
+ <th class="th_details" colspan="5">HAL Implementation Details</th>
+ </tr>
+ <tr class="entry_cont">
+ <td class="entry_details" colspan="5">
+ <p>Refer to <code>camera3_<wbr/>capture_<wbr/>result::partial_<wbr/>result</code>
+for information on how to implement partial results.<wbr/></p>
+ </td>
+ </tr>
<tr class="entry_spacer"><td class="entry_spacer" colspan="6"></td></tr>
<!-- end of entry -->
diff --git a/camera/docs/metadata_properties.xml b/camera/docs/metadata_properties.xml
index 433bd92..3b78a50 100644
--- a/camera/docs/metadata_properties.xml
+++ b/camera/docs/metadata_properties.xml
@@ -2355,18 +2355,24 @@
camera service.</details>
</entry>
<entry name="usePartialResult" type="byte" visibility="hidden" optional="true">
- <description>If set to 1, the HAL will always split result
+ <description>
+ If set to 1, the HAL will always split result
metadata for a single capture into multiple buffers,
returned using multiple process_capture_result calls.
</description>
- <details>Does not need to be listed in static
+ <range>**Deprecated**. Do not use.</range>
+ <details>
+ Does not need to be listed in static
metadata. Support for partial results will be reworked in
future versions of camera service. This quirk will stop
working at that point; DO NOT USE without careful
consideration of future support.
</details>
+ <hal_details>
+ Refer to `camera3_capture_result::partial_result`
+ for information on how to implement partial results.
+ </hal_details>
</entry>
-
</static>
<dynamic>
<entry name="partialResult" type="byte" visibility="hidden" optional="true" enum="true" typedef="boolean">
@@ -2382,12 +2388,14 @@
FINAL.</notes>
</value>
</enum>
- <description>Whether a result given to the framework is the
+ <description>
+ Whether a result given to the framework is the
final one for the capture, or only a partial that contains a
subset of the full set of dynamic metadata
values.</description>
- <range>Optional. Default value is FINAL.</range>
- <details>The entries in the result metadata buffers for a
+ <range>**Deprecated**. Do not use. Optional. Default value is FINAL.</range>
+ <details>
+ The entries in the result metadata buffers for a
single capture may not overlap, except for this entry. The
FINAL buffers must retain FIFO ordering relative to the
requests that generate them, so the FINAL buffer for frame 3 must
@@ -2397,6 +2405,10 @@
capture must arrive before the FINAL buffer for that capture. This entry may
only be used by the HAL if quirks.usePartialResult is set to 1.
</details>
+ <hal_details>
+ Refer to `camera3_capture_result::partial_result`
+ for information on how to implement partial results.
+ </hal_details>
</entry>
</dynamic>
</section>