@capgo/background-geolocation 7.0.9 → 7.0.10

package/README.md

@@ -9,48 +9,39 @@
 A Capacitor plugin that lets you receive geolocation updates even while the app is backgrounded.
 It has a web API to facilitate for a similar usage, but background geolocation is not supported in a regular browser, only in an app environment.
 
+## This plugin's history
+
+Interestingly enough, this plugin has a lot of history. The initial solution from [Transistorsoft](https://github.com/transistorsoft) was a great piece of software, and I encourage using it if it fits your needs.  
+I tried it and understood that it prioritizes battery life over accuracy, which wasn't the right fit for my hiking app.  
+There was a very good fork maintained by **mauron85** specifically for that use case, and I was happy to help maintain it.  
+But at some point, **mauron85** stopped responding to messages on GitHub, and no one could continue maintaining it.  
+I hope mauron85 is safe and sound somewhere.  
+
+So I created a fork and started maintaining it [here](https://github.com/HaylLtd/cordova-background-geolocation-plugin).  
+It served me well for over half a decade, but I felt it was hard to maintain due to all its history, features, and bug fixes.  
+I also felt like there was a barrier to introducing new features because of its complexity.
+
+So I started exploring what it would take to reduce that complexity—at the same time, I was envious of how small [`@capacitor-community/background-geolocation`](https://github.com/capacitor-community/background-geolocation) is.  
+I took the best of both worlds: tried to reduce the codebase in the original Cordova plugin and add some robustness to the Capacitor plugin.  
+
+That's how I ended up maintaining this one.  
+I hope you'll enjoy it!
+
+
 ## Usage
 
 ```javascript
 import { BackgroundGeolocation } from "@capgo/background-geolocation";
 
-// To start listening for changes in the device's location, add a new watcher.
-// You do this by calling 'addWatcher' with an options object and a callback. A
-// Promise is returned, which resolves to the callback ID used to remove the
-// watcher in the future. The callback will be called every time a new location
-// is available. Watchers can not be paused, only removed. Multiple watchers may
-// exist simultaneously.
-BackgroundGeolocation.addWatcher(
+BackgroundGeolocation.start(
     {
-        // If the "backgroundMessage" option is defined, the watcher will
-        // provide location updates whether the app is in the background or the
-        // foreground. If it is not defined, location updates are only
-        // guaranteed in the foreground. This is true on both platforms.
-
-        // On Android, a notification must be shown to continue receiving
-        // location updates in the background. This option specifies the text of
-        // that notification.
         backgroundMessage: "Cancel to prevent battery drain.",
-
-        // The title of the notification mentioned above. Defaults to "Using
-        // your location".
         backgroundTitle: "Tracking You.",
-        
-        // Whether permissions should be requested from the user automatically,
-        // if they are not already granted. Defaults to "true".
         requestPermissions: true,
-
-        // If "true", stale locations may be delivered while the device
-        // obtains a GPS fix. You are responsible for checking the "time"
-        // property. If "false", locations are guaranteed to be up to date.
-        // Defaults to "false".
         stale: false,
-
-        // The minimum number of metres between subsequent locations. Defaults
-        // to 0.
         distanceFilter: 50
     },
-    function callback(location, error) {
+    (location, error) => {
         if (error) {
             if (error.code === "NOT_AUTHORIZED") {
                 if (window.confirm(
@@ -67,56 +58,31 @@ BackgroundGeolocation.addWatcher(
             }
             return console.error(error);
         }
-
+        // in case of off-track for example, play a sound:
+        BackgroundGeolocation.playSound({soundFile: "assets/myFile.mp3" });
         return console.log(location);
     }
-).then(function after_the_watcher_has_been_added(watcher_id) {
-    // When a watcher is no longer needed, it should be removed by calling
-    // 'removeWatcher' with an object containing its ID.
-    BackgroundGeolocation.removeWatcher({
-        id: watcher_id
-    });
+).then(() => {
+    // When location updates are no longer needed, the plugin should be stopped by calling
+    BackgroundGeolocation.stop();
 });
 
-// The location object.
-{
-    // Longitude in degrees.
-    longitude: 131.723423719132,
-    // Latitude in degrees.
-    latitude: -22.40106297456,
-    // Radius of horizontal uncertainty in metres, with 68% confidence.
-    accuracy: 11,
-    // Metres above sea level (or null).
-    altitude: 65,
-    // Vertical uncertainty in metres, with 68% confidence (or null).
-    altitudeAccuracy: 4,
-    // Deviation from true north in degrees (or null).
-    bearing: 159.60000610351562,
-    // True if the location was simulated by software, rather than GPS.
-    simulated: false,
-    // Speed in metres per second (or null).
-    speed: 23.51068878173828,
-    // Time the location was produced, in milliseconds since the unix epoch.
-    time: 1562731602000
-}
-
 // If you just want the current location, try something like this. The longer
-// the timeout, the more accurate the guess will be. I wouldn't go below about
-// 100ms.
-function guess_location(callback, timeout) {
+// the timeout, the more accurate the guess will be. I wouldn't go below about 100ms.
+function guessLocation(callback, timeout) {
     let last_location;
-    BackgroundGeolocation.addWatcher(
+    BackgroundGeolocation.start(
         {
             requestPermissions: false,
             stale: true
         },
-        function (location) {
+        (location) => {
             last_location = location || undefined;
         }
-    ).then(function (id) {
-        setTimeout(function () {
+    ).then(() => {
+        setTimeout(() => {
             callback(last_location);
-            BackgroundGeolocation.removeWatcher({id});
+            BackgroundGeolocation.stop();
         }, timeout);
     });
 }
@@ -128,7 +94,7 @@ This plugin supports Capacitor v7:
 
 | Capacitor  | Plugin |
 |------------|--------|
-| v7         | v1     |
+| v7         | v7     |
 
 ```sh
 npm install @capgo/background-geolocation
@@ -211,6 +177,133 @@ Configration specific to Android can be made in `strings.xml`:
 * [`start(...)`](#start)
 * [`stop()`](#stop)
 * [`openSettings()`](#opensettings)
+* [`playSound(...)`](#playsound)
 * [Interfaces](#interfaces)
 
 </docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+Main plugin interface for background geolocation functionality.
+Provides methods to manage location updates and access device settings.
+
+### start(...)
+
+```typescript
+start(options: StartOptions, callback: (position?: Location | undefined, error?: CallbackError | undefined) => void) => Promise<void>
+```
+
+To start listening for changes in the device's location, call this method.
+A Promise is returned to indicate that it finished the call. The callback will be called every time a new location
+is available, or if there was an error when calling this method. Don't rely on promise rejection for this.
+
+| Param          | Type                                                                                                                      | Description                                                                       |
+| -------------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
+| **`options`**  | <code><a href="#startoptions">StartOptions</a></code>                                                                     | The configuration options                                                         |
+| **`callback`** | <code>(position?: <a href="#location">Location</a>, error?: <a href="#callbackerror">CallbackError</a>) =&gt; void</code> | The callback function invoked when a new location is available or an error occurs |
+
+**Since:** 7.0.9
+
+--------------------
+
+
+### stop()
+
+```typescript
+stop() => Promise<void>
+```
+
+Stops location updates.
+
+**Since:** 7.0.9
+
+--------------------
+
+
+### openSettings()
+
+```typescript
+openSettings() => Promise<void>
+```
+
+Opens the device's location settings page.
+Useful for directing users to enable location services or adjust permissions.
+
+**Since:** 7.0.0
+
+--------------------
+
+
+### playSound(...)
+
+```typescript
+playSound(options: PlaySoundOptions) => Promise<void>
+```
+
+Plays a sound file.
+This should be used to play a sound, in the background too.
+The idea behind this is to allow the user to hear a sound when a new location is available or when going off track.
+If you simply need to play a sound, you can use `@capgo/native-audio` plugin instead.
+For Android, there's a need to start monitoring location updates first, otherwise the sound will not play.
+
+| Param         | Type                                                          | Description                       |
+| ------------- | ------------------------------------------------------------- | --------------------------------- |
+| **`options`** | <code><a href="#playsoundoptions">PlaySoundOptions</a></code> | The options for playing the sound |
+
+**Since:** 7.0.10
+
+--------------------
+
+
+### Interfaces
+
+
+#### StartOptions
+
+The options for configuring for location updates.
+
+| Prop                     | Type                 | Description                                                                                                                                                                                                                                                                                                                                                                                                          | Default                            | Since |
+| ------------------------ | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | ----- |
+| **`backgroundMessage`**  | <code>string</code>  | If the "backgroundMessage" option is defined, the plugin will provide location updates whether the app is in the background or the foreground. If it is not defined, location updates are only guaranteed in the foreground. This is true on both platforms. On Android, a notification must be shown to continue receiving location updates in the background. This option specifies the text of that notification. |                                    | 7.0.9 |
+| **`backgroundTitle`**    | <code>string</code>  | The title of the notification mentioned above.                                                                                                                                                                                                                                                                                                                                                                       | <code>"Using your location"</code> | 7.0.9 |
+| **`requestPermissions`** | <code>boolean</code> | Whether permissions should be requested from the user automatically, if they are not already granted.                                                                                                                                                                                                                                                                                                                | <code>true</code>                  | 7.0.9 |
+| **`stale`**              | <code>boolean</code> | If "true", stale locations may be delivered while the device obtains a GPS fix. You are responsible for checking the "time" property. If "false", locations are guaranteed to be up to date.                                                                                                                                                                                                                         | <code>false</code>                 | 7.0.9 |
+| **`distanceFilter`**     | <code>number</code>  | The distance in meters that the device must move before a new location update is triggered. This is used to filter out small movements and reduce the number of updates.                                                                                                                                                                                                                                             | <code>0</code>                     | 7.0.9 |
+
+
+#### Location
+
+Represents a geographical location with various attributes.
+Contains all the standard location properties returned by GPS/network providers.
+
+| Prop                   | Type                        | Description                                                                                                                            | Since |
+| ---------------------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`latitude`**         | <code>number</code>         | Latitude in degrees. Range: -90.0 to +90.0                                                                                             | 7.0.0 |
+| **`longitude`**        | <code>number</code>         | Longitude in degrees. Range: -180.0 to +180.0                                                                                          | 7.0.0 |
+| **`accuracy`**         | <code>number</code>         | Radius of horizontal uncertainty in metres, with 68% confidence. Lower values indicate more accurate location.                         | 7.0.0 |
+| **`altitude`**         | <code>number \| null</code> | Metres above sea level (or null if not available).                                                                                     | 7.0.0 |
+| **`altitudeAccuracy`** | <code>number \| null</code> | Vertical uncertainty in metres, with 68% confidence (or null if not available).                                                        | 7.0.0 |
+| **`simulated`**        | <code>boolean</code>        | `true` if the location was simulated by software, rather than GPS. Useful for detecting mock locations in development or testing.      | 7.0.0 |
+| **`bearing`**          | <code>number \| null</code> | Deviation from true north in degrees (or null if not available). Range: 0.0 to 360.0                                                   | 7.0.0 |
+| **`speed`**            | <code>number \| null</code> | Speed in metres per second (or null if not available).                                                                                 | 7.0.0 |
+| **`time`**             | <code>number \| null</code> | Time the location was produced, in milliseconds since the unix epoch. Use this to check if a location is stale when using stale: true. | 7.0.0 |
+
+
+#### CallbackError
+
+Error object that may be passed to the location start callback.
+Extends the standard Error with optional error codes.
+
+| Prop       | Type                | Description                                           | Since |
+| ---------- | ------------------- | ----------------------------------------------------- | ----- |
+| **`code`** | <code>string</code> | Optional error code for more specific error handling. | 7.0.0 |
+
+
+#### PlaySoundOptions
+
+| Prop            | Type                | Description                                                                                                                                                                                             | Since  |
+| --------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ |
+| **`soundFile`** | <code>string</code> | The name of the sound file to play. Must be a valid sound relative path in the app's public folder to work for both web and native platforms. There's no need to include the public folder in the path. | 7.0.10 |
+
+</docgen-api>

package/android/src/main/java/com/capgo/capacitor_background_geolocation/BackgroundGeolocation.java

@@ -188,6 +188,31 @@ public class BackgroundGeolocation extends Plugin {
     call.resolve();
   }
 
+  @PluginMethod
+  public void playSound(PluginCall call) {
+    String soundFile = call.getString("soundFile");
+    if (soundFile == null || soundFile.isEmpty()) {
+      call.reject("Sound file is required");
+      return;
+    }
+    if (serviceConnectionFuture == null) {
+      call.reject(
+        "Service not started, make sure to call start() first",
+        "NOT_STARTED"
+      );
+      return;
+    }
+    serviceConnectionFuture
+      .thenAccept(service -> {
+        service.playSound(soundFile);
+        call.resolve();
+      })
+      .exceptionally(throwable -> {
+        call.reject("Failed to play sound: " + throwable.getMessage());
+        return null;
+      });
+  }
+
   // Checks if device-wide location services are disabled
   private static Boolean isLocationEnabled(Context context) {
     if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.P) {

package/android/src/main/java/com/capgo/capacitor_background_geolocation/BackgroundGeolocationService.java

@@ -5,9 +5,12 @@ import android.app.PendingIntent;
 import android.app.Service;
 import android.content.Context;
 import android.content.Intent;
+import android.content.res.AssetFileDescriptor;
+import android.content.res.AssetManager;
 import android.graphics.Color;
 import android.location.LocationListener;
 import android.location.LocationManager;
+import android.media.MediaPlayer;
 import android.os.Binder;
 import android.os.Build;
 import android.os.IBinder;
@@ -30,6 +33,7 @@ public class BackgroundGeolocationService extends Service {
 
   private LocationManager client;
   private LocationListener locationCallback;
+  private MediaPlayer mediaPlayer;
 
   @Override
   public IBinder onBind(Intent intent) {
@@ -43,10 +47,33 @@ public class BackgroundGeolocationService extends Service {
   @Override
   public boolean onUnbind(Intent intent) {
     client.removeUpdates(locationCallback);
+    releaseMediaPlayer();
     stopSelf();
     return false;
   }
 
+  @Override
+  public void onDestroy() {
+    client.removeUpdates(locationCallback);
+    super.onDestroy();
+    releaseMediaPlayer();
+  }
+
+  private void releaseMediaPlayer() {
+    if (mediaPlayer == null) {
+      return;
+    }
+    try {
+      if (mediaPlayer.isPlaying()) {
+        mediaPlayer.stop();
+      }
+      mediaPlayer.release();
+    } catch (Exception e) {
+      Logger.error("Error releasing MediaPlayer", e);
+    }
+    mediaPlayer = null;
+  }
+
   // Handles requests from the activity.
   public class LocalBinder extends Binder {
 
@@ -106,6 +133,55 @@ public class BackgroundGeolocationService extends Service {
       stopSelf();
       return callbackId;
     }
+
+    void playSound(String filePath) {
+      try {
+        releaseMediaPlayer();
+
+        mediaPlayer = new MediaPlayer();
+
+        AssetManager am = getApplicationContext().getResources().getAssets();
+        AssetFileDescriptor assetFileDescriptor = am.openFd(
+          "public/" + filePath
+        );
+
+        mediaPlayer.setDataSource(
+          assetFileDescriptor.getFileDescriptor(),
+          assetFileDescriptor.getStartOffset(),
+          assetFileDescriptor.getLength()
+        );
+        mediaPlayer.setLooping(false);
+
+        mediaPlayer.setOnCompletionListener(mp -> {
+          try {
+            mp.release();
+          } catch (Exception e) {
+            Logger.error("Error releasing MediaPlayer on completion", e);
+          }
+          mediaPlayer = null;
+        });
+
+        mediaPlayer.setOnErrorListener((mp, what, extra) -> {
+          Logger.error("MediaPlayer error: what=" + what + ", extra=" + extra);
+          releaseMediaPlayer();
+          return true; // Indicate we handled the error
+        });
+
+        mediaPlayer.prepareAsync();
+        mediaPlayer.setOnPreparedListener(mp -> {
+          try {
+            mp.start();
+            Logger.debug("PlaySound: Successfully started playing sound");
+          } catch (Exception e) {
+            Logger.error("Error starting MediaPlayer", e);
+            releaseMediaPlayer();
+          }
+        });
+      } catch (Exception e) {
+        Logger.error("PlaySound: Unexpected error", e);
+        releaseMediaPlayer();
+      }
+    }
   }
 
   private Notification createBackgroundNotification(

package/dist/docs.json

@@ -2,10 +2,10 @@
   "api": {
     "name": "BackgroundGeolocationPlugin",
     "slug": "backgroundgeolocationplugin",
-    "docs": "Main plugin interface for background geolocation functionality.\nProvides methods to manage location watchers and access device settings.",
+    "docs": "Main plugin interface for background geolocation functionality.\nProvides methods to manage location updates and access device settings.",
     "tags": [
       {
-        "text": "1.0.0",
+        "text": "7.0.0",
         "name": "since"
       }
     ],
@@ -16,7 +16,7 @@
         "parameters": [
           {
             "name": "options",
-            "docs": "The watcher configuration options",
+            "docs": "The configuration options",
             "type": "StartOptions"
           },
           {
@@ -29,7 +29,7 @@
         "tags": [
           {
             "name": "param",
-            "text": "options The watcher configuration options"
+            "text": "options The configuration options"
           },
           {
             "name": "param",
@@ -37,18 +37,18 @@
           },
           {
             "name": "returns",
-            "text": "A promise that resolves to a unique identifier for the watcher ID"
+            "text": "A promise that resolves when the method is successfully called"
           },
           {
             "name": "since",
-            "text": "1.0.0"
+            "text": "7.0.9"
           },
           {
             "name": "example",
             "text": "await BackgroundGeolocation.start(\n  {\n    backgroundMessage: \"App is using your location in the background\",\n    backgroundTitle: \"Location Service\",\n    requestPermissions: true,\n    stale: false,\n    distanceFilter: 10\n  },\n  (location, error) => {\n    if (error) {\n      console.error('Location error:', error);\n      return;\n    }\n    if (location) {\n      console.log('New location:', location.latitude, location.longitude);\n    }\n  }\n);"
           }
         ],
-        "docs": "Adds a watcher for location updates.\nThe watcher will be invoked with the latest location whenever it is available.\nIf an error occurs, the callback will be invoked with the error.",
+        "docs": "To start listening for changes in the device's location, call this method.\nA Promise is returned to indicate that it finished the call. The callback will be called every time a new location\nis available, or if there was an error when calling this method. Don't rely on promise rejection for this.",
         "complexTypes": [
           "StartOptions",
           "Location",
@@ -64,11 +64,11 @@
         "tags": [
           {
             "name": "returns",
-            "text": "A promise that resolves when the watcher is successfully removed"
+            "text": "A promise that resolves when the plugin stops successfully removed"
           },
           {
             "name": "since",
-            "text": "1.0.0"
+            "text": "7.0.9"
           },
           {
             "name": "example",
@@ -91,7 +91,7 @@
           },
           {
             "name": "since",
-            "text": "1.0.0"
+            "text": "7.0.0"
           },
           {
             "name": "example",
@@ -101,6 +101,41 @@
         "docs": "Opens the device's location settings page.\nUseful for directing users to enable location services or adjust permissions.",
         "complexTypes": [],
         "slug": "opensettings"
+      },
+      {
+        "name": "playSound",
+        "signature": "(options: PlaySoundOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "The options for playing the sound",
+            "type": "PlaySoundOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options The options for playing the sound"
+          },
+          {
+            "name": "returns",
+            "text": "A promise that resolves when the sound is successfully played"
+          },
+          {
+            "name": "since",
+            "text": "7.0.10"
+          },
+          {
+            "name": "example",
+            "text": "await BackgroundGeolocation.playSound({\n  soundFile: \"notification.mp3\"\n});"
+          }
+        ],
+        "docs": "Plays a sound file.\nThis should be used to play a sound, in the background too.\nThe idea behind this is to allow the user to hear a sound when a new location is available or when going off track.\nIf you simply need to play a sound, you can use `@capgo/native-audio` plugin instead.\nFor Android, there's a need to start monitoring location updates first, otherwise the sound will not play.",
+        "complexTypes": [
+          "PlaySoundOptions"
+        ],
+        "slug": "playsound"
       }
     ],
     "properties": []
@@ -112,7 +147,7 @@
       "docs": "The options for configuring for location updates.",
       "tags": [
         {
-          "text": "1.0.0",
+          "text": "7.0.9",
           "name": "since"
         }
       ],
@@ -122,7 +157,7 @@
           "name": "backgroundMessage",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.9",
               "name": "since"
             },
             {
@@ -130,7 +165,7 @@
               "name": "example"
             }
           ],
-          "docs": "If the \"backgroundMessage\" option is defined, the watcher will\nprovide location updates whether the app is in the background or the\nforeground. If it is not defined, location updates are only\nguaranteed in the foreground. This is true on both platforms.\n\nOn Android, a notification must be shown to continue receiving\nlocation updates in the background. This option specifies the text of\nthat notification.",
+          "docs": "If the \"backgroundMessage\" option is defined, the plugin will\nprovide location updates whether the app is in the background or the\nforeground. If it is not defined, location updates are only\nguaranteed in the foreground. This is true on both platforms.\n\nOn Android, a notification must be shown to continue receiving\nlocation updates in the background. This option specifies the text of\nthat notification.",
           "complexTypes": [],
           "type": "string | undefined"
         },
@@ -138,7 +173,7 @@
           "name": "backgroundTitle",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.9",
               "name": "since"
             },
             {
@@ -158,7 +193,7 @@
           "name": "requestPermissions",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.9",
               "name": "since"
             },
             {
@@ -178,7 +213,7 @@
           "name": "stale",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.9",
               "name": "since"
             },
             {
@@ -198,7 +233,7 @@
           "name": "distanceFilter",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.9",
               "name": "since"
             },
             {
@@ -222,7 +257,7 @@
       "docs": "Represents a geographical location with various attributes.\nContains all the standard location properties returned by GPS/network providers.",
       "tags": [
         {
-          "text": "1.0.0",
+          "text": "7.0.0",
           "name": "since"
         }
       ],
@@ -232,7 +267,7 @@
           "name": "latitude",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -248,7 +283,7 @@
           "name": "longitude",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -264,7 +299,7 @@
           "name": "accuracy",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -280,7 +315,7 @@
           "name": "altitude",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -296,7 +331,7 @@
           "name": "altitudeAccuracy",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -312,7 +347,7 @@
           "name": "simulated",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -328,7 +363,7 @@
           "name": "bearing",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -344,7 +379,7 @@
           "name": "speed",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -360,7 +395,7 @@
           "name": "time",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -377,10 +412,10 @@
     {
       "name": "CallbackError",
       "slug": "callbackerror",
-      "docs": "Error object that may be passed to the location watcher callback.\nExtends the standard Error with optional error codes.",
+      "docs": "Error object that may be passed to the location start callback.\nExtends the standard Error with optional error codes.",
       "tags": [
         {
-          "text": "1.0.0",
+          "text": "7.0.0",
           "name": "since"
         }
       ],
@@ -390,7 +425,7 @@
           "name": "code",
           "tags": [
             {
-              "text": "1.0.0",
+              "text": "7.0.0",
               "name": "since"
             },
             {
@@ -403,6 +438,31 @@
           "type": "string | undefined"
         }
       ]
+    },
+    {
+      "name": "PlaySoundOptions",
+      "slug": "playsoundoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "soundFile",
+          "tags": [
+            {
+              "text": "7.0.10",
+              "name": "since"
+            },
+            {
+              "text": "\"notification.mp3\"",
+              "name": "example"
+            }
+          ],
+          "docs": "The name of the sound file to play.\nMust be a valid sound relative path in the app's public folder to work for both web and native platforms.\nThere's no need to include the public folder in the path.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
     }
   ],
   "enums": [],

package/dist/esm/definitions.d.ts

@@ -1,11 +1,11 @@
 /**
  * The options for configuring for location updates.
  *
- * @since 1.0.0
+ * @since 7.0.9
  */
 export interface StartOptions {
     /**
-     * If the "backgroundMessage" option is defined, the watcher will
+     * If the "backgroundMessage" option is defined, the plugin will
      * provide location updates whether the app is in the background or the
      * foreground. If it is not defined, location updates are only
      * guaranteed in the foreground. This is true on both platforms.
@@ -14,14 +14,14 @@ export interface StartOptions {
      * location updates in the background. This option specifies the text of
      * that notification.
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @example "Getting your location to provide better service"
      */
     backgroundMessage?: string;
     /**
      * The title of the notification mentioned above.
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @default "Using your location"
      * @example "Location Service"
      */
@@ -30,7 +30,7 @@ export interface StartOptions {
      * Whether permissions should be requested from the user automatically,
      * if they are not already granted.
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @default true
      * @example
      * // Auto-request permissions
@@ -45,7 +45,7 @@ export interface StartOptions {
      * obtains a GPS fix. You are responsible for checking the "time"
      * property. If "false", locations are guaranteed to be up to date.
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @default false
      * @example
      * // Allow stale locations for faster initial response
@@ -59,7 +59,7 @@ export interface StartOptions {
      * The distance in meters that the device must move before a new location update is triggered.
      * This is used to filter out small movements and reduce the number of updates.
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @default 0
      * @example
      * // Update every 10 meters
@@ -74,14 +74,14 @@ export interface StartOptions {
  * Represents a geographical location with various attributes.
  * Contains all the standard location properties returned by GPS/network providers.
  *
- * @since 1.0.0
+ * @since 7.0.0
  */
 export interface Location {
     /**
      * Latitude in degrees.
      * Range: -90.0 to +90.0
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 40.7128
      */
     latitude: number;
@@ -89,7 +89,7 @@ export interface Location {
      * Longitude in degrees.
      * Range: -180.0 to +180.0
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example -74.0060
      */
     longitude: number;
@@ -97,21 +97,21 @@ export interface Location {
      * Radius of horizontal uncertainty in metres, with 68% confidence.
      * Lower values indicate more accurate location.
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 5.0
      */
     accuracy: number;
     /**
      * Metres above sea level (or null if not available).
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 10.5
      */
     altitude: number | null;
     /**
      * Vertical uncertainty in metres, with 68% confidence (or null if not available).
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 3.0
      */
     altitudeAccuracy: number | null;
@@ -119,7 +119,7 @@ export interface Location {
      * `true` if the location was simulated by software, rather than GPS.
      * Useful for detecting mock locations in development or testing.
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example false
      */
     simulated: boolean;
@@ -127,14 +127,14 @@ export interface Location {
      * Deviation from true north in degrees (or null if not available).
      * Range: 0.0 to 360.0
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 45.5
      */
     bearing: number | null;
     /**
      * Speed in metres per second (or null if not available).
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 2.5
      */
     speed: number | null;
@@ -142,43 +142,53 @@ export interface Location {
      * Time the location was produced, in milliseconds since the unix epoch.
      * Use this to check if a location is stale when using stale: true.
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example 1640995200000
      */
     time: number | null;
 }
 /**
- * Error object that may be passed to the location watcher callback.
+ * Error object that may be passed to the location start callback.
  * Extends the standard Error with optional error codes.
  *
- * @since 1.0.0
+ * @since 7.0.0
  */
 export interface CallbackError extends Error {
     /**
      * Optional error code for more specific error handling.
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example "PERMISSION_DENIED"
      */
     code?: string;
 }
+export interface PlaySoundOptions {
+    /**
+     * The name of the sound file to play.
+     * Must be a valid sound relative path in the app's public folder to work for both web and native platforms.
+     * There's no need to include the public folder in the path.
+     * @since 7.0.10
+     * @example "notification.mp3"
+     * */
+    soundFile: string;
+}
 /**
  * Main plugin interface for background geolocation functionality.
- * Provides methods to manage location watchers and access device settings.
+ * Provides methods to manage location updates and access device settings.
  *
- * @since 1.0.0
+ * @since 7.0.0
  */
 export interface BackgroundGeolocationPlugin {
     /**
-     * Adds a watcher for location updates.
-     * The watcher will be invoked with the latest location whenever it is available.
-     * If an error occurs, the callback will be invoked with the error.
+     * To start listening for changes in the device's location, call this method.
+     * A Promise is returned to indicate that it finished the call. The callback will be called every time a new location
+     * is available, or if there was an error when calling this method. Don't rely on promise rejection for this.
      *
-     * @param options The watcher configuration options
+     * @param options The configuration options
      * @param callback The callback function invoked when a new location is available or an error occurs
-     * @returns A promise that resolves to a unique identifier for the watcher ID
+     * @returns A promise that resolves when the method is successfully called
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @example
      * await BackgroundGeolocation.start(
      *   {
@@ -203,9 +213,9 @@ export interface BackgroundGeolocationPlugin {
     /**
      * Stops location updates.
      *
-     * @returns A promise that resolves when the watcher is successfully removed
+     * @returns A promise that resolves when the plugin stops successfully removed
      *
-     * @since 1.0.0
+     * @since 7.0.9
      * @example
      * await BackgroundGeolocation.stop();
      */
@@ -216,10 +226,27 @@ export interface BackgroundGeolocationPlugin {
      *
      * @returns A promise that resolves when the settings page is opened
      *
-     * @since 1.0.0
+     * @since 7.0.0
      * @example
      * // Direct user to location settings
      * await BackgroundGeolocation.openSettings();
      */
     openSettings(): Promise<void>;
+    /**
+     * Plays a sound file.
+     * This should be used to play a sound, in the background too.
+     * The idea behind this is to allow the user to hear a sound when a new location is available or when going off track.
+     * If you simply need to play a sound, you can use `@capgo/native-audio` plugin instead.
+     * For Android, there's a need to start monitoring location updates first, otherwise the sound will not play.
+     *
+     * @param options The options for playing the sound
+     * @returns A promise that resolves when the sound is successfully played
+     *
+     * @since 7.0.10
+     * @example
+     * await BackgroundGeolocation.playSound({
+     *   soundFile: "notification.mp3"
+     * });
+     */
+    playSound(options: PlaySoundOptions): Promise<void>;
 }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The options for configuring for location updates.\n *\n * @since 1.0.0\n */\nexport interface StartOptions {\n  /**\n   * If the \"backgroundMessage\" option is defined, the watcher will\n   * provide location updates whether the app is in the background or the\n   * foreground. If it is not defined, location updates are only\n   * guaranteed in the foreground. This is true on both platforms.\n   *\n   * On Android, a notification must be shown to continue receiving\n   * location updates in the background. This option specifies the text of\n   * that notification.\n   *\n   * @since 1.0.0\n   * @example \"Getting your location to provide better service\"\n   */\n  backgroundMessage?: string;\n  /**\n   * The title of the notification mentioned above.\n   *\n   * @since 1.0.0\n   * @default \"Using your location\"\n   * @example \"Location Service\"\n   */\n  backgroundTitle?: string;\n  /**\n   * Whether permissions should be requested from the user automatically,\n   * if they are not already granted.\n   *\n   * @since 1.0.0\n   * @default true\n   * @example\n   * // Auto-request permissions\n   * requestPermissions: true\n   *\n   * // Don't auto-request, handle manually\n   * requestPermissions: false\n   */\n  requestPermissions?: boolean;\n  /**\n   * If \"true\", stale locations may be delivered while the device\n   * obtains a GPS fix. You are responsible for checking the \"time\"\n   * property. If \"false\", locations are guaranteed to be up to date.\n   *\n   * @since 1.0.0\n   * @default false\n   * @example\n   * // Allow stale locations for faster initial response\n   * stale: true\n   *\n   * // Only fresh locations\n   * stale: false\n   */\n  stale?: boolean;\n  /**\n   * The distance in meters that the device must move before a new location update is triggered.\n   * This is used to filter out small movements and reduce the number of updates.\n   *\n   * @since 1.0.0\n   * @default 0\n   * @example\n   * // Update every 10 meters\n   * distanceFilter: 10\n   *\n   * // Update on any movement\n   * distanceFilter: 0\n   */\n  distanceFilter?: number;\n}\n\n/**\n * Represents a geographical location with various attributes.\n * Contains all the standard location properties returned by GPS/network providers.\n *\n * @since 1.0.0\n */\nexport interface Location {\n  /**\n   * Latitude in degrees.\n   * Range: -90.0 to +90.0\n   *\n   * @since 1.0.0\n   * @example 40.7128\n   */\n  latitude: number;\n  /**\n   * Longitude in degrees.\n   * Range: -180.0 to +180.0\n   *\n   * @since 1.0.0\n   * @example -74.0060\n   */\n  longitude: number;\n  /**\n   * Radius of horizontal uncertainty in metres, with 68% confidence.\n   * Lower values indicate more accurate location.\n   *\n   * @since 1.0.0\n   * @example 5.0\n   */\n  accuracy: number;\n  /**\n   * Metres above sea level (or null if not available).\n   *\n   * @since 1.0.0\n   * @example 10.5\n   */\n  altitude: number | null;\n  /**\n   * Vertical uncertainty in metres, with 68% confidence (or null if not available).\n   *\n   * @since 1.0.0\n   * @example 3.0\n   */\n  altitudeAccuracy: number | null;\n  /**\n   * `true` if the location was simulated by software, rather than GPS.\n   * Useful for detecting mock locations in development or testing.\n   *\n   * @since 1.0.0\n   * @example false\n   */\n  simulated: boolean;\n  /**\n   * Deviation from true north in degrees (or null if not available).\n   * Range: 0.0 to 360.0\n   *\n   * @since 1.0.0\n   * @example 45.5\n   */\n  bearing: number | null;\n  /**\n   * Speed in metres per second (or null if not available).\n   *\n   * @since 1.0.0\n   * @example 2.5\n   */\n  speed: number | null;\n  /**\n   * Time the location was produced, in milliseconds since the unix epoch.\n   * Use this to check if a location is stale when using stale: true.\n   *\n   * @since 1.0.0\n   * @example 1640995200000\n   */\n  time: number | null;\n}\n\n/**\n * Error object that may be passed to the location watcher callback.\n * Extends the standard Error with optional error codes.\n *\n * @since 1.0.0\n */\nexport interface CallbackError extends Error {\n  /**\n   * Optional error code for more specific error handling.\n   *\n   * @since 1.0.0\n   * @example \"PERMISSION_DENIED\"\n   */\n  code?: string;\n}\n\n/**\n * Main plugin interface for background geolocation functionality.\n * Provides methods to manage location watchers and access device settings.\n *\n * @since 1.0.0\n */\nexport interface BackgroundGeolocationPlugin {\n  /**\n   * Adds a watcher for location updates.\n   * The watcher will be invoked with the latest location whenever it is available.\n   * If an error occurs, the callback will be invoked with the error.\n   *\n   * @param options The watcher configuration options\n   * @param callback The callback function invoked when a new location is available or an error occurs\n   * @returns A promise that resolves to a unique identifier for the watcher ID\n   *\n   * @since 1.0.0\n   * @example\n   * await BackgroundGeolocation.start(\n   *   {\n   *     backgroundMessage: \"App is using your location in the background\",\n   *     backgroundTitle: \"Location Service\",\n   *     requestPermissions: true,\n   *     stale: false,\n   *     distanceFilter: 10\n   *   },\n   *   (location, error) => {\n   *     if (error) {\n   *       console.error('Location error:', error);\n   *       return;\n   *     }\n   *     if (location) {\n   *       console.log('New location:', location.latitude, location.longitude);\n   *     }\n   *   }\n   * );\n   */\n  start(\n    options: StartOptions,\n    callback: (position?: Location, error?: CallbackError) => void,\n  ): Promise<void>;\n\n  /**\n   * Stops location updates.\n   *\n   * @returns A promise that resolves when the watcher is successfully removed\n   *\n   * @since 1.0.0\n   * @example\n   * await BackgroundGeolocation.stop();\n   */\n  stop(): Promise<void>;\n\n  /**\n   * Opens the device's location settings page.\n   * Useful for directing users to enable location services or adjust permissions.\n   *\n   * @returns A promise that resolves when the settings page is opened\n   *\n   * @since 1.0.0\n   * @example\n   * // Direct user to location settings\n   * await BackgroundGeolocation.openSettings();\n   */\n  openSettings(): Promise<void>;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["/**\n * The options for configuring for location updates.\n *\n * @since 7.0.9\n */\nexport interface StartOptions {\n  /**\n   * If the \"backgroundMessage\" option is defined, the plugin will\n   * provide location updates whether the app is in the background or the\n   * foreground. If it is not defined, location updates are only\n   * guaranteed in the foreground. This is true on both platforms.\n   *\n   * On Android, a notification must be shown to continue receiving\n   * location updates in the background. This option specifies the text of\n   * that notification.\n   *\n   * @since 7.0.9\n   * @example \"Getting your location to provide better service\"\n   */\n  backgroundMessage?: string;\n  /**\n   * The title of the notification mentioned above.\n   *\n   * @since 7.0.9\n   * @default \"Using your location\"\n   * @example \"Location Service\"\n   */\n  backgroundTitle?: string;\n  /**\n   * Whether permissions should be requested from the user automatically,\n   * if they are not already granted.\n   *\n   * @since 7.0.9\n   * @default true\n   * @example\n   * // Auto-request permissions\n   * requestPermissions: true\n   *\n   * // Don't auto-request, handle manually\n   * requestPermissions: false\n   */\n  requestPermissions?: boolean;\n  /**\n   * If \"true\", stale locations may be delivered while the device\n   * obtains a GPS fix. You are responsible for checking the \"time\"\n   * property. If \"false\", locations are guaranteed to be up to date.\n   *\n   * @since 7.0.9\n   * @default false\n   * @example\n   * // Allow stale locations for faster initial response\n   * stale: true\n   *\n   * // Only fresh locations\n   * stale: false\n   */\n  stale?: boolean;\n  /**\n   * The distance in meters that the device must move before a new location update is triggered.\n   * This is used to filter out small movements and reduce the number of updates.\n   *\n   * @since 7.0.9\n   * @default 0\n   * @example\n   * // Update every 10 meters\n   * distanceFilter: 10\n   *\n   * // Update on any movement\n   * distanceFilter: 0\n   */\n  distanceFilter?: number;\n}\n\n/**\n * Represents a geographical location with various attributes.\n * Contains all the standard location properties returned by GPS/network providers.\n *\n * @since 7.0.0\n */\nexport interface Location {\n  /**\n   * Latitude in degrees.\n   * Range: -90.0 to +90.0\n   *\n   * @since 7.0.0\n   * @example 40.7128\n   */\n  latitude: number;\n  /**\n   * Longitude in degrees.\n   * Range: -180.0 to +180.0\n   *\n   * @since 7.0.0\n   * @example -74.0060\n   */\n  longitude: number;\n  /**\n   * Radius of horizontal uncertainty in metres, with 68% confidence.\n   * Lower values indicate more accurate location.\n   *\n   * @since 7.0.0\n   * @example 5.0\n   */\n  accuracy: number;\n  /**\n   * Metres above sea level (or null if not available).\n   *\n   * @since 7.0.0\n   * @example 10.5\n   */\n  altitude: number | null;\n  /**\n   * Vertical uncertainty in metres, with 68% confidence (or null if not available).\n   *\n   * @since 7.0.0\n   * @example 3.0\n   */\n  altitudeAccuracy: number | null;\n  /**\n   * `true` if the location was simulated by software, rather than GPS.\n   * Useful for detecting mock locations in development or testing.\n   *\n   * @since 7.0.0\n   * @example false\n   */\n  simulated: boolean;\n  /**\n   * Deviation from true north in degrees (or null if not available).\n   * Range: 0.0 to 360.0\n   *\n   * @since 7.0.0\n   * @example 45.5\n   */\n  bearing: number | null;\n  /**\n   * Speed in metres per second (or null if not available).\n   *\n   * @since 7.0.0\n   * @example 2.5\n   */\n  speed: number | null;\n  /**\n   * Time the location was produced, in milliseconds since the unix epoch.\n   * Use this to check if a location is stale when using stale: true.\n   *\n   * @since 7.0.0\n   * @example 1640995200000\n   */\n  time: number | null;\n}\n\n/**\n * Error object that may be passed to the location start callback.\n * Extends the standard Error with optional error codes.\n *\n * @since 7.0.0\n */\nexport interface CallbackError extends Error {\n  /**\n   * Optional error code for more specific error handling.\n   *\n   * @since 7.0.0\n   * @example \"PERMISSION_DENIED\"\n   */\n  code?: string;\n}\n\nexport interface PlaySoundOptions {\n  /**\n   * The name of the sound file to play.\n   * Must be a valid sound relative path in the app's public folder to work for both web and native platforms.\n   * There's no need to include the public folder in the path.\n   * @since 7.0.10\n   * @example \"notification.mp3\"\n   * */\n  soundFile: string;\n}\n\n/**\n * Main plugin interface for background geolocation functionality.\n * Provides methods to manage location updates and access device settings.\n *\n * @since 7.0.0\n */\nexport interface BackgroundGeolocationPlugin {\n  /**\n   * To start listening for changes in the device's location, call this method.\n   * A Promise is returned to indicate that it finished the call. The callback will be called every time a new location\n   * is available, or if there was an error when calling this method. Don't rely on promise rejection for this.\n   *\n   * @param options The configuration options\n   * @param callback The callback function invoked when a new location is available or an error occurs\n   * @returns A promise that resolves when the method is successfully called\n   *\n   * @since 7.0.9\n   * @example\n   * await BackgroundGeolocation.start(\n   *   {\n   *     backgroundMessage: \"App is using your location in the background\",\n   *     backgroundTitle: \"Location Service\",\n   *     requestPermissions: true,\n   *     stale: false,\n   *     distanceFilter: 10\n   *   },\n   *   (location, error) => {\n   *     if (error) {\n   *       console.error('Location error:', error);\n   *       return;\n   *     }\n   *     if (location) {\n   *       console.log('New location:', location.latitude, location.longitude);\n   *     }\n   *   }\n   * );\n   */\n  start(\n    options: StartOptions,\n    callback: (position?: Location, error?: CallbackError) => void,\n  ): Promise<void>;\n\n  /**\n   * Stops location updates.\n   *\n   * @returns A promise that resolves when the plugin stops successfully removed\n   *\n   * @since 7.0.9\n   * @example\n   * await BackgroundGeolocation.stop();\n   */\n  stop(): Promise<void>;\n\n  /**\n   * Opens the device's location settings page.\n   * Useful for directing users to enable location services or adjust permissions.\n   *\n   * @returns A promise that resolves when the settings page is opened\n   *\n   * @since 7.0.0\n   * @example\n   * // Direct user to location settings\n   * await BackgroundGeolocation.openSettings();\n   */\n  openSettings(): Promise<void>;\n\n  /**\n   * Plays a sound file.\n   * This should be used to play a sound, in the background too.\n   * The idea behind this is to allow the user to hear a sound when a new location is available or when going off track.\n   * If you simply need to play a sound, you can use `@capgo/native-audio` plugin instead.\n   * For Android, there's a need to start monitoring location updates first, otherwise the sound will not play.\n   *\n   * @param options The options for playing the sound\n   * @returns A promise that resolves when the sound is successfully played\n   *\n   * @since 7.0.10\n   * @example\n   * await BackgroundGeolocation.playSound({\n   *   soundFile: \"notification.mp3\"\n   * });\n   */\n  playSound(options: PlaySoundOptions): Promise<void>;\n}\n"]}

package/dist/esm/web.d.ts

@@ -1,8 +1,9 @@
 import { WebPlugin } from "@capacitor/core";
-import type { BackgroundGeolocationPlugin, StartOptions, Location, CallbackError } from "./definitions";
+import type { BackgroundGeolocationPlugin, StartOptions, Location, CallbackError, PlaySoundOptions } from "./definitions";
 export declare class BackgroundGeolocationWeb extends WebPlugin implements BackgroundGeolocationPlugin {
     private watchId;
     start(options: StartOptions, callback: (position?: Location, error?: CallbackError) => void): Promise<void>;
     stop(): Promise<void>;
     openSettings(): Promise<void>;
+    playSound(options: PlaySoundOptions): Promise<void>;
 }

package/dist/esm/web.js

@@ -53,5 +53,17 @@ export class BackgroundGeolocationWeb extends WebPlugin {
         console.log("openSettings: Web implementation cannot open native settings");
         window.alert("Please enable location permissions in your browser settings");
     }
+    async playSound(options) {
+        if (!options.soundFile) {
+            throw new Error("Sound file is required");
+        }
+        const audio = new Audio(options.soundFile);
+        try {
+            await audio.play();
+        }
+        catch (error) {
+            throw new Error(`Failed to play sound: ${error.message}`);
+        }
+    }
 }
 //# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -1 +1 @@
-{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAS5C,MAAM,OAAO,wBACX,SAAQ,SAAS;IAKjB,KAAK,CAAC,KAAK,CACT,OAAqB,EACrB,QAA8D;QAE9D,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;YAC3B,QAAQ,CAAC,SAAS,EAAE;gBAClB,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,8CAA8C;gBACvD,IAAI,EAAE,eAAe;aACtB,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,QAAQ,CAAC,SAAS,EAAE;gBAClB,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,6BAA6B;gBACtC,IAAI,EAAE,iBAAiB;aACxB,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,WAAW,CAAC,aAAa,CAChD,CAAC,QAAQ,EAAE,EAAE;YACX,MAAM,QAAQ,GAAa;gBACzB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;gBAClC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS;gBACpC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;gBAClC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;gBAClC,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB;gBAClD,SAAS,EAAE,KAAK;gBAChB,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO;gBAChC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK;gBAC5B,IAAI,EAAE,QAAQ,CAAC,SAAS;aACzB,CAAC;YACF,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACrB,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;YACR,MAAM,aAAa,GAAkB;gBACnC,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE;aAC5B,CAAC;YACF,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QACrC,CAAC,EACD;YACE,kBAAkB,EAAE,IAAI;YACxB,OAAO,EAAE,KAAK;YACd,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SACvC,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC/C,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;IACH,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,CAAC,GAAG,CAAC,8DAA8D,CAAC,CAAC;QAC5E,MAAM,CAAC,KAAK,CAAC,6DAA6D,CAAC,CAAC;IAC9E,CAAC;CACF","sourcesContent":["import { WebPlugin } from \"@capacitor/core\";\n\nimport type {\n  BackgroundGeolocationPlugin,\n  StartOptions,\n  Location,\n  CallbackError,\n} from \"./definitions\";\n\nexport class BackgroundGeolocationWeb\n  extends WebPlugin\n  implements BackgroundGeolocationPlugin\n{\n  private watchId: number | undefined;\n\n  async start(\n    options: StartOptions,\n    callback: (position?: Location, error?: CallbackError) => void,\n  ): Promise<void> {\n    if (!navigator.geolocation) {\n      callback(undefined, {\n        name: \"GeolocationError\",\n        message: \"Geolocation is not supported by this browser\",\n        code: \"NOT_SUPPORTED\",\n      });\n      return;\n    }\n\n    if (this.watchId) {\n      callback(undefined, {\n        name: \"GeolocationError\",\n        message: \"Geolocation already started\",\n        code: \"ALREADY_STARTED\",\n      });\n      return;\n    }\n\n    this.watchId = navigator.geolocation.watchPosition(\n      (position) => {\n        const location: Location = {\n          latitude: position.coords.latitude,\n          longitude: position.coords.longitude,\n          accuracy: position.coords.accuracy,\n          altitude: position.coords.altitude,\n          altitudeAccuracy: position.coords.altitudeAccuracy,\n          simulated: false,\n          bearing: position.coords.heading,\n          speed: position.coords.speed,\n          time: position.timestamp,\n        };\n        callback(location);\n      },\n      (error) => {\n        const callbackError: CallbackError = {\n          name: \"GeolocationError\",\n          message: error.message,\n          code: error.code.toString(),\n        };\n        callback(undefined, callbackError);\n      },\n      {\n        enableHighAccuracy: true,\n        timeout: 10000,\n        maximumAge: options.stale ? 300000 : 0,\n      },\n    );\n  }\n\n  async stop(): Promise<void> {\n    if (this.watchId) {\n      navigator.geolocation.clearWatch(this.watchId);\n      delete this.watchId;\n    }\n  }\n\n  async openSettings(): Promise<void> {\n    console.log(\"openSettings: Web implementation cannot open native settings\");\n    window.alert(\"Please enable location permissions in your browser settings\");\n  }\n}\n"]}
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAU5C,MAAM,OAAO,wBACX,SAAQ,SAAS;IAKjB,KAAK,CAAC,KAAK,CACT,OAAqB,EACrB,QAA8D;QAE9D,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;YAC3B,QAAQ,CAAC,SAAS,EAAE;gBAClB,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,8CAA8C;gBACvD,IAAI,EAAE,eAAe;aACtB,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,QAAQ,CAAC,SAAS,EAAE;gBAClB,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,6BAA6B;gBACtC,IAAI,EAAE,iBAAiB;aACxB,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,WAAW,CAAC,aAAa,CAChD,CAAC,QAAQ,EAAE,EAAE;YACX,MAAM,QAAQ,GAAa;gBACzB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;gBAClC,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS;gBACpC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;gBAClC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;gBAClC,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB;gBAClD,SAAS,EAAE,KAAK;gBAChB,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO;gBAChC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK;gBAC5B,IAAI,EAAE,QAAQ,CAAC,SAAS;aACzB,CAAC;YACF,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACrB,CAAC,EACD,CAAC,KAAK,EAAE,EAAE;YACR,MAAM,aAAa,GAAkB;gBACnC,IAAI,EAAE,kBAAkB;gBACxB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE;aAC5B,CAAC;YACF,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QACrC,CAAC,EACD;YACE,kBAAkB,EAAE,IAAI;YACxB,OAAO,EAAE,KAAK;YACd,UAAU,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;SACvC,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAC/C,OAAO,IAAI,CAAC,OAAO,CAAC;QACtB,CAAC;IACH,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,CAAC,GAAG,CAAC,8DAA8D,CAAC,CAAC;QAC5E,MAAM,CAAC,KAAK,CAAC,6DAA6D,CAAC,CAAC;IAC9E,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,OAAyB;QACvC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QAC5C,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAC3C,IAAI,CAAC;YACH,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC;QACrB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,yBAA0B,KAAe,CAAC,OAAO,EAAE,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;CACF","sourcesContent":["import { WebPlugin } from \"@capacitor/core\";\n\nimport type {\n  BackgroundGeolocationPlugin,\n  StartOptions,\n  Location,\n  CallbackError,\n  PlaySoundOptions,\n} from \"./definitions\";\n\nexport class BackgroundGeolocationWeb\n  extends WebPlugin\n  implements BackgroundGeolocationPlugin\n{\n  private watchId: number | undefined;\n\n  async start(\n    options: StartOptions,\n    callback: (position?: Location, error?: CallbackError) => void,\n  ): Promise<void> {\n    if (!navigator.geolocation) {\n      callback(undefined, {\n        name: \"GeolocationError\",\n        message: \"Geolocation is not supported by this browser\",\n        code: \"NOT_SUPPORTED\",\n      });\n      return;\n    }\n\n    if (this.watchId) {\n      callback(undefined, {\n        name: \"GeolocationError\",\n        message: \"Geolocation already started\",\n        code: \"ALREADY_STARTED\",\n      });\n      return;\n    }\n\n    this.watchId = navigator.geolocation.watchPosition(\n      (position) => {\n        const location: Location = {\n          latitude: position.coords.latitude,\n          longitude: position.coords.longitude,\n          accuracy: position.coords.accuracy,\n          altitude: position.coords.altitude,\n          altitudeAccuracy: position.coords.altitudeAccuracy,\n          simulated: false,\n          bearing: position.coords.heading,\n          speed: position.coords.speed,\n          time: position.timestamp,\n        };\n        callback(location);\n      },\n      (error) => {\n        const callbackError: CallbackError = {\n          name: \"GeolocationError\",\n          message: error.message,\n          code: error.code.toString(),\n        };\n        callback(undefined, callbackError);\n      },\n      {\n        enableHighAccuracy: true,\n        timeout: 10000,\n        maximumAge: options.stale ? 300000 : 0,\n      },\n    );\n  }\n\n  async stop(): Promise<void> {\n    if (this.watchId) {\n      navigator.geolocation.clearWatch(this.watchId);\n      delete this.watchId;\n    }\n  }\n\n  async openSettings(): Promise<void> {\n    console.log(\"openSettings: Web implementation cannot open native settings\");\n    window.alert(\"Please enable location permissions in your browser settings\");\n  }\n\n  async playSound(options: PlaySoundOptions): Promise<void> {\n    if (!options.soundFile) {\n      throw new Error(\"Sound file is required\");\n    }\n    const audio = new Audio(options.soundFile);\n    try {\n      await audio.play();\n    } catch (error) {\n      throw new Error(`Failed to play sound: ${(error as Error).message}`);\n    }\n  }\n}\n"]}

package/dist/plugin.cjs.js

@@ -60,6 +60,18 @@ class BackgroundGeolocationWeb extends core.WebPlugin {
         console.log("openSettings: Web implementation cannot open native settings");
         window.alert("Please enable location permissions in your browser settings");
     }
+    async playSound(options) {
+        if (!options.soundFile) {
+            throw new Error("Sound file is required");
+        }
+        const audio = new Audio(options.soundFile);
+        try {
+            await audio.play();
+        }
+        catch (error) {
+            throw new Error(`Failed to play sound: ${error.message}`);
+        }
+    }
 }
 
 var web = /*#__PURE__*/Object.freeze({

package/dist/plugin.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from \"@capacitor/core\";\nconst BackgroundGeolocation = registerPlugin(\"BackgroundGeolocation\", {\n    web: () => import(\"./web\").then((m) => new m.BackgroundGeolocationWeb()),\n});\nexport * from \"./definitions\";\nexport { BackgroundGeolocation };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from \"@capacitor/core\";\nexport class BackgroundGeolocationWeb extends WebPlugin {\n    async start(options, callback) {\n        if (!navigator.geolocation) {\n            callback(undefined, {\n                name: \"GeolocationError\",\n                message: \"Geolocation is not supported by this browser\",\n                code: \"NOT_SUPPORTED\",\n            });\n            return;\n        }\n        if (this.watchId) {\n            callback(undefined, {\n                name: \"GeolocationError\",\n                message: \"Geolocation already started\",\n                code: \"ALREADY_STARTED\",\n            });\n            return;\n        }\n        this.watchId = navigator.geolocation.watchPosition((position) => {\n            const location = {\n                latitude: position.coords.latitude,\n                longitude: position.coords.longitude,\n                accuracy: position.coords.accuracy,\n                altitude: position.coords.altitude,\n                altitudeAccuracy: position.coords.altitudeAccuracy,\n                simulated: false,\n                bearing: position.coords.heading,\n                speed: position.coords.speed,\n                time: position.timestamp,\n            };\n            callback(location);\n        }, (error) => {\n            const callbackError = {\n                name: \"GeolocationError\",\n                message: error.message,\n                code: error.code.toString(),\n            };\n            callback(undefined, callbackError);\n        }, {\n            enableHighAccuracy: true,\n            timeout: 10000,\n            maximumAge: options.stale ? 300000 : 0,\n        });\n    }\n    async stop() {\n        if (this.watchId) {\n            navigator.geolocation.clearWatch(this.watchId);\n            delete this.watchId;\n        }\n    }\n    async openSettings() {\n        console.log(\"openSettings: Web implementation cannot open native settings\");\n        window.alert(\"Please enable location permissions in your browser settings\");\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,qBAAqB,GAAGA,mBAAc,CAAC,uBAAuB,EAAE;AACtE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,wBAAwB,EAAE,CAAC;AAC5E,CAAC;;ACFM,MAAM,wBAAwB,SAASC,cAAS,CAAC;AACxD,IAAI,MAAM,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE;AACnC,QAAQ,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE;AACpC,YAAY,QAAQ,CAAC,SAAS,EAAE;AAChC,gBAAgB,IAAI,EAAE,kBAAkB;AACxC,gBAAgB,OAAO,EAAE,8CAA8C;AACvE,gBAAgB,IAAI,EAAE,eAAe;AACrC,aAAa,CAAC;AACd,YAAY;AACZ,QAAQ;AACR,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE;AAC1B,YAAY,QAAQ,CAAC,SAAS,EAAE;AAChC,gBAAgB,IAAI,EAAE,kBAAkB;AACxC,gBAAgB,OAAO,EAAE,6BAA6B;AACtD,gBAAgB,IAAI,EAAE,iBAAiB;AACvC,aAAa,CAAC;AACd,YAAY;AACZ,QAAQ;AACR,QAAQ,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,QAAQ,KAAK;AACzE,YAAY,MAAM,QAAQ,GAAG;AAC7B,gBAAgB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;AAClD,gBAAgB,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS;AACpD,gBAAgB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;AAClD,gBAAgB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;AAClD,gBAAgB,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB;AAClE,gBAAgB,SAAS,EAAE,KAAK;AAChC,gBAAgB,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO;AAChD,gBAAgB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK;AAC5C,gBAAgB,IAAI,EAAE,QAAQ,CAAC,SAAS;AACxC,aAAa;AACb,YAAY,QAAQ,CAAC,QAAQ,CAAC;AAC9B,QAAQ,CAAC,EAAE,CAAC,KAAK,KAAK;AACtB,YAAY,MAAM,aAAa,GAAG;AAClC,gBAAgB,IAAI,EAAE,kBAAkB;AACxC,gBAAgB,OAAO,EAAE,KAAK,CAAC,OAAO;AACtC,gBAAgB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE;AAC3C,aAAa;AACb,YAAY,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;AAC9C,QAAQ,CAAC,EAAE;AACX,YAAY,kBAAkB,EAAE,IAAI;AACpC,YAAY,OAAO,EAAE,KAAK;AAC1B,YAAY,UAAU,EAAE,OAAO,CAAC,KAAK,GAAG,MAAM,GAAG,CAAC;AAClD,SAAS,CAAC;AACV,IAAI;AACJ,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE;AAC1B,YAAY,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC;AAC1D,YAAY,OAAO,IAAI,CAAC,OAAO;AAC/B,QAAQ;AACR,IAAI;AACJ,IAAI,MAAM,YAAY,GAAG;AACzB,QAAQ,OAAO,CAAC,GAAG,CAAC,8DAA8D,CAAC;AACnF,QAAQ,MAAM,CAAC,KAAK,CAAC,6DAA6D,CAAC;AACnF,IAAI;AACJ;;;;;;;;;"}
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from \"@capacitor/core\";\nconst BackgroundGeolocation = registerPlugin(\"BackgroundGeolocation\", {\n    web: () => import(\"./web\").then((m) => new m.BackgroundGeolocationWeb()),\n});\nexport * from \"./definitions\";\nexport { BackgroundGeolocation };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from \"@capacitor/core\";\nexport class BackgroundGeolocationWeb extends WebPlugin {\n    async start(options, callback) {\n        if (!navigator.geolocation) {\n            callback(undefined, {\n                name: \"GeolocationError\",\n                message: \"Geolocation is not supported by this browser\",\n                code: \"NOT_SUPPORTED\",\n            });\n            return;\n        }\n        if (this.watchId) {\n            callback(undefined, {\n                name: \"GeolocationError\",\n                message: \"Geolocation already started\",\n                code: \"ALREADY_STARTED\",\n            });\n            return;\n        }\n        this.watchId = navigator.geolocation.watchPosition((position) => {\n            const location = {\n                latitude: position.coords.latitude,\n                longitude: position.coords.longitude,\n                accuracy: position.coords.accuracy,\n                altitude: position.coords.altitude,\n                altitudeAccuracy: position.coords.altitudeAccuracy,\n                simulated: false,\n                bearing: position.coords.heading,\n                speed: position.coords.speed,\n                time: position.timestamp,\n            };\n            callback(location);\n        }, (error) => {\n            const callbackError = {\n                name: \"GeolocationError\",\n                message: error.message,\n                code: error.code.toString(),\n            };\n            callback(undefined, callbackError);\n        }, {\n            enableHighAccuracy: true,\n            timeout: 10000,\n            maximumAge: options.stale ? 300000 : 0,\n        });\n    }\n    async stop() {\n        if (this.watchId) {\n            navigator.geolocation.clearWatch(this.watchId);\n            delete this.watchId;\n        }\n    }\n    async openSettings() {\n        console.log(\"openSettings: Web implementation cannot open native settings\");\n        window.alert(\"Please enable location permissions in your browser settings\");\n    }\n    async playSound(options) {\n        if (!options.soundFile) {\n            throw new Error(\"Sound file is required\");\n        }\n        const audio = new Audio(options.soundFile);\n        try {\n            await audio.play();\n        }\n        catch (error) {\n            throw new Error(`Failed to play sound: ${error.message}`);\n        }\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,qBAAqB,GAAGA,mBAAc,CAAC,uBAAuB,EAAE;AACtE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,wBAAwB,EAAE,CAAC;AAC5E,CAAC;;ACFM,MAAM,wBAAwB,SAASC,cAAS,CAAC;AACxD,IAAI,MAAM,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE;AACnC,QAAQ,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE;AACpC,YAAY,QAAQ,CAAC,SAAS,EAAE;AAChC,gBAAgB,IAAI,EAAE,kBAAkB;AACxC,gBAAgB,OAAO,EAAE,8CAA8C;AACvE,gBAAgB,IAAI,EAAE,eAAe;AACrC,aAAa,CAAC;AACd,YAAY;AACZ,QAAQ;AACR,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE;AAC1B,YAAY,QAAQ,CAAC,SAAS,EAAE;AAChC,gBAAgB,IAAI,EAAE,kBAAkB;AACxC,gBAAgB,OAAO,EAAE,6BAA6B;AACtD,gBAAgB,IAAI,EAAE,iBAAiB;AACvC,aAAa,CAAC;AACd,YAAY;AACZ,QAAQ;AACR,QAAQ,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,QAAQ,KAAK;AACzE,YAAY,MAAM,QAAQ,GAAG;AAC7B,gBAAgB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;AAClD,gBAAgB,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS;AACpD,gBAAgB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;AAClD,gBAAgB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;AAClD,gBAAgB,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB;AAClE,gBAAgB,SAAS,EAAE,KAAK;AAChC,gBAAgB,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO;AAChD,gBAAgB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK;AAC5C,gBAAgB,IAAI,EAAE,QAAQ,CAAC,SAAS;AACxC,aAAa;AACb,YAAY,QAAQ,CAAC,QAAQ,CAAC;AAC9B,QAAQ,CAAC,EAAE,CAAC,KAAK,KAAK;AACtB,YAAY,MAAM,aAAa,GAAG;AAClC,gBAAgB,IAAI,EAAE,kBAAkB;AACxC,gBAAgB,OAAO,EAAE,KAAK,CAAC,OAAO;AACtC,gBAAgB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE;AAC3C,aAAa;AACb,YAAY,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;AAC9C,QAAQ,CAAC,EAAE;AACX,YAAY,kBAAkB,EAAE,IAAI;AACpC,YAAY,OAAO,EAAE,KAAK;AAC1B,YAAY,UAAU,EAAE,OAAO,CAAC,KAAK,GAAG,MAAM,GAAG,CAAC;AAClD,SAAS,CAAC;AACV,IAAI;AACJ,IAAI,MAAM,IAAI,GAAG;AACjB,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE;AAC1B,YAAY,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC;AAC1D,YAAY,OAAO,IAAI,CAAC,OAAO;AAC/B,QAAQ;AACR,IAAI;AACJ,IAAI,MAAM,YAAY,GAAG;AACzB,QAAQ,OAAO,CAAC,GAAG,CAAC,8DAA8D,CAAC;AACnF,QAAQ,MAAM,CAAC,KAAK,CAAC,6DAA6D,CAAC;AACnF,IAAI;AACJ,IAAI,MAAM,SAAS,CAAC,OAAO,EAAE;AAC7B,QAAQ,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;AAChC,YAAY,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC;AACrD,QAAQ;AACR,QAAQ,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;AAClD,QAAQ,IAAI;AACZ,YAAY,MAAM,KAAK,CAAC,IAAI,EAAE;AAC9B,QAAQ;AACR,QAAQ,OAAO,KAAK,EAAE;AACtB,YAAY,MAAM,IAAI,KAAK,CAAC,CAAC,sBAAsB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;AACrE,QAAQ;AACR,IAAI;AACJ;;;;;;;;;"}

package/dist/plugin.js

@@ -59,6 +59,18 @@ var capacitorBackgroundGeolocation = (function (exports, core) {
             console.log("openSettings: Web implementation cannot open native settings");
             window.alert("Please enable location permissions in your browser settings");
         }
+        async playSound(options) {
+            if (!options.soundFile) {
+                throw new Error("Sound file is required");
+            }
+            const audio = new Audio(options.soundFile);
+            try {
+                await audio.play();
+            }
+            catch (error) {
+                throw new Error(`Failed to play sound: ${error.message}`);
+            }
+        }
     }
 
     var web = /*#__PURE__*/Object.freeze({

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from \"@capacitor/core\";\nconst BackgroundGeolocation = registerPlugin(\"BackgroundGeolocation\", {\n    web: () => import(\"./web\").then((m) => new m.BackgroundGeolocationWeb()),\n});\nexport * from \"./definitions\";\nexport { BackgroundGeolocation };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from \"@capacitor/core\";\nexport class BackgroundGeolocationWeb extends WebPlugin {\n    async start(options, callback) {\n        if (!navigator.geolocation) {\n            callback(undefined, {\n                name: \"GeolocationError\",\n                message: \"Geolocation is not supported by this browser\",\n                code: \"NOT_SUPPORTED\",\n            });\n            return;\n        }\n        if (this.watchId) {\n            callback(undefined, {\n                name: \"GeolocationError\",\n                message: \"Geolocation already started\",\n                code: \"ALREADY_STARTED\",\n            });\n            return;\n        }\n        this.watchId = navigator.geolocation.watchPosition((position) => {\n            const location = {\n                latitude: position.coords.latitude,\n                longitude: position.coords.longitude,\n                accuracy: position.coords.accuracy,\n                altitude: position.coords.altitude,\n                altitudeAccuracy: position.coords.altitudeAccuracy,\n                simulated: false,\n                bearing: position.coords.heading,\n                speed: position.coords.speed,\n                time: position.timestamp,\n            };\n            callback(location);\n        }, (error) => {\n            const callbackError = {\n                name: \"GeolocationError\",\n                message: error.message,\n                code: error.code.toString(),\n            };\n            callback(undefined, callbackError);\n        }, {\n            enableHighAccuracy: true,\n            timeout: 10000,\n            maximumAge: options.stale ? 300000 : 0,\n        });\n    }\n    async stop() {\n        if (this.watchId) {\n            navigator.geolocation.clearWatch(this.watchId);\n            delete this.watchId;\n        }\n    }\n    async openSettings() {\n        console.log(\"openSettings: Web implementation cannot open native settings\");\n        window.alert(\"Please enable location permissions in your browser settings\");\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,qBAAqB,GAAGA,mBAAc,CAAC,uBAAuB,EAAE;IACtE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,wBAAwB,EAAE,CAAC;IAC5E,CAAC;;ICFM,MAAM,wBAAwB,SAASC,cAAS,CAAC;IACxD,IAAI,MAAM,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE;IACnC,QAAQ,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE;IACpC,YAAY,QAAQ,CAAC,SAAS,EAAE;IAChC,gBAAgB,IAAI,EAAE,kBAAkB;IACxC,gBAAgB,OAAO,EAAE,8CAA8C;IACvE,gBAAgB,IAAI,EAAE,eAAe;IACrC,aAAa,CAAC;IACd,YAAY;IACZ,QAAQ;IACR,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE;IAC1B,YAAY,QAAQ,CAAC,SAAS,EAAE;IAChC,gBAAgB,IAAI,EAAE,kBAAkB;IACxC,gBAAgB,OAAO,EAAE,6BAA6B;IACtD,gBAAgB,IAAI,EAAE,iBAAiB;IACvC,aAAa,CAAC;IACd,YAAY;IACZ,QAAQ;IACR,QAAQ,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,QAAQ,KAAK;IACzE,YAAY,MAAM,QAAQ,GAAG;IAC7B,gBAAgB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;IAClD,gBAAgB,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS;IACpD,gBAAgB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;IAClD,gBAAgB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;IAClD,gBAAgB,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB;IAClE,gBAAgB,SAAS,EAAE,KAAK;IAChC,gBAAgB,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO;IAChD,gBAAgB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK;IAC5C,gBAAgB,IAAI,EAAE,QAAQ,CAAC,SAAS;IACxC,aAAa;IACb,YAAY,QAAQ,CAAC,QAAQ,CAAC;IAC9B,QAAQ,CAAC,EAAE,CAAC,KAAK,KAAK;IACtB,YAAY,MAAM,aAAa,GAAG;IAClC,gBAAgB,IAAI,EAAE,kBAAkB;IACxC,gBAAgB,OAAO,EAAE,KAAK,CAAC,OAAO;IACtC,gBAAgB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE;IAC3C,aAAa;IACb,YAAY,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;IAC9C,QAAQ,CAAC,EAAE;IACX,YAAY,kBAAkB,EAAE,IAAI;IACpC,YAAY,OAAO,EAAE,KAAK;IAC1B,YAAY,UAAU,EAAE,OAAO,CAAC,KAAK,GAAG,MAAM,GAAG,CAAC;IAClD,SAAS,CAAC;IACV,IAAI;IACJ,IAAI,MAAM,IAAI,GAAG;IACjB,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE;IAC1B,YAAY,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC;IAC1D,YAAY,OAAO,IAAI,CAAC,OAAO;IAC/B,QAAQ;IACR,IAAI;IACJ,IAAI,MAAM,YAAY,GAAG;IACzB,QAAQ,OAAO,CAAC,GAAG,CAAC,8DAA8D,CAAC;IACnF,QAAQ,MAAM,CAAC,KAAK,CAAC,6DAA6D,CAAC;IACnF,IAAI;IACJ;;;;;;;;;;;;;;;"}
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from \"@capacitor/core\";\nconst BackgroundGeolocation = registerPlugin(\"BackgroundGeolocation\", {\n    web: () => import(\"./web\").then((m) => new m.BackgroundGeolocationWeb()),\n});\nexport * from \"./definitions\";\nexport { BackgroundGeolocation };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from \"@capacitor/core\";\nexport class BackgroundGeolocationWeb extends WebPlugin {\n    async start(options, callback) {\n        if (!navigator.geolocation) {\n            callback(undefined, {\n                name: \"GeolocationError\",\n                message: \"Geolocation is not supported by this browser\",\n                code: \"NOT_SUPPORTED\",\n            });\n            return;\n        }\n        if (this.watchId) {\n            callback(undefined, {\n                name: \"GeolocationError\",\n                message: \"Geolocation already started\",\n                code: \"ALREADY_STARTED\",\n            });\n            return;\n        }\n        this.watchId = navigator.geolocation.watchPosition((position) => {\n            const location = {\n                latitude: position.coords.latitude,\n                longitude: position.coords.longitude,\n                accuracy: position.coords.accuracy,\n                altitude: position.coords.altitude,\n                altitudeAccuracy: position.coords.altitudeAccuracy,\n                simulated: false,\n                bearing: position.coords.heading,\n                speed: position.coords.speed,\n                time: position.timestamp,\n            };\n            callback(location);\n        }, (error) => {\n            const callbackError = {\n                name: \"GeolocationError\",\n                message: error.message,\n                code: error.code.toString(),\n            };\n            callback(undefined, callbackError);\n        }, {\n            enableHighAccuracy: true,\n            timeout: 10000,\n            maximumAge: options.stale ? 300000 : 0,\n        });\n    }\n    async stop() {\n        if (this.watchId) {\n            navigator.geolocation.clearWatch(this.watchId);\n            delete this.watchId;\n        }\n    }\n    async openSettings() {\n        console.log(\"openSettings: Web implementation cannot open native settings\");\n        window.alert(\"Please enable location permissions in your browser settings\");\n    }\n    async playSound(options) {\n        if (!options.soundFile) {\n            throw new Error(\"Sound file is required\");\n        }\n        const audio = new Audio(options.soundFile);\n        try {\n            await audio.play();\n        }\n        catch (error) {\n            throw new Error(`Failed to play sound: ${error.message}`);\n        }\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,qBAAqB,GAAGA,mBAAc,CAAC,uBAAuB,EAAE;IACtE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,wBAAwB,EAAE,CAAC;IAC5E,CAAC;;ICFM,MAAM,wBAAwB,SAASC,cAAS,CAAC;IACxD,IAAI,MAAM,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE;IACnC,QAAQ,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE;IACpC,YAAY,QAAQ,CAAC,SAAS,EAAE;IAChC,gBAAgB,IAAI,EAAE,kBAAkB;IACxC,gBAAgB,OAAO,EAAE,8CAA8C;IACvE,gBAAgB,IAAI,EAAE,eAAe;IACrC,aAAa,CAAC;IACd,YAAY;IACZ,QAAQ;IACR,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE;IAC1B,YAAY,QAAQ,CAAC,SAAS,EAAE;IAChC,gBAAgB,IAAI,EAAE,kBAAkB;IACxC,gBAAgB,OAAO,EAAE,6BAA6B;IACtD,gBAAgB,IAAI,EAAE,iBAAiB;IACvC,aAAa,CAAC;IACd,YAAY;IACZ,QAAQ;IACR,QAAQ,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,QAAQ,KAAK;IACzE,YAAY,MAAM,QAAQ,GAAG;IAC7B,gBAAgB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;IAClD,gBAAgB,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS;IACpD,gBAAgB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;IAClD,gBAAgB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,QAAQ;IAClD,gBAAgB,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB;IAClE,gBAAgB,SAAS,EAAE,KAAK;IAChC,gBAAgB,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO;IAChD,gBAAgB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK;IAC5C,gBAAgB,IAAI,EAAE,QAAQ,CAAC,SAAS;IACxC,aAAa;IACb,YAAY,QAAQ,CAAC,QAAQ,CAAC;IAC9B,QAAQ,CAAC,EAAE,CAAC,KAAK,KAAK;IACtB,YAAY,MAAM,aAAa,GAAG;IAClC,gBAAgB,IAAI,EAAE,kBAAkB;IACxC,gBAAgB,OAAO,EAAE,KAAK,CAAC,OAAO;IACtC,gBAAgB,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE;IAC3C,aAAa;IACb,YAAY,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;IAC9C,QAAQ,CAAC,EAAE;IACX,YAAY,kBAAkB,EAAE,IAAI;IACpC,YAAY,OAAO,EAAE,KAAK;IAC1B,YAAY,UAAU,EAAE,OAAO,CAAC,KAAK,GAAG,MAAM,GAAG,CAAC;IAClD,SAAS,CAAC;IACV,IAAI;IACJ,IAAI,MAAM,IAAI,GAAG;IACjB,QAAQ,IAAI,IAAI,CAAC,OAAO,EAAE;IAC1B,YAAY,SAAS,CAAC,WAAW,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC;IAC1D,YAAY,OAAO,IAAI,CAAC,OAAO;IAC/B,QAAQ;IACR,IAAI;IACJ,IAAI,MAAM,YAAY,GAAG;IACzB,QAAQ,OAAO,CAAC,GAAG,CAAC,8DAA8D,CAAC;IACnF,QAAQ,MAAM,CAAC,KAAK,CAAC,6DAA6D,CAAC;IACnF,IAAI;IACJ,IAAI,MAAM,SAAS,CAAC,OAAO,EAAE;IAC7B,QAAQ,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;IAChC,YAAY,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC;IACrD,QAAQ;IACR,QAAQ,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC;IAClD,QAAQ,IAAI;IACZ,YAAY,MAAM,KAAK,CAAC,IAAI,EAAE;IAC9B,QAAQ;IACR,QAAQ,OAAO,KAAK,EAAE;IACtB,YAAY,MAAM,IAAI,KAAK,CAAC,CAAC,sBAAsB,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IACrE,QAAQ;IACR,IAAI;IACJ;;;;;;;;;;;;;;;"}

package/ios/Plugin/Plugin.m

@@ -5,4 +5,5 @@ CAP_PLUGIN(BackgroundGeolocation, "BackgroundGeolocation",
     CAP_PLUGIN_METHOD(start, CAPPluginReturnCallback);
     CAP_PLUGIN_METHOD(stop, CAPPluginReturnPromise);
     CAP_PLUGIN_METHOD(openSettings, CAPPluginReturnPromise);
+    CAP_PLUGIN_METHOD(playSound, CAPPluginReturnPromise);
 )

package/ios/Plugin/Plugin.swift

@@ -2,6 +2,7 @@ import Capacitor
 import Foundation
 import UIKit
 import CoreLocation
+import AVFoundation
 
 // Avoids a bewildering type warning.
 let null = Optional<Double>.none as Any
@@ -40,6 +41,7 @@ public class BackgroundGeolocation: CAPPlugin, CLLocationManagerDelegate {
     private var allowStale: Bool = false
     private var isUpdatingLocation: Bool = false
     private var activeCallbackId: String?
+    private var audioPlayer: AVAudioPlayer?
 
     @objc override public func load() {
         UIDevice.current.isBatteryMonitoringEnabled = true
@@ -171,6 +173,30 @@ public class BackgroundGeolocation: CAPPlugin, CLLocationManagerDelegate {
         )
     }
 
+    @objc func playSound(_ call: CAPPluginCall) {
+        // Use a background queue for audio loading to avoid blocking the main thread
+        DispatchQueue.global(qos: .background).async { [weak self] in
+            guard let self = self else { return }
+
+            let assetPath = "public/" + (call.getString("soundFile") ?? "")
+            let assetPathSplit = assetPath.components(separatedBy: ".")
+            guard let url = Bundle.main.url(forResource: assetPathSplit[0], withExtension: assetPathSplit[1]) else {
+                call.reject("Sound file not found: \(assetPath)")
+                return
+            }
+
+            do {
+                self.audioPlayer?.stop()
+                self.audioPlayer = nil
+                self.audioPlayer = try AVAudioPlayer(contentsOf: url)
+                self.audioPlayer?.play()
+                call.resolve()
+            } catch {
+                call.reject("Could not play the sound file: \(error.localizedDescription)")
+            }
+        }
+    }
+
     public func locationManager(
         _ manager: CLLocationManager,
         didFailWithError error: Error

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@capgo/background-geolocation",
-    "version": "7.0.9",
+    "version": "7.0.10",
     "description": "Receive geolocation updates even while the app is in the background.",
     "main": "dist/plugin.cjs.js",
     "module": "dist/esm/index.js",