open-index/open-npm huggingface dataset:
npm package: @goheadroom/client-js-sdk
Description: [![Documentation](https://img.shields.io/badge/documentation-online-brightgreen)](https://docs.goheadroom.com)
Latest version: 0.0.12

# Headroom Javascript SDK

[![Documentation](https://img.shields.io/badge/documentation-online-brightgreen)](https://docs.goheadroom.com)

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](https://docs.goheadroom.com). 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](https://docs.goheadroom.com).

### 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](https://docs.goheadroom.com).

## Documentation

For detailed information about the API endpoints, parameters, and responses, please refer to our comprehensive [API documentation](https://docs.goheadroom.com).

## Support

If you encounter any issues or have questions, please feel free to reach out to our support team at support@goheadroom.com.

## Building

Run `nx build client-js-sdk` to build the library.

## Running unit tests

Run `nx test client-js-sdk` to execute the unit tests via [Jest](https://jestjs.io).
npm package: @goheadroom/client-react-sdk
Description: [![Documentation](https://img.shields.io/badge/documentation-online-brightgreen)](https://docs.goheadroom.com)
Latest version: 0.0.5

# Headroom React SDK

[![Documentation](https://img.shields.io/badge/documentation-online-brightgreen)](https://docs.goheadroom.com)

Welcome to the official Headroom React SDK. This SDK is a React wrapper around the Headroom JavaScript SDK, providing developers with convenient hooks and components to integrate real-time video and audio capabilities into their React applications.

## Overview

The Headroom React SDK is designed to simplify the integration of Headroom's real-time video conferencing capabilities into React applications. It leverages the power of the Headroom JavaScript SDK and provides additional convenient React hooks and components that make it easier to build and manage video conferencing features in your React application.

## Getting Started

To get started with the Headroom React SDK, follow the steps outlined in the 'Quickstart' section of our [documentation](https://docs.goheadroom.com). This will guide you through the process of setting up your React application, installing the necessary packages, 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](https://docs.goheadroom.com).

### Installation

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

Using npm:

```
npm install @goheadroom/client-js-sdk @goheadroom/client-react-sdk
```

Using Yarn:

```
yarn add @goheadroom/client-js-sdk @goheadroom/client-react-sdk
```

## Usage

The Headroom React SDK provides a set of hooks and components that you can use in your React application. For detailed information on how to use these hooks and components, please refer to our comprehensive [API documentation](https://docs.goheadroom.com).

## Documentation

For detailed information about the API endpoints, parameters, and responses, as well as the usage of hooks and components, please refer to our comprehensive [API documentation](https://docs.goheadroom.com).

## Support

If you encounter any issues or have questions, please feel free to reach out to our support team at support@goheadroom.com.

## Running unit tests

Run `nx test client-react-sdk` to execute the unit tests via [Jest](https://jestjs.io).