Types
MediaStreamConstraints
MediaStream
MediaDeviceInfo
RoomConnectionOptions: <Object>
Property | Description |
---|---|
| The name to use for the local participant (you) in the call |
| Constraints to use for the local participant media (camera and microphone) |
| Existing local media to use, as provided by the |
| 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 |
| Id of the participant who sent the chat message |
text |
| Content of the chat message |
timestamp |
| Timestamp of when the message was sent (TODO: format) |
CloudRecordingState: <Object>
Property | Type | Description |
---|---|---|
status |
| Cloud recording is active |
startedAt |
| When the recording started |
LocalScreenshareStatus: <string>
Value | Description |
---|---|
| Local screenshare is currently starting, eg the local user is selecting what to share |
| Local screenshare is active |
LocalParticipant: <Object>
Property | Type | Description |
---|---|---|
displayName |
| Display name of the local participant (you) |
id |
| Local participant id |
roleName |
| The role of the local participant. This will be one of the following values:
|
stream | When set, the media stream (audio & video) of the local participant | |
isAudioEnabled |
| The local participant has their microphone enabled |
isVideoEnabled |
| The local participant has their camera enabled |
isLocalParticipant |
| 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 |
| Display name of the remote participant |
id |
| Id of the remote participant |
roleName |
| The role of the local participant. This will be one of the following values:
|
stream | Stream of the remote participant | |
isAudioEnabled |
| Stream of the remote participant |
isVideoEnabled |
| The remote participant has their microphone enabled |
Screenshare: <Object>
Property | Type | Description |
---|---|---|
participantId |
| Id of the participant owning the screenshare |
id |
| Id of the screenshare |
hasAudioTrack |
| |
stream | ||
isLocal |
| Is the screenshare owned by the local participant? |
RoomConnectionStatus: <string>
Value | Description |
---|---|
| Currently in the process of doing the initial connection in the room |
| Connected in the room, this is the "stable" state |
| Connection failed due to the room being locked, a knock is required to proceed |
| Waiting for the room host to respond to the knock request |
| The host rejected your knock request |
LiveStreamState: <Object>
Property | Type | Description |
---|---|---|
status |
| Live streaming is in progress |
startedAt |
| When the live stream started |
WaitingParticipant: <Object>
Property | Type | Description |
---|---|---|
id |
| Id of the participant waiting to be let in |
displayName |
|
Last updated