Link Search Menu Expand Document

Constructor: groupCallParticipant

Back to constructors index

Info about a group call participant

Attributes:

NameTypeRequiredDescription
mutedBoolOptionalWhether the participant is muted
leftBoolOptionalWhether the participant has left
can_self_unmuteBoolOptionalWhether the participant can unmute themselves
just_joinedBoolOptionalWhether the participant has just joined
versionedBoolOptionalIf set, and updateGroupCallParticipants.version < locally stored call.version, info about this participant should be ignored. If (…), and updateGroupCallParticipants.version > call.version+1, the participant list should be refetched using phone.getGroupParticipants.
minBoolOptionalIf not set, the volume and muted_by_you fields can be safely used to overwrite locally cached information; otherwise, volume will contain valid information only if volume_by_admin is set both in the cache and in the received constructor.
muted_by_youBoolOptionalWhether this participant was muted by the current user
volume_by_adminBoolOptionalWhether our volume can only changed by an admin
selfBoolOptionalWhether this participant is the current user
video_joinedBoolOptionalWhether this participant is currently broadcasting video
peerlongYesPeer information
dateintYesWhen did this participant join the group call
active_dateintOptionalWhen was this participant last active in the group call
sourceintYesSource ID
volumeintOptionalVolume, if not set the volume is set to 100%.
aboutstringOptionalInfo about this participant
raise_hand_ratinglongOptionalSpecifies the UI visualization order of peers with raised hands: peers with a higher rating should be showed first in the list.
videoGroupCallParticipantVideoOptionalInfo about the video stream the participant is currently broadcasting
presentationGroupCallParticipantVideoOptionalInfo about the screen sharing stream the participant is currently broadcasting

Type: GroupCallParticipant

Example:

$groupCallParticipant = ['_' => 'groupCallParticipant', 'muted' => Bool, 'left' => Bool, 'can_self_unmute' => Bool, 'just_joined' => Bool, 'versioned' => Bool, 'min' => Bool, 'muted_by_you' => Bool, 'volume_by_admin' => Bool, 'self' => Bool, 'video_joined' => Bool, 'peer' => long, 'date' => int, 'active_date' => int, 'source' => int, 'volume' => int, 'about' => 'string', 'raise_hand_rating' => long, 'video' => GroupCallParticipantVideo, 'presentation' => GroupCallParticipantVideo];