Metadata-Version: 2.1
Name: sonos-websocket
Version: 0.1.3
Summary: An asynchronous Python library to communicate with Sonos devices over websockets.
Author-email: Jason Lawrence <jjlawren@users.noreply.github.com>
License: MIT License
Project-URL: Homepage, https://github.com/jjlawren/sonos-websocket
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Home Automation
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Multimedia :: Sound/Audio :: Players
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: aiohttp
Requires-Dist: async-timeout ; python_version < "3.11"

# sonos-websocket
Async Python library to communicate with Sonos devices over websockets.

## Example use: Audio Clips
Sonos audio clip functionality will overlay playback of the provided media on top of currently playing music. The music playback volume will be lowered while the audio clip is played and automatically returned to its original level when finished. This feature is especially useful for text-to-speech and alert sounds.

The below shows how to run `sonos-websocket` as a script:
```
python -m sonos_websocket \
    --ip_addr 192.168.1.88 \
    --uri https://freetestdata.com/wp-content/uploads/2021/09/Free_Test_Data_100KB_MP3.mp3 \
    --volume 15
```
Basic use of how to integrate the package can be found [here](https://github.com/jjlawren/sonos-websocket/blob/main/sonos_websocket/__main__.py).