Get Started

Create AR effects for Instagram and Meta.
Get Started

Scripting API

ParticipantsModule

Participant

Participant

Contents

Contents

Exposes details of an individual participant in a video call effect.

Example

Properties

Property	Description
`id`	(get) id: string (set) (Not Available) The unique identifier for the participant. You can pass this ID into the `getParticipantById()` method exposed by the `Participants` module to retrieve a specific participant. IDs are constant for the duration of the video call but are not persistent across separate calls. If a participant drops out and rejoins the same video call they will retain the same ID. However, if the video call ends and a new one is started, new unique identifiers are generated for each participant.
`isActiveInCall`	(get) isActiveInCall: BoolSignal (set) (Not Available) Whether the participant is currently active in the video call, as a `BoolSignal`. If a participant leaves the video call this property will return `false` but the participant will not be removed from the array returned by `Participants.getAllOtherParticipants()` or subtracted from the value returned by `Participants.otherParticipantCount`. A participant being active in the call does not guarantee that they are also active in the effect. For this, use the Participant's `isActiveInSameEffect` property instead.
`isActiveInSameEffect`	(get) isActiveInSameEffect: BoolSignal (set) (Not Available) Whether the participant is currently active in the same effect, as a `BoolSignal`. This is distinct from `isActiveInCall` as a participant may be active in the video call but not necessarily be active in the running effect.
`loadStatus`	(get) loadStatus: StringSignal<ParticipantLoadStatus> (set) (Not Available) The participant's load status, as a `StringSignal` containing a `ParticipantLoadStatus` enum value (`LOADING`, `LOADED`, `ERROR` or `OPTED_OUT`).

Methods

This module exposes no methods.