onyx_online/streamlabs-socketio-py
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/streamlabs-socketio-py synced 2026-03-24 15:59:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

upd example in README

Browse Source
This commit is contained in:
onyx-and-iris 2026-03-23 12:00:59 +00:00
parent ba35960790
commit 428db5bead
2 changed files with 15 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored
View File

@ -210,3 +210,5 @@ marimo/_lsp/
__marimo__/ __marimo__/
# End of ignr # End of ignr
test-*.py

23
README.md
View File

@ -26,13 +26,18 @@ pip install streamlabsio
import streamlabsio import streamlabsio
def on_twitch_event(event, data): def on_streamlabs_event(event, data):
print(f'{event}: {data.attrs()}') print(f'{event}: {data.attrs()}')
def on_twitch_event(event, data):
if event == 'follow':
print(f'{data.name} just followed!')
def main(): def main():
with streamlabsio.connect(token='<apikey>') as client: with streamlabsio.connect(token="<API token>") as client:
client.obs.on('streamlabs', on_twitch_event) client.obs.on('streamlabs', on_streamlabs_event)
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
@ -43,19 +48,17 @@ if __name__ == '__main__':
main() main()
``` ```
#### note > 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.
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="<apikey>", raw=False)` *`streamlabsio.connect(*, token: str, raw: bool = False)`*
The following keyword arguments may be passed: The following keyword arguments may be passed:
- `token`: str Streamlabs SocketIO api token. - token: Streamlabs SocketIO api token.
- `raw`: boolean=False Receive raw data messages as json objects. - raw: Receive raw data messages as json objects.
### 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()`.