Added rest of the types for #25, verified tests pass, and sanity-checked responses from getSourceFilters and getSourceFilterInfo methods (added exclude for Main.java class to make development a bit easier since OBS testing is manual atm.

blorp-goes-the-derp · blorp-goes-the-derp · commit bf218a696a1e · 2021-01-05T12:53:16.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,6 @@
+# Exclude 'Main' java class
+**/Main.java
+
 # Filesystem Stuff
 **.DS_Store
 
diff --git a/src/main/java/net/twasi/obsremotejava/OBSCommunicator.java b/src/main/java/net/twasi/obsremotejava/OBSCommunicator.java
@@ -24,6 +24,10 @@
 import net.twasi.obsremotejava.requests.GetSceneItemProperties.GetSceneItemPropertiesRequest;
 import net.twasi.obsremotejava.requests.GetSceneList.GetSceneListRequest;
 import net.twasi.obsremotejava.requests.GetSceneList.GetSceneListResponse;
+import net.twasi.obsremotejava.requests.GetSourceFilterInfo.GetSourceFilterInfoRequest;
+import net.twasi.obsremotejava.requests.GetSourceFilterInfo.GetSourceFilterInfoResponse;
+import net.twasi.obsremotejava.requests.GetSourceFilters.GetSourceFiltersRequest;
+import net.twasi.obsremotejava.requests.GetSourceFilters.GetSourceFiltersResponse;
 import net.twasi.obsremotejava.requests.GetSourceSettings.GetSourceSettingsRequest;
 import net.twasi.obsremotejava.requests.GetSourceSettings.GetSourceSettingsResponse;
 import net.twasi.obsremotejava.requests.GetStreamingStatus.GetStreamingStatusRequest;
@@ -55,6 +59,8 @@
 import net.twasi.obsremotejava.requests.SetPreviewScene.SetPreviewSceneResponse;
 import net.twasi.obsremotejava.requests.SetSceneItemProperties.SetSceneItemPropertiesRequest;
 import net.twasi.obsremotejava.requests.SetSceneItemProperties.SetSceneItemPropertiesResponse;
+import net.twasi.obsremotejava.requests.SetSourceFilterVisibility.SetSourceFilterVisibilityRequest;
+import net.twasi.obsremotejava.requests.SetSourceFilterVisibility.SetSourceFilterVisibilityResponse;
 import net.twasi.obsremotejava.requests.SetSourceSettings.SetSourceSettingsRequest;
 import net.twasi.obsremotejava.requests.SetSourceSettings.SetSourceSettingsResponse;
 import net.twasi.obsremotejava.requests.SetStudioModeEnabled.SetStudioModeEnabledRequest;
