feat: Implement playing audio in background

README.md

@@ -101,6 +101,8 @@ The following constants are reported as the only parameter to the
 
 - `media.play`: Start or resume playing an audio file.
 
+- `media.playInBackground`: Start or resume playing an audio file in background.
+
 - `media.pause`: Pause playback of an audio file.
 
 - `media.pauseRecord`: Pause recording of an audio file.
@@ -364,6 +366,41 @@ function playAudio(url) {
         var myMedia = new Media("audio/beer.mp3")
         myMedia.play()  // first looks for file in www/audio/beer.mp3 then in <application>/documents/tmp/audio/beer.mp3
 
+## media.playInBackground
+
+Starts or resumes playing an audio file in background.
+
+```js
+media.playInBackground();
+```
+
+### Supported Platforms
+
+- Android
+- iOS
+
+### Quick Example
+
+```js
+// Play audio in background
+//
+function playAudioInBackground(url) {
+    // Play the audio file at url
+    var my_media = new Media(url,
+        // success callback
+        function () {
+            console.log("playAudioInBackground():Audio Success");
+        },
+        // error callback
+        function (err) {
+            console.log("playAudioInBackground():Audio Error: " + err);
+        }
+    );
+    // Play audio
+    my_media.playInBackground();
+}
+```
+
 ## media.release
 
 Releases the underlying operating system's audio resources.
@@ -556,7 +593,7 @@ function recordAudio() {
 
 This plugins requires the following usage description:
 
-* `NSMicrophoneUsageDescription` describes the reason that the app accesses the user's microphone. 
+* `NSMicrophoneUsageDescription` describes the reason that the app accesses the user's microphone.
 
 To add this entry into the `info.plist`, you can use the `edit-config` tag in the `config.xml` like this:
 

src/android/AudioHandler.java

@@ -137,6 +137,17 @@ else if (action.equals("startPlayingAudio")) {
             }
             this.startPlayingAudio(args.getString(0), FileHelper.stripFileProtocol(fileUriStr));
         }
+        else if (action.equals("startPlayingAudioInBackground")) {
+            String target = args.getString(1);
+            String fileUriStr;
+            try {
+                Uri targetUri = resourceApi.remapUri(Uri.parse(target));
+                fileUriStr = targetUri.toString();
+            } catch (IllegalArgumentException e) {
+                fileUriStr = target;
+            }
+            this.startPlayingAudioInBackground(args.getString(0), FileHelper.stripFileProtocol(fileUriStr));
+        }
         else if (action.equals("seekToAudio")) {
             this.seekToAudio(args.getString(0), args.getInt(1));
         }
@@ -321,6 +332,14 @@ public void startPlayingAudio(String id, String file) {
         getAudioFocus();
     }
 
+    public void startPlayingAudioInBackground(final String id, final String file) {
+      cordova.getThreadPool().execute(new Runnable() {
+        public void run() {
+          startPlayingAudio(id, file);
+        }
+      });
+    }
+
     /**
      * Seek to a location.
      * @param id				The id of the audio player

src/ios/CDVSound.h

@@ -95,6 +95,7 @@ typedef NSUInteger CDVMediaMsg;
 @property (nonatomic, strong) NSString* statusCallbackId;
 
 - (void)startPlayingAudio:(CDVInvokedUrlCommand*)command;
+- (void)startPlayingAudioInBackground:(CDVInvokedUrlCommand*)command;
 - (void)pausePlayingAudio:(CDVInvokedUrlCommand*)command;
 - (void)stopPlayingAudio:(CDVInvokedUrlCommand*)command;
 - (void)seekToAudio:(CDVInvokedUrlCommand*)command;

src/ios/CDVSound.m

@@ -338,6 +338,11 @@ - (void)setRate:(CDVInvokedUrlCommand*)command
     // don't care for any callbacks
 }
 
+- (void)startPlayingAudioInBackground:(CDVInvokedUrlCommand*)command
+{
+    [self startPlayingAudio:command];
+}
+
 - (void)startPlayingAudio:(CDVInvokedUrlCommand*)command
 {
     [self.commandDelegate runInBackground:^{
@@ -839,7 +844,7 @@ - (void)onMemoryWarning
 {
     /* https://issues.apache.org/jira/browse/CB-11513 */
     NSMutableArray* keysToRemove = [[NSMutableArray alloc] init];
-    
+
     for(id key in [self soundCache]) {
         CDVAudioFile* audioFile = [[self soundCache] objectForKey:key];
         if (audioFile != nil) {
@@ -851,9 +856,9 @@ - (void)onMemoryWarning
             }
         }
     }
-    
+
     [[self soundCache] removeObjectsForKeys:keysToRemove];
-    
+
     // [[self soundCache] removeAllObjects];
     // [self setSoundCache:nil];
     [self setAvSession:nil];

www/Media.js

@@ -76,6 +76,13 @@ Media.prototype.play = function(options) {
     exec(null, null, "Media", "startPlayingAudio", [this.id, this.src, options]);
 };
 
+/**
+ * Start or resume playing audio file in a background thread.
+ */
+Media.prototype.playInBackground = function(options) {
+    exec(null, null, "Media", "startPlayingAudioInBackground", [this.id, this.src, options]);
+};
+
 /**
  * Stop playing audio file.
  */