mirror of
https://github.com/onyx-and-iris/streamlabs-socketio-py
synced 2026-04-01 11:19:10 +00:00
onyx-and-iris
336a52d172
update example READMEs add script entry point for block_forever example add poe task block-forever
20 lines
768 B
Markdown
20 lines
768 B
Markdown
## About
|
|
|
|
This example demonstrates the following:
|
|
|
|
- How to register callback functions for different kinds of events.
|
|
- How to view the logs emitted by the streamlabsio library.
|
|
- How to print the attributes of an event data dataclass using the *attrs()* method.
|
|
- How to use dataclass methods on the dataclasses, this case *asdict*.
|
|
- How to use {Client}.wait() to block the main thread for a period of time.
|
|
|
|
## Configure
|
|
|
|
The script expects the Streamlabs token to be loaded into the environment with key `STREAMLABS_TOKEN`.
|
|
|
|
If you're running the script with `poetry poe events` then poe is configured to load a `.env` file in the root of the repository.
|
|
|
|
## Use
|
|
|
|
Run the script and trigger any of the events with `Test Widgets` in the Streamlabs GUI.
|