@@ -125,6 +131,7 @@ public class OBSCommunicator {
     private Callback<TransitionListChangedResponse> onTransitionListChanged;
     private Callback<TransitionBeginResponse> onTransitionBegin;
     private Callback<TransitionEndResponse> onTransitionEnd;
+    private Callback<SourceFilterVisibilityChangedResponse> onSourceFilterVisibilityChanged;
 
     private GetVersionResponse versionInfo;
 
@@ -292,6 +299,11 @@ private void processIncomingEvent(String msg, EventType eventType) {
                     onScenesChanged.run(new Gson().fromJson(msg, ScenesChangedResponse.class));
                 }
                 break;
+            case SourceFilterVisibilityChanged:
+                if(onSourceFilterVisibilityChanged != null) {
+                    onSourceFilterVisibilityChanged.run(new Gson().fromJson(msg, SourceFilterVisibilityChangedResponse.class));
+                }
+                break;
             case SwitchTransition:
                 if (onSwitchTransition != null) {
                     onSwitchTransition.run(new Gson().fromJson(msg, SwitchTransitionResponse.class));
@@ -407,6 +419,10 @@ public void registerOnScenesChanged(Callback<ScenesChangedResponse> onScenesChan
         this.onScenesChanged = onScenesChanged;
     }
 
+    public void registerOnSourceFilterVisibilityChanged(Callback<SourceFilterVisibilityChangedResponse> onSourceFilterVisibilityChanged) {
+        this.onSourceFilterVisibilityChanged = onSourceFilterVisibilityChanged;
+    }
+
     public void registerOnSwitchTransition(Callback<SwitchTransitionResponse> onSwitchTransition) {
         this.onSwitchTransition = onSwitchTransition;
     }
@@ -493,6 +509,24 @@ public void setSourceSettings(String sourceName, Map<String, Object> settings, C
         callbacks.put(SetSourceSettingsResponse.class, callback);
     }
 
+    public void getSourceFilters(String sourceName, Callback<GetSourceFiltersResponse> callback) {
+        GetSourceFiltersRequest request = new GetSourceFiltersRequest(sourceName);
+        session.getRemote().sendStringByFuture(new Gson().toJson(request));
+        callbacks.put(GetSourceFiltersResponse.class, callback);
+    }
+
+    public void getSourceFilterInfo(String sourceName, String filterName, Callback<GetSourceFilterInfoResponse> callback) {
+        GetSourceFilterInfoRequest request = new GetSourceFilterInfoRequest(sourceName, filterName);
+        session.getRemote().sendStringByFuture(new Gson().toJson(request));
+        callbacks.put(GetSourceFilterInfoResponse.class, callback);
+    }
+
+    public void setSourceFilterVisibility(String sourceName, String filterName, boolean filterEnabled, Callback<SetSourceFilterVisibilityResponse> callback) {
+        SetSourceFilterVisibilityRequest request = new SetSourceFilterVisibilityRequest(sourceName, filterName, filterEnabled);
+        session.getRemote().sendStringByFuture(new Gson().toJson(request));
+        callbacks.put(callback.getClass().getSuperclass(), callback);
+    }
+
     public void startRecording(Callback<StartRecordingResponse> callback) {
         StartRecordingRequest request = new StartRecordingRequest(this);
 
diff --git a/src/main/java/net/twasi/obsremotejava/OBSRemoteController.java b/src/main/java/net/twasi/obsremotejava/OBSRemoteController.java
@@ -1,5 +1,6 @@
 package net.twasi.obsremotejava;
 
+import com.google.gson.Gson;
 import net.twasi.obsremotejava.callbacks.Callback;
 import net.twasi.obsremotejava.callbacks.ErrorCallback;
 import net.twasi.obsremotejava.callbacks.StringCallback;
@@ -10,6 +11,10 @@
 import net.twasi.obsremotejava.requests.GetCurrentScene.GetCurrentSceneResponse;
 import net.twasi.obsremotejava.requests.GetPreviewScene.GetPreviewSceneResponse;
 import net.twasi.obsremotejava.requests.GetSceneList.GetSceneListResponse;
+import net.twasi.obsremotejava.requests.GetSourceFilterInfo.GetSourceFilterInfoRequest;
+import net.twasi.obsremotejava.requests.GetSourceFilterInfo.GetSourceFilterInfoResponse;
+import net.twasi.obsremotejava.requests.GetSourceFilters.GetSourceFiltersRequest;
+import net.twasi.obsremotejava.requests.GetSourceFilters.GetSourceFiltersResponse;
 import net.twasi.obsremotejava.requests.GetSourceSettings.GetSourceSettingsResponse;
 import net.twasi.obsremotejava.requests.GetStreamingStatus.GetStreamingStatusResponse;
 import net.twasi.obsremotejava.requests.GetStudioModeEnabled.GetStudioModeEnabledResponse;
@@ -25,6 +30,8 @@
 import net.twasi.obsremotejava.requests.SetMute.SetMuteResponse;
 import net.twasi.obsremotejava.requests.SetPreviewScene.SetPreviewSceneResponse;
 import net.twasi.obsremotejava.requests.SetSceneItemProperties.SetSceneItemPropertiesResponse;
+import net.twasi.obsremotejava.requests.SetSourceFilterVisibility.SetSourceFilterVisibilityRequest;
+import net.twasi.obsremotejava.requests.SetSourceFilterVisibility.SetSourceFilterVisibilityResponse;
 import net.twasi.obsremotejava.requests.SetSourceSettings.SetSourceSettingsResponse;
 import net.twasi.obsremotejava.requests.SetStudioModeEnabled.SetStudioModeEnabledResponse;
 import net.twasi.obsremotejava.requests.SetTransitionDuration.SetTransitionDurationResponse;
@@ -218,6 +225,10 @@ public void registerTransitionEndCallback(Callback<TransitionEndResponse> onTran
         communicator.registerOnTransitionEnd(onTransitionEnd);
     }
 
+    public void registerSourceFilterVisibilityChangedCallback(Callback<SourceFilterVisibilityChangedResponse> onSourceVisibilityChanged) {
+        communicator.registerOnSourceFilterVisibilityChanged(onSourceVisibilityChanged);
+    }
+
     public void await() throws InterruptedException {
         communicator.await();
     }
@@ -248,6 +259,22 @@ public void getSceneItemProperties(String scene, String source, Callback<SetScen
         communicator.getSceneItemProperties(scene, source, callback);
     }
 
+    public void getSourceProperties(String scene, String source, Callback<SetSceneItemPropertiesResponse> callback) {
+        getSceneItemProperties(scene, source, callback);
+    }
+
+    public void getSourceFilters(String sourceName, Callback<GetSourceFiltersResponse> callback) {
+        communicator.getSourceFilters(sourceName, callback);
+    }
+
+    public void getSourceFilterInfo(String sourceName, String filterName, Callback<GetSourceFilterInfoResponse> callback) {
+        communicator.getSourceFilterInfo(sourceName, filterName, callback);
+    }
+
+    public void setSourceFilterVisibility(String sourceName, String filterName, boolean filterEnabled, Callback<SetSourceFilterVisibilityResponse> callback) {
+        communicator.setSourceFilterVisibility(sourceName, filterName, filterEnabled, callback);
+    }
+
     public void getTransitionList(Callback<GetTransitionListResponse> callback) {
         communicator.getTransitionList(callback);
     }
diff --git a/src/main/java/net/twasi/obsremotejava/events/EventType.java b/src/main/java/net/twasi/obsremotejava/events/EventType.java
@@ -11,6 +11,7 @@ public enum EventType {
     StreamStopped,
     SwitchScenes,
     ScenesChanged,
+    SourceFilterVisibilityChanged,
     SwitchTransition,
     TransitionListChanged,
     TransitionBegin,
diff --git a/src/main/java/net/twasi/obsremotejava/objects/SourceFilterInfo.java b/src/main/java/net/twasi/obsremotejava/objects/SourceFilterInfo.java
@@ -0,0 +1,27 @@
+package net.twasi.obsremotejava.objects;
+
+import java.util.Map;
+
+public class SourceFilterInfo {
+
+    private boolean filterStatus; // whether the filter is visible or not
+    private String type;
+    private String name;
+    private Map<String, String> settings;
+
+    public boolean isFilterVisible() {
+        return filterStatus;
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public Map<String, String> getSettings() {
+        return settings;
+    }
+}
diff --git a/src/main/java/net/twasi/obsremotejava/objects/SourceFilterSettings.java b/src/main/java/net/twasi/obsremotejava/objects/SourceFilterSettings.java
@@ -0,0 +1,19 @@
+package net.twasi.obsremotejava.objects;
+
+import java.util.Collection;
+import java.util.Map;
+
+public class SourceFilterSettings {
+    private Collection<Map<String,String>> map;
+
+    public Collection<Map<String, String>> getMap() {
+        return map;
+    }
+
+    @Override
+    public String toString() {
+        return "SourceFilterSettings{" +
+                map +
+                '}';
+    }
+}
diff --git a/src/main/java/net/twasi/obsremotejava/requests/GetSourceFilterInfo/GetSourceFilterInfoRequest.java b/src/main/java/net/twasi/obsremotejava/requests/GetSourceFilterInfo/GetSourceFilterInfoRequest.java
@@ -0,0 +1,16 @@
+package net.twasi.obsremotejava.requests.GetSourceFilterInfo;
+
+import net.twasi.obsremotejava.requests.BaseRequest;
+import net.twasi.obsremotejava.requests.RequestType;
+
+public class GetSourceFilterInfoRequest extends BaseRequest {
+    private final String sourceName;
+    private final String filterName;
+
+    public GetSourceFilterInfoRequest(String sourceName, String filterName) {
+        super(RequestType.GetSourceFilterInfo);
+        this.sourceName = sourceName;
+        this.filterName = filterName;
+    }
+
+}
diff --git a/src/main/java/net/twasi/obsremotejava/requests/GetSourceFilterInfo/GetSourceFilterInfoResponse.java b/src/main/java/net/twasi/obsremotejava/requests/GetSourceFilterInfo/GetSourceFilterInfoResponse.java
@@ -0,0 +1,29 @@
+package net.twasi.obsremotejava.requests.GetSourceFilterInfo;
+
+import net.twasi.obsremotejava.objects.SourceFilterInfo;
+import net.twasi.obsremotejava.requests.ResponseBase;
+
+import java.util.Map;
+
+public class GetSourceFilterInfoResponse extends ResponseBase {
+    private boolean filterStatus; // whether the filter is visible or not
+    private String type;
+    private String name;
+    private Map<String, String> settings;
+
+    public boolean isFilterVisible() {
+        return filterStatus;
+    }
+
+    public String getType() {
+        return type;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public Map<String, String> getSettings() {
+        return settings;
+    }
+}
diff --git a/src/main/java/net/twasi/obsremotejava/requests/GetSourceFilters/GetSourceFiltersRequest.java b/src/main/java/net/twasi/obsremotejava/requests/GetSourceFilters/GetSourceFiltersRequest.java
@@ -0,0 +1,13 @@
+package net.twasi.obsremotejava.requests.GetSourceFilters;
+
+import net.twasi.obsremotejava.requests.BaseRequest;
+import net.twasi.obsremotejava.requests.RequestType;
+
+public class GetSourceFiltersRequest extends BaseRequest {
+    private final String sourceName;
+
+    public GetSourceFiltersRequest(String sourceName) {
+        super(RequestType.GetSourceFilters);
+        this.sourceName = sourceName;
+    }
+}
diff --git a/src/main/java/net/twasi/obsremotejava/requests/GetSourceFilters/GetSourceFiltersResponse.java b/src/main/java/net/twasi/obsremotejava/requests/GetSourceFilters/GetSourceFiltersResponse.java
@@ -0,0 +1,16 @@
+package net.twasi.obsremotejava.requests.GetSourceFilters;
+
+import net.twasi.obsremotejava.objects.SourceFilterInfo;
+import net.twasi.obsremotejava.requests.GetSourceSettings.GetSourceSettingsResponse;
+import net.twasi.obsremotejava.requests.ResponseBase;
+
+import java.util.List;
+
+public class GetSourceFiltersResponse extends ResponseBase {
+
+    List<SourceFilterInfo> filters;
+
+    public List<SourceFilterInfo> getFilters() {
+        return filters;
+    }
+}
diff --git a/src/main/java/net/twasi/obsremotejava/requests/RequestType.java b/src/main/java/net/twasi/obsremotejava/requests/RequestType.java
@@ -9,6 +9,7 @@ public enum RequestType {
     GetSceneList,
     GetCurrentScene,
 
+
     SetCurrentTransition,
 
     GetSceneItemProperties,
@@ -25,7 +26,10 @@ public enum RequestType {
 
     GetSourceSettings,
     SetSourceSettings,
+
+    GetSourceFilters,
     SetSourceFilterVisibility,
+    GetSourceFilterInfo,
 
     GetStreamingStatus,
     StartRecording,
diff --git a/src/main/java/net/twasi/obsremotejava/requests/SetSourceFilterVisibility/SetSourceFilterVisibilityRequest.java b/src/main/java/net/twasi/obsremotejava/requests/SetSourceFilterVisibility/SetSourceFilterVisibilityRequest.java
@@ -9,7 +9,7 @@ public class SetSourceFilterVisibilityRequest extends BaseRequest {
     private final String filterName;
     private final boolean filterEnabled;
 
-    public SetSourceFilterVisibilityRequest(RequestType type, String sourceName, String filterName, boolean filterEnabled) {
+    public SetSourceFilterVisibilityRequest(String sourceName, String filterName, boolean filterEnabled) {
         super(RequestType.SetSourceFilterVisibility);
         this.sourceName = sourceName;
         this.filterName = filterName;
diff --git a/src/test/java/net/twasi/obsremotejava/test/OBSRemoteControllerUnsecuredIT.java b/src/test/java/net/twasi/obsremotejava/test/OBSRemoteControllerUnsecuredIT.java
@@ -57,6 +57,11 @@ void test() {
             controller.registerTransitionBeginCallback(res -> System.out.println("Transition started from scene: '" + res.getFromScene() + "' to scene: '" + res.getToScene() + "'"));
 
             controller.registerTransitionEndCallback(res -> System.out.println("Transition ended with scene: " + res.getToScene()));
+
+            controller.registerSourceFilterVisibilityChangedCallback(res -> System.out.println(String.format(
+               "Source Filter visibility changed on filter '%s' in source '%s'", res.getFilterName(), res.getSourceName()
+            )));
+
         });
 
         try {
