Add EventsListener.onPanicState() (#233)

* Add EventsListener.onPanicState()

* Removed reason + send WS event for `panic`

Co-authored-by: ma5309 <[email protected]>
Co-authored-by: devgianlu <[email protected]>

Author: 3 people

api/README.md

@@ -37,19 +37,20 @@ All the endpoints will respond with `200` if successful or:
 ### Events
 You can subscribe for players events by creating a WebSocket connection to `/events`.
 The currently available events are:
-- `contextChanged`, the Spotify context URI changed
-- `trackChanged`, the Spotify track URI changed
-- `playbackPaused`, playback has been paused
-- `playbackResumed`, playback has been resumed
-- `volumeChanged`, playback volume changed
-- `trackSeeked`, track has been seeked
-- `metadataAvailable`, metadata for the current track is available
-- `playbackHaltStateChanged`, playback halted or resumed from halt
-- `sessionCleared`, (Zeroconf only) current session went away
-- `sessionChanged`, (Zeroconf only) current session changed
-- `inactiveSession`, current session is now inactive (no audio)
-- `connectionDropped`, a network error occurred and we're trying to reconnect
-- `connectionEstablished`, successfully reconnected
+- `contextChanged` The Spotify context URI changed
+- `trackChanged` The Spotify track URI changed
+- `playbackPaused` Playback has been paused
+- `playbackResumed` Playback has been resumed
+- `volumeChanged` Playback volume changed
+- `trackSeeked` Track has been seeked
+- `metadataAvailable` Metadata for the current track is available
+- `playbackHaltStateChanged` Playback halted or resumed from halt
+- `sessionCleared` Current session went away (Zeroconf only)
+- `sessionChanged` Current session changed (Zeroconf only)
+- `inactiveSession` Current session is now inactive (no audio)
+- `connectionDropped` A network error occurred and we're trying to reconnect
+- `connectionEstablished` Successfully reconnected
+- `panic` Entered the panic state, playback is stopped. This is usually recoverable.
 
 ## Examples
 `curl -X POST -d "uri=spotify:track:xxxxxxxxxxxxxxxxxxxxxx&play=true" http://localhost:24879/player/load`

api/src/main/java/xyz/gianlu/librespot/api/handlers/EventsHandler.java

@@ -108,6 +108,13 @@ public void onVolumeChanged(@Range(from = 0, to = 1) float volume) {
         dispatch(obj);
     }
 
+    @Override
+    public void onPanicState() {
+        JsonObject obj = new JsonObject();
+        obj.addProperty("event", "panic");
+        dispatch(obj);
+    }
+
     @Override
     public void onSessionCleared(@NotNull Session old) {
         old.player().removeEventsListener(this);

core/src/main/java/xyz/gianlu/librespot/player/Player.java

@@ -171,6 +171,8 @@ private void panicState(@Nullable PlaybackMetrics.Reason reason) {
         } else if (playerSession != null) {
             endMetrics(playerSession.currentPlaybackId(), reason, playerSession.currentMetrics(), state.getPosition());
         }
+
+        events.panicState();
     }
 
     /**
@@ -816,6 +818,8 @@ public interface EventsListener {
         void onInactiveSession(boolean timeout);
 
         void onVolumeChanged(@Range(from = 0, to = 1) float volume);
+
+        void onPanicState();
     }
 
     /**
@@ -1078,6 +1082,12 @@ void inactiveSession(boolean timeout) {
                 executorService.execute(() -> l.onInactiveSession(timeout));
         }
 
+
+        private void panicState() {
+            for (EventsListener l : new ArrayList<>(listeners))
+                executorService.execute(l::onPanicState);
+        }
+
         public void close() {
             executorService.shutdown();
         }