Add stopTrack method to player

Author: duncte123

src/main/kotlin/dev/arbjerg/lavalink/client/IUpdatablePlayer.kt

@@ -12,7 +12,12 @@ interface IUpdatablePlayer {
      *
      * @return The updated builder, useful for chaining
      */
-    fun applyTrack(track: Track): PlayerUpdateBuilder
+    fun applyTrack(track: Track?): PlayerUpdateBuilder
+
+    /**
+     * Shortcut for setting the encoded track to {@code null}. This will also clear the user data.
+     */
+    fun stopTrack(): PlayerUpdateBuilder
 
     /**
      * Sets the encoded track to be played.

src/main/kotlin/dev/arbjerg/lavalink/client/LavalinkPlayer.kt

@@ -33,9 +33,12 @@ class LavalinkPlayer(private val node: LavalinkNode, protocolPlayer: Player) : I
             }
         }
 
-    override fun applyTrack(track: Track) = PlayerUpdateBuilder(node, guildId)
+    override fun applyTrack(track: Track?) = PlayerUpdateBuilder(node, guildId)
         .applyTrack(track)
 
+    override fun stopTrack() = PlayerUpdateBuilder(node, guildId)
+        .stopTrack()
+
     override fun setEncodedTrack(encodedTrack: String?) = PlayerUpdateBuilder(node, guildId)
         .setEncodedTrack(encodedTrack)
 

src/main/kotlin/dev/arbjerg/lavalink/client/PlayerUpdateBuilder.kt

@@ -19,9 +19,16 @@ class PlayerUpdateBuilder internal constructor(private val node: LavalinkNode, p
     private var state: Omissible<VoiceState> = Omissible.omitted()
     private var noReplace = false
 
-    override fun applyTrack(track: Track): PlayerUpdateBuilder {
-        this.encodedTrack = Omissible.of(track.encoded)
-        this.trackUserData = Omissible.of(track.userData)
+    override fun applyTrack(track: Track?): PlayerUpdateBuilder {
+        this.encodedTrack = Omissible.of(track?.encoded)
+        this.trackUserData = track?.userData.toOmissible()
+        return this
+    }
+
+    override fun stopTrack(): PlayerUpdateBuilder {
+        this.encodedTrack = Omissible.of(null)
+        this.identifier = null.toOmissible()
+        this.trackUserData = null.toOmissible()
         return this
     }
 

upgrade.md

@@ -14,6 +14,7 @@ This client also uses project reactor, their docs are over at https://projectrea
 - `LavalinkRestClient` -> `Node`
 - `LavalinkLoadBalancer` -> `DefaultLoadBalancer`
 - `PenaltyProvider` -> `IPenaltyProvider`
+- `IPlayer#stopTrack` -> Set encodedTrack to `null` on the player. 
 - Any filters -> they are in `dev.arbjerg.lavalink.protocol.v4.Filters` class.
 
 If you are missing anything from here, feel free to let me know in the lavalink discord