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

package/README.md

@@ -262,8 +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)
@@ -374,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
 
 --------------------
 
@@ -389,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
 
 --------------------
 
@@ -546,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
 
 --------------------
 
@@ -561,7 +563,7 @@ Gets all available camera devices.
 
 **Returns:** <code>Promise&lt;{ devices: CameraDevice[]; }&gt;</code>
 
-**Since:** 7.4.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -576,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
 
 --------------------
 
@@ -593,6 +595,8 @@ Returns zoom button values for quick switching.
 
 **Returns:** <code>Promise&lt;{ values: number[]; }&gt;</code>
 
+**Since:** 7.5.0
+
 --------------------
 
 
@@ -608,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
 
 --------------------
 
@@ -623,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
 
 --------------------
 
@@ -636,7 +640,7 @@ removeAllListeners() => Promise<void>
 
 Removes all registered listeners.
 
-**Since:** 7.4.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -653,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
 
 --------------------
 
@@ -668,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
 
 --------------------
 
@@ -683,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
+
 --------------------
 
 
@@ -700,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
+
 --------------------
 
 
@@ -715,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
 
 --------------------
 
@@ -726,13 +734,37 @@ 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
+
 --------------------
 
 
@@ -752,7 +784,7 @@ On web, this is not supported and will throw.
 
 **Returns:** <code>Promise&lt;{ success: boolean; }&gt;</code>
 
-**Since:** 8.2.0
+**Since:** 7.5.0
 
 --------------------
 
@@ -771,6 +803,21 @@ Returns the top and bottom insets in dp and the current orientation.
 --------------------
 
 
+### 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
+
+--------------------
+
+
 ### Interfaces
 
 
@@ -959,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

@@ -77,6 +77,26 @@ public class CameraPreview
   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) {
     boolean disableAudio = Boolean.TRUE.equals(
@@ -1037,6 +1057,23 @@ public class CameraPreview
           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);
         });
       });
   }

package/dist/docs.json

@@ -161,7 +161,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Set the aspect ratio of the camera preview.",
@@ -180,7 +184,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the current aspect ratio of the camera preview.",
@@ -422,7 +430,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Checks if the camera preview is currently running.",
@@ -441,7 +453,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets all available camera devices.",
@@ -462,7 +478,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the current zoom state, including min/max and current lens info.",
@@ -476,7 +496,16 @@
         "signature": "() => Promise<{ values: number[]; }>",
         "parameters": [],
         "returns": "Promise<{ values: number[]; }>",
-        "tags": [],
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
         "docs": "Returns zoom button values for quick switching.\n- iOS/Android: includes 0.5 if ultra-wide available; 1 and 2 if wide available; 3 if telephoto available\n- Web: unsupported",
         "complexTypes": [],
         "slug": "getzoombuttonvalues"
@@ -503,7 +532,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Sets the zoom level of the camera.",
@@ -522,7 +555,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the current flash mode.",
@@ -539,7 +576,11 @@
         "tags": [
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Removes all registered listeners.",
@@ -568,7 +609,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Switches the active camera to the one with the specified `deviceId`.",
@@ -587,7 +632,11 @@
           },
           {
             "name": "since",
-            "text": "7.4.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the ID of the currently active camera device.",
@@ -602,6 +651,14 @@
         "tags": [
           {
             "name": "returns"
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Gets the current preview size and position.",
@@ -627,6 +684,14 @@
           {
             "name": "returns",
             "text": "A promise that resolves with the actual preview dimensions and position."
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Sets the preview size and position.",
@@ -655,7 +720,11 @@
           },
           {
             "name": "since",
-            "text": "8.1.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Sets the camera focus to a specific point in the preview.",
@@ -668,23 +737,89 @@
         "parameters": [
           {
             "name": "eventName",
-            "docs": "",
+            "docs": "- The event name to listen for.",
             "type": "'screenResize'"
           },
           {
             "name": "listenerFunc",
-            "docs": "",
+            "docs": "- The function to call when the event is triggered.",
             "type": "(data: { width: number; height: number; x: number; y: number; }) => void"
           }
         ],
         "returns": "Promise<PluginListenerHandle>",
-        "tags": [],
-        "docs": "",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name to listen for."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The function to call when the event is triggered."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with a handle to the listener."
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "docs": "Adds a listener for screen resize events.",
         "complexTypes": [
           "PluginListenerHandle"
         ],
         "slug": "addlistenerscreenresize-"
       },
+      {
+        "name": "addListener",
+        "signature": "(eventName: \"orientationChange\", listenerFunc: (data: { orientation: DeviceOrientation; }) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "- The event name to listen for.",
+            "type": "'orientationChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "- The function to call when the event is triggered.",
+            "type": "(data: { orientation: DeviceOrientation; }) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName - The event name to listen for."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc - The function to call when the event is triggered."
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves with a handle to the listener."
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "docs": "Adds a listener for orientation change events.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "DeviceOrientation"
+        ],
+        "slug": "addlistenerorientationchange-"
+      },
       {
         "name": "deleteFile",
         "signature": "(options: { path: string; }) => Promise<{ success: boolean; }>",
@@ -699,7 +834,11 @@
         "tags": [
           {
             "name": "since",
-            "text": "8.2.0"
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
           }
         ],
         "docs": "Deletes a file at the given absolute path on the device.\nUse this to quickly clean up temporary images created with `storeToFile`.\nOn web, this is not supported and will throw.",
@@ -722,6 +861,27 @@
           "SafeAreaInsets"
         ],
         "slug": "getsafeareainsets"
+      },
+      {
+        "name": "getOrientation",
+        "signature": "() => Promise<{ orientation: DeviceOrientation; }>",
+        "parameters": [],
+        "returns": "Promise<{ orientation: DeviceOrientation; }>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.5.0"
+          },
+          {
+            "name": "platform",
+            "text": "android, ios"
+          }
+        ],
+        "docs": "Gets the current device orientation in a cross-platform format.",
+        "complexTypes": [
+          "DeviceOrientation"
+        ],
+        "slug": "getorientation"
       }
     ],
     "properties": []
@@ -1630,6 +1790,37 @@
           ]
         }
       ]
+    },
+    {
+      "name": "DeviceOrientation",
+      "slug": "deviceorientation",
+      "docs": "Canonical device orientation values across platforms.",
+      "types": [
+        {
+          "text": "\"portrait\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"landscape\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"landscape-left\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"landscape-right\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"portrait-upside-down\"",
+          "complexTypes": []
+        },
+        {
+          "text": "\"unknown\"",
+          "complexTypes": []
+        }
+      ]
     }
   ],
   "pluginConfigs": []