@javascriptcommon/react-native-track-player 1.2.9 → 1.2.23

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/BufferConfig.kt

@@ -0,0 +1,8 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+data class BufferConfig(
+    val minBuffer: Int?,
+    val maxBuffer: Int?,
+    val playBuffer: Int?,
+    val backBuffer: Int?,
+)

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/CacheConfig.kt

@@ -0,0 +1,17 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+/**
+ * Configuration for cache properties of player.
+ */
+data class CacheConfig(
+    /**
+     * Maximum player cache size in kilobytes.
+     */
+    val maxCacheSize: Long?,
+
+    /**
+     * Cache identifier, used to make cache directory.
+     */
+    val identifier: String = "TrackPlayer"
+)
+

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/Capability.kt

@@ -0,0 +1,19 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+enum class Capability {
+    PLAY,
+    PLAY_FROM_ID,
+    PLAY_FROM_SEARCH,
+    PAUSE,
+    STOP,
+    SEEK_TO,
+    SKIP,
+    SKIP_TO_NEXT,
+    SKIP_TO_PREVIOUS,
+    JUMP_FORWARD,
+    JUMP_BACKWARD,
+    SET_RATING,
+    LIKE,
+    DISLIKE,
+    BOOKMARK
+}

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/FocusChangeData.kt

@@ -0,0 +1,3 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+data class FocusChangeData(val isPaused: Boolean, val isFocusLostPermanently: Boolean)

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/MediaSessionCallback.kt

@@ -0,0 +1,17 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+import android.os.Bundle
+import android.support.v4.media.RatingCompat
+
+sealed class MediaSessionCallback {
+    class RATING(val rating: RatingCompat, extras: Bundle?): MediaSessionCallback()
+    object PLAY : MediaSessionCallback()
+    object PAUSE : MediaSessionCallback()
+    object NEXT : MediaSessionCallback()
+    object PREVIOUS : MediaSessionCallback()
+    object FORWARD : MediaSessionCallback()
+    object REWIND : MediaSessionCallback()
+    object STOP : MediaSessionCallback()
+    class SEEK(val positionMs: Long): MediaSessionCallback()
+    class CUSTOMACTION(val customAction: String): MediaSessionCallback()
+}

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/NotificationConfig.kt

@@ -0,0 +1,43 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+import android.app.PendingIntent
+import androidx.annotation.DrawableRes
+
+/**
+ * Used to configure the player notification.
+ * @param buttons Provide customized notification buttons. They will be shown by default. Note that buttons can still be shown and hidden at runtime by using the functions in [NotificationManager][com.doublesymmetry.kotlinaudio.notification.NotificationManager], but they will have the default icon if not set explicitly here.
+ * @param accentColor The accent color of the notification.
+ * @param smallIcon The small icon of the notification which is also shown in the system status bar.
+ * @param pendingIntent The [PendingIntent] that would be called when tapping on the notification itself.
+ */
+data class NotificationConfig(
+    val buttons: List<NotificationButton>,
+    val accentColor: Int? = null,
+    @DrawableRes val smallIcon: Int? = null,
+    val pendingIntent: PendingIntent? = null
+)
+
+/**
+ * Provide customized notification buttons. They will be shown by default. Note that buttons can still be shown and hidden at runtime by using the functions in [NotificationManager][com.doublesymmetry.kotlinaudio.notification.NotificationManager], but they will have the default icon if not set explicitly here.
+ * @see [com.doublesymmetry.kotlinaudio.notification.NotificationManager.showPlayPauseButton]
+ * @see [com.doublesymmetry.kotlinaudio.notification.NotificationManager.showStopButton]
+ * @see [com.doublesymmetry.kotlinaudio.notification.NotificationManager.showRewindButton]
+ * @see [com.doublesymmetry.kotlinaudio.notification.NotificationManager.showRewindButtonCompact]
+ * @see [com.doublesymmetry.kotlinaudio.notification.NotificationManager.showForwardButton]
+ * @see [com.doublesymmetry.kotlinaudio.notification.NotificationManager.showForwardButtonCompact]
+ * @see [com.doublesymmetry.kotlinaudio.notification.NotificationManager.showNextButton]
+ * @see [com.doublesymmetry.kotlinaudio.notification.NotificationManager.showNextButtonCompact]
+ * @see [com.doublesymmetry.kotlinaudio.notification.NotificationManager.showPreviousButton]
+ * @see [com.doublesymmetry.kotlinaudio.notification.NotificationManager.showPreviousButtonCompact]
+ */
+@Suppress("ClassName")
+sealed class NotificationButton(val customAction: String? = null) {
+    class PLAY_PAUSE(@DrawableRes val playIcon: Int? = null, @DrawableRes val pauseIcon: Int? = null): NotificationButton()
+    class STOP(@DrawableRes val icon: Int? = null): NotificationButton()
+    class FORWARD(@DrawableRes val icon: Int? = null, val isCompact: Boolean = false): NotificationButton()
+    class BACKWARD(@DrawableRes val icon: Int? = null, val isCompact: Boolean = false): NotificationButton()
+    class NEXT(@DrawableRes val icon: Int? = null, val isCompact: Boolean = false): NotificationButton()
+    class PREVIOUS(@DrawableRes val icon: Int? = null, val isCompact: Boolean = false): NotificationButton()
+    object SEEK_TO : NotificationButton()
+    class CUSTOM_ACTION(@DrawableRes val icon: Int? = null, val isCompact: Boolean = false, customAction: String): NotificationButton(customAction=customAction)
+}

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/NotificationMetadata.kt

