GroupCall
Describes a group call.
This is an alias for the GroupCallUnion
type.
chevron_leftchevron_right
Parameters
Interface
Name | Type | Description |
---|---|---|
_ | "groupCall" | |
id | number | Group call identifier |
title | string | Group call title |
scheduledStartDate | number | Point in time (Unix timestamp) when the group call is supposed to be started by an administrator; 0 if it is already active or was ended |
enabledStartNotification | boolean | True, if the group call is scheduled and the current user will receive a notification when the group call will start |
isActive | boolean | True, if the call is active |
isJoined | boolean | True, if the call is joined |
needRejoin | boolean | True, if user was kicked from the call because of network loss and the call needs to be rejoined |
canBeManaged | boolean | True, if the current user can manage the group call |
participantCount | number | Number of participants in the group call |
loadedAllParticipants | boolean | True, if all group call participants are loaded |
recentSpeakers | At most 3 recently speaking users in the group call | |
isMyVideoEnabled | boolean | True, if the current user's video is enabled |
isMyVideoPaused | boolean | True, if the current user's video is paused |
canEnableVideo | boolean | True, if the current user can broadcast video or share screen |
muteNewParticipants | boolean | True, if only group call administrators can unmute new participants |
canToggleMuteNewParticipants | boolean | True, if the current user can enable or disable mute_new_participants setting |
recordDuration | number | Duration of the ongoing group call recording, in seconds; 0 if none. An updateGroupCall update is not triggered when value of this field changes, but the same recording goes on |
isVideoRecorded | boolean | True, if a video file is being recorded for the call |
duration | number | Call duration, in seconds; for ended calls only |