Quickstart
Start with one secure room that you can explain, reproduce, and test. The ReactJS reference path uses mediasfu-reactjs@4.3.7; it covers secure create, join, participants, microphone and camera state, remote media, screen sharing, participant leave, and host end.
The shortest trustworthy path
- Mount the React prebuilt room and prove a local development create/join flow.
- Before sharing or releasing the build, put reusable room credentials behind your authenticated backend.
- Prove create and join with two real participants.
- Prove local production and remote consumption separately.
- Prove screen-share start and stop.
- Prove participant leave and host end, including cleanup.
Build the React room step by step
Follow the complete React example, then test it with two users in a live room before release.
Security boundary
Your application backend owns authentication, room policy, host authority, rate limits, and MediaSFU credentials. The SDK owns the room and media runtime. Your client receives only the minimum short-lived result needed to enter the authorized room.
Use the production credential boundary before shipping. A restricted, revocable credential can speed up isolated local development, but it must not be committed or distributed in a client build.
Choose another SDK deliberately
React is the first reference implementation, not proof that every SDK exposes the same operations.
| Target | What this documentation currently covers | Continue |
|---|---|---|
ReactJS 4.3.7 | Complete room lifecycle guide; run the live two-user test before release | React room operations |
Angular 2.4.1 | Angular-owned room lifecycle and media guide | Angular room lifecycle |
React Native 2.4.5 | Native room lifecycle; validate media and permissions on a physical device | React Native room operations |
React Native Expo 2.5.5 | Expo room operations in a development build | Expo room operations |
Vue 1.2.1 | Vue-owned room lifecycle and media guide | Vue room operations |
Android 1.0.7 | Android-specific artifact and Compose room guide; validate permissions and media on physical devices | Android SDK |
Kotlin Multiplatform 1.0.7 | Shared Android and iOS-target package guide available; validate each shipping target | Kotlin SDK |
Unity 0.1.0-preview.2 | Room operations guide for join, participants, media, screen sharing, leave, and host end; secure distributed-game create needs a backend-authorized package contract | Unity room operations |
mediasfu-shared 1.2.5 | Framework-neutral runtime primitives; this is not a prebuilt room UI | Shared core |
Flutter 2.3.6 | Package guide available; put room create and join behind your authenticated backend, then validate each target platform | Flutter SDK |
Swift / Apple 0.1.3 + room framework 1.0.3 | Native Apple room setup, hosted controller, media controls, and release checklist | Swift SDK |
What to build next
For a runnable product journey, open Starter Projects. The Interactive Classroom, Familiar Calls, Live Auction, and Watch Together repositories show distinct application compositions. Check each project's platform-specific guidance rather than assuming identical behavior across its ports. For encoder ingest, external playback, and large-audience output, follow the separate WHIP, WHEP, and HLS guide.
- Want a working room now? Follow React room operations.
- Want to see the wider system? Browse React capabilities by product outcome.
- Want a product-shaped path? Start from Build by outcome.
- Want to own more of the interface? First prove the prebuilt room, then move to the customization path linked from the outcome hub.
Each room-operation guide is written for its named package. Use its code only with that package and version.