Docs
v2.0
Concepts
Concepts
Core Concepts and Glossary
Core Concepts and Glossary
Huddle01's React SDK is designed with core principles that make it simple and enjoyable to use. Before diving in, it's helpful to understand a few key concepts & terms related to the SDK.
Huddle01's React SDK is designed with core principles that make it simple and enjoyable to use. Before diving in, it's helpful to understand a few key concepts & terms related to the SDK.
Room
A room is a virtual space where Huddle01 meeting sessions take place. It includes all participants and their media streams. Each room is assigned a unique roomID when created. Rooms don't expire, allowing multiple meeting sessions to occur within the same room, one at a time.
A room is a virtual space where Huddle01 meeting sessions take place. It includes all participants and their media streams. Each room is assigned a unique roomID when created. Rooms don't expire, allowing multiple meeting sessions to occur within the same room, one at a time.
Peer
A peer is a participant within a room. It is represented as an object that includes all the participant's media streams. Each peer has a unique peerId and is always linked to a specific room.
A peer is a participant within a room. It is represented as an object that includes all the participant's media streams. Each peer has a unique peerId and is always linked to a specific room.
MediaStream
The MediaStream interface represents a stream of media content, which can include multiple tracks—either audio or video. These MediaStreams are tied to their respective peers.
The MediaStream interface represents a stream of media content, which can include multiple tracks—either audio or video. These MediaStreams are tied to their respective peers.
MediaStreamTrack
The MediaStreamTrack interface represents a single media track within a MediaStream. It can be either an audio or video track.
The MediaStreamTrack interface represents a single media track within a MediaStream. It can be either an audio or video track.
Local
When you join a room, your own Peer object within the room is referred to as 'local.' All operations related to your Peer will use this keyword.
When you join a room, your own Peer object within the room is referred to as 'local.' All operations related to your Peer will use this keyword.
Item
Variable
Your Peer Object
Your Peer Object
localPeer
localPeer
Your Audio Stream
Your Audio Stream
localAudio
localAudio
Your Video Stream
Your Video Stream
localVideo
localVideo
Remote
Peers in the same room, other than yourself, are represented by the keyword 'remote.' To perform any operation on a remote peer, you need to provide their unique peerId.
Peers in the same room, other than yourself, are represented by the keyword 'remote.' To perform any operation on a remote peer, you need to provide their unique peerId.
Item
Variable
Another Peer Object
Another Peer Object
remotePeer
remotePeer
Another Peer's Audio Stream
Another Peer's Audio Stream
remoteAudio
remoteAudio
Another Peer's Video Stream
Another Peer's Video Stream
remoteVideo
remoteVideo
Data Message
Data Message
In addition to MediaStreams, peers can send data messages to one another in the form of text strings, with a maximum length of 280 characters.
Step by step guides to build popular apps and experiences with Huddle01.
Metadata
Metadata
Metadata is a versatile object that can be attached to both Peers and Rooms. It allows you to store extra information tied to either a Peer or a Room. The SDKs provide methods to manage this metadata.
Step by step guides to build popular apps and experiences with Huddle01.
Room States
Room States
A Room can be in one of six possible states at any given time.
Step by step guides to build popular apps and experiences with Huddle01.
Item
Variable
idle
idle
Room is created & ready to be joined
Room is created, ready to be joined
connecting
connecting
You are trying to join the room
You are trying to join the room
connected
connected
You have joined the room
You have joined the room
failed
failed
You have failed to join the room
You have failed to join the room
left
left
You have left the room
You have left the room
closed
closed
The room has been closed
The room has been closed
Last Updated on
20 jan, 2025
Powered by
·
Huddle01
Design
Last Updated on
20 jan, 2025
Powered by
·
Huddle01
Design
Last Updated:
20 jan, 2025
Powered by
·
Huddle01
Design
Last Updated on
20 jan, 2025
Powered by
·
Huddle01
Design