Skip to main content

CLASP client for Python - Creative Low-Latency Application Streaming Protocol

Project description

CLASP Python Client

A Python client for the CLASP protocol - Creative Low-Latency Application Streaming Protocol for creative tools communication.

Installation

pip install clasp-to

Quick Start

import asyncio
from clasp import Clasp

async def main():
    # Connect to a CLASP server
    sf = Clasp('ws://localhost:7330')
    await sf.connect()

    # Subscribe to parameter changes
    @sf.on('/lumen/layer/*/opacity')
    def on_opacity(value, address):
        print(f'{address} = {value}')

    # Set a parameter
    await sf.set('/lumen/layer/0/opacity', 0.75)

    # Get a parameter
    opacity = await sf.get('/lumen/layer/0/opacity')
    print(f'Current opacity: {opacity}')

    # Emit an event
    await sf.emit('/lumen/cue/fire', {'cue': 1})

    # Keep running
    sf.run()

asyncio.run(main())

Builder Pattern

from clasp import ClaspBuilder

async def main():
    client = await (
        ClaspBuilder('ws://localhost:7330')
        .with_name('My Python App')
        .with_features(['param', 'event'])
        .with_reconnect(True, interval=5.0)
        .connect()
    )

    # Use client...
    await client.close()

API Reference

Clasp

  • connect() - Connect to server
  • close() - Close connection
  • subscribe(pattern, callback) - Subscribe to address pattern
  • on(pattern) - Decorator for subscriptions
  • set(address, value) - Set parameter value
  • get(address) - Get parameter value
  • emit(address, payload) - Emit event
  • stream(address, value) - Send stream sample
  • bundle(messages, at) - Send atomic bundle
  • cached(address) - Get cached value
  • time() - Get server time (microseconds)

Properties

  • connected - Check if connected
  • session_id - Get session ID

Callbacks

  • on_connect(callback) - Register connect callback
  • on_disconnect(callback) - Register disconnect callback
  • on_error(callback) - Register error callback

Address Patterns

CLASP supports wildcard patterns:

  • * - Match single path segment
  • ** - Match multiple path segments

Examples:

  • /lumen/layer/*/opacity - All layer opacities
  • /lumen/**/enabled - All enabled properties

Documentation

Visit clasp.to for full documentation.

License

MIT


Maintained by LumenCanvas | 2026

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

clasp_to-3.3.0.tar.gz (14.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

clasp_to-3.3.0-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

Details for the file clasp_to-3.3.0.tar.gz.

File metadata

  • Download URL: clasp_to-3.3.0.tar.gz
  • Upload date:
  • Size: 14.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for clasp_to-3.3.0.tar.gz
Algorithm Hash digest
SHA256 7e4f3a64cd6db2e934c38e252af41d8be3f6c19c5b48f164111fd8d4abef875d
MD5 7d8004ec4eca31f9f6f15809d505fcc4
BLAKE2b-256 660228c2dae85b6f7b091df2028696dcbc38b39beec13f67d7ba78f1425d20a3

See more details on using hashes here.

File details

Details for the file clasp_to-3.3.0-py3-none-any.whl.

File metadata

  • Download URL: clasp_to-3.3.0-py3-none-any.whl
  • Upload date:
  • Size: 12.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for clasp_to-3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 881bd38e623ec472b4c1b6546d73d7b3a64255500467e71bc5554d63510a81b5
MD5 6c838224794fffd165ef86cc1a30d16e
BLAKE2b-256 1e94f2755f0d05821fdb7b5d9e62434c257165f744601dbb152d4e34cba38f9e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page