Assistant Types

MediaStream

MediaStreamTrack

RemoteParticipantState:<Object>

Property
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

isLocalParticipant:boolean

For remote participants, this value is always false

presentationStream: MediaStream | null

If the participant is sharing their screen

externalId: string | null

A custom identifier for the participant.

stickyReaction?: StickyReaction

Whether the participant has hand raised

isDialIn: boolean

True if participant is a dial in agent

ChatMessage: <Object>

Property
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

AssistantEvents:<Object>

Property
Description

[AUDIO_STREAM_READY]: [ { stream: MediaStream; track: MediaStreamTrack} ];

Emitted when combined audio stream is ready

[ASSISTANT_JOINED_ROOM]: [{ roomUrl: string }]+

Emitted when the assistant joins the room

[ASSISTANT_LEFT_ROOM]: [{ roomUrl: string }]

Emitted when the assistant leaves the room

Last updated

Was this helpful?