Participant
Last updated
Last updated
© Copyright 2024 ALO.ai, Inc. • All Rights Reserved
A participant object represents a user that is connected to a given channel. You can get the list of participants from the VideoChannel object. You will also get a list of participants with the onParticipantsChanged event.
Property
Type
Description
connectionId
String
Unique identifier, generated by the Video Service, that identifies a user's connection to a given channel.
id
String
Identifies the participant. This id will not change even if the connectionId changes.
isMutedLocally
Boolean
This is set totrue
when the current user decides to mute the participant's audio. If true
and the participant is publishing audio, the audio track will be disabled.
isPublishingAudio
Boolean
This is true
when the participant's published stream contains an audio track.
isPublishingStream
Boolean
This is true
if the participant is publishing a stream (audio and/or video).
isPublishingVideo
Boolean
This is true
when the participant's published stream contains a video track.
isCurrentUser
Boolean
This is true
when the participant represents the current user.
mediaStream
If the participant is publishing audio and/or video this will be their media stream
mutedByPublisher
Boolean
When true
the given participant's is publishing audio.
name
String
Name of the participant that can be used for display purposes.
userId
String
User id of the given participant.