Documentation Map
Find the guide for the task in front of you. New to MediaSFU? Start with the Quickstart.
Get started
| I want to… | Go to |
|---|---|
| Get a live room running in five minutes | Quickstart |
| Create a room without an SDK | Quickstart: HTTP option |
| Understand rooms, roles and keys | Core concepts |
| Fix a problem | Troubleshooting |
| Pick the right SDK for my app | SDK guides |
| Keep API keys off the client before I ship | Secure backend |
| Start from a complete, runnable app | Starter projects |
| See what changed in the latest SDK release | Release notes |
Shape the interface
| I want to… | Go to |
|---|---|
| Decide how much of the UI my app owns | Choose your UI mode |
| Change branding, cards, controls or dialogs | UI overrides |
| Build my own interface on top of the room | Headless mode |
| Place a room inside an existing page layout | Embed a room |
| Browse the React components visually | Storybook preview |
Add room features
| I want to… | Go to |
|---|---|
| Find any feature and the guide that covers it | Feature directory |
| Blur or replace backgrounds | Virtual backgrounds |
| Reduce background noise for everyone | Server audio denoising |
| Split participants into breakout rooms | Breakout rooms |
| Run large rooms and moderate participants | Large rooms and moderation |
| Record the layout my app renders | Record your custom interface |
| Handle leaving, ending and rejoining | Leave, end and rejoin |
| Recover from device changes and dropped connections | Recovery and media controls |
| Understand how media is captured, sent and rendered | Media lifecycle |
Build a product
| I want to build… | Go to |
|---|---|
| A familiar chat and call app | Familiar chat and call |
| A classroom | Interactive classroom |
| Live shopping or auctions | Live auction and shopping |
| A watch party | Watch together |
| A broadcast control room | Broadcast control room |
| A stage with a large audience | Hybrid stage and audience |
| Voice and vision AI agents | AI agents |
| Phone calls and SIP | VOIP and telephony |
| Embeddable widgets for my site | Widgets |
Connect servers and tools
| I want to… | Go to |
|---|---|
| Look up any HTTP endpoint, field or error code | HTTP API reference |
| Run a call with no SDK: publish, receive, chat and polls over HTTP | Participants over HTTP |
| Go live from OBS or an encoder | Stream from OBS |
| Play a stream in a WebRTC player | Play with WHEP |
| Broadcast to a large audience | Broadcast with HLS |
| Control AI calls from my server | AI call control |
| Try any HTTP endpoint and copy the request | API Sandbox |
| Look up exact SDK types and methods | API reference |
| Use MediaSFU from an AI coding assistant | MediaSFU MCP |
| Manage rooms, usage and recordings in the dashboard | Dashboards |