@goheadroom/client-js-sdk NPM

Headroom Javascript SDK

Welcome to the official Headroom SDK. This SDK provides developers with the necessary tools to seamlessly integrate real-time video and audio capabilities into their web applications, along with advanced features like recording interactions, transforming them into knowledge, and more.

Overview

The Headroom SDK is designed to empower your applications with real-time video conferencing capabilities powered by WebRTC, and also provides additional features that simplify the integration process. With the Headroom SDK, your application can automatically handle codec and scalable video encoding, select the optimal resolution based on display size, mute videos not visible in the viewport to save bandwidth, and disable videos in case of limited bandwidth.

Furthermore, the SDK includes an 'Understand' module with a 'Generators' component that converts all the data obtained from meetings into actionable knowledge using large language models (LLMs).

Getting Started

To get started with the Headroom SDK, follow the steps outlined in the 'Quickstart' section of our documentation. This will guide you through registering on the Admin Portal, obtaining API keys, setting up your web client, and initializing the Headroom client using the obtained tokens.

Prerequisites

Before you begin, make sure you have installed the necessary packages using either npm (Node Package Manager) or Yarn. Detailed instructions can be found in the 'Quickstart' section of our documentation.

Installation

To install the Headroom SDK package, use the following commands based on your package manager:

Using npm:

npm install @goheadroom/client-js-sdk

Using Yarn:

yarn add @goheadroom/client-js-sdk

Concepts

Understanding the key concepts of the Headroom SDK is crucial for its effective integration and utilization. Concepts such as 'Rooms', 'Participants', 'Sessions', and the 'Generators' component of the 'Understand' module are explained in detail in the 'Concepts' section of our documentation.