diff --git a/OBSActionBase.py b/OBSActionBase.py new file mode 100644 index 0000000..db9746d --- /dev/null +++ b/OBSActionBase.py @@ -0,0 +1,79 @@ +from src.backend.PluginManager.ActionBase import ActionBase +from src.backend.PluginManager.PluginBase import PluginBase + +# Import gtk modules +import gi +gi.require_version("Gtk", "4.0") +gi.require_version("Adw", "1") +from gi.repository import Gtk, Adw + +class OBSActionBase(ActionBase): + def __init__(self, deck_controller, page, coords): + super().__init__(deck_controller=deck_controller, page=page, coords=coords) + + self.status_label = Gtk.Label(label="Couldn't connect to OBS", css_classes=["bold", "red"]) + + def get_config_rows(self) -> list: + self.ip_entry = Adw.EntryRow(title="IP Address") + self.port_spinner = Adw.SpinRow.new_with_range(0, 65535, 1) + self.port_spinner.set_title("Port:") + self.password_entry = Adw.PasswordEntryRow(title="Password") + + self.load_config_defaults() + + # Connect signals + self.ip_entry.connect("notify::text", self.on_change_ip) + self.port_spinner.connect("notify::value", self.on_change_port) + self.password_entry.connect("notify::text", self.on_change_password) + + return [self.ip_entry, self.port_spinner, self.password_entry] + + def load_config_defaults(self): + settings = self.PLUGIN_BASE.get_settings() + ip = settings.setdefault("ip", "localhost") + port = settings.setdefault("port", 4455) + password = settings.setdefault("password", "") + + # Update ui + self.ip_entry.set_text(ip) + self.port_spinner.set_value(port) + self.password_entry.set_text(password) + + self.PLUGIN_BASE.set_settings(settings) + + def on_change_ip(self, entry, *args): + settings = self.PLUGIN_BASE.get_settings() + settings["ip"] = entry.get_text() + self.PLUGIN_BASE.set_settings(settings) + + self.reconnect_obs() + + def on_change_port(self, spinner, *args): + settings = self.PLUGIN_BASE.get_settings() + settings["port"] = int(spinner.get_value()) + self.PLUGIN_BASE.set_settings(settings) + + self.reconnect_obs() + + def on_change_password(self, entry, *args): + settings = self.PLUGIN_BASE.get_settings() + settings["password"] = entry.get_text() + self.PLUGIN_BASE.set_settings(settings) + + self.reconnect_obs() + + def reconnect_obs(self): + print("reconnecing obs") + self.PLUGIN_BASE.obs.connect_to(host=self.PLUGIN_BASE.get_settings()["ip"], port=self.PLUGIN_BASE.get_settings()["port"], password=self.PLUGIN_BASE.get_settings()["password"], timeout=3, legacy=False) + + if self.PLUGIN_BASE.obs.connected: + self.status_label.set_label("Successfully connected to OBS") + self.status_label.remove_css_class("red") + self.status_label.add_css_class("green") + else: + self.status_label.set_label("Couldn't connect to OBS") + self.status_label.remove_css_class("green") + self.status_label.add_css_class("red") + + def get_custom_config_area(self): + return self.status_label \ No newline at end of file diff --git a/OBSController.py b/OBSController.py new file mode 100644 index 0000000..22445ec --- /dev/null +++ b/OBSController.py @@ -0,0 +1,192 @@ +from obswebsocket import obsws, requests +import obswebsocket +from loguru import logger as log +import websocket + +class OBSController(obsws): + def __init__(self): + self.connected = False + self.event_obs: obsws = None # All events are connected to this to avoid crash if a request is made in an event + pass + + def on_connect(self, obs): + self.connected = True + + def on_disconnect(self, obs): + self.connected = False + + def connect_to(self, host=None, port=None, timeout=1, legacy=False, **kwargs): + try: + log.debug(f"Trying to connect to obs with legacy: {legacy}") + super().__init__(host=host, port=port, timeout=timeout, legacy=legacy, on_connect=self.on_connect, on_disconnect=self.on_disconnect, authreconnect=True, **kwargs) + self.event_obs = obsws(host=host, port=port, timeout=timeout, legacy=legacy, on_connect=self.on_connect, on_disconnect=self.on_disconnect, authreconnect=True, **kwargs) + self.connect() + log.info("Successfully connected to OBS") + except obswebsocket.exceptions.ConnectionFailure as e: + try: + log.error(f"Failed to connect to OBS with legacy: {legacy}, trying with legacy: {not legacy}") + super().__init__(host=host, port=port, timeout=timeout, legacy=not legacy, on_connect=self.on_connect, on_disconnect=self.on_disconnect, authreconnect=True, **kwargs) + self.event_obs = obsws(host=host, port=port, timeout=timeout, legacy=not legacy, on_connect=self.on_connect, on_disconnect=self.on_disconnect, authreconnect=True, **kwargs) + self.connect() + log.info("Successfully connected to OBS") + except obswebsocket.exceptions.ConnectionFailure as e: + log.error(f"Failed to connect to OBS: {e}") + + + def get_scenes(self) -> list: + try: + scenes = self.call(requests.GetSceneList()).getScenes() + return [scene["sceneName"] for scene in scenes] + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def switch_to_scene(self, scene:str) -> None: + try: + self.call(requests.SetCurrentProgramScene(sceneName=scene)) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + ## Stream methods + def start_stream(self) -> None: + try: + self.call(requests.StartStream()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def stop_stream(self) -> None: + try: + self.call(requests.StopStream()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def toggle_stream(self): + """ + outputActive: bool -> The new state of the stream + """ + try: + self.call(requests.ToggleStream()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def get_stream_status(self) -> bool: + """ + outputActive: bool -> Whether streaming is active + outputReconnecting: bool -> Whether streaming is reconnecting + outputTimecode: str -> The current timecode of the stream + outputDuration: int -> The duration of the stream in milliseconds + outputCongestion: int -> The congestion of the stream + outputBytes: int -> The number of bytes written to the stream + outputSkippedFrames: int -> The number of skipped frames + outputTotalFrames: int -> The total number of delivered frames + """ + try: + return self.call(requests.GetStreamStatus()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def send_stream_caption(self, caption:str): + try: + self.call(requests.SendStreamCaption(caption=caption)) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + + ## Record methods + def start_record(self) -> None: + try: + return self.call(requests.StartRecord()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def pause_record(self): + try: + return self.call(requests.PauseRecord()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def resume_record(self): + try: + return self.call(requests.ResumeRecord()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def stop_recording(self) -> None: + """ + outputPath: str -> The path to the saved recording + """ + try: + return self.call(requests.StopRecord()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def get_record_status(self): + """ + outputActive: bool -> Whether recording is active + outputPaused: bool -> Whether recording is paused + outputTimecode: str -> The current timecode of the recording + outputDuration: int -> The duration of the recording in milliseconds + outputBytes: int -> The number of bytes written to the recording + """ + try: + return self.call(requests.GetRecordStatus()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def toggle_record(self): + try: + return self.call(requests.ToggleRecord()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def toggle_record_pause(self): + try: + return self.call(requests.ToggleRecordPause()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + + ## UI methods + def get_studio_mode_enabled(self): + """ + studioModeEnabled: bool -> Whether studio mode is enabled + """ + try: + return self.call(requests.GetStudioModeEnabled()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def set_studio_mode_enabled(self, enabled:bool): + return self.call(requests.SetStudioModeEnabled(studioModeEnabled=enabled)) + + + ## Replay Buffer + def start_replay_buffer(self): + try: + return self.call(requests.StartReplayBuffer()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def stop_replay_buffer(self): + try: + return self.call(requests.StopReplayBuffer()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def get_replay_buffer_status(self): + """ + outputActive: bool -> Whether replay buffer is active + """ + try: + return self.call(requests.GetReplayBufferStatus()) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) + + def register(self, *args, **kwargs): + """ + Pass all event register calls to the event_obs. + This avoid crashes if a request is made in an event + """ + try: + self.event_obs.register(*args, **kwargs) + except (obswebsocket.exceptions.MessageTimeout, websocket._exceptions.WebSocketConnectionClosedException, KeyError) as e: + log.error(e) \ No newline at end of file diff --git a/assets/Apache-2.0.txt b/assets/Apache-2.0.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/assets/Apache-2.0.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/assets/Attribution.txt b/assets/Attribution.txt new file mode 100644 index 0000000..74a7047 --- /dev/null +++ b/assets/Attribution.txt @@ -0,0 +1,6 @@ +All images in this folder are compositions of icons from Google's Material icons +which can be accessed under: https://fonts.google.com/icons. + +They are licensed under the Apache 2.0 license +which can be found under: https://www.apache.org/licenses/LICENSE-2.0. +A copy of this license can be found in the "Apache 2.0.txt" file \ No newline at end of file diff --git a/assets/error.png b/assets/error.png new file mode 100644 index 0000000..22c253e Binary files /dev/null and b/assets/error.png differ diff --git a/assets/record_active.png b/assets/record_active.png new file mode 100644 index 0000000..745c62f Binary files /dev/null and b/assets/record_active.png differ diff --git a/assets/record_inactive.png b/assets/record_inactive.png new file mode 100644 index 0000000..f77dd41 Binary files /dev/null and b/assets/record_inactive.png differ diff --git a/assets/record_pause.png b/assets/record_pause.png new file mode 100644 index 0000000..fbf68ed Binary files /dev/null and b/assets/record_pause.png differ diff --git a/assets/record_paused.png b/assets/record_paused.png new file mode 100644 index 0000000..bc200bf Binary files /dev/null and b/assets/record_paused.png differ diff --git a/assets/record_resume.png b/assets/record_resume.png new file mode 100644 index 0000000..1faa753 Binary files /dev/null and b/assets/record_resume.png differ diff --git a/main.py b/main.py new file mode 100644 index 0000000..a291924 --- /dev/null +++ b/main.py @@ -0,0 +1,201 @@ +from src.backend.PluginManager.ActionBase import ActionBase +from src.backend.PluginManager.PluginBase import PluginBase + +# Import gtk modules +import gi +gi.require_version("Gtk", "4.0") +gi.require_version("Adw", "1") +from gi.repository import Gtk, Adw, Gdk + +import sys +import os +import threading +from datetime import timedelta +from loguru import logger as log +from obswebsocket import events + +# Add plugin to sys.paths +sys.path.append(os.path.dirname(__file__)) + +from OBSController import OBSController +from OBSActionBase import OBSActionBase + +class ToggleRecord(OBSActionBase): + ACTION_NAME = "Toggle Record" + CONTROLS_KEY_IMAGE = True + def __init__(self, deck_controller, page, coords): + super().__init__(deck_controller=deck_controller, page=page, coords=coords) + + def on_ready(self): + # Connect to obs if not connected + if not self.PLUGIN_BASE.obs.connected: + # self.PLUGIN_BASE.obs.connect_to(host="localhost", port=4444, timeout=3, legacy=False) + self.reconnect_obs() + + # Show current rec status + self.show_current_rec_status() + + # Register signal + self.PLUGIN_BASE.obs.register(self.on_state_change, events.RecordStateChanged) + + + def on_state_change(self, message): + state_string = message.datain["outputState"] + state = 0 + if state_string == "OBS_WEBSOCKET_OUTPUT_STOPPED": + state = 0 + elif state_string in ["OBS_WEBSOCKET_OUTPUT_STARTING", "OBS_WEBSOCKET_OUTPUT_STARTED", "OBS_WEBSOCKET_OUTPUT_RESUMED"]: + state = 1 + elif state_string == "OBS_WEBSOCKET_OUTPUT_PAUSED": + state = 2 + + self.show_for_state(state) + + def show_current_rec_status(self, new_paused = False): + if not self.PLUGIN_BASE.obs.connected: + self.set_key(media_path=os.path.join(self.PLUGIN_BASE.PATH, "assets", "error.png")) + return + status = self.PLUGIN_BASE.obs.get_record_status() + if status is None: + self.set_key(media_path=os.path.join(self.PLUGIN_BASE.PATH, "assets", "error.png")) + return + active = status.datain["outputActive"] + paused = status.datain["outputPaused"] + if paused: + self.show_for_state(2) + elif active: + self.show_for_state(1) + else: + self.show_for_state(0) + + def show_for_state(self, state: int): + """ + 0: Not Recording + 1: Recording + 2: Paused + 3: Stopping in progress + """ + image = "record_inactive.png" + if state == 0: + self.set_bottom_label(None) + image = "record_inactive.png" + elif state == 1: + self.show_rec_time() + image = "record_active.png" + print("active") + elif state == 2: + self.show_rec_time() + image = "record_resume.png" + + self.set_key(media_path=os.path.join(self.PLUGIN_BASE.PATH, "assets", image)) + + def on_key_down(self): + if not self.PLUGIN_BASE.obs.connected: + return + self.PLUGIN_BASE.obs.toggle_record() + + def on_tick(self): + self.show_current_rec_status() + + def show_rec_time(self): + if not self.PLUGIN_BASE.obs.connected: + self.set_key(media_path=os.path.join(self.PLUGIN_BASE.PATH, "assets", "error.png")) + return + status = self.PLUGIN_BASE.obs.get_record_status() + if status is None: + self.set_key(media_path=os.path.join(self.PLUGIN_BASE.PATH, "assets", "error.png")) + return + active = status.datain["outputActive"] + if not active: + self.set_bottom_label(None) + return + self.set_bottom_label(status.datain["outputTimecode"][:-4], font_size=16) + +class RecPlayPause(OBSActionBase): + ACTION_NAME = "Recording Play/Pause" + CONTROLS_KEY_IMAGE = True + def __init__(self, deck_controller, page, coords): + super().__init__(deck_controller=deck_controller, page=page, coords=coords) + + def on_ready(self): + # Connect to obs if not connected + if not self.PLUGIN_BASE.obs.connected: + # self.PLUGIN_BASE.obs.connect_to(host="localhost", port=4444, timeout=3, legacy=False) + self.reconnect_obs() + + # Show current rec status + self.show_current_rec_status() + + # Register signal + self.PLUGIN_BASE.obs.register(self.on_state_change, events.RecordStateChanged) + + + def on_state_change(self, message): + state_string = message.datain["outputState"] + state = 0 + if state_string in ["OBS_WEBSOCKET_OUTPUT_RESUMED", "OBS_WEBSOCKET_OUTPUT_STARTED"]: + state = 1 + if state_string == "OBS_WEBSOCKET_OUTPUT_PAUSED": + state = 2 + + print(state_string) + + self.show_for_state(state) + + def show_current_rec_status(self, new_paused = False): + if not self.PLUGIN_BASE.obs.connected: + self.set_key(media_path=os.path.join(self.PLUGIN_BASE.PATH, "assets", "error.png")) + return + status = self.PLUGIN_BASE.obs.get_record_status() + if status is None: + self.set_key(media_path=os.path.join(self.PLUGIN_BASE.PATH, "assets", "error.png")) + return + active = status.datain["outputActive"] + paused = status.datain["outputPaused"] + if active and not paused: + self.show_for_state(1) + elif paused: + self.show_for_state(2) + else: + self.show_for_state(0) + + def show_for_state(self, state: int): + """ + 0: Not Recording + 1: Recording + 2: Paused + 3: Stopping in progress + """ + image = "record_inactive.png" + if state == 1: + self.set_bottom_label("Pause", font_size=16) + image = "record_pause.png" + if state == 2: + self.set_bottom_label("Resume", font_size=16) + image = "record_resume.png" + else: + self.set_bottom_label(None) + + self.set_key(media_path=os.path.join(self.PLUGIN_BASE.PATH, "assets", image)) + + def on_key_down(self): + if not self.PLUGIN_BASE.obs.connected: + return + self.PLUGIN_BASE.obs.toggle_record_pause() + + def on_tick(self): + self.show_current_rec_status() + +class OBS(PluginBase): + def __init__(self): + self.PLUGIN_NAME = "OBS" + self.GITHUB_REPO = "https://github.com/your-github-repo" + super().__init__() + + self.obs = OBSController() + + self.add_action(ToggleRecord) + self.add_action(RecPlayPause) + + # Load custom css + self.add_css_stylesheet(os.path.join(self.PATH, "style.css")) \ No newline at end of file diff --git a/manifest.json b/manifest.json new file mode 100644 index 0000000..6c68db0 --- /dev/null +++ b/manifest.json @@ -0,0 +1,6 @@ +{ + "version": "1.0.0", + "thumbnail": "store/Thumbnail.png", + "id": "dev_core447_OBSPlugin", + "name": "OBSPlugin" +} \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..6e645da --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +obs-websocket-py>=1.0 \ No newline at end of file diff --git a/settings.json b/settings.json new file mode 100644 index 0000000..110b765 --- /dev/null +++ b/settings.json @@ -0,0 +1,5 @@ +{ + "ip": "localhost", + "port": 4455, + "password": "Gsn7JSlcFL3LXWAe" +} \ No newline at end of file diff --git a/store/Attribution.txt b/store/Attribution.txt new file mode 100644 index 0000000..c412596 --- /dev/null +++ b/store/Attribution.txt @@ -0,0 +1 @@ +The Thumbnail.png image was created by me. \ No newline at end of file diff --git a/store/Thumbnail.png b/store/Thumbnail.png new file mode 100644 index 0000000..59483e2 Binary files /dev/null and b/store/Thumbnail.png differ diff --git a/style.css b/style.css new file mode 100644 index 0000000..b32cd58 --- /dev/null +++ b/style.css @@ -0,0 +1,6 @@ +.red { + color: red; +} +.green { + color: green; +} \ No newline at end of file