MadelineProtoDocs/docs/API_docs/constructors/groupCallParticipant.md
2024-05-01 14:53:46 +02:00

3.6 KiB

title description nav_exclude image
groupCallParticipant Info about a group call participant true https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Constructor: groupCallParticipant

Back to constructors index

Info about a group call participant

Attributes:

Name Type Required Description
muted Bool Optional Whether the participant is muted
left Bool Optional Whether the participant has left
can_self_unmute Bool Optional Whether the participant can unmute themselves
just_joined Bool Optional Whether the participant has just joined
versioned Bool Optional If 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.
min Bool Optional If 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_you Bool Optional Whether this participant was muted by the current user
volume_by_admin Bool Optional Whether our volume can only changed by an admin
self Bool Optional Whether this participant is the current user
video_joined Bool Optional Whether this participant is currently broadcasting video
peer long Yes Peer information
date int Yes When did this participant join the group call
active_date int Optional When was this participant last active in the group call
source int Yes Source ID
volume int Optional Volume, if not set the volume is set to 100%.
about string Optional Info about this participant
raise_hand_rating long Optional Specifies the UI visualization order of peers with raised hands: peers with a higher rating should be showed first in the list.
video GroupCallParticipantVideo Optional Info about the video stream the participant is currently broadcasting
presentation GroupCallParticipantVideo Optional Info 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];