capacitor-plugin-playlist 0.4.2 → 0.6.0

package/README.md

@@ -1,4 +1,5 @@
 # capacitor-plugin-playlist
+
 Will probably be published as @dwbn/capacitor-playlist
 
 A capacitor 3. 0 plugin for Android, iOS and Web with native support for audio playlists, background support, and lock screen controls
@@ -21,12 +22,13 @@ cordova, and here we wanna give back to the community our outcome, any help is a
 
 ## 2. Notes
 
-### On *Android*, utilizes a wrapper over ExoPlayer called [ExoMedia](https://github.com/brianwernick/ExoMedia). ExoPlayer is a powerful, high-quality player for Android provided by Google
+### On _Android_, utilizes a wrapper over ExoPlayer called [ExoMedia](https://github.com/brianwernick/ExoMedia). ExoPlayer is a powerful, high-quality player for Android provided by Google
+
 ### On iOS, utilizes a customized AVQueuePlayer in order to provide feedback about track changes, buffering, etc.; given that AVQueuePlayer can keep the audio session running between songs.
 
-* This plugin is not designed to play mixable, rapid-fire, low-latency audio, as you would use in a game. A more appropriate cordova plugin for that use case is [cordova-plugin-nativeaudio](https://github.com/floatinghotpot/cordova-plugin-nativeaudio)
+- This plugin is not designed to play mixable, rapid-fire, low-latency audio, as you would use in a game. A more appropriate cordova plugin for that use case is [cordova-plugin-nativeaudio](https://github.com/floatinghotpot/cordova-plugin-nativeaudio)
 
-* Cannot mix audio; again the NativeAudio plugin is probably more appropriate. This is due to supporting the lock screen and command center controls: only an app in command of audio can do this, otherwise the controls have no meaning. I would like to add an option to do this, it should be fairly straightforward; at the cost of not supporting the OS-level controls for that invokation.
+- Cannot mix audio; again the NativeAudio plugin is probably more appropriate. This is due to supporting the lock screen and command center controls: only an app in command of audio can do this, otherwise the controls have no meaning. I would like to add an option to do this, it should be fairly straightforward; at the cost of not supporting the OS-level controls for that invokation.
 
 ## 3. Installation
 
@@ -36,10 +38,13 @@ As with most capacitor plugins...
 npm i capacitor-plugin-playlist
 npx cap sync
 ```
+
 ### For web
-include hlsjs in your build 
 
-#### E.G. for Angular 2+: 
+include hlsjs in your build
+
+#### E.G. for Angular 2+:
+
 ```
 npm i hls.js
 ```
@@ -55,16 +60,8 @@ architect => build => options:
     ]
 ```
 
-### On Android:
-
-##### Add to your build.gradle
-```
-ext {
-    exoPlayerVersion = "2.9.6"
-    supportLibVersion = "28.0.0"
-}
-```
 ##### AndroidManifest.xml:
+
 ```
     <uses-permission android:name="android.permission.WAKE_LOCK" />
     <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
@@ -78,7 +75,9 @@ ext {
 ```
 
 ##### Glide image loading for notifiction center
+
 To be able to use glide you need to create a file MyAppGlideModule.java:
+
 ```
 package org.your.package.namespace;
 
@@ -88,10 +87,13 @@ import com.bumptech.glide.module.AppGlideModule;
 @GlideModule
 public final class MyAppGlideModule extends AppGlideModule {}
 ```
+
 also see https://guides.codepath.com/android/Displaying-Images-with-the-Glide-Library
 
 ### iOS
+
 ##### inside Info.plist:
+
 ```
 	<key>UIBackgroundModes</key>
 	<array>
@@ -105,6 +107,7 @@ Android normally will give you ~2-3 minutes of background playback before killin
 iOS will immediately stop playback when the app goes into the background if you do not include the `audio` `UIBackgroundMode`. iOS has an additional requirement that audio playback must never stop; when it does, the audio session will be terminated and playback cannot continue without user interaction.
 
 ### Android notification icon
+
 To show a better notification icon in Android Lollipop (API 21) and above, create a transparent (silhouette) icon and name the file e.g. as "ic_notification.png".
 Then you can use the options like:
 
@@ -124,8 +127,10 @@ Just drop into your project and go.
 Should be quite obvious howto adapt this for other frameworks, or just vanillaJS
 
 ### API
+
 Example:
 @see definition.ts
+
 ```
 import {Playlist, AudioTrack} from 'capacitor-plugin-playlist'
 
@@ -147,20 +152,21 @@ Its a meant as a drop in replacement
 
 in the best case you only change your import. :D
 
-
 ## 5. Todo
-* [iOS] Utilize [AudioPlayer](https://github.com/delannoyk/AudioPlayer) instead of directly implementing AVQueuePlayer. `AudioPlayer` includes some smart network recovery features
-* [iOS, Android] Add a full example
+
+- [iOS] Utilize [AudioPlayer](https://github.com/delannoyk/AudioPlayer) instead of directly implementing AVQueuePlayer. `AudioPlayer` includes some smart network recovery features
+- [iOS, Android] Add a full example
 
 ## 6. Credits
 
 There are several plugins that are similar to this one, but all are focused on aspects of the media management experience. This plugin takes inspiration from:
-* [cordova-plugin-playlist](https://github.com/Rolamix/cordova-plugin-playlist)
-* [cordova-plugin-media](https://github.com/apache/cordova-plugin-media)
-* [ExoMedia](https://github.com/brianwernick/ExoMedia)
-* [PlaylistCore](https://github.com/brianwernick/PlaylistCore) (provides player controls on top of ExoMedia)
-* [Bi-Directional AVQueuePlayer proof of concept](https://github.com/jrtaal/AVBidirectionalQueuePlayer)
-* [cordova-music-controls-plugin](https://github.com/homerours/cordova-music-controls-plugin)
+
+- [cordova-plugin-playlist](https://github.com/Rolamix/cordova-plugin-playlist)
+- [cordova-plugin-media](https://github.com/apache/cordova-plugin-media)
+- [ExoMedia](https://github.com/brianwernick/ExoMedia)
+- [PlaylistCore](https://github.com/brianwernick/PlaylistCore) (provides player controls on top of ExoMedia)
+- [Bi-Directional AVQueuePlayer proof of concept](https://github.com/jrtaal/AVBidirectionalQueuePlayer)
+- [cordova-music-controls-plugin](https://github.com/homerours/cordova-music-controls-plugin)
 
 ## 7. License
 

package/android/build.gradle

@@ -2,17 +2,16 @@ ext {
     junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
     androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
     androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
-    exoPlayerVersion = project.hasProperty('exoPlayerVersion') ? rootProject.ext.exoPlayerVersion : "2.9.6"
 }
 
 buildscript {
-    ext.kotlin_version = project.hasProperty("kotlin_version") ? rootProject.ext.kotlin_version : '1.8.20'
+    ext.kotlin_version = project.hasProperty("kotlin_version") ? rootProject.ext.kotlin_version : '1.9.10'
     repositories {
         google()
         mavenCentral()
     }
     dependencies {
-        classpath 'com.android.tools.build:gradle:8.0.0'
+        classpath 'com.android.tools.build:gradle:8.2.1'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }
@@ -22,10 +21,10 @@ apply plugin: 'kotlin-android'
 
 android {
     namespace "org.dwbn.plugins.playlist"
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
+    compileSdk project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 34
     defaultConfig {
         minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 34
         versionCode 1
         versionName "1.0"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
@@ -65,8 +64,7 @@ dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
 
     // Image Exomedia
-    implementation 'com.devbrackets.android:exomedia:4.3.0'
-    implementation "com.google.android.exoplayer:extension-okhttp:$exoPlayerVersion"
+    implementation 'com.devbrackets.android:exomedia:5.1.0'
 
     // Image Loading
     implementation 'com.github.bumptech.glide:glide:4.6.1'

package/android/gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.0.2-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-all.zip
 networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

package/android/gradlew

@@ -85,9 +85,6 @@ done
 APP_BASE_NAME=${0##*/}
 APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
-
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
 
@@ -133,10 +130,13 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
@@ -197,6 +197,10 @@ if "$cygwin" || "$msys" ; then
     done
 fi
 
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
 # Collect all arguments for the java command;
 #   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
 #     shell script including quotes and variable substitutions, so put them in

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

@@ -1,17 +1,7 @@
 package org.dwbn.plugins.playlist
 
 import android.app.Application
-import com.devbrackets.android.exomedia.ExoMedia
 import org.dwbn.plugins.playlist.manager.PlaylistManager
-import com.google.android.exoplayer2.ext.okhttp.OkHttpDataSourceFactory
-import com.google.android.exoplayer2.upstream.DataSource
-import com.google.android.exoplayer2.upstream.TransferListener
-import com.google.android.exoplayer2.upstream.cache.CacheDataSource
-import com.google.android.exoplayer2.upstream.cache.CacheDataSourceFactory
-import com.google.android.exoplayer2.upstream.cache.LeastRecentlyUsedCacheEvictor
-import com.google.android.exoplayer2.upstream.cache.SimpleCache
-import okhttp3.OkHttpClient
-import java.io.File
 
 class App : Application() {
     private lateinit var _playlistManager: PlaylistManager;
@@ -25,38 +15,5 @@ class App : Application() {
         resetPlaylistManager()
         super.onCreate()
 
-        configureExoMedia()
-    }
-
-    private fun configureExoMedia() {
-        // Registers the media sources to use the OkHttp client instead of the standard Apache one
-        // Note: the OkHttpDataSourceFactory can be found in the ExoPlayer extension library `extension-okhttp`
-        ExoMedia.setDataSourceFactoryProvider(object : ExoMedia.DataSourceFactoryProvider {
-            private var instance: CacheDataSourceFactory? = null
-
-            override fun provide(
-                userAgent: String,
-                listener: TransferListener?
-            ): DataSource.Factory {
-                if (instance == null) {
-                    // Updates the network data source to use the OKHttp implementation
-                    val upstreamFactory =
-                        OkHttpDataSourceFactory(OkHttpClient(), userAgent, listener)
-
-                    // Adds a cache around the upstreamFactory
-                    val cache = SimpleCache(
-                        File(cacheDir, "ExoMediaCache"),
-                        LeastRecentlyUsedCacheEvictor((50 * 1024 * 1024).toLong())
-                    )
-                    instance = CacheDataSourceFactory(
-                        cache,
-                        upstreamFactory,
-                        CacheDataSource.FLAG_IGNORE_CACHE_ON_ERROR
-                    )
-                }
-
-                return instance!!
-            }
-        })
     }
 }