capacitor-plugin-playlist 0.10.10 → 0.11.0

package/README.md

@@ -49,7 +49,7 @@ Requires **Capacitor 8+** (peer dependency `@capacitor/core >= 8.0.0`).
 
 ### Background audio
 
-- Android: foreground media service with `WAKE_LOCK` and `FOREGROUND_SERVICE_MEDIA_PLAYBACK` (Android 14+)
+- Android: foreground media service with `WAKE_LOCK`, `FOREGROUND_SERVICE`, and `FOREGROUND_SERVICE_MEDIA_PLAYBACK` (Android 14+)
 - iOS: `UIBackgroundModes` → `audio`
 - Position events throttled while WebView is backgrounded; one live snapshot emitted on foreground resume (0.9.1+)
 
@@ -132,16 +132,16 @@ Add to `angular.json` → architect → build → options → scripts:
 
 #### AndroidManifest.xml
 
-```xml
-<uses-permission android:name="android.permission.WAKE_LOCK" />
-<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />
-<application android:name="org.dwbn.plugins.playlist.App">
-    <service android:enabled="true" android:exported="false"
-             android:foregroundServiceType="mediaPlayback"
-             android:name="org.dwbn.plugins.playlist.service.MediaService">
-    </service>
-</application>
-```
+From **0.11.0**, the plugin library manifest merges the media playback service and required permissions into your app automatically:
+
+- `android.permission.WAKE_LOCK`
+- `android.permission.FOREGROUND_SERVICE`
+- `android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK`
+- `org.dwbn.plugins.playlist.service.MediaService` (`exported="false"`, `foregroundServiceType="mediaPlayback"`)
+
+After upgrading, run `npx cap sync android`. You do **not** need to copy these entries into your host `AndroidManifest.xml` unless you want to override plugin defaults.
+
+Keep your application's existing Android `Application` class. The legacy `org.dwbn.plugins.playlist.App` class remains available for compatibility, but it is no longer required — remove `android:name="org.dwbn.plugins.playlist.App"` from `<application>` when upgrading from older setups.
 
 #### Gradle 9+
 

package/android/src/main/AndroidManifest.xml

@@ -1,4 +1,13 @@
 
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-          >
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-permission android:name="android.permission.WAKE_LOCK" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PLAYBACK" />
+
+    <application>
+        <service
+            android:name="org.dwbn.plugins.playlist.service.MediaService"
+            android:exported="false"
+            android:foregroundServiceType="mediaPlayback" />
+    </application>
 </manifest>

package/android/src/main/java/org/dwbn/plugins/playlist/App.kt

@@ -1,19 +1,6 @@
 package org.dwbn.plugins.playlist
 
 import android.app.Application
-import org.dwbn.plugins.playlist.manager.PlaylistManager
 
-class App : Application() {
-    private lateinit var _playlistManager: PlaylistManager;
-    val playlistManager get() = _playlistManager
-
-    fun resetPlaylistManager() {
-        _playlistManager = PlaylistManager(this)
-    }
-
-    override fun onCreate() {
-        resetPlaylistManager()
-        super.onCreate()
-
-    }
-}
+@Deprecated("No longer required; use your app's existing Application class")
+class App : Application()

package/android/src/main/java/org/dwbn/plugins/playlist/PlaylistPlugin.kt