@@ -0,0 +1,8 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+data class NotificationMetadata(
+    val title: String?= null,
+    val artist: String? = null,
+    val artworkUrl: String? = null,
+    val duration: Long? = null
+)

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/NotificationState.kt

@@ -0,0 +1,8 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+import android.app.Notification
+
+sealed class NotificationState {
+    class POSTED(val notificationId: Int, val notification: Notification, val ongoing: Boolean) : NotificationState()
+    class CANCELLED(val notificationId: Int): NotificationState()
+}

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/PlayWhenReadyChangeData.kt

@@ -0,0 +1,5 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+import com.google.android.exoplayer2.Player
+
+data class PlayWhenReadyChangeData(val playWhenReady: Boolean, val pausedBecauseReachedEnd: Boolean)

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/PlaybackEndedReason.kt

@@ -0,0 +1,5 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+enum class PlaybackEndedReason {
+    PLAYED_UNTIL_END, PLAYER_STOPPED, SKIPPED_TO_NEXT, SKIPPED_TO_PREVIOUS, JUMPED_TO_INDEX
+}

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/PlaybackError.kt

@@ -0,0 +1,6 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+data class PlaybackError (
+    val code: String? = null,
+    val message: String? = null
+)

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/PlaybackMetadata.kt

@@ -0,0 +1,200 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+import com.google.android.exoplayer2.metadata.flac.VorbisComment
+import com.google.android.exoplayer2.metadata.icy.IcyHeaders
+import com.google.android.exoplayer2.metadata.icy.IcyInfo
+import com.google.android.exoplayer2.metadata.id3.TextInformationFrame
+import com.google.android.exoplayer2.metadata.id3.UrlLinkFrame
+import com.google.android.exoplayer2.metadata.mp4.MdtaMetadataEntry
+import com.google.android.exoplayer2.metadata.Metadata
+
+data class PlaybackMetadata(
+    val source: String,
+    var title: String? = null,
+    var url: String? = null,
+    var artist: String? = null,
+    var album: String? = null,
+    var date: String? = null,
+    var genre: String? = null
+) {
+    companion object {
+        /**
+         * ID3 Metadata (MP3)
+         * https://en.wikipedia.org/wiki/ID3
+         */
+        fun fromId3Metadata(metadata: Metadata): PlaybackMetadata? {
+            var handled = false
+
+            var title: String? = null
+            var url: String? = null
+            var artist: String? = null
+            var album: String? = null
+            var date: String? = null
+            var genre: String? = null
+
+            (0 until metadata.length()).forEach { i ->
+                when (val entry = metadata[i]) {
+                    is TextInformationFrame -> {
+                        when (entry.id.uppercase()) {
+                            "TIT2", "TT2" -> {
+                                handled = true
+                                title = entry.value
+                            }
+                            "TALB", "TOAL", "TAL" -> {
+                                handled = true
+                                album = entry.value
+                            }
+                            "TOPE", "TPE1", "TP1" -> {
+                                handled = true
+                                artist = entry.value
+                            }
+                            "TDRC", "TOR" -> {
+                                handled = true
+                                date = entry.value
+                            }
+                            "TCON", "TCO" -> {
+                                handled = true
+                                genre = entry.value
+                            }
+
+                        }
+                    }
+                    is UrlLinkFrame -> {
+                        when (entry.id.uppercase()) {
+                            "WOAS", "WOAF", "WOAR", "WAR" -> {
+                                handled = true;
+                                url = entry.url;
+                            }
+                        }
+                    }
+                }
+            }
+
+
+            return if (handled) PlaybackMetadata("id3", title, url, artist, album, date, genre) else null
+        }
+
+        /**
+         * Shoutcast / Icecast metadata (ICY protocol)
+         * https://cast.readme.io/docs/icy
+         */
+        fun fromIcy(metadata: Metadata): PlaybackMetadata? {
+            for (i in 0 until metadata.length()) {
+                when (val entry = metadata[i]) {
+                    is IcyHeaders -> {
+                        return PlaybackMetadata("icy-headers", title = entry.name, url = entry.url, genre = entry.genre)
+                    }
+                    is IcyInfo -> {
+                        val artist: String?
+                        val title: String?
+                        val index =
+                            if (entry.title == null) -1 else entry.title!!.indexOf(" - ")
+                        if (index != -1) {
+                            artist = entry.title!!.substring(0, index)
+                            title = entry.title!!.substring(index + 3)
+                        } else {
+                            artist = null
+                            title = entry.title
+                        }
+
+                        return PlaybackMetadata("icy", title = title, url = entry.url, artist = artist)
+                    }
+                }
+            }
+
+            return null
+        }
+
+        /**
+         * Vorbis Comments (Vorbis, FLAC, Opus, Speex, Theora)
+         * https://xiph.org/vorbis/doc/v-comment.html
+         */
+        fun fromVorbisComment(metadata: Metadata): PlaybackMetadata? {
+            var handled = false;
+
+            var title: String? = null
+            var url: String? = null
+            var artist: String? = null
+            var album: String? = null
+            var date: String? = null
+            var genre: String? = null
+
+            for (i in 0 until metadata.length()) {
+                val entry = metadata[i]
+                if (entry is VorbisComment) {
+                    when (entry.key) {
+                        "TITLE" -> {
+                            handled = true
+                            title = entry.value;
+                        }
+                        "ARTIST" -> {
+                            handled = true
+                            artist = entry.value;
+                        }
+                        "ALBUM" -> {
+                            handled = true
+                            album = entry.value;
+                        }
+                        "DATE" -> {
+                            handled = true
+                            date = entry.value
+                        }
+                        "GENRE" -> {
+                            handled = true
+                            genre = entry.value
+                        }
+                        "URL" -> {
+                            handled = true
+                            url = entry.value
+                        }
+                    }
+                }
+            }
+            return if (handled) PlaybackMetadata("vorbis-comment", title, url, artist, album, date, genre) else null
+        }
+
+        /**
+         * QuickTime MDTA metadata (mov, qt)
+         * https://developer.apple.com/library/archive/documentation/QuickTime/QTFF/Metadata/Metadata.html
+         */
+        fun fromQuickTime(metadata: Metadata): PlaybackMetadata? {
+            var handled = false;
+
+            var title: String? = null
+            var artist: String? = null
+            var album: String? = null
+            var date: String? = null
+            var genre: String? = null
+
+            for (i in 0 until metadata.length()) {
+                val entry = metadata[i];
+                if (entry is MdtaMetadataEntry) {
+                    when (entry.key) {
+                        "com.apple.quicktime.title" -> {
+                            handled = true
+                            title = entry.value.toString();
+                        }
+                        "com.apple.quicktime.artist" -> {
+                            handled = true
+                            artist = entry.value.toString();
+                        }
+                        "com.apple.quicktime.album" -> {
+                            handled = true
+                            album = entry.value.toString();
+                        }
+                        "com.apple.quicktime.creationdate" -> {
+                            handled = true
+                            date = entry.value.toString();
+                        }
+                        "com.apple.quicktime.genre" -> {
+                            handled = true
+                            genre = entry.value.toString();
+                        }
+                    }
+                }
+            }
+
+            return if (handled) PlaybackMetadata("quicktime", title = title, artist = artist, album = album, date = date, genre = genre) else null
+        }
+    }
+}

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/PlayerConfig.kt

