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-0.1.0.tar.gz (8.8 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-0.1.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for clasp_to-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6aa0619804537aff65c9a31f57e97d3f7b68e7f57097e5c02d25842a791bb407
MD5 12227821050a4c41df75edd0081b9858
BLAKE2b-256 8ad08fc488e7640a06723aec59581c5194da15b1fe3d7b4b0df5b99f054eeb86

See more details on using hashes here.

File details

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

File metadata

  • Download URL: clasp_to-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 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-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 227b232b8611b15ea593c49202f312b2d94e27a4336c25004c28275365cf491b
MD5 06d2a6c7bbcbd2a92ead31a11ddddf4d
BLAKE2b-256 7f22930b64292e9376ca479119f32388d89ece977837eddacfe1b1109a39e665

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