Documentation

👋 Hello! Welcome to the Peerix documentation!

What is Peerix?

Peerix is a powerful and flexible peer-to-peer communication library that enables developers to build real-time applications with ease. It provides a simple and intuitive API for creating peer connections, managing media streams and data channels, and handling signaling, allowing you to focus on building your application without worrying about the underlying complexities of WebRTC communication.

Key Features

Easy-to-use API for peer connections, media streams, and data channels
Transport-agnostic design that allows you to choose the best signaling method, including custom implementations
Supports serverless architecture (no server-side code required)
Room and state management features to simplify building complex applications
Multiplexing multiple media streams and data channels over a single connection per peer
Extensible architecture that allows you to build custom features and integrations
Cross-browser compatibility with support for all modern browsers
TypeScript support for a better developer experience and type safety
Well-documented codebase with comprehensive examples and the API reference
Automatically tested and optimized for performance and reliability
Zero dependencies to reduce security risks
Open-source, actively maintained project

When to Choose Peerix?

Peerix is designed to be a versatile and developer-friendly library that abstracts away the complexities of peer-to-peer communication. Whether you’re building a simple chat application, a collaborative workspace, or a complex real-time game, Peerix provides the tools and flexibility you need to create robust and scalable P2P applications. With its transport-agnostic design, you can choose the signaling method that best fits your application’s needs, whether it’s a built-in driver or a custom implementation. Peerix’s focus on simplicity, extensibility, and performance makes it an excellent choice for developers looking to build real-time applications with WebRTC.

If your application handles small or medium-sized groups of peers and does not require server-side media processing, Peerix is an ideal choice for your project.

When Not to Choose Peerix?

Peerix is not an SFU or MCU , and it does not provide server-side media processing or routing capabilities. Instead, it focuses on enabling direct peer-to-peer communication between clients, allowing you to build applications that leverage the full potential of WebRTC without the need for a central media server.