mirror of
https://github.com/onyx-and-iris/streamlabs-socketio-py
synced 2025-01-30 23:00:49 +00:00
100 lines
2.6 KiB
Markdown
100 lines
2.6 KiB
Markdown
[](https://badge.fury.io/py/streamlabsio)
|
|
[](https://github.com/onyx-and-iris/streamlabs-socketio-py/blob/dev/LICENSE)
|
|
[](https://python-poetry.org/)
|
|
[](https://github.com/astral-sh/ruff)
|
|
|
|
# A Python client for Streamlabs Socket API
|
|
|
|
For an outline of past/future changes refer to: [CHANGELOG](CHANGELOG.md)
|
|
|
|
### Requirements
|
|
|
|
- A Streamlabs Socket API key.
|
|
- You can acquire this by logging into your Streamlabs.com dashboard then `Settings->Api Settings->API Tokens`
|
|
|
|
- Python 3.8 or greater
|
|
|
|
### How to install using pip
|
|
|
|
```
|
|
pip install streamlabsio
|
|
```
|
|
|
|
### How to Use
|
|
|
|
You may store your api key in a `config.toml` file, its contents should resemble:
|
|
|
|
```toml
|
|
[streamlabs]
|
|
token = "<apikey>"
|
|
```
|
|
|
|
Place it next to your `__main__.py` file.
|
|
|
|
#### Otherwise:
|
|
|
|
You may pass it as a keyword argument.
|
|
|
|
Example `__main__.py`:
|
|
|
|
```python
|
|
import streamlabsio
|
|
|
|
|
|
def on_twitch_event(event, data):
|
|
print(f'{event}: {data.attrs()}')
|
|
|
|
|
|
def main():
|
|
with streamlabsio.connect(token='<apikey>') as client:
|
|
client.obs.on('streamlabs', on_twitch_event)
|
|
client.obs.on('twitch_account', on_twitch_event)
|
|
|
|
# run for 30 seconds then disconnect client from server
|
|
client.sio.sleep(30)
|
|
|
|
|
|
if __name__ == '__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
|
|
`streamlabsio.connect(token="<apikey>", raw=False)`
|
|
|
|
The following keyword arguments may be passed:
|
|
|
|
- `token`: str Streamlabs SocketIO api token.
|
|
- `raw`: boolean=False Receive raw data messages as json objects.
|
|
|
|
The following attribute is available:
|
|
|
|
- `raw`: boolean Toggle raw mode at runtime.
|
|
|
|
### Attributes
|
|
|
|
For event data you may inspect the available attributes using `attrs()`.
|
|
|
|
example:
|
|
|
|
```python
|
|
def on_twitch_event(event, data):
|
|
print(f'{event}: {data.attrs()}')
|
|
```
|
|
|
|
### Errors
|
|
|
|
- `SteamlabsSIOError`: Base StreamlabsSIO error class
|
|
- `SteamlabsSIOConnectionError`: Exception raised when connection errors occur
|
|
|
|
### Logging
|
|
|
|
To view raw incoming event data set logging level to DEBUG. Check `debug` example.
|
|
|
|
### Official Documentation
|
|
|
|
- [Streamlabs Socket API](https://dev.streamlabs.com/docs/socket-api)
|