mirror of
https://github.com/onyx-and-iris/obsws-python.git
synced 2024-11-22 04:40:53 +00:00
onyx-and-iris
6aa6db09eb
sets the event object on WebSocketConnectionClosedException adds __enter__(), __exit__() methods adds disconnect() to event client. aliases it as unsubscribe checks for non-empty response with: `if r := self.base_client.ws.recv()` before attempting to json.load() it.
91 lines
2.8 KiB
Python
91 lines
2.8 KiB
Python
import json
|
|
import logging
|
|
import threading
|
|
|
|
from websocket import WebSocketConnectionClosedException, WebSocketTimeoutException
|
|
|
|
from .baseclient import ObsClient
|
|
from .callback import Callback
|
|
from .error import OBSSDKError, OBSSDKTimeoutError
|
|
from .subs import Subs
|
|
|
|
"""
|
|
A class to interact with obs-websocket events
|
|
defined in official github repo
|
|
https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#events
|
|
"""
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class EventClient:
|
|
def __init__(self, **kwargs):
|
|
self.logger = logger.getChild(self.__class__.__name__)
|
|
defaultkwargs = {"subs": Subs.LOW_VOLUME}
|
|
kwargs = defaultkwargs | kwargs
|
|
self.base_client = ObsClient(**kwargs)
|
|
try:
|
|
success = self.base_client.authenticate()
|
|
self.logger.info(
|
|
f"Successfully identified {self} with the server using RPC version:{success['negotiatedRpcVersion']}"
|
|
)
|
|
except OBSSDKError as e:
|
|
self.logger.error(f"{type(e).__name__}: {e}")
|
|
raise
|
|
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
|
|
).__name__ + "(host='{host}', port={port}, password='{password}', subs={subs}, timeout={timeout})".format(
|
|
**self.base_client.__dict__,
|
|
)
|
|
|
|
def __str__(self):
|
|
return type(self).__name__
|
|
|
|
def subscribe(self):
|
|
stop_event = threading.Event()
|
|
self.worker = threading.Thread(
|
|
target=self.trigger, daemon=True, args=(stop_event,)
|
|
)
|
|
self.worker.start()
|
|
|
|
def trigger(self, stop_event):
|
|
"""
|
|
Continuously listen for events.
|
|
|
|
Triggers a callback on event received.
|
|
"""
|
|
while not stop_event.is_set():
|
|
try:
|
|
if r := self.base_client.ws.recv():
|
|
event = json.loads(r)
|
|
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 {})
|
|
except WebSocketTimeoutException as e:
|
|
self.logger.exception(f"{type(e).__name__}: {e}")
|
|
raise OBSSDKTimeoutError("Timeout while waiting for event") from e
|
|
except WebSocketConnectionClosedException as e:
|
|
self.logger.debug(f"{type(e).__name__} terminating the event thread")
|
|
stop_event.set()
|
|
|
|
def disconnect(self):
|
|
"""stop listening for events"""
|
|
|
|
self.base_client.ws.close()
|
|
self.worker.join()
|
|
|
|
unsubscribe = disconnect
|