panaudia-client

This repo contains documentation and resources for use with panaudia.com

Usage

A Panaudia Space is a multi-user audio space that enables users to connect and collaborate in real-time.

There are three steps to using Panaudia

1. Set up a Panaudia Space
2. Integrate client software
3. Give users Tickets to join the Space

Set up a Panaudia Space

There are three options for hosting Panaudia Spaces:

• Use our existing dev server for experimentation
• Host your own Panaudia Space server
• Use Panaudia Cloud to create hosted Spaces programmatically

See hosting spaces for details

Integrate client software

We currently offer web, Unreal Engine, and macOS native clients. More are on the way, including Unity and PortAudio.

TypeScript SDK

• README & Quick Start — Installation, coordinate conversion for web frameworks, transport selection, browser support
• API Reference — Full method, event, and type reference for PanaudiaClient

Unreal Engine Plugin

• Usage Guide — Installation, connection flow, position mapping, audio control, reconnection, troubleshooting
• API Reference — UPanaudiaAudioComponent methods, properties, delegates, and data types
• PanaudiaPresence Plugin — Companion plugin for visualising remote participants
• Third Party Libraries — Build instructions for libpanaudia-core, libopus, libmsquic

OS Native clients

• Panaudia Link — macOS native client application for connecting to Panaudia Spaces

Give users Tickets to join the Space

Panaudia uses JWTs as tickets to control access to Spaces. You create and sign tickets yourself using Ed25519 keys, then pass them to the client software on connection.

See Tickets for details on how to generate and sign tickets.

Guides

• Quickstart — End-to-end walkthrough: two browser tabs with spatial audio in five minutes
• Space Hosting — Three ways to set up a Panaudia Space
• Panaudia Space — Self-hosting Panaudia Space server, quick start with Docker, and configuration options
• Spaces API Guide — REST API for creating Spaces programmatically in Panaudia Cloud
• Tickets — Creating Ed25519 key pairs, building JWT payloads, signing, and code examples
• Data Tracks — State, attributes, and control messages between participants
• Coordinates — Panaudia's ambisonic coordinate system, axis conventions, and rotation order
• Troubleshooting — Common issues with tickets, connections, audio, and self-hosted servers

Agent Skills

There are some skills to help agents work with Panaudia's API and client software:

• integrate-panaudia — End-to-end integration guide: hosting, client SDKs, and tickets
• create-tickets — Create tickets for joining Panaudia Spaces
• integrate-typescript — Integrate Panaudia's TypeScript client
• integrate-unreal — Integrate Panaudia's Unreal Engine client
• spaces-api — Use the Spaces API to create Spaces programmatically

Schemas

API and data format schemas are in schemata/:

• panaudia-ticket-1.0.0.schema.json — JWT ticket payload format
• panaudia-spaces-1.0.2.openapi.json — Spaces management API