Skip to content

README.md

Latest commit

 

History

History
66 lines (43 loc) · 3 KB

README.md

File metadata and controls

66 lines (43 loc) · 3 KB
Raw

Conference Room — Manual Signaling

Same browser conference demo as conference-room, but signaling is implemented by hand — this example does not import @node-webrtc-rust/signaling.

Use it when you already have a signaling stack (Socket.IO, Redis pub/sub, your own WebSocket server) and want to see exactly how browser SDP/ICE maps into native conference DTOs.

What is manual here?

Piece Standard conference-room This example
WebSocket room relay SignalingServer from @node-webrtc-rust/signaling ManualSignalingServer in src/manual-signaling.ts
Conference bridge ConferenceServer.attachSignaling() + SDK bridge Inline in ManualSignalingServer — calls ConferenceRoom.handleSignalingMessage() directly
Browser client Same wire protocol Same public/client.js (unchanged)

The wire protocol matches @node-webrtc-rust/signaling:

  • join — enter a room (room, peerId)
  • offer / answer / ice-candidate — targeted SDP/ICE relay (targetPeerId)
  • peer-joined / peer-left — room membership notifications

Messages addressed to conference-server are translated into native join/offer/answer/ice DTOs. Outbound offers from the mixer are sent back to browsers as offer messages from conference-server.

Prerequisites

From the repo root:

npm install
npm run build:ts
cd packages/bindings && npm run build:local

Run

npm run start --workspace=@node-webrtc-rust/example-conference-room-manual-signaling

Open http://localhost:8081 in two or more browser tabs (default port 8081 so it can run alongside the standard conference demo on 8080).

Key server code

import { ConferenceServer } from '@node-webrtc-rust/sdk/conference'
import { ManualSignalingServer } from './manual-signaling'

const conference = new ConferenceServer()
const signaling = new ManualSignalingServer(httpServer, { path: '/ws' })
signaling.attachConference(conference)

When a browser sends join, ManualSignalingServer:

  1. Adds the peer to the in-memory room map and broadcasts peer-joined.
  2. Calls room.handleSignalingMessage(JSON.stringify({ type: 'join', participantId, roomId })).
  3. Forwards any returned SDP offer to the browser as a signaling offer from conference-server.

See src/manual-signaling.ts for the full relay and bridge logic.

Manual test script

Same as conference-room/README.md: join room demo in two tabs, verify exclude-self mixing, try mute/kick/mixing controls.

License

MIT