Red5 Pro Conference SDK

The Red5 Pro Conference SDK is a powerful, professional-grade toolkit for building multi-party video conferencing applications on the Red5 Pro and Red5 Cloud platform. It handles room management, media streaming WHIP/WHEP, WebRTC statistics interactive features powered by PubNub, and advanced features like virtual backgrounds and local recording.

Table of Contents

• Installation
• Quick Start
• Configuration
• API Reference
• Examples

Installation

Install the SDK via npm:

npm install red5pro-conference-sdk

Quick Start

import { ConferenceClient, ConferenceEvents } from 'red5pro-conference-sdk';

// 1. Configure the client
const config = {
  host: 'your-red5-pro-host',
  nodeGroup: 'your-node-group',
  iceServers: [{ urls: 'stun:stun.l.google.com:19302' }],
  pubnubPublishKey: 'your-pubnub-publish-key',
  pubnubSubscribeKey: 'your-pubnub-subscribe-key'
};

const client = new ConferenceClient(config);

// 2. Listen for events
client.on(ConferenceEvents.USER_PUBLISHED, (event) => {
  console.log('Successfully published to room:', event.streamName);
});

client.on(ConferenceEvents.NEW_PARTICIPANT, (participant) => {
  console.log('New participant joined:', participant.userId);
  // Auto-subscribe to the new participant
  client.subscribe(participant);
});

// 3. Join a room
const joinParams = {
  roomId: 'my-awesome-room',
  userId: 'user-' + Math.floor(Math.random() * 1000),
  token: 'your-auth-token',
  role: 'publisher',
  mediaStream: await navigator.mediaDevices.getUserMedia({ video: true, audio: true }),
  videoEnabled: true,
  audioEnabled: true
};

await client.join(
  joinParams.roomId,
  joinParams.userId,
  joinParams.token,
  joinParams.role,
  joinParams.mediaStream,
  joinParams.videoEnabled,
  joinParams.audioEnabled
);

Configuration

The ConferenceConfig object supports the following parameters:

Next Steps

To see fully working examples of these features, check out the Conference SDK Examples.