@@ -0,0 +1,33 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+import com.guichaguri.trackplayer.kotlinaudio.models.AudioContentType
+
+data class PlayerConfig(
+    /**
+     * Toggle whether or not a player action triggered from an outside source should be intercepted.
+     *
+     * The sources can be: media buttons on headphones, Android Wear, Android Auto, Google Assistant, media notification, etc.
+     *
+     * Setting this to true enables the use of [onPlayerActionTriggeredExternally][com.doublesymmetry.kotlinaudio.event.PlayerEventHolder.onPlayerActionTriggeredExternally] events.
+     *
+     * **Example**:
+     * ```
+     *  val player = QueuedAudioPlayer(requireActivity(), playerConfig = PlayerConfig(interceptPlayerActionsTriggeredExternally = true))
+     * ```
+     */
+    var interceptPlayerActionsTriggeredExternally: Boolean = false,
+
+    /**
+     * Toggle whether the player should pause automatically when audio is rerouted from a headset to device speakers.
+     */
+    val handleAudioBecomingNoisy: Boolean = false,
+
+    /**
+     * Whether audio focus should be managed automatically. See https://medium.com/google-exoplayer/easy-audio-focus-with-exoplayer-a2dcbbe4640e
+     */
+    val handleAudioFocus: Boolean = false,
+    /**
+     * The audio content type.
+     */
+    val audioContentType: AudioContentType = AudioContentType.MUSIC
+)

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/PlayerOptions.kt

