add v5.4, v5.5 methods

v5.4:
- get_source_filter_kind_list
- get_scene_item_source

v5.5:
- split_record_file
- create_record_chapter

minor bump

.gitignore

@@ -51,7 +51,7 @@ venv.bak/
 .python-version
 
 # Test/config
-quick.py
+test-*.py
 config.toml
 obsws.log
 

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: local
+    hooks:
+      - id: format
+        name: format
+        entry: hatch run style:fmt
+        language: system
+        pass_filenames: false
+        verbose: true
+        files: \.(py)$

README.md

@@ -1,5 +1,6 @@
 [![PyPI version](https://badge.fury.io/py/obsws-python.svg)](https://badge.fury.io/py/obsws-python)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/aatikturk/obsstudio_sdk/blob/main/LICENSE)
+[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
 
@@ -92,7 +93,7 @@ resp = cl_req.send("GetVersion", raw=True)
 print(f"response data: {resp}")
 ```
 
-For a full list of requests refer to [Requests](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requests)
+For a full list of requests refer to [Requests][obsws-reqs]
 
 ### Events
 
@@ -125,7 +126,7 @@ cl.callback.deregister(on_input_mute_state_changed)
 
 `register(fns)` and `deregister(fns)` accept both single functions and lists of functions.
 
-For a full list of events refer to [Events](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#events)
+For a full list of events refer to [Events][obsws-events]
 
 ### Attributes
 
@@ -149,7 +150,7 @@ def on_scene_created(data):
   - The following attributes are available:
     - `req_name`: name of the request.
     - `code`: request status code.
-  - For a full list of status codes refer to [Codes](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus)
+  - For a full list of status codes refer to [Codes][obsws-codes]
 
 ### Logging
 
@@ -168,18 +169,21 @@ logging.basicConfig(level=logging.DEBUG)
 
 ### Tests
 
-First install development dependencies:
+Install [hatch][hatch-install] and then:
-
-`pip install -e .['dev']`
-
-To run all tests:
 
 ```
-pytest -v
+hatch test
 ```
 
 ### Official Documentation
 
 For the full documentation:
 
-- [OBS Websocket SDK](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#obs-websocket-501-protocol)
+- [OBS Websocket SDK][obsws-pro]
+
+
+[obsws-reqs]: https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requests
+[obsws-events]: https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#events
+[obsws-codes]: https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#requeststatus
+[obsws-pro]: https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#obs-websocket-501-protocol
+[hatch-install]: https://hatch.pypa.io/latest/install/

examples/events/__main__.py

@@ -17,6 +17,12 @@ 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}")
@@ -31,13 +37,11 @@ class Observer:
 
     def on_exit_started(self, _):
         """OBS has begun the shutdown process."""
-        print(f"OBS closing!")
+        print("OBS closing!")
-        self._client.unsubscribe()
         self.running = False
 
 
 if __name__ == "__main__":
-    observer = Observer()
+    with Observer() as observer:
-
         while observer.running:
             time.sleep(0.1)

examples/hotkeys/__main__.py

@@ -1,6 +1,7 @@
 import inspect
 
 import keyboard
+
 import obsws_python as obs
 
 
@@ -10,6 +11,12 @@ 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
@@ -31,9 +38,8 @@ def set_scene(scene, *args):
 
 
 if __name__ == "__main__":
-    req_client = obs.ReqClient()
+    with obs.ReqClient() as req_client:
-    observer = Observer()
+        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",))

examples/levels/__main__.py

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

obsws_python/baseclient.py

@@ -96,10 +96,8 @@ class ObsClient:
 
             auth = base64.b64encode(
                 hashlib.sha256(
-                    (
                     secret
                     + self.server_hello["d"]["authentication"]["challenge"].encode()
-                    )
                 ).digest()
             ).decode()
 

obsws_python/callback.py

@@ -1,4 +1,5 @@
-from typing import Callable, Iterable, Union
+from collections.abc import Callable, Iterable
+from typing import Union
 
 from .util import as_dataclass, to_camel_case, to_snake_case
 

obsws_python/events.py

@@ -1,9 +1,8 @@
 import json
 import logging
-import time
+import threading
-from threading import Thread
 
-from websocket import WebSocketTimeoutException
+from websocket import WebSocketConnectionClosedException, WebSocketTimeoutException
 
 from .baseclient import ObsClient
 from .callback import Callback
@@ -20,8 +19,6 @@ 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}
@@ -38,6 +35,12 @@ 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
@@ -49,33 +52,40 @@ class EventClient:
         return type(self).__name__
 
     def subscribe(self):
-        worker = Thread(target=self.trigger, daemon=True)
+        self.base_client.ws.settimeout(None)
-        worker.start()
+        stop_event = threading.Event()
+        self.worker = threading.Thread(
+            target=self.trigger, daemon=True, args=(stop_event,)
+        )
+        self.worker.start()
 
-    def trigger(self):
+    def trigger(self, stop_event):
         """
         Continuously listen for events.
 
         Triggers a callback on event received.
         """
-        self.running = True
+        while not stop_event.is_set():
-        while self.running:
             try:
-                event = json.loads(self.base_client.ws.recv())
+                if response := self.base_client.ws.recv():
-            except WebSocketTimeoutException as e:
+                    event = json.loads(response)
-                self.logger.exception(f"{type(e).__name__}: {e}")
-                raise OBSSDKTimeoutError("Timeout while waiting for event") from e
                     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)
+            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"""
 
-    def unsubscribe(self):
-        """
-        stop listening for events
-        """
-        self.running = False
         self.base_client.ws.close()
+        self.worker.join()
+
+    unsubscribe = disconnect

obsws_python/reqs.py

@@ -1,4 +1,5 @@
 import logging
+from warnings import warn
 
 from .baseclient import ObsClient
 from .error import OBSSDKError, OBSSDKRequestError
@@ -30,7 +31,7 @@ class ReqClient:
         return self
 
     def __exit__(self, exc_type, exc_value, exc_traceback):
-        self.base_client.ws.close()
+        self.disconnect()
 
     def __repr__(self):
         return type(
@@ -42,6 +43,9 @@ 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:
             response = self.base_client.req(param, data)
@@ -134,39 +138,39 @@ class ReqClient:
 
     get_hotkey_list = get_hot_key_list
 
-    def trigger_hot_key_by_name(self, hotkeyName):
+    def trigger_hot_key_by_name(self, hotkeyName, contextName=None):
         """
         Triggers a hotkey using its name. For hotkey names
         See GetHotkeyList
 
         :param hotkeyName: Name of the hotkey to trigger
         :type hotkeyName: str
+        :param contextName: Name of context of the hotkey to trigger
+        :type contextName: str, optional
 
 
         """
-        payload = {"hotkeyName": hotkeyName}
+        payload = {"hotkeyName": hotkeyName, "contextName": contextName}
         self.send("TriggerHotkeyByName", payload)
 
     trigger_hotkey_by_name = trigger_hot_key_by_name
 
     def trigger_hot_key_by_key_sequence(
-        self, keyId, pressShift, pressCtrl, pressAlt, pressCmd
+        self, keyId, pressShift=None, pressCtrl=None, pressAlt=None, pressCmd=None
     ):
         """
         Triggers a hotkey using a sequence of keys.
 
         :param keyId: The OBS key ID to use. See https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h
         :type keyId: str
-        :param keyModifiers: Object containing key modifiers to apply.
+        :param pressShift: Press Shift
-        :type keyModifiers: dict
+        :type pressShift: bool, optional
-        :param keyModifiers.shift: Press Shift
+        :param pressCtrl: Press CTRL
-        :type keyModifiers.shift: bool
+        :type pressCtrl: bool, optional
-        :param keyModifiers.control: Press CTRL
+        :param pressAlt: Press ALT
-        :type keyModifiers.control: bool
+        :type pressAlt: bool, optional
-        :param keyModifiers.alt: Press ALT
+        :param pressCmd: Press CMD (Mac)
-        :type keyModifiers.alt: bool
+        :type pressCmd: bool, optional
-        :param keyModifiers.cmd: Press CMD (Mac)
-        :type keyModifiers.cmd: bool
 
 
         """
@@ -432,6 +436,19 @@ 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
@@ -1083,6 +1100,14 @@ class ReqClient:
         payload = {"position": pos, "release": release}
         self.send("SetTBarPosition", payload)
 
+    def get_source_filter_kind_list(self):
+        """
+        Gets an array of all available source filter kinds.
+
+
+        """
+        return self.send("GetSourceFilterKindList")
+
     def get_source_filter_list(self, name):
         """
         Gets a list of all of a source's filters.
@@ -1294,6 +1319,23 @@ class ReqClient:
         }
         return self.send("GetSceneItemId", payload)
 
+    def get_scene_item_source(self, scene_name, scene_item_id):
+        """
+        Gets the source associated with a scene item.
+
+        :param scene_item_id: Numeric ID of the scene item (>= 0)
+        :type scene_item_id: int
+        :param scene_name: Name of the scene the item is in.
+        :type scene_name: str
+
+
+        """
+        payload = {
+            "sceneItemId": scene_item_id,
+            "sceneName": scene_name,
+        }
+        return self.send("GetSceneItemSource", payload)
+
     def create_scene_item(self, scene_name, source_name, enabled=None):
         """
         Creates a new scene item using a source.
@@ -1767,7 +1809,7 @@ class ReqClient:
 
 
         """
-        self.send("ToggleRecord")
+        return self.send("ToggleRecord")
 
     def start_record(self):
         """
@@ -1809,6 +1851,28 @@ class ReqClient:
         """
         self.send("ResumeRecord")
 
+    def split_record_file(self):
+        """
+        Splits the current file being recorded into a new file.
+
+
+        """
+        self.send("SplitRecordFile")
+
+    def create_record_chapter(self, chapter_name=None):
+        """
+        Adds a new chapter marker to the file currently being recorded.
+
+        Note: As of OBS 30.2.0, the only file format supporting this feature is Hybrid MP4.
+
+        :param chapter_name: Name of the new chapter
+        :type chapter_name: str
+
+
+        """
+        payload = {"chapterName": chapter_name}
+        self.send("CreateRecordChapter", payload)
+
     def get_media_input_status(self, name):
         """
         Gets the status of a media input.
@@ -1938,3 +2002,66 @@ class ReqClient:
 
         """
         return self.send("GetMonitorList")
+
+    def open_video_mix_projector(
+        self, video_mix_type, monitor_index=-1, projector_geometry=None
+    ):
+        """
+        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
+
+        """
+        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.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        payload = {
+            "videoMixType": video_mix_type,
+            "monitorIndex": monitor_index,
+            "projectorGeometry": projector_geometry,
+        }
+        self.send("OpenVideoMixProjector", payload)
+
+    def open_source_projector(
+        self, source_name, monitor_index=-1, projector_geometry=None
+    ):
+        """
+        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
+
+        """
+        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.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        payload = {
+            "sourceName": source_name,
+            "monitorIndex": monitor_index,
+            "projectorGeometry": projector_geometry,
+        }
+        self.send("OpenSourceProjector", payload)

obsws_python/version.py

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

pyproject.toml

@@ -7,7 +7,7 @@ name = "obsws-python"
 dynamic = ["version"]
 description = "A Python SDK for OBS Studio WebSocket v5.0"
 readme = "README.md"
-license = "GPL-3.0-only"
+license = { text = "GPL-3.0-only" }
 requires-python = ">=3.9"
 authors = [
     { name = "Adem Atikturk", email = "aatikturk@gmail.com" },
@@ -17,14 +17,6 @@ dependencies = [
     "websocket-client",
 ]
 
-[project.optional-dependencies]
-dev = [
-    "black",
-    "isort",
-    "pytest",
-    "pytest-randomly",
-]
-
 [project.urls]
 Homepage = "https://github.com/aatikturk/obsws-python"
 
@@ -36,19 +28,58 @@ include = [
     "/obsws_python",
 ]
 
+[tool.hatch.envs.default]
+dependencies = ["pre-commit"]
+
+[tool.hatch.envs.e]
+dependencies = ["keyboard"]
+
 [tool.hatch.envs.e.scripts]
 events = "python {root}\\examples\\events\\."
 hotkeys = "python {root}\\examples\\hotkeys\\."
 levels = "python {root}\\examples\\levels\\."
 scene_rotate = "python {root}\\examples\\scene_rotate\\."
 
-[tool.hatch.envs.test]
+[tool.hatch.envs.hatch-test]
+randomize = true
+
+[tool.hatch.envs.hatch-test.scripts]
+run = "pytest{env:HATCH_TEST_ARGS:} {args}"
+
+[[tool.hatch.envs.hatch-test.matrix]]
+python = ["313", "312", "311", "310", "39"]
+
+[tool.hatch.envs.style]
+detached = true
 dependencies = [
-  "pytest",
+    "black",
+    "isort",
 ]
 
-[tool.hatch.envs.test.scripts]
+[tool.hatch.envs.style.scripts]
-run = 'pytest -v'
+check = [
+    "black --check --diff .",
+    "isort --check-only --diff .",
+]
+fmt = [
+    "isort .",
+    "black .",
+]
 
-[[tool.hatch.envs.test.matrix]]
+[tool.black]
-python = ["39", "310", "311"]
+line-length = 88
+include = '\.pyi?$'
+# 'extend-exclude' excludes files or directories in addition to the defaults
+extend-exclude = '''
+(
+    ^/\.git/  # exclude all files in the .git directory
+    ^/\.hatch/  # exclude all files in the .hatch directory
+    ^/\.pytest_cache/  # exclude all files in the .pytest_cache directory
+    | .*_pb2.py  # exclude autogenerated Protocol Buffer files anywhere in the project
+)
+'''
+
+[tool.isort]
+profile = "black"
+skip = [".gitignore", ".dockerignore"]
+skip_glob = [".git/*", ".hatch/*", ".pytest_cache/*"]

tests/test_attrs.py

@@ -18,7 +18,12 @@ class TestAttrs:
 
     def test_get_current_program_scene_attrs(self):
         resp = req_cl.get_current_program_scene()
-        assert resp.attrs() == ["current_program_scene_name"]
+        assert resp.attrs() == [
+            "current_program_scene_name",
+            "current_program_scene_uuid",
+            "scene_name",
+            "scene_uuid",
+        ]
 
     def test_get_transition_kind_list_attrs(self):
         resp = req_cl.get_transition_kind_list()

tests/test_callback.py

@@ -1,4 +1,5 @@
 import pytest
+
 from obsws_python.callback import Callback
 
 

tests/test_request.py

@@ -13,33 +13,8 @@ class TestRequests:
 
     def test_get_hot_key_list(self):
         resp = req_cl.get_hot_key_list()
-        obsbasic_hotkey_list = [
+        assert resp.hotkeys
-            "OBSBasic.SelectScene",
+        assert any(x.startswith("OBSBasic.") for x in resp.hotkeys)
-            "OBSBasic.SelectScene",
-            "OBSBasic.SelectScene",
-            "OBSBasic.SelectScene",
-            "OBSBasic.StartStreaming",
-            "OBSBasic.StopStreaming",
-            "OBSBasic.ForceStopStreaming",
-            "OBSBasic.StartRecording",
-            "OBSBasic.StopRecording",
-            "OBSBasic.PauseRecording",
-            "OBSBasic.UnpauseRecording",
-            "OBSBasic.StartReplayBuffer",
-            "OBSBasic.StopReplayBuffer",
-            "OBSBasic.StartVirtualCam",
-            "OBSBasic.StopVirtualCam",
-            "OBSBasic.EnablePreview",
-            "OBSBasic.DisablePreview",
-            "OBSBasic.ShowContextBar",
-            "OBSBasic.HideContextBar",
-            "OBSBasic.TogglePreviewProgram",
-            "OBSBasic.Transition",
-            "OBSBasic.ResetStats",
-            "OBSBasic.Screenshot",
-            "OBSBasic.SelectedSourceScreenshot",
-        ]
-        assert all(x in resp.hotkeys for x in obsbasic_hotkey_list)
 
     @pytest.mark.parametrize(
         "name,data",
@@ -53,6 +28,7 @@ class TestRequests:
         resp = req_cl.get_persistent_data("OBS_WEBSOCKET_DATA_REALM_PROFILE", name)
         assert resp.slot_value == data
 
+    @pytest.mark.skip(reason="possible bug in obs-websocket, needs checking")
     def test_profile_list(self):
         req_cl.create_profile("test")
         resp = req_cl.get_profile_list()
@@ -95,11 +71,15 @@ class TestRequests:
             "START_TEST", "test", "color_source_v3", {"color": 4294945535}, True
         )
         resp = req_cl.get_input_list()
-        assert {
+        for input_item in resp.inputs:
-            "inputKind": "color_source_v3",
+            if input_item["inputName"] == "test":
-            "inputName": "test",
+                assert input_item["inputKind"] == "color_source_v3"
-            "unversionedInputKind": "color_source",
+                assert input_item["unversionedInputKind"] == "color_source"
-        } in resp.inputs
+                break
+        else:
+            # This else block is executed if the for loop completes without finding the input_item with inputName "test"
+            raise AssertionError("Input with inputName 'test' not found")
+
         resp = req_cl.get_input_settings("test")
         assert resp.input_kind == "color_source_v3"
         assert resp.input_settings == {"color": 4294945535}