Video Call Participants patches let you track all the participants in a video call and retrieve their ID and call activity. They are useful for building group effects for video calling.
You could use these patches, for example, if you’re building an AR game designed for a set number of players and you want your effect to respond in a certain way if one player leaves the game or video call.
If you're familiar with scripting, you can also use the
ParticipantsModule API to get this information.
There are four patches you can use to create these kinds of effects: Participant, Participant Finder, Participant Select and Participant ID. You can find them in Spark AR Studio, in the Video Call Participants section of the Patch Menu.
Use this patch with the Participant Finder and Participant Select patches to output a participant’s ID and status. This could be the participant in the self-view, or other participants on the video call.
Use this patch to find and identify the participants on a video call. Connect it to the Participant Select patch to target a specific participant.
Use this patch to select a participant from the other participants in the Participant Finder patch. Connect it to the Participant patch to get the status and ID for the selected participant.
Specify the participant you want to select using the unique ID that identifies them in a video calling session. You can retrieve this ID from a script using the
In the example above, the instructions Tap to Play are displayed on screen when both the participant in the self view and Participant 2 is active in the effect. We used Spark AR Player for Desktop to preview this, to simulate an environment with multiple participants on a call.
We achieved this with the patch graph below:
To find and select the participants we want, we connected:
To trigger instructions based on which participants are active in the effect, we connected: