@capgo/camera-preview 7.4.0-beta.1 → 7.4.0-beta.3

package/README.md

@@ -92,6 +92,52 @@ Then run
 npx cap sync
 ```
 
+## Optional Configuration
+
+To use certain features of this plugin, you will need to add the following permissions/keys to your native project configurations.
+
+### Android
+
+In your `android/app/src/main/AndroidManifest.xml`:
+
+- **Audio Recording** (`disableAudio: false`):
+  ```xml
+  <uses-permission android:name="android.permission.RECORD_AUDIO" />
+  ```
+
+- **Saving to Gallery** (`saveToGallery: true`):
+  ```xml
+  <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+  ```
+
+- **Location in EXIF Data** (`withExifLocation: true`):
+  ```xml
+  <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+  <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+  ```
+
+### iOS
+
+In your `ios/App/App/Info.plist`, you must provide descriptions for the permissions your app requires. The keys are added automatically, but you need to provide the `string` values.
+
+- **Audio Recording** (`disableAudio: false`):
+  ```xml
+  <key>NSMicrophoneUsageDescription</key>
+  <string>To record audio with videos</string>
+  ```
+
+- **Saving to Gallery** (`saveToGallery: true`):
+  ```xml
+  <key>NSPhotoLibraryAddUsageDescription</key>
+  <string>To save photos to your gallery</string>
+  ```
+
+- **Location in EXIF Data** (`withExifLocation: true`):
+  ```xml
+  <key>NSLocationWhenInUseUsageDescription</key>
+  <string>To add location data to your photos</string>
+  ```
+
 ## Extra Android installation steps
 
 **Important** `camera-preview` 3+ requires Gradle 7.
@@ -233,7 +279,7 @@ Stops the camera preview.
 ### capture(...)
 
 ```typescript
