Comment on page
Types
Property | Description |
---|---|
displayName?: string | The name to use for the local participant (you) in the call |
Constraints to use for the local participant media (camera and microphone) | |
roomKey?: string | Room key to use if the local participant should assume a non-standard role in the room, such as host or viewer |
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) |
Property | Type | Description |
---|---|---|
status | "recording" | Cloud recording is active |
startedAt | number | When the recording started |
Value | Description |
---|---|
"starting" | Local screenshare is currently starting, eg the local user is selecting what to share |
"active" | Local screenshare is active |
Property | Type | Description |
---|---|---|
displayName | string | Display name of the local participant (you) |
id | string | Local participant id |
stream | 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 |
Property | Types | Description |
---|---|---|
displayName | string | Display name of the remote participant |
id | string | Id of the remote participant |
stream | Stream of the remote participant | |
isAudioEnabled | boolean | Stream of the remote participant |
isVideoEnabled | boolean | The remote participant has their microphone enabled |
Property | Type | Description |
---|---|---|
participantId | string | Id of the participant owning the screenshare |
id | string | Id of the screenshare |
hasAudioTrack | boolean | |
stream | | |
isLocal | boolean | Is the screenshare owned by the local participant? |
Value | Description |
---|---|
"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 |
Property | Type | Description |
---|---|---|
status | "streaming" | Live streaming is in progress |
startedAt | number | When the live stream started |
Property | Type | Description |
---|---|---|
id | string | Id of the participant waiting to be let in |
displayName | string | |
Last modified 30d ago