@@ -22,7 +22,7 @@ public class PlaylistPlugin : Plugin(), OnStatusReportListener {
     private var isWebViewActive = true
 
     override fun load() {
-        audioPlayerImpl = RmxAudioPlayer(this, (this.context.applicationContext as App))
+        audioPlayerImpl = RmxAudioPlayer(this, context.applicationContext)
     }
 
     @PluginMethod

package/android/src/main/java/org/dwbn/plugins/playlist/PlaylistRuntime.kt

@@ -0,0 +1,16 @@
+package org.dwbn.plugins.playlist
+
+import android.app.Application
+import android.content.Context
+import org.dwbn.plugins.playlist.manager.PlaylistManager
+
+object PlaylistRuntime {
+    private var playlistManager: PlaylistManager? = null
+
+    @JvmStatic
+    fun getPlaylistManager(context: Context): PlaylistManager = synchronized(this) {
+        playlistManager ?: PlaylistManager(context.applicationContext as Application).also {
+            playlistManager = it
+        }
+    }
+}

package/android/src/main/java/org/dwbn/plugins/playlist/RmxAudioPlayer.java

@@ -1,5 +1,6 @@
 package org.dwbn.plugins.playlist;
 
+import android.content.Context;
 import android.util.Log;
 
 import androidx.annotation.NonNull;
@@ -39,16 +40,16 @@ public class RmxAudioPlayer implements PlaybackStatusListener<AudioTrack>,
     // It would be used to switch between playlists. I guess we could
     // support that in the future, might be cool.
     private static final int PLAYLIST_ID = 32;
-    private PlaylistManager playlistManager;
+    private final PlaylistManager playlistManager;
     private final OnStatusReportListener statusListener;
 
     private int lastBufferPercent = 0;
     private long lastDuration = 0;
     private boolean trackLoaded = false;
     private boolean resetStreamOnPause = true;
-    private final App app;
+    private final Context context;
 
-    public RmxAudioPlayer(@NonNull OnStatusReportListener statusListener, App context) {
+    public RmxAudioPlayer(@NonNull OnStatusReportListener statusListener, @NonNull Context context) {
         // AudioPlayerPlugin and RmxAudioPlayer are separate classes in order to increase
         // the portability of this code.
         // Because AudioPlayerPlugin itself holds a strong reference to this class,
@@ -56,10 +57,9 @@ public class RmxAudioPlayer implements PlaybackStatusListener<AudioTrack>,
         // but these two objects will always live together (And the plugin couldn't function
         // at all if this one gets garbage collected).
         this.statusListener = statusListener;
-        this.app = context;
+        this.context = context.getApplicationContext();
+        this.playlistManager = PlaylistRuntime.getPlaylistManager(this.context);
 
-        app.resetPlaylistManager();
-        getPlaylistManager();
         playlistManager.setId(PLAYLIST_ID);
         playlistManager.setPlaybackStatusListener(this);
         playlistManager.setOnErrorListener(this);
@@ -67,7 +67,6 @@ public class RmxAudioPlayer implements PlaybackStatusListener<AudioTrack>,
     }
 
     public PlaylistManager getPlaylistManager() {
-        playlistManager = app.getPlaylistManager();
         return playlistManager;
     }
 
@@ -81,7 +80,7 @@ public class RmxAudioPlayer implements PlaybackStatusListener<AudioTrack>,
     }
 
     public void setOptions(JSONObject val) {
-        Options options = new Options(app, val);
+        Options options = new Options(context, val);
         getPlaylistManager().setOptions(options);
     }
 
@@ -412,7 +411,6 @@ public class RmxAudioPlayer implements PlaybackStatusListener<AudioTrack>,
 
     public void resume() {
         Log.i(TAG, "Resumed, wiring up event listeners");
-        getPlaylistManager();
         registerPlaylistListeners();
         //Makes sure to retrieve the current playback information
         updateCurrentPlaybackInformation();

package/android/src/main/java/org/dwbn/plugins/playlist/service/MediaService.kt

@@ -8,7 +8,7 @@ import android.os.Build
 import android.util.Log
 import com.devbrackets.android.playlistcore.components.playlisthandler.PlaylistHandler
 import com.devbrackets.android.playlistcore.service.BasePlaylistService
-import org.dwbn.plugins.playlist.App
+import org.dwbn.plugins.playlist.PlaylistRuntime
 import org.dwbn.plugins.playlist.data.AudioTrack
 import org.dwbn.plugins.playlist.manager.PlaylistManager
 import org.dwbn.plugins.playlist.playlist.AudioApi
@@ -97,7 +97,7 @@ class MediaService : BasePlaylistService<AudioTrack, PlaylistManager>() {
     fun isRunningInForeground(): Boolean = inForeground
 
     override val playlistManager: PlaylistManager
-        get() = (applicationContext as App).playlistManager
+        get() = PlaylistRuntime.getPlaylistManager(applicationContext)
 
     override fun newPlaylistHandler(): PlaylistHandler<AudioTrack> {
         val imageProvider = MediaImageProvider(applicationContext, object : OnImageUpdatedListener {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-plugin-playlist",
-  "version": "0.10.10",
+  "version": "0.11.0",
   "description": "Playlist ",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",