fix docstring.

examples/events/__main__.py

@@ -17,12 +17,6 @@ class Observer:
         print(f"Registered events: {self._client.callback.get()}")
         self.running = True
 
-    def __enter__(self):
-        return self
-
-    def __exit__(self, exc_type, exc_value, exc_traceback):
-        self._client.disconnect()
-
     def on_current_program_scene_changed(self, data):
         """The current program scene has changed."""
         print(f"Switched to scene {data.scene_name}")
@@ -37,11 +31,13 @@ class Observer:
 
     def on_exit_started(self, _):
         """OBS has begun the shutdown process."""
-        print("OBS closing!")
+        print(f"OBS closing!")
+        self._client.unsubscribe()
         self.running = False
 
 
 if __name__ == "__main__":
-    with Observer() as observer:
-        while observer.running:
-            time.sleep(0.1)
+    observer = Observer()
+
+    while observer.running:
+        time.sleep(0.1)

examples/hotkeys/__main__.py

@@ -1,7 +1,6 @@
 import inspect
 
 import keyboard
-
 import obsws_python as obs
 
 
@@ -11,12 +10,6 @@ class Observer:
         self._client.callback.register(self.on_current_program_scene_changed)
         print(f"Registered events: {self._client.callback.get()}")
 
-    def __enter__(self):
-        return self
-
-    def __exit__(self, exc_type, exc_value, exc_traceback):
-        self._client.disconnect()
-
     @property
     def event_identifier(self):
         return inspect.stack()[1].function
@@ -38,12 +31,13 @@ def set_scene(scene, *args):
 
 
 if __name__ == "__main__":
-    with obs.ReqClient() as req_client:
-        with Observer() as observer:
-            keyboard.add_hotkey("0", version)
-            keyboard.add_hotkey("1", set_scene, args=("START",))
-            keyboard.add_hotkey("2", set_scene, args=("BRB",))
-            keyboard.add_hotkey("3", set_scene, args=("END",))
+    req_client = obs.ReqClient()
+    observer = Observer()
 
-            print("press ctrl+enter to quit")
-            keyboard.wait("ctrl+enter")
+    keyboard.add_hotkey("0", version)
+    keyboard.add_hotkey("1", set_scene, args=("START",))
+    keyboard.add_hotkey("2", set_scene, args=("BRB",))
+    keyboard.add_hotkey("3", set_scene, args=("END",))
+
+    print("press ctrl+enter to quit")
+    keyboard.wait("ctrl+enter")

examples/levels/__main__.py

@@ -9,8 +9,6 @@ LEVELTYPE = IntEnum(
     start=0,
 )
 
-DEVICE = "Desktop Audio"
-
 
 def on_input_mute_state_changed(data):
     """An input's mute state has changed."""
@@ -34,14 +32,15 @@ def on_input_volume_meters(data):
 
 
 def main():
-    with obs.EventClient(
-        subs=(obs.Subs.LOW_VOLUME | obs.Subs.INPUTVOLUMEMETERS)
-    ) as client:
-        client.callback.register([on_input_volume_meters, on_input_mute_state_changed])
+    client = obs.EventClient(subs=(obs.Subs.LOW_VOLUME | obs.Subs.INPUTVOLUMEMETERS))
+    client.callback.register([on_input_volume_meters, on_input_mute_state_changed])
 
-        while _ := input("Press <Enter> to exit\n"):
-            pass
+    while cmd := input("<Enter> to exit>\n"):
+        if not cmd:
+            break
 
 
 if __name__ == "__main__":
+    DEVICE = "Desktop Audio"
+
     main()

obsws_python/events.py

@@ -1,8 +1,9 @@
 import json
 import logging
-import threading
+import time
+from threading import Thread
 
-from websocket import WebSocketConnectionClosedException, WebSocketTimeoutException
+from websocket import WebSocketTimeoutException
 
 from .baseclient import ObsClient
 from .callback import Callback
@@ -19,6 +20,8 @@ logger = logging.getLogger(__name__)
 
 
 class EventClient:
+    DELAY = 0.001
+
     def __init__(self, **kwargs):
         self.logger = logger.getChild(self.__class__.__name__)
         defaultkwargs = {"subs": Subs.LOW_VOLUME}
@@ -35,12 +38,6 @@ class EventClient:
         self.callback = Callback()
         self.subscribe()
 
