Merge pull request #5 from sampie777/add_sceneschanged_and_transition_events

Added three more events

Author: Laraakaa

src/main/java/net/twasi/obsremotejava/OBSCommunicator.java

@@ -5,7 +5,10 @@
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
 import net.twasi.obsremotejava.events.EventType;
+import net.twasi.obsremotejava.events.responses.ScenesChangedResponse;
 import net.twasi.obsremotejava.events.responses.SwitchScenesResponse;
+import net.twasi.obsremotejava.events.responses.TransitionBeginResponse;
+import net.twasi.obsremotejava.events.responses.TransitionEndResponse;
 import net.twasi.obsremotejava.requests.GetAuthRequired.GetAuthRequiredRequest;
 import net.twasi.obsremotejava.requests.GetAuthRequired.GetAuthRequiredResponse;
 import net.twasi.obsremotejava.requests.GetCurrentProfile.GetCurrentProfileRequest;
@@ -97,6 +100,9 @@ public class OBSCommunicator {
     private Callback onReplayStopped;
     private Callback onReplayStopping;
     private Callback onSwitchScenes;
+    private Callback onScenesChanged;
+    private Callback onTransitionBegin;
+    private Callback onTransitionEnd;
 
     private GetVersionResponse versionInfo;
 
@@ -205,10 +211,25 @@ public void onMessage(String msg) {
                             onSwitchScenes.run(new Gson().fromJson(msg, SwitchScenesResponse.class));
                         }
                         break;
+                    case ScenesChanged:
+                        if (onScenesChanged != null) {
+                            onScenesChanged.run(new Gson().fromJson(msg, ScenesChangedResponse.class));
+                        }
+                        break;
+                    case TransitionBegin:
+                        if (onTransitionBegin != null) {
+                            onTransitionBegin.run(new Gson().fromJson(msg, TransitionBeginResponse.class));
+                        }
+                        break;
+                    case TransitionEnd:
+                        if (onTransitionEnd != null) {
+                            onTransitionEnd.run(new Gson().fromJson(msg, TransitionEndResponse.class));
+                        }
+                        break;
                 }
             }
         } catch (Exception e) {
-            System.out.println("Websockte Exception: " + e.getMessage());
+            System.out.println("Websocket Exception: " + e.getMessage());
         }
     }
 
@@ -240,6 +261,18 @@ public void registerOnSwitchScenes(Callback onSwitchScenes) {
         this.onSwitchScenes = onSwitchScenes;
     }
 
