ParticipantsModule

Exposes the ability to retrieve the participants in a video call effect. Each user on the call is considered a participant, including the host.
When a new user joins the call a new Participant object is added to the array returned by getAllOtherParticipants() and otherParticipantCount is increased.


Participants are not removed from the array if they leave while the call is still active. This allows individual participants to retain the same unique ID that can be referenced for the duration of the video call, even after a dropout. Similarly, otherParticipantCount is not decreased when a participant leaves. However, if the the video call ends then the participant array and count are both reset.


Importing this module automatically enables the Participants capability within the project's Properties.

(get) effectGroupInitialised: BoolSignal
(set) (Not Available)

(get) otherParticipantCount: ScalarSignal
(set) (Not Available)

(get) otherParticipantsInSameEffectCount: ScalarSignal
(set) (Not Available)

(get) self: Promise<Participant>
(set) (Not Available)

getAllOtherParticipants(): Promise<Array<Participant>>

getOtherParticipantsInSameEffect(): Promise<Array<Participant>>

getParticipantById(id: string): Promise<Participant>

const otherParticipants = await Participants.getAllOtherParticipants();
const participant = otherParticipants[0];
const participantId = participant.id;

// Retrieves the above participant via its unique ID
const sameParticipant = Participants.getParticipantById(participantId)

onOtherParticipantAdded(): EventSource<Participant>

Participants.onOtherParticipantAdded().subscribe((participant) => {
// const newParticipantId = participant.id;
});