useConferenceSystem

GitHub

A comprehensive hook for managing video conferencing state, including camera access, screen sharing, network monitoring, and automatic media quality adjustment.

Installation

npx sse-hooks add use-conference-system

yarn dlx sse-hooks add use-conference-system

pnpm dlx sse-hooks add use-conference-system

deno run -A npm:sse-hooks add use-conference-system

bunx sse-hooks add use-conference-system

Usage

example.ts

import { useConferenceSystem } from "./{hooks file}";

const { camera, screen, quality, network } = useConferenceSystem({
  defaultAutoQuality: true,
});
return (
  <div>
    <video ref={(v) => (v.srcObject = camera.stream)} autoPlay />
    <button onClick={camera.start}>Start Camera</button>
    <p>
      Current Quality: {quality.current} (Auto: {quality.isAuto ? "On" : "Off"})
    </p>
    <p>Network Speed: {network.speed} Mbps</p>
  </div>
);

API

Parameters

Prop	Default	Type
`options`	`{}`	`UseConferenceSystemOptions` Configuration options for the conference system.

Returns

Return Value	Default	Type
`camera`	-	`Object` Camera management and state
`network`	-	`Object` Network status and telemetry
`quality`	-	`Object` Media quality management
`screen`	-	`Object` Screen sharing management and state

Types Aliases

No specific type aliases defined for this component.

Changelog

31af5 — Refactor useBattery hook and remove utility functions

c165d — feat: enhance useRoleGuard and useSSR hooks with additional options and documentation

30da4 — feat: add new hooks and their metadata

2f161 — feat: add useConferenceSystem, useKbd, useMediaQuality, useNetworkInformation, usePortal, useRoleGuard, useScreenShare, useSymbol hooks

useWindowSize

Custom hook that tracks the size of the window.

useCounter

Custom hook that manages a counter with increment, decrement, reset, and setCount functionalities.