mediasfu-reactjs
v4.2.9
Published
mediasfu-reactjs – React 18/19 WebRTC SDK for video conferencing, webinars, broadcasts, live streaming, chat, recording, whiteboard, and AI agents. Plug-in prebuilt rooms or build fully custom UIs.
Maintainers
Keywords
Readme
MediaSFU ReactJS SDK · mediasfu-reactjs on npm
mediasfu-reactjs is the React 18/19 WebRTC SDK for video conferencing, webinars, live streaming, broadcast, screen sharing, whiteboard, chat, recording, live subtitles, translation, and AI agent rooms — powered by MediaSFU Cloud or your self-hosted MediaSFU Open server. Install with npm install mediasfu-reactjs.
Build real-time communication into React
mediasfu-reactjs combines a React 18/19 WebRTC client, prebuilt room experiences, and lower-level customization APIs for products that need video meetings, voice and video calls, webinars, interactive broadcasts, chat, screen sharing, recording, whiteboards, live captions, translation, or AI-assisted communication.
Choose the integration depth that matches your product:
- Prebuilt rooms: render
MediasfuGeneric,MediasfuConference,MediasfuWebinar,MediasfuBroadcast, orMediasfuChat. - Modern room UI: use
ModernMediasfuGenericfor the newer theme-aware meeting shell. - Progressive customization: keep the room runtime while replacing cards, modals, controls, and layouts through
uiOverridesand custom components. - Headless React integration: set
returnUI={false}and use MediaSFU's room, media, and participant helpers inside your own interface.
Common React product shapes
| You are building | Start with | Extend with |
| --- | --- | --- |
| Team meetings or embedded video calls | MediasfuGeneric or MediasfuConference | branding, waiting rooms, screen sharing, annotation, recording |
| A webinar or virtual event | MediasfuWebinar | panelists, permissions, audience controls, polls |
| An interactive livestream or host-led broadcast | MediasfuBroadcast | custom host controls, layouts, recording |
| A support, community, or chat-first room | MediasfuChat | audio/video escalation, moderation, custom messages |
| A fully branded collaboration workspace | ModernMediasfuGeneric or headless mode | uiOverrides, custom cards, sourceParameters |
Start Here
npm install mediasfu-reactjsimport { MediasfuGeneric } from "mediasfu-reactjs";
export default function App() {
return (
<MediasfuGeneric
credentials={{ apiUserName: "your-api-username", apiKey: "your-api-key" }}
connectMediaSFU={true}
/>
);
}Prefer the themed modern shell? Start with ModernMediasfuGeneric instead of MediasfuGeneric:
import { ModernMediasfuGeneric } from 'mediasfu-reactjs';
export default function App() {
return (
<ModernMediasfuGeneric
credentials={{ apiUserName: 'your-api-username', apiKey: 'your-api-key' }}
containerStyle={{
minHeight: '100vh',
background: 'linear-gradient(135deg, #0f172a, #1e3a8a)',
}}
/>
);
}Backend Requirement
This SDK needs a MediaSFU-compatible backend for room lifecycle, signaling, and media routing.
| Option | Use it when | What to pass |
|---|---|---|
| MediaSFU Cloud | You want managed infrastructure | credentials={{ apiUserName, apiKey }} |
| MediaSFU Open / CE | You want to self-host | localLink="http://your-server:3000" and your own server config |
Cloud room helpers in this package target https://mediasfu.com/v1/rooms/ by default. For self-hosted deployments, pass a non-MediaSFU localLink.
Common questions
Is MediaSFU ReactJS only a component library?
No. The package includes prebuilt React room UI and the browser-side WebRTC/session runtime. A MediaSFU-compatible backend still handles signaling, room lifecycle, and SFU media routing.
Can I use MediaSFU with my own React design system?
Yes. Start by replacing individual surfaces through uiOverrides and custom cards. Use returnUI={false} when your application should own the entire visual shell.
Can I self-host the backend?
Yes. Point localLink at a MediaSFU Open deployment. The same React components can also connect to managed MediaSFU Cloud rooms.
Does the SDK support more than basic video calls?
Yes. The room runtime includes meeting, webinar, broadcast, and chat experiences with screen sharing and annotation, recording, whiteboards, polls, breakout rooms, live captions, translation, and extensible AI-agent workflows.
Integration Paths
- Keep the bundled room UI for the fastest route to production.
- Use
ModernMediasfuGenericwhen you want the premium themed shell as your default entry point. - Replace targeted surfaces with
uiOverrides, custom cards, and custom shells. - Use
customComponentorreturnUI={false}when your app should own the entire shell.
Package Links
- Docs portal: https://mediasfu.com/documentation
- User guide: https://mediasfu.com/user-guide
- Storybook: https://mediasfu.com/storybook
- Detailed guide: README_DETAILED.md
📖 Table of Contents
- Quick Start
- Installation
- Component Storybook
- Prebuilt Event Rooms
- Modern UI Components
- Usage Examples
- Key Components
- Customization
- API Reference
- Self-Hosting / Community Edition
- Advanced Features (Panelists, Permissions, Translation)
- sourceParameters - The Power API
- AudioGrid - Display All Audio Participants
- Using Modals Standalone
- Building Your Own UI
- SDKs for Every Framework
- Detailed Documentation
🚀 Quick Start
Three steps. Under 5 minutes. First video call live.
1. Install
npm install mediasfu-reactjs2. Import & Render
import { MediasfuGeneric } from 'mediasfu-reactjs';
function App() {
return (
<MediasfuGeneric
credentials={{ apiUserName: "yourUsername", apiKey: "yourAPIKey" }}
/>
);
}3. Run
npm startThat's it. You have a fully-featured video conferencing room with screen sharing, chat, recording, and more.
ℹ️ Critical component styles are automatically injected at runtime. For additional styling options, see Optional CSS Import.
Want to try without a server? Use demo mode:
<MediasfuGeneric useLocalUIMode={true} useSeed={true} seedData={{ member: "DemoUser", eventType: "conference" }} />
📦 Installation
# npm
npm install mediasfu-reactjs
# yarn
yarn add mediasfu-reactjs
# pnpm
pnpm add mediasfu-reactjsPeer Dependencies
The following are required peer dependencies:
{
"react": "^18.2.0 || ^19.0.0",
"react-dom": "^18.2.0 || ^19.0.0",
"@fortawesome/fontawesome-svg-core": "^6.0.0",
"@fortawesome/free-solid-svg-icons": "^6.0.0",
"@fortawesome/react-fontawesome": "^0.2.0",
"bootstrap": "^5.0.0",
"mediasoup-client": "^3.7.0",
"socket.io-client": "^4.0.0",
"universal-cookie": "^7.0.0"
}Optional Peer Dependencies
For virtual background support (blur, image backgrounds):
npm install @mediapipe/[email protected]This is optional — if not installed, virtual backgrounds simply won't be available.
Optional CSS Import
Critical styles for control buttons, containers, and core components are automatically injected at runtime — no manual import needed.
If you need additional styling (e.g., custom modal themes, waiting room lists), you can optionally import the full stylesheet:
// Optional: Import for additional component styles
import 'mediasfu-reactjs/dist/main.css';Most applications work perfectly without this import.
📚 Component Storybook
This package includes the React Storybook used to preview MediaSFU components, seeded room shells, and customization surfaces. It complements the main docs portal and gives teams a fast way to inspect UI behavior before wiring a live backend.
Run it from the MediaSFUReactJS package directory:
npm run storybookBuild the static Storybook output for deployment:
npm run build-storybookAfter building, you can preview the deployment output from storybook-static with any static file server:
python3 -m http.server 6006 -d storybook-staticStory coverage is split between generated baseline stories for runtime-light components and curated stories for richer meeting surfaces. Generated baseline stories refresh automatically before both Storybook commands run. To refresh them directly:
npm run generate-storybook-storiesStory organization:
src/stories/Guidescovers onboarding, build-style choices, and override guidance.src/stories/MediaSFUComponentshouses the curatedModernMediasfuGenericroom-shell preview.src/stories/DisplayComponents,src/stories/InternalComponents, andsrc/stories/WhiteboardComponentscover stateful visual surfaces that benefit from hand-tuned fixtures.src/stories/generatedcontains safely stubbed baseline stories for runtime-light modern components.
Curated stories cover flagship meeting shells, video and audio cards, control surfaces, pagination, whiteboard flows, and other stateful experiences that are better represented with explicit fixtures than auto-generated examples.
If you want the public docs site to expose Storybook in navigation, deploy the generated storybook-static output separately and point the docs portal at it with MEDIASFU_STORYBOOK_URL.
🏛️ Prebuilt Event Rooms
Choose the room type that fits your use case — or use MediasfuGeneric for maximum flexibility:
| Component | Use Case | Description |
|-----------|----------|-------------|
| MediasfuGeneric | Universal | Supports all event types dynamically |
| ModernMediasfuGeneric | Universal (Premium) | Theme-aware, glassmorphism UI |
| MediasfuConference | Meetings | Multi-party video conferencing |
| MediasfuWebinar | Webinars | Presenters + audience model |
| MediasfuBroadcast | Broadcasting | One-to-many live streaming |
| MediasfuChat | Chat Rooms | Text-based with optional media |
All prebuilt components share the same props interface:
interface MediasfuProps {
// Authentication
credentials?: { apiUserName: string; apiKey: string };
// Connection
localLink?: string; // Self-hosted server URL
connectMediaSFU?: boolean; // Toggle auto-connection
// Customization
PrejoinPage?: (options) => ReactNode;
customVideoCard?: CustomVideoCardType;
customAudioCard?: CustomAudioCardType;
customMiniCard?: CustomMiniCardType;
uiOverrides?: MediasfuUICustomOverrides;
// Advanced
returnUI?: boolean; // Set false for headless mode
useLocalUIMode?: boolean; // Demo/local mode
seedData?: SeedData; // Pre-populate for demos
}💡 Usage Examples
Basic Conference Room
import { MediasfuConference } from 'mediasfu-reactjs';
function ConferenceApp() {
return (
<MediasfuConference
credentials={{
apiUserName: "yourUsername",
apiKey: "yourAPIKey"
}}
/>
);
}Webinar with Custom Branding
import { MediasfuWebinar, PreJoinPage } from 'mediasfu-reactjs';
function WebinarApp() {
return (
<MediasfuWebinar
credentials={{ apiUserName: "user", apiKey: "key" }}
PrejoinPage={(options) => (
<PreJoinPage
{...options}
imgSrc="/your-logo.png"
/>
)}
containerStyle={{
background: "linear-gradient(135deg, #1a1a2e, #16213e)"
}}
/>
);
}Demo/Preview Mode (No Server)
import {
MediasfuGeneric,
generateRandomParticipants,
generateRandomMessages
} from 'mediasfu-reactjs';
function DemoApp() {
return (
<MediasfuGeneric
useLocalUIMode={true}
useSeed={true}
seedData={{
member: "DemoUser",
participants: generateRandomParticipants({ count: 5 }),
messages: generateRandomMessages({ count: 10 }),
eventType: "conference"
}}
/>
);
}Custom Video Cards
import { MediasfuGeneric, VideoCard, CustomVideoCardType } from 'mediasfu-reactjs';
const customVideoCard: CustomVideoCardType = (props) => (
<VideoCard
{...props}
customStyle={{
border: "3px solid #4c1d95",
borderRadius: 20,
boxShadow: "0 10px 40px rgba(76, 29, 149, 0.4)"
}}
/>
);
function App() {
return (
<MediasfuGeneric
credentials={{ apiUserName: "user", apiKey: "key" }}
customVideoCard={customVideoCard}
/>
);
}Headless Mode (Custom UI)
import { MediasfuGeneric } from 'mediasfu-reactjs';
import { useState, useCallback } from 'react';
function CustomApp() {
const [helpers, setHelpers] = useState<Record<string, unknown>>({});
const updateSourceParameters = useCallback((data: Record<string, unknown>) => {
setHelpers(data);
}, []);
return (
<>
<MediasfuGeneric
credentials={{ apiUserName: "user", apiKey: "key" }}
returnUI={false} // No default UI
noUIPreJoinOptions={{
action: "create",
capacity: 10,
eventType: "conference",
userName: "Host"
}}
sourceParameters={helpers}
updateSourceParameters={updateSourceParameters}
/>
{/* Use `helpers` to build your completely custom UI */}
{/* helpers.clickVideo(), helpers.clickAudio(), helpers.participants, etc. */}
</>
);
}UI Overrides
import {
MediasfuGeneric,
MainContainerComponent,
MediasfuUICustomOverrides
} from 'mediasfu-reactjs';
const overrides: MediasfuUICustomOverrides = {
// Override component rendering
mainContainer: {
render: (props) => (
<div style={{ border: "4px dashed purple", padding: 16 }}>
<MainContainerComponent {...props} />
</div>
)
},
// Wrap function behavior
consumerResume: {
wrap: (originalFn) => async (params) => {
console.log("Consumer resuming:", params);
return await originalFn(params);
}
}
};
function App() {
return (
<MediasfuGeneric
credentials={{ apiUserName: "user", apiKey: "key" }}
uiOverrides={overrides}
/>
);
}🧩 Key Components
Display Components
| Component | Purpose |
|-----------|---------|
| MainContainerComponent | Root container for meeting UI |
| MainGridComponent | Grid layout for video tiles |
| FlexibleGrid | Dynamic responsive grid |
| VideoCard | Individual video participant |
| AudioCard | Audio-only participant with waveform |
| MiniCard | Thumbnail participant card |
| Pagination | Navigate participant pages |
Modal Components
| Component | Purpose |
|-----------|---------|
| LoadingModal | Loading overlay |
| AlertComponent | Toast notifications |
| ParticipantsModal | Participant list/management |
| MessagesModal | Chat interface |
| RecordingModal | Recording controls |
| PollModal | Create/vote on polls |
| BackgroundModal | Virtual backgrounds |
| BreakoutRoomsModal | Breakout room management |
| ConfigureWhiteboardModal | Whiteboard settings |
| MediaSettingsModal | Audio/video device selection |
Control Methods
import {
clickVideo, // Toggle video
clickAudio, // Toggle audio
clickScreenShare, // Toggle screen share
startRecording, // Start recording
stopRecording, // Stop recording
launchPoll, // Open poll modal
launchMessages, // Open chat modal
} from 'mediasfu-reactjs';Socket Events
import {
connectSocket,
disconnectSocket,
joinRoomClient,
// Event handlers
personJoined,
meetingEnded,
receiveMessage,
} from 'mediasfu-reactjs';🎨 Customization
CSS Variables
The package uses CSS variables for theming:
:root {
--mediasfu-primary: #4c1d95;
--mediasfu-background: #1a1a2e;
--mediasfu-surface: #16213e;
--mediasfu-text: #ffffff;
}Custom Cards
// Custom video card with overlay
const customVideoCard: CustomVideoCardType = (props) => (
<div style={{ position: 'relative' }}>
<VideoCard {...props} />
<div className="custom-overlay">
<span>{props.name}</span>
<button onClick={() => props.onMute?.()}>Mute</button>
</div>
</div>
);Complete UI Override
const overrides: MediasfuUICustomOverrides = {
// Layout components
mainContainer: { render: CustomMainContainer },
mainGrid: { render: CustomGrid },
// Modal components
menuModal: { component: CustomMenuModal },
participantsModal: { component: CustomParticipantsModal },
messagesModal: { component: CustomMessagesModal },
// Functions
consumerResume: { wrap: loggingWrapper },
addVideosGrid: { implementation: customGridLogic },
};📚 API Reference
Types
import type {
// Core types
Participant,
Stream,
Message,
CoHostResponsibility,
Poll,
// Event types
EventType, // 'conference' | 'webinar' | 'chat' | 'broadcast'
CreateMediaSFURoomOptions,
JoinMediaSFURoomOptions,
ResponseJoinRoom,
// UI types
MediasfuUICustomOverrides,
CustomVideoCardType,
CustomAudioCardType,
CustomMiniCardType,
// Socket types
ConnectSocketType,
ConnectLocalSocketType,
} from 'mediasfu-reactjs';Utilities
import {
// Room management
joinRoomOnMediaSFU,
createRoomOnMediaSFU,
checkLimitsAndMakeRequest,
// Demo utilities
generateRandomParticipants,
generateRandomMessages,
generateRandomPolls,
// State
initialValuesState,
// Helpers
formatNumber,
sleep,
checkPermission,
} from 'mediasfu-reactjs';🏠 Self-Hosting / Community Edition
For self-hosted MediaSFU servers:
<MediasfuGeneric
localLink="https://your-mediasfu-server.com"
connectMediaSFU={false} // Don't connect to cloud
/>Hybrid Mode (Local + Cloud)
<MediasfuGeneric
localLink="https://your-server.com"
connectMediaSFU={true} // Also connect to MediaSFU cloud
credentials={{ apiUserName: "user", apiKey: "key" }}
/>📖 Detailed Documentation
For comprehensive documentation including:
- Advanced customization patterns
- Full API reference
- All component props
- Socket event handling
- Recording configuration
- Breakout rooms
- Whiteboard integration
- And much more...
📄 See README_DETAILED.md
🎨 Modern UI Components
ModernMediasfuGeneric is the most advanced, themed variant featuring:
- Premium glass-morphism design with backdrop blur effects
- Smooth animations and micro-interactions
- Dark/Light theme support built-in
- Accessibility-first components
- Responsive layouts for all screen sizes
import { ModernMediasfuGeneric } from 'mediasfu-reactjs';
function App() {
return (
<ModernMediasfuGeneric
credentials={{ apiUserName: "user", apiKey: "key" }}
containerStyle={{
background: "linear-gradient(135deg, #0f172a, #1e3a8a)",
minHeight: "100vh"
}}
/>
);
}Modern Components Available
| Modern Component | Classic Equivalent | Features |
|-----------------|-------------------|----------|
| ModernVideoCard | VideoCard | Glass effect, animated borders |
| ModernAudioCard | AudioCard | Gradient waveforms, glow effects |
| ModernMiniCard | MiniCard | Sleek thumbnails with status |
| ModernMenuModal | MenuModal | Slide animations, blur backdrop |
| ModernMessagesModal | MessagesModal | Chat bubbles, typing indicators |
| ModernRecordingModal | RecordingModal | Status animations, progress rings |
| ModernParticipantsModal | ParticipantsModal | Search, filters, role badges |
| ModernBackgroundModal | BackgroundModal | Image gallery, blur previews |
| ModernPollModal | PollModal | Real-time voting, animations |
| ModernBreakoutRoomsModal | BreakoutRoomsModal | Drag-and-drop, room previews |
| ModernPanelistsModal | PanelistsModal | Panelist management for webinars |
| ModernPermissionsModal | PermissionsModal | Per-participant permission control |
| TranslationSettingsModal | — | Real-time translation configuration |
🌐 Advanced Features
Panelists Mode (Webinars)
In webinar mode, designate specific participants as panelists who can speak, while others remain audience members.
// Panelists are managed via sourceParameters
const { panelists, updatePanelists } = sourceParameters;
// Listen for panelist changes
// Events: panelistsUpdated, addedAsPanelist, removedFromPanelists, panelistFocusChangedIndividual Permissions
Control each participant's capabilities individually:
import { ModernPermissionsModal } from 'mediasfu-reactjs';
// Permission levels:
// "0" - Standard participant
// "1" - Elevated (co-host level)
// "2" - Host (full control)
// Configure per-participant capabilities:
// - Video on/off
// - Audio on/off
// - Screen sharing
// - Chat accessReal-time Translation 🌍
Enable participants to speak in their native language and listen in any language with live AI translation.
import { TranslationSettingsModal } from 'mediasfu-reactjs';
function TranslationExample({ sourceParameters }) {
const [showTranslation, setShowTranslation] = useState(false);
return (
<>
<button onClick={() => setShowTranslation(true)}>
🌐 Translation Settings
</button>
<TranslationSettingsModal
isVisible={showTranslation}
onClose={() => setShowTranslation(false)}
parameters={sourceParameters}
/>
</>
);
}
// Translation events available:
// - translation:roomConfig
// - translation:languageSet
// - translation:subscribed
// - translation:transcriptFeatures include:
- Set your spoken language — The system knows what language you're speaking
- Choose listening language — Hear others translated to your preferred language
- Real-time transcription — See live transcripts
- Multiple language support — 50+ languages available
🔧 sourceParameters - The Power API
When building custom UIs or using headless mode (returnUI={false}), you need both props:
| Prop | Purpose |
|------|---------|
| sourceParameters | Initial state object (can be empty {}) |
| updateSourceParameters | Callback that receives the complete helper bundle |
The updateSourceParameters callback delivers a comprehensive object containing all room state, methods, and streams. This is your bridge to building completely custom UIs.
import { MediasfuGeneric } from 'mediasfu-reactjs';
import { useState, useCallback } from 'react';
function CustomUI() {
const [helpers, setHelpers] = useState<Record<string, unknown>>({});
// This callback receives ALL MediaSFU state and methods
const updateSourceParameters = useCallback((data: Record<string, unknown>) => {
setHelpers(data);
}, []);
return (
<>
<MediasfuGeneric
credentials={{ apiUserName: "user", apiKey: "key" }}
returnUI={false} // Headless mode - no UI rendered
noUIPreJoinOptions={{
action: "create",
capacity: 10,
eventType: "conference",
userName: "Host"
}}
sourceParameters={helpers} // Required: pass state object
updateSourceParameters={updateSourceParameters} // Required: receive updates
/>
{helpers.validated && <MyCustomMeetingUI sourceParameters={helpers} />}
</>
);
}Key sourceParameters Properties
Media Streams
const {
allVideoStreams, // All video MediaStream objects
allAudioStreams, // All audio MediaStream objects
localStream, // Your local camera stream
localStreamAudio, // Your local microphone stream
localStreamScreen, // Your screen share stream (if active)
remoteScreenStream, // Remote screen share stream
} = sourceParameters;Participant Data
const {
participants, // Full participant list
participantsCounter, // Current count
filteredParticipants, // Filtered by search
waitingRoomList, // Users in waiting room
coHost, // Current co-host name
member, // Your username
islevel, // Your permission level ('0', '1', '2')
youAreHost, // Boolean
youAreCoHost, // Boolean
} = sourceParameters;Room State
const {
roomName, // Current room name
eventType, // 'conference' | 'webinar' | 'broadcast' | 'chat'
recordStarted, // Is recording active
recordPaused, // Is recording paused
shareScreenStarted, // Is screen sharing active
validated, // Is room validated/connected
messages, // Chat messages array
polls, // Active polls
} = sourceParameters;Helper Methods
getParticipantMedia - Get Individual Streams
const { getParticipantMedia } = sourceParameters;
// Get video stream by participant name
const videoStream = await getParticipantMedia({
name: "Alice",
kind: "video"
});
// Get audio stream by producer ID
const audioStream = await getParticipantMedia({
id: "producer-id-123",
kind: "audio"
});
// Use in a video element
if (videoStream) {
videoRef.current.srcObject = videoStream;
}Media Control Methods
const {
clickVideo, // Toggle local video
clickAudio, // Toggle local audio
clickScreenShare, // Toggle screen share
switchVideoAlt, // Switch camera device
switchUserAudio, // Switch audio input device
} = sourceParameters;
// Toggle video with parameters
await clickVideo({ parameters: sourceParameters });Modal Toggles
const {
updateIsMenuModalVisible,
updateIsRecordingModalVisible,
updateIsParticipantsModalVisible,
updateIsMessagesModalVisible,
updateIsPollModalVisible,
updateIsBackgroundModalVisible,
updateIsBreakoutRoomsModalVisible,
updateIsMediaSettingsModalVisible,
} = sourceParameters;
// Open the chat modal
updateIsMessagesModalVisible(true);🎵 AudioGrid - Display All Audio Participants
Use AudioGrid with audio streams from sourceParameters:
import { AudioGrid, AudioCard } from 'mediasfu-reactjs';
function AudioParticipantsView({ sourceParameters }) {
const { allAudioStreams, participants } = sourceParameters;
// Build audio components from streams
const audioComponents = allAudioStreams.map((streamObj, index) => {
const participant = participants.find(p => p.audioID === streamObj.producerId);
return (
<AudioCard
key={streamObj.producerId || index}
name={participant?.name || 'Unknown'}
audioStream={streamObj.stream}
showWaveform={true}
barColor="#22c55e"
customStyle={{
background: "rgba(34, 197, 94, 0.1)",
borderRadius: 16,
padding: 12
}}
/>
);
});
return (
<AudioGrid
componentsToRender={audioComponents}
containerProps={{
style: {
display: 'grid',
gridTemplateColumns: 'repeat(auto-fill, minmax(200px, 1fr))',
gap: 16,
padding: 20
}
}}
/>
);
}🎬 Using Modals Standalone
You can use any modal component independently with sourceParameters:
Recording Modal
import { ModernRecordingModal } from 'mediasfu-reactjs';
function MyRecordingButton({ sourceParameters }) {
const [showRecording, setShowRecording] = useState(false);
return (
<>
<button onClick={() => setShowRecording(true)}>
🔴 Recording Settings
</button>
<ModernRecordingModal
isVisible={showRecording}
onClose={() => setShowRecording(false)}
parameters={sourceParameters}
position="center"
/>
</>
);
}Virtual Background Modal
import { ModernBackgroundModal } from 'mediasfu-reactjs';
function BackgroundSelector({ sourceParameters }) {
const [showBg, setShowBg] = useState(false);
return (
<>
<button onClick={() => setShowBg(true)}>
🖼️ Change Background
</button>
<ModernBackgroundModal
isVisible={showBg}
onClose={() => setShowBg(false)}
parameters={sourceParameters}
/>
</>
);
}Media Settings Modal
import { ModernMediaSettingsModal } from 'mediasfu-reactjs';
function DeviceSelector({ sourceParameters }) {
const [showSettings, setShowSettings] = useState(false);
return (
<>
<button onClick={() => setShowSettings(true)}>
⚙️ Audio/Video Settings
</button>
<ModernMediaSettingsModal
isVisible={showSettings}
onClose={() => setShowSettings(false)}
parameters={sourceParameters}
/>
</>
);
}🏗️ Building Your Own UI
Here's a complete example of building a custom meeting interface:
import {
MediasfuGeneric,
VideoCard,
AudioCard,
ModernMessagesModal,
ModernParticipantsModal,
ModernRecordingModal,
} from 'mediasfu-reactjs';
import { useState, useEffect } from 'react';
function CustomMeetingApp() {
const [params, setParams] = useState<any>(null);
const [showChat, setShowChat] = useState(false);
const [showParticipants, setShowParticipants] = useState(false);
const [showRecording, setShowRecording] = useState(false);
if (!params?.validated) {
return (
<MediasfuGeneric
credentials={{ apiUserName: "user", apiKey: "key" }}
returnUI={true} // Show pre-join UI
updateSourceParameters={setParams}
/>
);
}
const {
participants,
allVideoStreams,
allAudioStreams,
member,
roomName,
clickVideo,
clickAudio,
clickScreenShare,
videoAlreadyOn,
audioAlreadyOn,
shareScreenStarted,
recordStarted,
} = params;
return (
<div style={{ display: 'flex', flexDirection: 'column', height: '100vh', background: '#0f172a' }}>
{/* Header */}
<header style={{ padding: 16, borderBottom: '1px solid #334155', display: 'flex', justifyContent: 'space-between' }}>
<h1 style={{ color: 'white', margin: 0 }}>{roomName}</h1>
<span style={{ color: '#94a3b8' }}>{participants.length} participants</span>
</header>
{/* Video Grid */}
<main style={{ flex: 1, display: 'grid', gridTemplateColumns: 'repeat(auto-fill, minmax(300px, 1fr))', gap: 16, padding: 16 }}>
{allVideoStreams.map((stream, i) => {
const participant = participants.find(p => p.videoID === stream.producerId);
return (
<VideoCard
key={stream.producerId || i}
videoStream={stream.stream}
name={participant?.name || 'Unknown'}
customStyle={{ borderRadius: 16, overflow: 'hidden' }}
/>
);
})}
</main>
{/* Controls */}
<footer style={{ padding: 16, borderTop: '1px solid #334155', display: 'flex', justifyContent: 'center', gap: 16 }}>
<button
onClick={() => clickVideo({ parameters: params })}
style={{
padding: '12px 24px',
borderRadius: 12,
background: videoAlreadyOn ? '#22c55e' : '#ef4444',
color: 'white',
border: 'none',
cursor: 'pointer'
}}
>
{videoAlreadyOn ? '📹 Video On' : '📹 Video Off'}
</button>
<button
onClick={() => clickAudio({ parameters: params })}
style={{
padding: '12px 24px',
borderRadius: 12,
background: audioAlreadyOn ? '#22c55e' : '#ef4444',
color: 'white',
border: 'none',
cursor: 'pointer'
}}
>
{audioAlreadyOn ? '🎤 Mic On' : '🎤 Mic Off'}
</button>
<button onClick={() => setShowParticipants(true)} style={{ padding: '12px 24px', borderRadius: 12, background: '#3b82f6', color: 'white', border: 'none', cursor: 'pointer' }}>
👥 Participants
</button>
<button onClick={() => setShowChat(true)} style={{ padding: '12px 24px', borderRadius: 12, background: '#8b5cf6', color: 'white', border: 'none', cursor: 'pointer' }}>
💬 Chat
</button>
<button onClick={() => setShowRecording(true)} style={{ padding: '12px 24px', borderRadius: 12, background: recordStarted ? '#ef4444' : '#6b7280', color: 'white', border: 'none', cursor: 'pointer' }}>
🔴 Record
</button>
</footer>
{/* Modals */}
<ModernMessagesModal
isVisible={showChat}
onClose={() => setShowChat(false)}
parameters={params}
/>
<ModernParticipantsModal
isVisible={showParticipants}
onClose={() => setShowParticipants(false)}
parameters={params}
/>
<ModernRecordingModal
isVisible={showRecording}
onClose={() => setShowRecording(false)}
parameters={params}
/>
</div>
);
}�️ SDKs for Every Framework
MediaSFU isn't just React. The same communication platform is available across 7 frameworks — same API surface, same capabilities, same pricing:
| Framework | Package | |-----------|---------| | React | mediasfu-reactjs (you are here) | | React Native | @mediasfu/mediasfu-reactnative | | Expo | @mediasfu/mediasfu-reactnative-expo | | Flutter | mediasfu_sdk | | Angular | @mediasfu/mediasfu-angular | | Vue | @mediasfu/mediasfu-vue | | Android (Kotlin) | MediaSFU Android |
�🔗 Links
- Website: mediasfu.com
- Documentation: mediasfu.com/reactjs
- API Documentation: mediasfu.com/developers
- MediaSFU Open: github.com/MediaSFU/MediaSFUOpen
- Sandbox: mediasfu.com/sandbox
- Community Forum: mediasfu.com/forums
- GitHub: github.com/MediaSFU
📄 License
MIT © MediaSFU
Related SDKs
| Package | Framework | npm |
|---------|-----------|-----|
| mediasfu-reactjs | React 18/19 | this package |
| mediasfu-vue | Vue 3 | npm install mediasfu-vue |
| mediasfu-angular | Angular 17+ | npm install mediasfu-angular |
| mediasfu-shared | Framework-agnostic | npm install mediasfu-shared |
