Merge pull request #22 from cbrews/cbrews/adding-transition-events

Feature: New Event Callbacks: SwitchTransition, TransitionListChanged

Author: DieserMerlin

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

@@ -8,10 +8,7 @@
 import net.twasi.obsremotejava.callbacks.ErrorCallback;
 import net.twasi.obsremotejava.callbacks.StringCallback;
 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.events.responses.*;
 import net.twasi.obsremotejava.objects.throwables.InvalidResponseTypeError;
 import net.twasi.obsremotejava.requests.Authenticate.AuthenticateRequest;
 import net.twasi.obsremotejava.requests.Authenticate.AuthenticateResponse;
@@ -123,6 +120,8 @@ public class OBSCommunicator {
     private Callback onStreamStopped;
     private Callback onSwitchScenes;
     private Callback onScenesChanged;
+    private Callback onSwitchTransition;
+    private Callback onTransitionListChanged;
     private Callback onTransitionBegin;
     private Callback onTransitionEnd;
 
@@ -292,6 +291,16 @@ private void processIncomingEvent(String msg, EventType eventType) {
                     onScenesChanged.run(new Gson().fromJson(msg, ScenesChangedResponse.class));
                 }
                 break;
+            case SwitchTransition:
+                if (onSwitchTransition != null) {
+                    onSwitchTransition.run(new Gson().fromJson(msg, SwitchTransitionResponse.class));
+                }
+                break;
+            case TransitionListChanged:
+                if (onTransitionListChanged != null) {
+                    onTransitionListChanged.run(new Gson().fromJson(msg, TransitionListChangedResponse.class));
+                }
+                break;
             case TransitionBegin:
                 if (onTransitionBegin != null) {
                     onTransitionBegin.run(new Gson().fromJson(msg, TransitionBeginResponse.class));
@@ -397,6 +406,14 @@ public void registerOnScenesChanged(Callback onScenesChanged) {
         this.onScenesChanged = onScenesChanged;
     }
 
+    public void registerOnSwitchTransition(Callback onSwitchTransition) {
+        this.onSwitchTransition = onSwitchTransition;
+    }
+
+    public void registerOnTransitionListChanged(Callback onTransitionListChanged) {
+        this.onTransitionListChanged = onTransitionListChanged;
+    }
+
     public void registerOnTransitionBegin(Callback onTransitionBegin) {
         this.onTransitionBegin = onTransitionBegin;
     }

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

@@ -170,6 +170,14 @@ public void registerScenesChangedCallback(Callback onScenesChanged) {
         communicator.registerOnScenesChanged(onScenesChanged);
     }
 
+    public void registerSwitchTransitionCallback(Callback onSwitchTransition) {
+        communicator.registerOnSwitchTransition(onSwitchTransition);
+    }
+
+    public void registerTransitionListChangedCallback(Callback onTransitionListChanged) {
+        communicator.registerOnTransitionListChanged(onTransitionListChanged);
+    }
+
     public void registerTransitionBeginCallback(Callback onTransitionBegin) {
         communicator.registerOnTransitionBegin(onTransitionBegin);
     }

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

@@ -11,6 +11,8 @@ public enum EventType {
     StreamStopped,
     SwitchScenes,
     ScenesChanged,
+    SwitchTransition,
+    TransitionListChanged,
     TransitionBegin,
     TransitionEnd
 }

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

@@ -0,0 +1,13 @@
+package net.twasi.obsremotejava.events.responses;
+
+import com.google.gson.annotations.SerializedName;
+import net.twasi.obsremotejava.requests.ResponseBase;
+
+public class SwitchTransitionResponse extends ResponseBase {
+    @SerializedName("transition-name")
+    private String transitionName;
+
+    public String getTransitionName() {
+        return transitionName;
+    }
+}

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

@@ -0,0 +1,13 @@
+package net.twasi.obsremotejava.events.responses;
+
+import net.twasi.obsremotejava.objects.Transition;
+import net.twasi.obsremotejava.requests.ResponseBase;
+
+import java.util.List;
+
+public class TransitionListChangedResponse extends ResponseBase {
+    // Note: enabled these when https://github.com/Palakis/obs-websocket/blob/4.x-current/src/WSEvents.cpp#L561 is released.
+    // private List<Transition> transitions;
+
+    // public List<Transition> getTransitions() { return transitions; }
+}

src/main/java/net/twasi/obsremotejava/objects/Transition.java

@@ -0,0 +1,9 @@
+package net.twasi.obsremotejava.objects;
+
+public class Transition {
+    private String name;
+
+    public String getName() {
+        return name;
+    }
+}

src/main/java/net/twasi/obsremotejava/requests/GetTransitionList/GetTransitionListResponse.java

@@ -1,6 +1,7 @@
 package net.twasi.obsremotejava.requests.GetTransitionList;
 
 import com.google.gson.annotations.SerializedName;
+import net.twasi.obsremotejava.objects.Transition;
 import net.twasi.obsremotejava.requests.ResponseBase;
 
 import java.util.List;
@@ -18,12 +19,4 @@ public String getCurrentTransition() {
     public List<Transition> getTransitions() {
         return transitions;
     }
-
-    public class Transition {
-        private String name;
-
-        public String getName() {
-            return name;
-        }
-    }
 }

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

@@ -2,10 +2,7 @@
 
 import net.twasi.obsremotejava.callbacks.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.events.responses.*;
 import net.twasi.obsremotejava.requests.GetVersion.GetVersionResponse;
 import net.twasi.obsremotejava.requests.ResponseBase;
 import org.junit.jupiter.api.Disabled;
@@ -265,6 +262,16 @@ public void run(ResponseBase response) {
                     System.out.println("Scenes changed");
                 });
 
+                controller.registerSwitchTransitionCallback(res -> {
+                    SwitchTransitionResponse switchTransitionResponse = (SwitchTransitionResponse) res;
+                    System.out.println("Switched active transition to: " + switchTransitionResponse.getTransitionName());
+                });
+
+                controller.registerTransitionListChangedCallback(res -> {
+                    TransitionListChangedResponse transitionListChangedResponse = (TransitionListChangedResponse) res;
+                    System.out.println("Transition list changed");
+                });
+
                 controller.registerTransitionBeginCallback(res -> {
                     TransitionBeginResponse transitionBeginResponse = (TransitionBeginResponse) res;
                     System.out.println("Transition started from scene: '" + transitionBeginResponse.getFromScene() + "' to scene: '" + transitionBeginResponse.getToScene() + "'");

src/test/resources/simplelogger.properties

@@ -4,4 +4,4 @@ org.eclipse.jetty.LEVEL=OFF
 
 # Default levels for the project
 org.slf4j.simpleLogger.defaultLogLevel=info
-org.slf4j.simpleLogger.log.net.twasi.obsremotejava=debuggi
+org.slf4j.simpleLogger.log.net.twasi.obsremotejava=debug