Quick Start

This page assumes the C# mod is deployed and the Resonite client is running, and that you have the resoio Python client installed (see Installation).

Every client is an async context manager so the gRPC channel is opened and closed deterministically. With socket_path=None the socket path is resolved on entry from RESONITE_IO_SOCKET → RESONITE_IO_SOCKET_DIR → ~/.resonite-io/.

Ping the session

import asyncio

from resoio import ConnectionClient


async def main() -> None:
    async with ConnectionClient() as session:
        response = await session.ping("hello")
        print(response.message)


asyncio.run(main())

Any client already logs a one-time warning on its first connection if the running C# mod's version differs from the installed resoio package. ConnectionClient.get_mod_version() returns that mod version string if you want to check it explicitly.

Stream camera frames

Camera is a server-streaming modality (Resonite → Python). Each Frame carries an (H, W, 4) RGBA8 array plus a capture timestamp. stream() takes no arguments — frames arrive uncapped at best-effort native fps, and the capture resolution is the Display modality's responsibility.

import asyncio

from resoio import CameraClient


async def main() -> None:
    async with CameraClient() as camera:
        async for frame in camera.stream():
            print(frame.frame_id, frame.width, frame.height, frame.pixels.shape)
            if frame.frame_id >= 100:
                break


asyncio.run(main())

From the command line

The same capabilities are reachable from the resoio CLI without writing code:

resoio ping --message hello
resoio record --video out.mp4     # capture Camera (and/or Speaker) to a file

See the CLI page for the full command list, and the API Reference for every client.

Runnable examples

Every modality has a minimal, runnable script under python/examples/ (one file per modality) — the fastest way to see a client's call shape end to end. Each API Reference page links its matching example, and the examples README lists the per-modality preconditions.