LiveKit

# LiveKit Docs

> LiveKit is an open source platform for developers building realtime media applications. It makes it easy to integrate audio, video, text, data, and AI models while offering scalable realtime infrastructure built on top of WebRTC.

## Overview

LiveKit contains these primary components:

- [Open source WebRTC SFU](https://github.com/livekit/livekit), with a hosted global mesh version available as [LiveKit Cloud](https://cloud.livekit.io)
- [Open source AI Agents Framework](https://github.com/livekit/agents) for building realtime and Voice AI agents in Python (Node.js beta also [available](https://github.com/livekit/agents-js))
- [Realtime SDKs](https://docs.livekit.io/home/client/connect.md) to make it easy to add realitme audio, video, and data to your apps (available for Web, iOS, Android, Flutter, React Native, Unity, Python, Node.js, Rust, and more))
- [Telephony integration](https://docs.livekit.io/sip.md) built on SIP for integrating telephony into LiveKit rooms

For greater detail, see [Intro to LiveKit](https://docs.livekit.io/home/get-started/intro-to-livekit.md).

The following document is a comprehensive list of all available documentation and examples for LiveKit.

## Home

### Get Started

- [Intro to LiveKit](https://docs.livekit.io/home/get-started/intro-to-livekit.md): An overview of the LiveKit ecosystem.
- [Rooms, participants, and tracks](https://docs.livekit.io/home/get-started/api-primitives.md): Guide to the core API primitives in LiveKit.
- [Authentication](https://docs.livekit.io/home/get-started/authentication.md): Learn how to authenticate your users to LiveKit sessions.

### LiveKit SDKs

- [Overview](https://docs.livekit.io/home/client.md): A guide to LiveKit's client and server SDKs for building realtime applications.
- [Connecting to LiveKit](https://docs.livekit.io/home/client/connect.md): Learn how to connect with realtime SDKs.

#### Realtime media

- [Overview](https://docs.livekit.io/home/client/tracks.md): Audio and video media exchange between participants.
- [Camera & microphone](https://docs.livekit.io/home/client/tracks/publish.md): Publish realtime audio and video from any device.
- [Screen sharing](https://docs.livekit.io/home/client/tracks/screenshare.md): Publish your screen with LiveKit.
- [Subscribing to tracks](https://docs.livekit.io/home/client/tracks/subscribe.md): Play and render realtime media tracks in your application.
- [Processing raw tracks](https://docs.livekit.io/home/client/tracks/raw-tracks.md): How to read, process, and publish raw media tracks and files.
- [Noise & echo cancellation](https://docs.livekit.io/home/client/tracks/noise-cancellation.md): Achieve crystal-clear audio for video conferencing and voice AI.
- [End-to-end encryption](https://docs.livekit.io/home/client/tracks/encryption.md): Secure your realtime media tracks with E2EE.
- [Codecs & more](https://docs.livekit.io/home/client/tracks/advanced.md): Advanced audio and video topics.

#### Realtime text & data

- [Overview](https://docs.livekit.io/home/client/data.md): Exchange text, files, and custom data between participants.
- [Sending text](https://docs.livekit.io/home/client/data/text-streams.md): Use text streams to send any amount of text between participants.
- [Sending files & bytes](https://docs.livekit.io/home/client/data/byte-streams.md): Use byte streams to send files, images, or any other kind of data between participants.
- [Remote method calls](https://docs.livekit.io/home/client/data/rpc.md): Use RPC to execute custom methods on other participants in the room and await a response.
- [Data packets](https://docs.livekit.io/home/client/data/packets.md): Low-level API for high frequency or advanced use cases.

#### State synchronization

- [Overview](https://docs.livekit.io/home/client/state.md)
- [Participant attributes](https://docs.livekit.io/home/client/state/participant-attributes.md): A key-value store for per-participant state.
- [Room metadata](https://docs.livekit.io/home/client/state/room-metadata.md): Share application-specific state with all participants.
- [Handling events](https://docs.livekit.io/home/client/events.md): Observe and respond to events in the LiveKit SDK.

#### Platform-specific quickstarts

- [Overview](https://docs.livekit.io/home/quickstarts.md)
- [Next.js](https://docs.livekit.io/home/quickstarts/nextjs.md): Get started with LiveKit and Next.js
- [React](https://docs.livekit.io/home/quickstarts/react.md): Get started with LiveKit and React.
- [JavaScript](https://docs.livekit.io/home/quickstarts/javascript.md): Get started with LiveKit and JavaScript
- [Unity (WebGL)](https://docs.livekit.io/home/quickstarts/unity-web.md): Get started with LiveKit and Unity (WebGL)
- [Swift](https://docs.livekit.io/home/quickstarts/swift.md): Get started with LiveKit on iOS using SwiftUI
- [Android (Compose)](https://docs.livekit.io/home/quickstarts/android-compose.md): Get started with LiveKit and Android using Jetpack Compose
- [Android](https://docs.livekit.io/home/quickstarts/android.md): Get started with LiveKit and Android
- [Flutter](https://docs.livekit.io/home/quickstarts/flutter.md): Get started with LiveKit and Flutter
- [React Native](https://docs.livekit.io/home/quickstarts/react-native.md): Get started with LiveKit and React Native
- [Expo](https://docs.livekit.io/home/quickstarts/expo.md): Get started with LiveKit and Expo on React Native

### LiveKit CLI

- [Getting started](https://docs.livekit.io/home/cli.md): Install the LiveKit CLI and test your setup using an example frontend application.
- [Project management](https://docs.livekit.io/home/cli/projects.md): Add, list, and manage projects in the LiveKit CLI.
- [App templates](https://docs.livekit.io/home/cli/templates.md): Create and initialize an app from a convenient set of templates.

### Server APIs

- [Token generation](https://docs.livekit.io/home/server/generating-tokens.md): Generate tokens for your frontend
- [Room management](https://docs.livekit.io/home/server/managing-rooms.md): Create, list, and delete Rooms from your backend server.
- [Participant management](https://docs.livekit.io/home/server/managing-participants.md): List, remove, and mute from your backend server.
- [Webhooks](https://docs.livekit.io/home/server/webhooks.md): Configure LiveKit to notify your server when room events take place.

### Stream import

- [Overview](https://docs.livekit.io/home/ingress/overview.md): Use LiveKit's ingress service to bring live streams from non-WebRTC sources into LiveKit rooms.
- [Encoder configuration](https://docs.livekit.io/home/ingress/configure-streaming-software.md): How to configure streaming software to work with LiveKit Ingress.

### Recording & export

- [Overview](https://docs.livekit.io/home/egress/overview.md): Use LiveKit's egress service to record or livestream a room.
- [Composite & web recordings](https://docs.livekit.io/home/egress/composite-recording.md): LiveKit web-based recorder gives you flexible compositing options.
- [Recording participants](https://docs.livekit.io/home/egress/participant.md): Record participants individually with the Egress API.
- [Recording individual tracks](https://docs.livekit.io/home/egress/track.md): Track egress allows you export a single track without transcoding.
- [Output and streaming options](https://docs.livekit.io/home/egress/outputs.md): Export content anywhere, in any format.
- [Auto Egress](https://docs.livekit.io/home/egress/autoegress.md): Automatically start recording with a room.
- [Custom recording templates](https://docs.livekit.io/home/egress/custom-template.md): Create your own recording layout to use with Room Composite Egress.
- [Egress API](https://docs.livekit.io/home/egress/api.md): Use LiveKit's egress service to record or livestream a Room.
- [Examples](https://docs.livekit.io/home/egress/examples.md): Usage examples for Egress APIs to record or livestream a room or individual tracks.