onyx_online/streamlabs-socketio-py
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/streamlabs-socketio-py synced 2026-04-01 11:19:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
onyx-and-iris 2026-03-25 05:47:02 +00:00
parent efde969527
commit d6a26fda34
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -41,23 +41,28 @@ def main():
client.obs.on('twitch_account', on_twitch_event) client.obs.on('twitch_account', on_twitch_event)
# run for 30 seconds then disconnect client from server # run for 30 seconds then disconnect client from server
client.sio.sleep(30) client.wait(30)
if __name__ == '__main__': if __name__ == '__main__':
main() main()
``` ```
> note: From the [SocketIO docs](https://python-socketio.readthedocs.io/en/latest/client.html#managing-background-tasks), `client.sio.wait()` may be used if your application has nothing to do in the main thread.
### Client class ### Client class
*`streamlabsio.connect(*, token: str, raw: bool = False)`* *`streamlabsio.connect(*, token: str, raw: bool = False) -> Client`*
The following keyword arguments may be passed: The following keyword arguments may be passed:
- token: Streamlabs SocketIO api token. - token: Streamlabs SocketIO api token.
- raw: Receive raw data messages as json objects. - raw: Receive raw data messages as json objects.
#### methods
*wait(self, seconds: float | None = None) -> None*
- float: Time in seconds to block the main thread
- If None, the method will block indefinitely.
### Event Data Attributes ### Event Data Attributes
For event data you may inspect the available attributes using `attrs()`. For event data you may inspect the available attributes using `attrs()`.