@@ -0,0 +1,9 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+interface PlayerOptions {
+    var alwaysPauseOnInterruption: Boolean
+}
+
+internal data class DefaultPlayerOptions(
+    override var alwaysPauseOnInterruption: Boolean = false,
+) : PlayerOptions

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/PositionChangedReason.kt

@@ -0,0 +1,39 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+/**
+ * Use these events to track when and why the positionMs of an [AudioItem] changes.
+ * Examples include changes to [AudioItem] queue, seeking, skipping, etc.
+ */
+sealed class PositionChangedReason(val oldPosition: Long, val newPosition: Long) {
+    /**
+     * Position has changed because the player has automatically transitioned to the next [AudioItem].
+     *
+     * @see [AudioItemTransitionReason]
+     */
+    class AUTO(oldPosition: Long, newPosition: Long) : PositionChangedReason(oldPosition, newPosition)
+
+    /**
+     * Position has changed because of a queue update.
+     */
+    class QUEUE_CHANGED(oldPosition: Long, newPosition: Long) : PositionChangedReason(oldPosition, newPosition)
+
+    /**
+     * Position has changed because a seek has occurred within the current [AudioItem], or another one.
+     */
+    class SEEK(oldPosition: Long, newPosition: Long) : PositionChangedReason(oldPosition, newPosition)
+
+    /**
+     * Position has changed because an attempted seek has failed. This can occur if we tried to see to an invalid positionMs.
+     */
+    class SEEK_FAILED(oldPosition: Long, newPosition: Long) : PositionChangedReason(oldPosition, newPosition)
+
+    /**
+     * Position has changed because a period (example: an ad) has been skipped.
+     */
+    class SKIPPED_PERIOD(oldPosition: Long, newPosition: Long) : PositionChangedReason(oldPosition, newPosition)
+
+    /**
+     * Position has changed for an unknown reason.
+     */
+    class UNKNOWN(oldPosition: Long, newPosition: Long) : PositionChangedReason(oldPosition, newPosition)
+}

package/android/src/main/java/com/guichaguri/trackplayer/kotlinaudio/models/QueuedPlayerOptions.kt

@@ -0,0 +1,49 @@
+package com.guichaguri.trackplayer.kotlinaudio.models
+
+import com.google.android.exoplayer2.ExoPlayer
+import com.google.android.exoplayer2.Player
+
+interface QueuedPlayerOptions : PlayerOptions {
+    override var alwaysPauseOnInterruption: Boolean
+    var repeatMode: RepeatMode
+}
+
+class DefaultQueuedPlayerOptions(
+    private val exoPlayer: ExoPlayer,
+    override var alwaysPauseOnInterruption: Boolean = false,
+) : QueuedPlayerOptions {
+    // Functions in data classes might or might not be a bit of a code smell.
+    // I'm using the passed exoPlayer which breaks separation of concerns. But it's also useful.
+    // More here: https://www.reddit.com/r/Kotlin/comments/ehqe4e/why_is_it_bad_practice_to_have_functions_in_data/
+    // TODO: Figure out a way for this function to be outside of this data class
+    override var repeatMode: RepeatMode
+        get() {
+            return when (exoPlayer.repeatMode) {
+                Player.REPEAT_MODE_ALL -> RepeatMode.ALL
+                Player.REPEAT_MODE_ONE -> RepeatMode.ONE
+                else -> RepeatMode.OFF
+            }
+        }
+        set(value) {
+            when (value) {
+                RepeatMode.ALL -> exoPlayer.repeatMode = Player.REPEAT_MODE_ALL
+                RepeatMode.ONE -> exoPlayer.repeatMode = Player.REPEAT_MODE_ONE
+                RepeatMode.OFF -> exoPlayer.repeatMode = Player.REPEAT_MODE_OFF
+            }
+        }
+}
+
+enum class RepeatMode {
+    OFF, ONE, ALL;
+
+    companion object {
+        fun fromOrdinal(ordinal: Int): RepeatMode {
+            return when (ordinal) {
+                0 -> OFF
+                1 -> ONE
+                2 -> ALL
+                else -> error("Wrong ordinal")
+            }
+        }
+    }
+}