mirror of
https://github.com/onyx-and-iris/obsws-python.git
synced 2024-11-22 04:40:53 +00:00
65 lines
1.8 KiB
Python
65 lines
1.8 KiB
Python
import json
|
|
import logging
|
|
import time
|
|
from threading import Thread
|
|
|
|
from .baseclient import ObsClient
|
|
from .callback import Callback
|
|
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
|
|
"""
|
|
|
|
|
|
class EventClient:
|
|
logger = logging.getLogger("events.eventclient")
|
|
DELAY = 0.001
|
|
|
|
def __init__(self, **kwargs):
|
|
defaultkwargs = {"subs": Subs.LOW_VOLUME}
|
|
kwargs = defaultkwargs | kwargs
|
|
self.base_client = ObsClient(**kwargs)
|
|
if self.base_client.authenticate():
|
|
self.logger.info(f"Successfully identified {self} with the server")
|
|
self.callback = Callback()
|
|
self.subscribe()
|
|
|
|
def __repr__(self):
|
|
return type(self).__name__ + "({host} {port} {password} {subs})".format(
|
|
**self.base_client.__dict__
|
|
)
|
|
|
|
def __str__(self):
|
|
return type(self).__name__
|
|
|
|
def subscribe(self):
|
|
worker = Thread(target=self.trigger, daemon=True)
|
|
worker.start()
|
|
|
|
def trigger(self):
|
|
"""
|
|
Continuously listen for events.
|
|
|
|
Triggers a callback on event received.
|
|
"""
|
|
self.running = True
|
|
while self.running:
|
|
event = json.loads(self.base_client.ws.recv())
|
|
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()
|