https://github.com/happyleavesaoc/python-snapcast

Python API for controlling Snapcast, a multi-room synchronous audio solution.
https://github.com/happyleavesaoc/python-snapcast

api async multi-room-audio python3 snapcast

Last synced: 6 days ago
JSON representation

Python API for controlling Snapcast, a multi-room synchronous audio solution.

• Host: GitHub
• URL: https://github.com/happyleavesaoc/python-snapcast
• Owner: happyleavesaoc
• License: mit
• Created: 2016-01-16T18:26:18.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-22T13:25:08.000Z (3 months ago)
• Last Synced: 2025-01-04T17:01:47.057Z (14 days ago)
• Topics: api, async, multi-room-audio, python3, snapcast
• Language: Python
• Homepage:
• Size: 114 KB
• Stars: 70
• Watchers: 8
• Forks: 31
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/happyleavesaoc/python-snapcast.svg?branch=master)](https://travis-ci.org/happyleavesaoc/python-snapcast) [![PyPI version](https://badge.fury.io/py/snapcast.svg)](https://badge.fury.io/py/snapcast)

# python-snapcast

Control [Snapcast](https://github.com/badaix/snapcast) in Python 3. Reads client configurations, updates clients, and receives updates from other controllers.

Supports Snapcast `0.15.0`.

## Install

`pip install snapcast`

## Usage

### Control

```python

import asyncio

import snapcast.control

loop = asyncio.get_event_loop()

server = loop.run_until_complete(snapcast.control.create_server(loop, 'localhost'))

# print all client names

for client in server.clients:

  print(client.friendly_name)

# set volume for client #0 to 50%

client = server.clients[0]

percent = 50

loop.run_until_complete(client.set_volume(percent))

# create background task (polling)

async def testloop():

    while(1):

        print("still running")

        #print(json.dumps(server.streams[0].properties, indent=4))

        print(server.groups)

        await asyncio.sleep(10)

test = loop.create_task(testloop())

# add callback for client #0 volume change

def my_update_func(client):

    print(client.volume)

    

server.clients[0].set_callback(my_update_func)

# keep loop running to receive callbacks and to keep background task alive

loop.run_forever()

```

### Client

Note: This is experimental. Synchronization is not yet supported.

Requires GStreamer 1.0.

```python

import snapcast.client

client = snapcast.client.Client('localhost', snapcast.client.SERVER_PORT)

client.register()

client.request_start() # this blocks

```