Merge pull request #186 from android/camera2-readme

Add README for Camera2 samples.
android · Jul 25, 2024 · 0479d2e · 0479d2e
2 parents cbf500d + 9894f5d
commit 0479d2e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/samples/camera/camera2/README.md b/samples/camera/camera2/README.md
@@ -2,7 +2,14 @@
 
 This is a catalog of camera2-specific APIs to demonstrate the usage and capabilities of the API.
 
-> 🚧 **Work-in-Progress:** we are working on brining more existing and new samples for camera2
+- [Camera Preview]():
+  Demonstrates displaying processed pixel data directly from the camera sensor to the screen using Camera2.
+- [Image Capture]():
+  Demonstrates how to capture an image using Camera2 and encode it into a JPEG container.
+- [UltraHDR Image Capture]():
+  Demonstrates how to capture a 10-bit compressed still image and store it using the new UltraHDR image format using Camera2.
+
+> 🚧 **Work-in-Progress:** we are working on brining more existing and new samples for camera2, and soon, CameraX as well
 
 Check out our guides at https://developer.android.com/training/camera2
 

diff --git a/...era/camera2/src/main/java/com/example/platform/camera/imagecapture/Camera2ImageCapture.kt b/...era/camera2/src/main/java/com/example/platform/camera/imagecapture/Camera2ImageCapture.kt
@@ -56,7 +56,7 @@ import kotlin.coroutines.suspendCoroutine
 
 @Sample(
     name = "Image Capture",
-    description = "This sample demonstrates how to capture and image using Camera2 and encode it " +
+    description = "This sample demonstrates how to capture an image using Camera2 and encode it " +
             "into a JPEG container.",
     documentation = "https://developer.android.com/training/camera2/capture-sessions-requests",
     tags = ["Camera2"]