-    def __enter__(self):
-        return self
-
-    def __exit__(self, exc_type, exc_value, exc_traceback):
-        self.disconnect()
-
     def __repr__(self):
         return type(
             self
@@ -52,40 +49,33 @@ class EventClient:
         return type(self).__name__
 
     def subscribe(self):
-        self.base_client.ws.settimeout(None)
-        stop_event = threading.Event()
-        self.worker = threading.Thread(
-            target=self.trigger, daemon=True, args=(stop_event,)
-        )
-        self.worker.start()
+        worker = Thread(target=self.trigger, daemon=True)
+        worker.start()
 
-    def trigger(self, stop_event):
+    def trigger(self):
         """
         Continuously listen for events.
 
         Triggers a callback on event received.
         """
-        while not stop_event.is_set():
+        self.running = True
+        while self.running:
             try:
-                if response := self.base_client.ws.recv():
-                    event = json.loads(response)
-                    self.logger.debug(f"Event received {event}")
-                    type_, data = (
-                        event["d"].get("eventType"),
-                        event["d"].get("eventData"),
-                    )
-                    self.callback.trigger(type_, data if data else {})
+                event = json.loads(self.base_client.ws.recv())
             except WebSocketTimeoutException as e:
                 self.logger.exception(f"{type(e).__name__}: {e}")
                 raise OBSSDKTimeoutError("Timeout while waiting for event") from e
-            except (WebSocketConnectionClosedException, OSError) as e:
-                self.logger.debug(f"{type(e).__name__} terminating the event thread")
-                stop_event.set()
-
-    def disconnect(self):
-        """stop listening for events"""
+            self.logger.debug(f"Event received {event}")
+            type_, data = (
+                event["d"].get("eventType"),
+                event["d"].get("eventData"),
+            )
+            self.callback.trigger(type_, data if data else {})
+            time.sleep(self.DELAY)
 
+    def unsubscribe(self):
+        """
+        stop listening for events
+        """
+        self.running = False
         self.base_client.ws.close()
-        self.worker.join()
-
-    unsubscribe = disconnect

obsws_python/reqs.py

@@ -31,7 +31,7 @@ class ReqClient:
         return self
 
     def __exit__(self, exc_type, exc_value, exc_traceback):
-        self.disconnect()
+        self.base_client.ws.close()
 
     def __repr__(self):
         return type(
@@ -42,9 +42,6 @@ class ReqClient:
 
     def __str__(self):
         return type(self).__name__
-    
-    def disconnect(self):
-        self.base_client.ws.close()
 
     def send(self, param, data=None, raw=False):
         try:
@@ -436,19 +433,6 @@ class ReqClient:
         """
         return self.send("GetRecordDirectory")
 
-    def set_record_directory(self, recordDirectory):
-        """
-        Sets the current directory that the record output writes files to. 
-        IMPORTANT NOTE: Requires obs websocket v5.3 or higher.
-
-        :param recordDirectory: Output directory
-        :type recordDirectory: str
-        """
-        payload = {
-            "recordDirectory": recordDirectory,
-        }
-        return self.send("SetRecordDirectory", payload)
-    
     def get_source_active(self, name):
         """
         Gets the active and show state of a source
@@ -1962,24 +1946,16 @@ class ReqClient:
         """
         Opens a projector for a specific output video mix.
 
-        The available mix types are:
-            OBS_WEBSOCKET_VIDEO_MIX_TYPE_PREVIEW
-            OBS_WEBSOCKET_VIDEO_MIX_TYPE_PROGRAM
-            OBS_WEBSOCKET_VIDEO_MIX_TYPE_MULTIVIEW
-
-        :param video_mix_type: Type of mix to open.
-        :type video_mix_type:  str
-        :param monitor_index: Monitor index, use GetMonitorList to obtain index
-        :type monitor_index:  int
-        :param projector_geometry:
-            Size/Position data for a windowed projector, in Qt Base64 encoded format.
-            Mutually exclusive with monitorIndex
-        :type projector_geometry: str
+        :param videoMixType: Type of mix to open
+        :type videoMixType:  str
+        :param monitorIndex: Monitor index, use GetMonitorList to obtain index
+        :type monitorIndex:  int
+        :param projectorGeometry: Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with monitorIndex
+        :type projectorGeometry: str
 
         """
         warn(
-            "open_video_mix_projector request serves to provide feature parity with 4.x. "
-            "It is very likely to be changed/deprecated in a future release.",
+            "open_video_mix_projector request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.",
             DeprecationWarning,
             stacklevel=2,
         )
@@ -1996,19 +1972,16 @@ class ReqClient:
         """
         Opens a projector for a source.
 
-        :param source_name: Name of the source to open a projector for
-        :type source_name:  str
-        :param monitor_index: Monitor index, use GetMonitorList to obtain index
-        :type monitor_index:  int
-        :param projector_geometry:
-            Size/Position data for a windowed projector, in Qt Base64 encoded format.
-            Mutually exclusive with monitorIndex
-        :type projector_geometry: str
+        :param sourceName: Name of the source to open a projector for
+        :type sourceName:  str
+        :param monitorIndex: Monitor index, use GetMonitorList to obtain index
+        :type monitorIndex:  int
+        :param projectorGeometry: Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with monitorIndex
+        :type projectorGeometry: str
 
         """
         warn(
-            "open_source_projector request serves to provide feature parity with 4.x. "
-            "It is very likely to be changed/deprecated in a future release.",
+            "open_source_projector request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.",
             DeprecationWarning,
             stacklevel=2,
         )

obsws_python/version.py

@@ -1 +1 @@
-version = "1.7.0"
+version = "1.6.0"

tests/test_request.py

@@ -15,9 +15,9 @@ class TestRequests:
         resp = req_cl.get_hot_key_list()
         obsbasic_hotkey_list = [
             "OBSBasic.SelectScene",
-            "OBSBasic.QuickTransition.1",
-            "OBSBasic.QuickTransition.2",
-            "OBSBasic.QuickTransition.3",
+            "OBSBasic.SelectScene",
+            "OBSBasic.SelectScene",
+            "OBSBasic.SelectScene",
             "OBSBasic.StartStreaming",
             "OBSBasic.StopStreaming",
             "OBSBasic.ForceStopStreaming",
@@ -25,17 +25,15 @@ class TestRequests:
             "OBSBasic.StopRecording",
             "OBSBasic.PauseRecording",
             "OBSBasic.UnpauseRecording",
-            "OBSBasic.SplitFile",
             "OBSBasic.StartReplayBuffer",
             "OBSBasic.StopReplayBuffer",
             "OBSBasic.StartVirtualCam",
             "OBSBasic.StopVirtualCam",
             "OBSBasic.EnablePreview",
             "OBSBasic.DisablePreview",
-            "OBSBasic.EnablePreviewProgram",
-            "OBSBasic.DisablePreviewProgram",
             "OBSBasic.ShowContextBar",
             "OBSBasic.HideContextBar",
+            "OBSBasic.TogglePreviewProgram",
             "OBSBasic.Transition",
             "OBSBasic.ResetStats",
             "OBSBasic.Screenshot",