-capture(options: CameraPreviewPictureOptions) => Promise<{ value: string; }>
+capture(options: CameraPreviewPictureOptions) => Promise<{ value: string; exif: ExifData; }>
 ```
 
 Captures a picture from the camera.
@@ -242,7 +288,7 @@ Captures a picture from the camera.
 | ------------- | ----------------------------------------------------------------------------------- | ---------------------------------------- |
 | **`options`** | <code><a href="#camerapreviewpictureoptions">CameraPreviewPictureOptions</a></code> | - The options for capturing the picture. |
 
-**Returns:** <code>Promise&lt;{ value: string; }&gt;</code>
+**Returns:** <code>Promise&lt;{ value: string; exif: <a href="#exifdata">ExifData</a>; }&gt;</code>
 
 **Since:** 0.0.1
 
@@ -538,7 +584,7 @@ Defines the configuration options for starting the camera preview.
 | **`storeToFile`**                  | <code>boolean</code> | If true, saves the captured image to a file and returns the file path. If false, returns a base64 encoded string. | <code>false</code>  |
 | **`disableExifHeaderStripping`**   | <code>boolean</code> | If true, prevents the plugin from rotating the image based on EXIF data.                                          | <code>false</code>  |
 | **`enableHighResolution`**         | <code>boolean</code> | If true, enables high-resolution image capture.                                                                   | <code>false</code>  |
-| **`disableAudio`**                 | <code>boolean</code> | If true, disables the audio stream, preventing audio permission requests.                                         | <code>false</code>  |
+| **`disableAudio`**                 | <code>boolean</code> | If true, disables the audio stream, preventing audio permission requests.                                         | <code>true</code>   |
 | **`lockAndroidOrientation`**       | <code>boolean</code> | If true, locks the device orientation while the camera is active.                                                 | <code>false</code>  |
 | **`enableOpacity`**                | <code>boolean</code> | If true, allows the camera preview's opacity to be changed.                                                       | <code>false</code>  |
 | **`enableZoom`**                   | <code>boolean</code> | If true, enables pinch-to-zoom functionality on the preview.                                                      | <code>false</code>  |
@@ -546,16 +592,23 @@ Defines the configuration options for starting the camera preview.
 | **`deviceId`**                     | <code>string</code>  | The `deviceId` of the camera to use. If provided, `position` is ignored.                                          |                     |
 
 
+#### ExifData
+
+Represents EXIF data extracted from an image.
+
+
 #### CameraPreviewPictureOptions
 
 Defines the options for capturing a picture.
 
-| Prop          | Type                                                    | Description                                                                               | Default             |
-| ------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------- |
-| **`height`**  | <code>number</code>                                     | The desired height of the picture in pixels. If not provided, the device default is used. |                     |
-| **`width`**   | <code>number</code>                                     | The desired width of the picture in pixels. If not provided, the device default is used.  |                     |
-| **`quality`** | <code>number</code>                                     | The quality of the captured image, from 0 to 100. Does not apply to `png` format.         | <code>85</code>     |
-| **`format`**  | <code><a href="#pictureformat">PictureFormat</a></code> | The format of the captured image.                                                         | <code>"jpeg"</code> |
+| Prop                   | Type                                                    | Description                                                                                                                                | Default             | Since |
+| ---------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ------------------- | ----- |
+| **`height`**           | <code>number</code>                                     | The desired height of the picture in pixels. If not provided, the device default is used.                                                  |                     |       |
+| **`width`**            | <code>number</code>                                     | The desired width of the picture in pixels. If not provided, the device default is used.                                                   |                     |       |
+| **`quality`**          | <code>number</code>                                     | The quality of the captured image, from 0 to 100. Does not apply to `png` format.                                                          | <code>85</code>     |       |
+| **`format`**           | <code><a href="#pictureformat">PictureFormat</a></code> | The format of the captured image.                                                                                                          | <code>"jpeg"</code> |       |
+| **`saveToGallery`**    | <code>boolean</code>                                    | If true, the captured image will be saved to the user's gallery.                                                                           | <code>false</code>  | 7.5.0 |
+| **`withExifLocation`** | <code>boolean</code>                                    | If true, the plugin will attempt to add GPS location data to the image's EXIF metadata. This may prompt the user for location permissions. | <code>false</code>  | 7.6.0 |
 
 
 #### CameraSampleOptions

package/android/build.gradle

@@ -49,7 +49,8 @@ dependencies {
     implementation project(':capacitor-android')
     implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
     implementation 'androidx.exifinterface:exifinterface:1.4.1'
-    
+    implementation 'com.google.android.gms:play-services-location:21.3.0'
+
     // CameraX dependencies
     def camerax_version = "1.5.0-beta01"
     implementation "androidx.camera:camera-core:${camerax_version}"

package/android/src/main/AndroidManifest.xml

@@ -1,5 +1,7 @@
 
-  <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-      >
+  <manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-permission android:name="android.permission.CAMERA" />
+    <uses-feature android:name="android.hardware.camera" />
+    <uses-feature android:name="android.hardware.camera.autofocus" />
   </manifest>
   

package/android/src/main/java/com/ahm/capacitor/camera/preview/CameraPreview.java

@@ -3,15 +3,12 @@ package com.ahm.capacitor.camera.preview;
 import static android.Manifest.permission.CAMERA;
 import static android.Manifest.permission.RECORD_AUDIO;
 
+import android.Manifest;
 import android.content.pm.ActivityInfo;
-import android.graphics.Point;
 import android.util.DisplayMetrics;
 import android.util.TypedValue;
-import android.view.Display;
-import androidx.annotation.NonNull;
 import com.getcapacitor.JSArray;
 import com.getcapacitor.JSObject;
-import com.getcapacitor.Logger;
 import com.getcapacitor.PermissionState;
 import com.getcapacitor.Plugin;
 import com.getcapacitor.PluginCall;
@@ -27,6 +24,11 @@ import java.util.Objects;
 import android.util.Size;
 import android.util.Log;
 import com.ahm.capacitor.camera.preview.model.LensInfo;
+import com.google.android.gms.location.FusedLocationProviderClient;
+import com.google.android.gms.location.LocationServices;
+import org.json.JSONObject;
+import android.location.Location;
+import com.getcapacitor.Logger;
 
 @CapacitorPlugin(
   name = "CameraPreview",
@@ -39,6 +41,10 @@ import com.ahm.capacitor.camera.preview.model.LensInfo;
       strings = { CAMERA },
       alias = CameraPreview.CAMERA_ONLY_PERMISSION_ALIAS
     ),
+    @Permission(
+      strings = { Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION },
+      alias = CameraPreview.CAMERA_WITH_LOCATION_PERMISSION_ALIAS
+    )
   }
 )
 public class CameraPreview
@@ -47,12 +53,15 @@ public class CameraPreview
 
   static final String CAMERA_WITH_AUDIO_PERMISSION_ALIAS = "cameraWithAudio";
   static final String CAMERA_ONLY_PERMISSION_ALIAS = "cameraOnly";
+  static final String CAMERA_WITH_LOCATION_PERMISSION_ALIAS = "cameraWithLocation";
 
   private String captureCallbackId = "";
   private String snapshotCallbackId = "";
   private String cameraStartCallbackId = "";
   private int previousOrientationRequest = ActivityInfo.SCREEN_ORIENTATION_UNSPECIFIED;
   private CameraXView cameraXView;
+  private FusedLocationProviderClient fusedLocationClient;
+  private Location lastLocation;
 
   @PluginMethod
   public void start(PluginCall call) {
@@ -83,15 +92,62 @@ public class CameraPreview
   }
 
   @PluginMethod
-  public void capture(PluginCall call) {
+  public void capture(final PluginCall call) {
     if (cameraXView == null || !cameraXView.isRunning()) {
       call.reject("Camera is not running");
       return;
     }
+
+    final boolean withExifLocation = call.getBoolean("withExifLocation", false);
+
+    if (withExifLocation) {
+      if (getPermissionState(CAMERA_WITH_LOCATION_PERMISSION_ALIAS) != PermissionState.GRANTED) {
+        requestPermissionForAlias(CAMERA_WITH_LOCATION_PERMISSION_ALIAS, call, "captureWithLocationPermission");
+      } else {
+        getLocationAndCapture(call);
+      }
+    } else {
+      captureWithoutLocation(call);
+    }
+  }
+
+  @PermissionCallback
+  private void captureWithLocationPermission(PluginCall call) {
+    if (getPermissionState(CAMERA_WITH_LOCATION_PERMISSION_ALIAS) == PermissionState.GRANTED) {
+      getLocationAndCapture(call);
+    } else {
+      Logger.warn("Location permission denied. Capturing photo without location data.");
+      captureWithoutLocation(call);
+    }
+  }
+
+  private void getLocationAndCapture(PluginCall call) {
+      if (fusedLocationClient == null) {
+        fusedLocationClient = LocationServices.getFusedLocationProviderClient(getContext());
+      }
+        fusedLocationClient.getLastLocation().addOnSuccessListener(getActivity(), location -> {
+        lastLocation = location;
+        proceedWithCapture(call, lastLocation);
+      }).addOnFailureListener(e -> {
+        Logger.error("Failed to get location: " + e.getMessage());
+        proceedWithCapture(call, null);
+      });
+  }
+
+  private void captureWithoutLocation(PluginCall call) {
+    proceedWithCapture(call, null);
+  }
+
+  private void proceedWithCapture(PluginCall call, Location location) {
     bridge.saveCall(call);
     captureCallbackId = call.getCallbackId();
+
     Integer quality = Objects.requireNonNull(call.getInt("quality", 85));
-    cameraXView.capturePhoto(quality);
+    final boolean saveToGallery = call.getBoolean("saveToGallery", false);
+    Integer width = call.getInt("width");
+    Integer height = call.getInt("height");
+    
+    cameraXView.capturePhoto(quality, saveToGallery, width, height, location);
   }
 
   @PluginMethod
@@ -326,13 +382,13 @@ public class CameraPreview
     final int width = call.getInt("width", 0);
     final int height = call.getInt("height", 0);
     final int paddingBottom = call.getInt("paddingBottom", 0);
-    final boolean toBack = call.getBoolean("toBack", true);
-    final boolean storeToFile = call.getBoolean("storeToFile", false);
-    final boolean enableOpacity = call.getBoolean("enableOpacity", false);
-    final boolean enableZoom = call.getBoolean("enableZoom", false);
-    final boolean disableExifHeaderStripping = call.getBoolean("disableExifHeaderStripping", false);
-    final boolean lockOrientation = call.getBoolean("lockAndroidOrientation", false);
-    final boolean disableAudio = call.getBoolean("disableAudio", true);
+    final boolean toBack = Boolean.TRUE.equals(call.getBoolean("toBack", true));
+    final boolean storeToFile = Boolean.TRUE.equals(call.getBoolean("storeToFile", false));
+    final boolean enableOpacity = Boolean.TRUE.equals(call.getBoolean("enableOpacity", false));
+    final boolean enableZoom = Boolean.TRUE.equals(call.getBoolean("enableZoom", false));
+    final boolean disableExifHeaderStripping = Boolean.TRUE.equals(call.getBoolean("disableExifHeaderStripping", false));
+    final boolean lockOrientation = Boolean.TRUE.equals(call.getBoolean("lockAndroidOrientation", false));
+    final boolean disableAudio = Boolean.TRUE.equals(call.getBoolean("disableAudio", true));
     
     float targetZoom = 1.0f;
     // Check if the selected device is a physical ultra-wide
@@ -367,8 +423,8 @@ public class CameraPreview
         }
         int computedX = (int) TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, x, metrics);
         int computedY = (int) TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, y, metrics);
-        int computedWidth = width != 0 ? (int) TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, width, metrics) : (int) getBridge().getWebView().getWidth();
-        int computedHeight = height != 0 ? (int) TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, height, metrics) : (int) getBridge().getWebView().getHeight();
+        int computedWidth = width != 0 ? (int) TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, width, metrics) : getBridge().getWebView().getWidth();
+        int computedHeight = height != 0 ? (int) TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, height, metrics) : getBridge().getWebView().getHeight();
         computedHeight -= (int) TypedValue.applyDimension(TypedValue.COMPLEX_UNIT_DIP, paddingBottom, metrics);
 
         CameraSessionConfiguration config = new CameraSessionConfiguration(finalDeviceId, position, computedX, computedY, computedWidth, computedHeight, paddingBottom, toBack, storeToFile, enableOpacity, enableZoom, disableExifHeaderStripping, disableAudio, 1.0f);
@@ -382,15 +438,28 @@ public class CameraPreview
   }
 
   @Override
-  public void onPictureTaken(String result) {
-    JSObject jsObject = new JSObject();
-    jsObject.put("value", result);
-    bridge.getSavedCall(captureCallbackId).resolve(jsObject);
+  public void onPictureTaken(String base64, JSONObject exif) {
+    PluginCall pluginCall = bridge.getSavedCall(captureCallbackId);
+    if (pluginCall == null) {
+      Log.e("CameraPreview", "onPictureTaken: captureCallbackId is null");
+      return;
+    }
+    JSObject result = new JSObject();
+    result.put("value", base64);
+    result.put("exif", exif);
+    pluginCall.resolve(result);
+    bridge.releaseCall(pluginCall);
   }
 
   @Override
   public void onPictureTakenError(String message) {
-    bridge.getSavedCall(captureCallbackId).reject(message);
+    PluginCall pluginCall = bridge.getSavedCall(captureCallbackId);
+    if (pluginCall == null) {
+      Log.e("CameraPreview", "onPictureTakenError: captureCallbackId is null");
+      return;
+    }
+    pluginCall.reject(message);
+    bridge.releaseCall(pluginCall);
   }
 
   @Override
@@ -422,4 +491,5 @@ public class CameraPreview
       bridge.releaseCall(pluginCall);
     }
   }
+
 }