+    public void registerOnScenesChanged(Callback onScenesChanged) {
+        this.onScenesChanged = onScenesChanged;
+    }
+
+    public void registerOnTransitionBegin(Callback onTransitionBegin) {
+        this.onTransitionBegin = onTransitionBegin;
+    }
+
+    public void registerOnTransitionEnd(Callback onTransitionEnd) {
+        this.onTransitionEnd = onTransitionEnd;
+    }
+
     public void getScenes(Callback callback) {
         session.getRemote().sendStringByFuture(new Gson().toJson(new GetSceneListRequest(this)));
         callbacks.put(GetSceneListResponse.class, callback);

src/main/java/net/twasi/obsremotejava/OBSRemoteController.java

@@ -99,6 +99,18 @@ public void registerSwitchScenesCallback(Callback onSwitchScenes) {
         communicator.registerOnSwitchScenes(onSwitchScenes);
     }
 
+    public void registerScenesChangedCallback(Callback onScenesChanged) {
+        communicator.registerOnScenesChanged(onScenesChanged);
+    }
+
+    public void registerTransitionBeginCallback(Callback onTransitionBegin) {
+        communicator.registerOnTransitionBegin(onTransitionBegin);
+    }
+
+    public void registerTransitionEndCallback(Callback onTransitionEnd) {
+        communicator.registerOnTransitionEnd(onTransitionEnd);
+    }
+
     public void await() throws InterruptedException {
         communicator.await();
     }

src/main/java/net/twasi/obsremotejava/events/EventType.java

@@ -5,5 +5,8 @@ public enum EventType {
     ReplayStarted,
     ReplayStopping,
     ReplayStopped,
-    SwitchScenes
+    SwitchScenes,
+    ScenesChanged,
+    TransitionBegin,
+    TransitionEnd
 }

src/main/java/net/twasi/obsremotejava/events/responses/ScenesChangedResponse.java

@@ -0,0 +1,5 @@
+package net.twasi.obsremotejava.events.responses;
+
+import net.twasi.obsremotejava.requests.ResponseBase;
+
+public class ScenesChangedResponse extends ResponseBase {}

src/main/java/net/twasi/obsremotejava/events/responses/TransitionBeginResponse.java

@@ -0,0 +1,37 @@
+package net.twasi.obsremotejava.events.responses;
+
+import com.google.gson.annotations.SerializedName;
+import net.twasi.obsremotejava.requests.ResponseBase;
+
+public class TransitionBeginResponse extends ResponseBase {
+    private String name;
+    private String type;
+
+    @SerializedName("from-scene")
+    private String fromScene;
+
+    @SerializedName("to-scene")
+    private String toScene;
+
+    private Integer duration;
+
+    public String getName() {
+        return name;
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public String getFromScene() {
+        return fromScene;
+    }
+
+    public String getToScene() {
+        return toScene;
+    }
+
+    public Integer getDuration() {
+        return duration;
+    }
+}

src/main/java/net/twasi/obsremotejava/events/responses/TransitionEndResponse.java

@@ -0,0 +1,30 @@
+package net.twasi.obsremotejava.events.responses;
+
+import com.google.gson.annotations.SerializedName;
+import net.twasi.obsremotejava.requests.ResponseBase;
+
+public class TransitionEndResponse extends ResponseBase {
+    private String name;
+    private String type;
+
+    @SerializedName("to-scene")
+    private String toScene;
+
+    private Integer duration;
+
+    public String getName() {
+        return name;
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public String getToScene() {
+        return toScene;
+    }
+
+    public Integer getDuration() {
+        return duration;
+    }
+}

src/test/java/net/twasi/obsremotejava/test/OBSRemoteControllerTest.java

@@ -2,7 +2,10 @@
 
 import net.twasi.obsremotejava.Callback;
 import net.twasi.obsremotejava.OBSRemoteController;
+import net.twasi.obsremotejava.events.responses.ScenesChangedResponse;
 import net.twasi.obsremotejava.events.responses.SwitchScenesResponse;
+import net.twasi.obsremotejava.events.responses.TransitionBeginResponse;
+import net.twasi.obsremotejava.events.responses.TransitionEndResponse;
 import net.twasi.obsremotejava.requests.GetVersion.GetVersionResponse;
 import net.twasi.obsremotejava.requests.ResponseBase;
 import org.junit.jupiter.api.Test;
@@ -243,6 +246,21 @@ public void run(ResponseBase response) {
                     SwitchScenesResponse switchScenesResponse = (SwitchScenesResponse) res;
                     System.out.println("Switched to scene: " + switchScenesResponse.getSceneName());
                 });
+
+                controller.registerScenesChangedCallback(res -> {
+                    ScenesChangedResponse scenesChangedResponse = (ScenesChangedResponse) res;
+                    System.out.println("Scenes changed");
+                });
+
+                controller.registerTransitionBeginCallback(res -> {
+                    TransitionBeginResponse transitionBeginResponse = (TransitionBeginResponse) res;
+                    System.out.println("Transition started from scene: '" + transitionBeginResponse.getFromScene() + "' to scene: '" + transitionBeginResponse.getToScene() + "'");
+                });
+
+                controller.registerTransitionEndCallback(res -> {
+                    TransitionEndResponse transitionEndResponse = (TransitionEndResponse) res;
+                    System.out.println("Transition ended with scene: " + transitionEndResponse.getToScene());
+                });
             }
         });