Hiyve RTC Client - WebRTC Communication Library

A comprehensive WebRTC client library for real-time communication, enabling audio/video conferencing with advanced features like recording, streaming, screen sharing, and file management.

Documentation

Features

• HD Video Conferencing - High-quality audio and video with adaptive bitrate
• Room Management - Create, join, and manage rooms with owner privileges
• Screen Sharing - Share your screen or specific windows
• Cloud Recording - Record meetings with automatic video composition
• Live Streaming - Stream to external platforms (YouTube, Twitch, etc.)
• Real-time Transcription - Live speech-to-text with AI summaries
• In-Room Chat - Real-time messaging with history
• File Sharing - Upload and share files with participants
• TypeScript Support - Full type definitions included

Installation

npm install @hiyve/rtc-client
Copy

import { Client, ClientEvents } from '@hiyve/rtc-client';
Copy

Quick Start

1. Server-side: Generate Room Token

app.post('/generate-room-token', async function (req, res) {
  try {
    const response = await fetch('https://rtc.muziemedia.com/room-token', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({
        apiKey: process.env.APIKEY,
        secret: process.env.CLIENT_SECRET
      }),
    });
    const data = await response.json();
    res.send(data);
  } catch (error) {
    res.status(500).send({ error: 'Error generating room token' });
  }
});
Copy

2. Client-side: Join a Room

const { Client, ClientEvents } = window.MuzieClient;

// Initialize client
const client = new Client({ roomToken: 'your-room-token' });

// Listen for remote participants
client.addEventListener(ClientEvents.MEDIA_TRACK_ADDED, (event) => {
  const { userId, track, kind, paused } = event.detail;
  if (kind === 'video') {
    const videoEl = document.getElementById(`remote-video-${userId}`);
    videoEl.srcObject = new MediaStream([track]);
  }
});

// Setup devices
const cameras = await client.listVideoDevices();
const mics = await client.listAudioInputDevices();
await client.setLocalVideoDevice({ videoDeviceId: cameras[0].deviceId });
await client.setLocalAudioInputDevice({ audioInputDeviceId: mics[0].deviceId });

// Create and join room
const room = await client.createRoom({
  roomName: 'my-meeting',
  userId: 'user-123'
});

// Connect media
await client.connectTransports({ localVideoElementId: 'local-video' });
Copy

See the Workflow Guide for complete examples including:

• Token-based invites
• Recording with transcription
• Screen sharing
• Waiting room management
• And more...

Audio capture profiles

Browsers open a microphone for phone calls: echo cancellation, noise suppression, automatic gain, mono. Right for speech, wrong for an instrument or an audio interface. A capture profile names the trade-off once; the live room and any preview that uses it ask the browser for the same thing.

const client = new Client({ roomToken, options: { audioProfile: 'music' } });
// later, while in a room — the microphone is re-opened with the new settings
await client.setAudioProfile('instrument');
client.getAudioProfile(); // 'instrument'
Copy

Only capture changes. The encoder follows the media server's codec parameters (stereo, bitrate, FEC), not the profile. audioProfileConstraints(profile) is exported for previews that open the microphone themselves.

Optional peer dependencies

Sentiment (mood) analysis is loaded on demand and can use one of three analysers. The faceapi analyser's library is an optional peer — install it in your app only if you select that analyser:

npm install face-api.js      # only for analyzerType: 'faceapi'
Copy

Without it the rest of the client installs and builds normally; starting the faceapi analyser rejects with Failed to load face-api.js … npm install face-api.js. The human (@vladmandic/human) and mediapipe (@mediapipe/tasks-vision) analysers are still regular dependencies.

Key Events

See the API Reference for all 40+ events.

Browser Support

• Chrome (desktop and Android)
• Firefox (desktop and Android)
• Safari (desktop and iOS)
• Edge (Chromium-based)

License

Copyright 2023 by IWantToPractice, LLC. All rights reserved.

Use of this software is subject to license agreement. Unauthorized reproduction, distribution, or modification is expressly forbidden.