@capgo/camera-preview 7.4.0-alpha.13 → 7.4.0-alpha.18

package/README.md

@@ -262,6 +262,10 @@ Documentation for the [uploader](https://github.com/Cap-go/capacitor-uploader)
 * [`setPreviewSize(...)`](#setpreviewsize)
 * [`setFocus(...)`](#setfocus)
 * [`addListener('screenResize', ...)`](#addlistenerscreenresize-)
+* [`addListener('orientationChange', ...)`](#addlistenerorientationchange-)
+* [`deleteFile(...)`](#deletefile)
+* [`getSafeAreaInsets()`](#getsafeareainsets)
+* [`getOrientation()`](#getorientation)
 * [Interfaces](#interfaces)
 * [Type Aliases](#type-aliases)
 * [Enums](#enums)
@@ -372,7 +376,7 @@ Set the aspect ratio of the camera preview.
 
 **Returns:** <code>Promise&lt;{ width: number; height: number; x: number; y: number; }&gt;</code>
 
-**Since:** 7.4.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -387,7 +391,7 @@ Gets the current aspect ratio of the camera preview.
 
 **Returns:** <code>Promise&lt;{ aspectRatio: '4:3' | '16:9'; }&gt;</code>
 
-**Since:** 7.4.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -544,7 +548,7 @@ Checks if the camera preview is currently running.
 
 **Returns:** <code>Promise&lt;{ isRunning: boolean; }&gt;</code>
 
-**Since:** 7.4.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -559,7 +563,7 @@ Gets all available camera devices.
 
 **Returns:** <code>Promise&lt;{ devices: CameraDevice[]; }&gt;</code>
 
-**Since:** 7.4.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -574,7 +578,7 @@ Gets the current zoom state, including min/max and current lens info.
 
 **Returns:** <code>Promise&lt;{ min: number; max: number; current: number; lens: <a href="#lensinfo">LensInfo</a>; }&gt;</code>
 
-**Since:** 7.4.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -591,6 +595,8 @@ Returns zoom button values for quick switching.
 
 **Returns:** <code>Promise&lt;{ values: number[]; }&gt;</code>
 
+**Since:** 7.5.0
+
 --------------------
 
 
@@ -606,7 +612,7 @@ Sets the zoom level of the camera.
 | ------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
 | **`options`** | <code>{ level: number; ramp?: boolean; autoFocus?: boolean; }</code> | - The desired zoom level. `ramp` is currently unused. `autoFocus` defaults to true. |
 
-**Since:** 7.4.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -621,7 +627,7 @@ Gets the current flash mode.
 
 **Returns:** <code>Promise&lt;{ flashMode: <a href="#camerapreviewflashmode">CameraPreviewFlashMode</a>; }&gt;</code>
 
-**Since:** 7.4.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -634,7 +640,7 @@ removeAllListeners() => Promise<void>
 
 Removes all registered listeners.
 
-**Since:** 7.4.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -651,7 +657,7 @@ Switches the active camera to the one with the specified `deviceId`.
 | ------------- | ---------------------------------- | ------------------------------------ |
 | **`options`** | <code>{ deviceId: string; }</code> | - The ID of the device to switch to. |
 
-**Since:** 7.4.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -666,7 +672,7 @@ Gets the ID of the currently active camera device.
 
 **Returns:** <code>Promise&lt;{ deviceId: string; }&gt;</code>
 
-**Since:** 7.4.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -681,6 +687,8 @@ Gets the current preview size and position.
 
 **Returns:** <code>Promise&lt;{ x: number; y: number; width: number; height: number; }&gt;</code>
 
+**Since:** 7.5.0
+
 --------------------
 
 
@@ -698,6 +706,8 @@ Sets the preview size and position.
 
 **Returns:** <code>Promise&lt;{ width: number; height: number; x: number; y: number; }&gt;</code>
 
+**Since:** 7.5.0
+
 --------------------
 
 
@@ -713,7 +723,7 @@ Sets the camera focus to a specific point in the preview.
 | ------------- | -------------------------------------- | -------------------- |
 | **`options`** | <code>{ x: number; y: number; }</code> | - The focus options. |
 
-**Since:** 8.1.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -724,13 +734,87 @@ Sets the camera focus to a specific point in the preview.
 addListener(eventName: "screenResize", listenerFunc: (data: { width: number; height: number; x: number; y: number; }) => void) => Promise<PluginListenerHandle>
 ```
 
-| Param              | Type                                                                                     |
-| ------------------ | ---------------------------------------------------------------------------------------- |
-| **`eventName`**    | <code>'screenResize'</code>                                                              |
-| **`listenerFunc`** | <code>(data: { width: number; height: number; x: number; y: number; }) =&gt; void</code> |
+Adds a listener for screen resize events.
+
+| Param              | Type                                                                                     | Description                                         |
+| ------------------ | ---------------------------------------------------------------------------------------- | --------------------------------------------------- |
+| **`eventName`**    | <code>'screenResize'</code>                                                              | - The event name to listen for.                     |
+| **`listenerFunc`** | <code>(data: { width: number; height: number; x: number; y: number; }) =&gt; void</code> | - The function to call when the event is triggered. |
 
 **Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
 
+**Since:** 7.5.0
+
+--------------------
+
+
+### addListener('orientationChange', ...)
+
+```typescript
+addListener(eventName: "orientationChange", listenerFunc: (data: { orientation: DeviceOrientation; }) => void) => Promise<PluginListenerHandle>
+```
+
+Adds a listener for orientation change events.
+
+| Param              | Type                                                                                                 | Description                                         |
+| ------------------ | ---------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
+| **`eventName`**    | <code>'orientationChange'</code>                                                                     | - The event name to listen for.                     |
+| **`listenerFunc`** | <code>(data: { orientation: <a href="#deviceorientation">DeviceOrientation</a>; }) =&gt; void</code> | - The function to call when the event is triggered. |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+**Since:** 7.5.0
+
+--------------------
+
+
+### deleteFile(...)
+
+```typescript
+deleteFile(options: { path: string; }) => Promise<{ success: boolean; }>
+```
+
+Deletes a file at the given absolute path on the device.
+Use this to quickly clean up temporary images created with `storeToFile`.
+On web, this is not supported and will throw.
+
+| Param         | Type                           |
+| ------------- | ------------------------------ |
+| **`options`** | <code>{ path: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ success: boolean; }&gt;</code>
+
+**Since:** 7.5.0
+
+--------------------
+
+
+### getSafeAreaInsets()
+
+```typescript
+getSafeAreaInsets() => Promise<SafeAreaInsets>
+```
+
+Gets the safe area insets for Android devices.
+Returns the top and bottom insets in dp and the current orientation.
+
+**Returns:** <code>Promise&lt;<a href="#safeareainsets">SafeAreaInsets</a>&gt;</code>
+
+--------------------
+
+
+### getOrientation()
+
+```typescript
+getOrientation() => Promise<{ orientation: DeviceOrientation; }>
+```
+
+Gets the current device orientation in a cross-platform format.
+
+**Returns:** <code>Promise&lt;{ orientation: <a href="#deviceorientation">DeviceOrientation</a>; }&gt;</code>
+
+**Since:** 7.5.0
+
 --------------------
 
 
@@ -874,6 +958,18 @@ Represents the detailed information of the currently active lens.
 | **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
 
 
+#### SafeAreaInsets
+
+Represents safe area insets on Android.
+Values are expressed in logical pixels (dp) to match JS layout units.
+
+| Prop              | Type                | Description                                                      |
+| ----------------- | ------------------- | ---------------------------------------------------------------- |
+| **`orientation`** | <code>number</code> | Current device orientation as reported by Android configuration. |
+| **`top`**         | <code>number</code> | Top inset (e.g., status bar or cutout) in dp.                    |
+| **`bottom`**      | <code>number</code> | Bottom inset (e.g., navigation bar) in dp.                       |
+
+
 ### Type Aliases
 
 
@@ -910,6 +1006,13 @@ The available flash modes for the camera.
 <code><a href="#camerapreviewflashmode">CameraPreviewFlashMode</a></code>
 
 
+#### DeviceOrientation
+
+Canonical device orientation values across platforms.
+
+<code>"portrait" | "landscape" | "landscape-left" | "landscape-right" | "portrait-upside-down" | "unknown"</code>
+
+
 ### Enums
 
 

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

@@ -5,13 +5,18 @@ import static android.Manifest.permission.RECORD_AUDIO;
 
 import android.Manifest;
 import android.content.pm.ActivityInfo;
+import android.content.res.Configuration;
 import android.location.Location;
 import android.util.DisplayMetrics;
 import android.util.Log;
 import android.util.Size;
+import android.view.OrientationEventListener;
 import android.view.View;
 import android.view.ViewGroup;
 import android.webkit.WebView;
+import androidx.core.graphics.Insets;
+import androidx.core.view.ViewCompat;
+import androidx.core.view.WindowInsetsCompat;
 import com.ahm.capacitor.camera.preview.model.CameraDevice;
 import com.ahm.capacitor.camera.preview.model.CameraSessionConfiguration;
 import com.ahm.capacitor.camera.preview.model.LensInfo;
@@ -69,6 +74,28 @@ public class CameraPreview
   private CameraXView cameraXView;
   private FusedLocationProviderClient fusedLocationClient;
   private Location lastLocation;
+  private OrientationEventListener orientationListener;
+  private int lastOrientation = Configuration.ORIENTATION_UNDEFINED;
+
+  @PluginMethod
+  public void getOrientation(PluginCall call) {
+    int orientation = getContext()
+      .getResources()
+      .getConfiguration()
+      .orientation;
+    String o;
+    if (orientation == Configuration.ORIENTATION_PORTRAIT) {
+      // We don't distinguish upside-down reliably on Android, report generic portrait
+      o = "portrait";
+    } else if (orientation == Configuration.ORIENTATION_LANDSCAPE) {
+      o = "landscape";
+    } else {
+      o = "unknown";
+    }
+    JSObject ret = new JSObject();
+    ret.put("orientation", o);
+    call.resolve(ret);
+  }
 
   @PluginMethod
   public void start(PluginCall call) {
@@ -205,6 +232,13 @@ public class CameraPreview
           .getActivity()
           .setRequestedOrientation(previousOrientationRequest);
 
+        // Disable and clear orientation listener
+        if (orientationListener != null) {
+          orientationListener.disable();
+          orientationListener = null;
+          lastOrientation = Configuration.ORIENTATION_UNDEFINED;
+        }
+
         if (cameraXView != null && cameraXView.isRunning()) {
           cameraXView.stopSession();
           cameraXView = null;
@@ -215,6 +249,10 @@ public class CameraPreview
 
   @PluginMethod
   public void getSupportedFlashModes(PluginCall call) {
+    if (cameraXView == null || !cameraXView.isRunning()) {
+      call.reject("Camera is not running");
+      return;
+    }
     List<String> supportedFlashModes = cameraXView.getSupportedFlashModes();
     JSArray jsonFlashModes = new JSArray();
     for (String mode : supportedFlashModes) {
@@ -268,6 +306,10 @@ public class CameraPreview
 
   @PluginMethod
   public void getZoom(PluginCall call) {
+    if (cameraXView == null || !cameraXView.isRunning()) {
+      call.reject("Camera is not running");
+      return;
+    }
     ZoomFactors zoomFactors = cameraXView.getZoomFactors();
     JSObject result = new JSObject();
     result.put("min", zoomFactors.getMin());
@@ -278,6 +320,10 @@ public class CameraPreview
 
   @PluginMethod
   public void getZoomButtonValues(PluginCall call) {
+    if (cameraXView == null || !cameraXView.isRunning()) {
+      call.reject("Camera is not running");
+      return;
+    }
     // Build a sorted set to dedupe and order ascending
     java.util.Set<Double> sorted = new java.util.TreeSet<>();
     sorted.add(1.0);
@@ -968,6 +1014,67 @@ public class CameraPreview
         bridge.saveCall(call);
         cameraStartCallbackId = call.getCallbackId();
         cameraXView.startSession(config);
+
+        // Setup orientation listener to mirror iOS screenResize emission
+        if (orientationListener == null) {
+          lastOrientation = getContext()
+            .getResources()
+            .getConfiguration()
+            .orientation;
+          orientationListener = new OrientationEventListener(getContext()) {
+            @Override
+            public void onOrientationChanged(int orientation) {
+              if (orientation == ORIENTATION_UNKNOWN) return;
+              int current = getContext()
+                .getResources()
+                .getConfiguration()
+                .orientation;
+              if (current != lastOrientation) {
+                lastOrientation = current;
+                handleOrientationChange();
+              }
+            }
+          };
+          if (orientationListener.canDetectOrientation()) {
+            orientationListener.enable();
+          }
+        }
+      });
+  }
+
+  private void handleOrientationChange() {
+    if (cameraXView == null || !cameraXView.isRunning()) return;
+    getBridge()
+      .getActivity()
+      .runOnUiThread(() -> {
+        // Reapply current aspect ratio to recompute layout, then emit screenResize
+        String ar = cameraXView.getAspectRatio();
+        cameraXView.setAspectRatio(ar, null, null, () -> {
+          int[] bounds = cameraXView.getCurrentPreviewBounds();
+          JSObject data = new JSObject();
+          data.put("x", bounds[0]);
+          data.put("y", bounds[1]);
+          data.put("width", bounds[2]);
+          data.put("height", bounds[3]);
+          notifyListeners("screenResize", data);
+
+          // Also emit orientationChange with a unified string value
+          int current = getContext()
+            .getResources()
+            .getConfiguration()
+            .orientation;
+          String o;
+          if (current == Configuration.ORIENTATION_PORTRAIT) {
+            o = "portrait";
+          } else if (current == Configuration.ORIENTATION_LANDSCAPE) {
+            o = "landscape";
+          } else {
+            o = "unknown";
+          }
+          JSObject oData = new JSObject();
+          oData.put("orientation", o);
+          notifyListeners("orientationChange", oData);
+        });
       });
   }
 
@@ -1255,4 +1362,120 @@ public class CameraPreview
       call.reject("Failed to delete file: " + e.getMessage());
     }
   }
+
+  @PluginMethod
+  public void getSafeAreaInsets(PluginCall call) {
+    JSObject ret = new JSObject();
+    int orientation = getContext()
+      .getResources()
+      .getConfiguration()
+      .orientation;
+
+    int topPx = 0;
+    int bottomPx = 0;
+    try {
+      View webView = getBridge().getWebView();
+      if (webView != null) {
+        DisplayMetrics metrics = getBridge()
+          .getActivity()
+          .getResources()
+          .getDisplayMetrics();
+        int screenHeight = metrics.heightPixels;
+        int[] location = new int[2];
+        webView.getLocationOnScreen(location);
+        int webViewTop = location[1];
+        int webViewBottom = webViewTop + webView.getHeight();
+        int webViewBottomGap = Math.max(0, screenHeight - webViewBottom);
+
+        // System insets (status/navigation/cutout)
+        int systemTop = 0;
+        int systemBottom = 0;
+        View decorView = getBridge().getActivity().getWindow().getDecorView();
+        WindowInsetsCompat insets = ViewCompat.getRootWindowInsets(decorView);
+        if (insets != null) {
+          Insets sysBars = insets.getInsets(
+            WindowInsetsCompat.Type.systemBars()
+          );
+          Insets cutout = insets.getInsets(
+            WindowInsetsCompat.Type.displayCutout()
+          );
+          systemTop = Math.max(sysBars.top, cutout.top);
+          systemBottom = Math.max(sysBars.bottom, cutout.bottom);
+        } else {
+          systemTop = getStatusBarHeightPx();
+          systemBottom = getNavigationBarHeightPx();
+        }
+
+        // Top: report the gap between screen and WebView (useful when not edge-to-edge)
+        topPx = Math.max(0, webViewTop);
+
+        // Bottom logic:
+        // - If WebView has a bottom gap equal to the system nav bar height (3-button mode),
+        //   it means layout already accounts for it -> return 0 as requested.
+        // - If WebView has no gap (edge-to-edge or overlay), return system bottom inset.
+        // - Otherwise, default to system bottom inset (avoid counting app UI like tab bars).
+        if (
+          webViewBottomGap > 0 && approxEqualPx(webViewBottomGap, systemBottom)
+        ) {
+          bottomPx = 0; // already offset by system nav bar
+        } else if (webViewBottomGap == 0) {
+          bottomPx = systemBottom;
+        } else {
+          bottomPx = systemBottom;
+        }
+      } else {
+        // Fallback if WebView is unavailable
+        View decorView = getBridge().getActivity().getWindow().getDecorView();
+        WindowInsetsCompat insets = ViewCompat.getRootWindowInsets(decorView);
+        if (insets != null) {
+          Insets sysBars = insets.getInsets(
+            WindowInsetsCompat.Type.systemBars()
+          );
+          Insets cutout = insets.getInsets(
+            WindowInsetsCompat.Type.displayCutout()
+          );
+          topPx = Math.max(sysBars.top, cutout.top);
+          bottomPx = Math.max(sysBars.bottom, cutout.bottom);
+        } else {
+          topPx = getStatusBarHeightPx();
+          bottomPx = getNavigationBarHeightPx();
+        }
+      }
+    } catch (Exception e) {
+      topPx = getStatusBarHeightPx();
+      bottomPx = getNavigationBarHeightPx();
+    }
+
+    float density = getContext().getResources().getDisplayMetrics().density;
+    ret.put("orientation", orientation);
+    ret.put("top", topPx / density);
+    ret.put("bottom", bottomPx / density);
+    call.resolve(ret);
+  }
+
+  private boolean approxEqualPx(int a, int b) {
+    return Math.abs(a - b) <= 2; // within 2px tolerance
+  }
+
+  private int getStatusBarHeightPx() {
+    int result = 0;
+    int resourceId = getContext()
+      .getResources()
+      .getIdentifier("status_bar_height", "dimen", "android");
+    if (resourceId > 0) {
+      result = getContext().getResources().getDimensionPixelSize(resourceId);
+    }
+    return result;
+  }
+
+  private int getNavigationBarHeightPx() {
+    int result = 0;
+    int resourceId = getContext()
+      .getResources()
+      .getIdentifier("navigation_bar_height", "dimen", "android");
+    if (resourceId > 0) {
+      result = getContext().getResources().getDimensionPixelSize(resourceId);
+    }
+    return result;
+  }
 }