@huddle01/react NPM

Huddle01 React SDK

NOTE: Request for access to the huddle01-client pkg on Huddle01's discord or reach out to the team.

React SDK

The Huddle01 React SDK offers a comprehensive suite of hooks, methods and event listeners that allow for seamless real-time audio and video communication with minimal coding required.

Pre Requisites

Before using the React SDK, you must have Node.js installed on your machine. You can install Node.js using one of the following methods:

Install Node.js with NVM by following the instructions on this GitHub page
Install Node.js with FNM by following the instructions on this GitHub page
Download Node.js from the official website

Pro Tip : Use NVM or FNM to install Node.js as they help in version management and easy updation

After installing Node.js, verify it's installed by running the following command in your terminal:

node --version

Installing the packages:

To get started with the Huddle01 React SDK, you can install the package using npm or pnpm or yarn:

npm install @huddle01/react

Initializing the SDK:

After installing the package, you can initialize the SDK by using the useHuddle01 hook:

import { useHuddle01 } from '@huddle01/react';

function App() {
  const { initialize } = useHuddle01();

  initialize('YOUR_PROJECT_ID');
}

Summary of Hooks:

useHuddle01() ✅

initialize()
isInitialized

joinLobby(roomId: string)
- if isInitialized
leaveLobby()
- if isLobbyJoined
isLoading
isLobbyJoined
error

useRoom() ✅

joinRoom()
- *if isLobbyJoined*
leaveRoom()
- *if isRoomJoined*
isLoading
isRoomJoined
error

fetchAudioStream()
- if isLobbyJoined
produceAudio(stream)
- if isRoomJoined
stopProducingAudio() — if isProducing
stopAudioStream()
isLoading
isProducing
stream
error

useVideo() ✅

fetchVideoStream()
- if isLobbyJoined
produceVideo(stream)
- if isRoomJoined
stopProducingVideo() — if isProducing
stopVideoStream()
isLoading
isProducing
stream
error

usePeers() ✅

peerIds[]
peers
error

startRecording()
- if isRoomJoined & not inProgress
stopRecording()
- if isRoomJoined & inProgress
isStarting
inProgress
isStopping
data
error

useLivestreaming() ✅

startLivestream()
- if isRoomJoined & not inProgress
stopLivestream()
- if isRoomJoined & inProgress
isStarting
inProgress
isStopping
data
error

💡 For more information head to https://huddle01.com/docs

💡 For any help reach out to us on Discord

huddle01 react RTC web3

@huddle01/web-core @tanstack/react-query @testing-library/react @testing-library/react-hooks axios react

@everything-registry/sub-chunk-404 @huddle01/react-native @huddle01/react-native-embed

5 days ago

5 days ago

5 days ago

13 days ago

13 days ago

12 days ago

14 days ago

15 days ago

15 days ago

23 days ago

23 days ago

23 days ago

23 days ago

23 days ago

22 days ago

23 days ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

10 months ago

7 months ago

10 months ago

10 months ago

7 months ago

7 months ago

5 months ago

7 months ago

5 months ago

7 months ago

5 months ago

7 months ago

5 months ago

7 months ago

7 months ago

7 months ago

5 months ago

7 months ago

7 months ago

5 months ago

5 months ago

5 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

5 months ago

5 months ago

5 months ago

6 months ago

5 months ago

5 months ago

9 months ago

8 months ago

6 months ago

10 months ago

10 months ago

7 months ago

6 months ago

6 months ago

7 months ago

7 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

5 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

8 months ago

7 months ago

7 months ago

10 months ago

9 months ago

8 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago