Types

MediaStreamConstraints

MediaDevices: getUserMedia() method - Web APIs | MDN

MediaStream

MediaStream - Web APIs | MDN

MediaDeviceInfo

MediaDeviceInfo - Web APIs | MDN

RoomConnectionOptions: <Object>

Property	Description
displayName?: string	The name to use for the local participant (you) in the call
localMediaConstraints?: MediaStreamConstraints	Constraints to use for the local participant media (camera and microphone)
localMedia: LocalMedia	Existing local media to use, as provided by the useLocalMedia hook
roomKey?: string	Room key to use if the local participant should assume a non-standard role in the room, such as host or viewer

ChatMessage: <Object>

Property	Type	Description
senderId	string	Id of the participant who sent the chat message
text	string	Content of the chat message
timestamp	string	Timestamp of when the message was sent (TODO: format)

CloudRecordingState: <Object>

Property	Type	Description
status	"recording"	Cloud recording is active
startedAt	number	When the recording started

LocalScreenshareStatus: <string>

Value	Description
"inactive"	Local screenshare is inactive
"starting"	Local screenshare is currently starting, eg the local user is selecting what to share
"active"	Local screenshare is active

LocalParticipant: <Object>

Property	Type	Description
displayName	string	Display name of the local participant (you)
id	string	Local participant id
roleName	string	The role of the local participant. This will be one of the following values: none, visitor, granted_visitor, viewer, granted_viewer, host, recorder, streamer
stream	MediaStream?	When set, the media stream (audio & video) of the local participant
isAudioEnabled	boolean	The local participant has their microphone enabled
isVideoEnabled	boolean	The local participant has their camera enabled
isLocalParticipant	true	Always set to true. Can be used to easily identify the local participant if in an array with eg remote participants

RemoteParticipant: <Object>

Property	Types	Description
displayName	string	Display name of the remote participant
id	string	Id of the remote participant
roleName	string	The role of the local participant. This will be one of the following values: none, visitor, granted_visitor, viewer, granted_viewer, host, recorder, streamer
stream	MediaStream?	Stream of the remote participant
isAudioEnabled	boolean	The remote participant has their camera enabled
isVideoEnabled	boolean	The remote participant has their microphone enabled

ClientView: <Object>

A client view can be either a participant or a screenshare.

Property	Type	Description
id	string	Internal id
clientId	string	Id of the participant
displayName	string	Display name of the participant or screenshare
stream	MediaStream?
isLocalClient	boolean	Is the client view owned by the local participant?
isAudioEnabled	boolean	The client view has their microphone enabled
isVideoEnabled	boolean	The client view has their camera enabled
isPresentation	boolean	The client view is a presentation (screenshare)

Screenshare: <Object>

Property	Type	Description
participantId	string	Id of the participant owning the screenshare
id	string	Id of the screenshare
hasAudioTrack	boolean
stream	MediaStream?
isLocal	boolean	Is the screenshare owned by the local participant?

RoomConnectionStatus: <string>

Value	Description
"ready"	Ready to join the room
"connecting"	Currently in the process of doing the initial connection in the room
"connected"	Connected in the room, this is the "stable" state
"room_locked"	Connection failed due to the room being locked, a knock is required to proceed
"knocking"	Waiting for the room host to respond to the knock request
"knock_rejected"	The host rejected your knock request
"kicked"	The current participant was kicked from the room. This can happen in the following scenarios: when a meeting host ends the meeting for all participants in the room when a meeting host kicks the current participant individually from the room
"leaving"	The current participant has invoked the leaveRoom action to exit the room.
"left"	The current participant has now successfully left the room and all other room participants have been notified.
"disconnected"	The current participant has been disconnected from the room due to an unplanned loss of network connection. This can happen during temporary network outage (e.g. loss of network or switching networks). If/when the network connection returns the SDK will change the room connection status to reconnectingautomatically.
"reconnecting"	A lost internet connection has been re-established. The SDK will now automatically re-connect the current participant to the previous room and the room connection state will change to either: a.) knocking if the room is locked, or; b.) connected if the room is unlocked.

LiveStreamState: <Object>

Property	Type	Description
status	"streaming"	Live streaming is in progress
startedAt	number	When the live stream started

WaitingParticipant: <Object>

Property	Type	Description
id	string	Id of the participant waiting to be let in
displayName	string

Events

NotificationEvent

All events are of type NotificationEvent, with

Property	Type	Description
type	string
message	string
props	EventProps

Event Props

StickyReactionEvent

Property	Type	Description
client	RemoteParticipant
stickyReaction	{ reaction: string, timestamp: string } | null

RequestAudioEvent

Property	Type	Description
client	RemoteParticipant
enable	boolean

SignalStatusEvent

Property	Type	Description

ChatMessageEvent

Property	Type	Description
client	RemoteParticipant
chatMessage	ChatMessage