Inherits Object.
Description
Describes a group call.
Public Fields | |
| int32 | id_ |
| Group call identifier. | |
| string | title_ |
| Group call title; for video chats only. | |
| string | invite_link_ |
| Invite link for the group call; for group calls that aren't bound to a chat. For video chats call getVideoChatInviteLink to get the link. | |
| int32 | scheduled_start_date_ |
| Point in time (Unix timestamp) when the group call is expected to be started by an administrator; 0 if it is already active or was ended; for video chats only. | |
| bool | enabled_start_notification_ |
| True, if the group call is scheduled and the current user will receive a notification when the group call starts; for video chats only. | |
| bool | is_active_ |
| True, if the call is active. | |
| bool | is_video_chat_ |
| True, if the call is bound to a chat. | |
| bool | is_rtmp_stream_ |
| True, if the call is an RTMP stream instead of an ordinary video chat; for video chats only. | |
| bool | is_joined_ |
| True, if the call is joined. | |
| bool | need_rejoin_ |
| True, if user was kicked from the call because of network loss and the call needs to be rejoined. | |
| bool | is_owned_ |
| True, if the user is the owner of the call and can end the call, change volume level of other users, or ban users there; for group calls that aren't bound to a chat. | |
| bool | can_be_managed_ |
| True, if the current user can manage the group call; for video chats only. | |
| int32 | participant_count_ |
| Number of participants in the group call. | |
| bool | has_hidden_listeners_ |
| True, if group call participants, which are muted, aren't returned in participant list; for video chats only. | |
| bool | loaded_all_participants_ |
| True, if all group call participants are loaded. | |
| array< object_ptr< groupCallRecentSpeaker > > | recent_speakers_ |
| At most 3 recently speaking users in the group call. | |
| bool | is_my_video_enabled_ |
| True, if the current user's video is enabled. | |
| bool | is_my_video_paused_ |
| True, if the current user's video is paused. | |
| bool | can_enable_video_ |
| True, if the current user can broadcast video or share screen. | |
| bool | mute_new_participants_ |
| True, if only group call administrators can unmute new participants; for video chats only. | |
| bool | can_toggle_mute_new_participants_ |
| True, if the current user can enable or disable mute_new_participants setting; for video chats only. | |
| int32 | record_duration_ |
| 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. | |
| bool | is_video_recorded_ |
| True, if a video file is being recorded for the call. | |
| int32 | duration_ |
| Call duration, in seconds; for ended calls only. | |
Public Instance Methods inherited from Static Public Attributes | |
| static const std::int32_t | ID = -144438687 |
| Identifier uniquely determining a type of the object. | |
Constructor & Destructor Documentation
◆ groupCall() [1/2]
| groupCall | ( | ) |
Describes a group call.
◆ groupCall() [2/2]
| groupCall | ( | int32 | id_, |
| string const & | title_, | ||
| string const & | invite_link_, | ||
| int32 | scheduled_start_date_, | ||
| bool | enabled_start_notification_, | ||
| bool | is_active_, | ||
| bool | is_video_chat_, | ||
| bool | is_rtmp_stream_, | ||
| bool | is_joined_, | ||
| bool | need_rejoin_, | ||
| bool | is_owned_, | ||
| bool | can_be_managed_, | ||
| int32 | participant_count_, | ||
| bool | has_hidden_listeners_, | ||
| bool | loaded_all_participants_, | ||
| array< object_ptr< groupCallRecentSpeaker >> && | recent_speakers_, | ||
| bool | is_my_video_enabled_, | ||
| bool | is_my_video_paused_, | ||
| bool | can_enable_video_, | ||
| bool | mute_new_participants_, | ||
| bool | can_toggle_mute_new_participants_, | ||
| int32 | record_duration_, | ||
| bool | is_video_recorded_, | ||
| int32 | duration_ | ||
| ) |
Describes a group call.
- Parameters
-
[in] id_ Group call identifier. [in] title_ Group call title; for video chats only. [in] invite_link_ Invite link for the group call; for group calls that aren't bound to a chat. For video chats call getVideoChatInviteLink to get the link. [in] scheduled_start_date_ Point in time (Unix timestamp) when the group call is expected to be started by an administrator; 0 if it is already active or was ended; for video chats only. [in] enabled_start_notification_ True, if the group call is scheduled and the current user will receive a notification when the group call starts; for video chats only. [in] is_active_ True, if the call is active. [in] is_video_chat_ True, if the call is bound to a chat. [in] is_rtmp_stream_ True, if the call is an RTMP stream instead of an ordinary video chat; for video chats only. [in] is_joined_ True, if the call is joined. [in] need_rejoin_ True, if user was kicked from the call because of network loss and the call needs to be rejoined. [in] is_owned_ True, if the user is the owner of the call and can end the call, change volume level of other users, or ban users there; for group calls that aren't bound to a chat. [in] can_be_managed_ True, if the current user can manage the group call; for video chats only. [in] participant_count_ Number of participants in the group call. [in] has_hidden_listeners_ True, if group call participants, which are muted, aren't returned in participant list; for video chats only. [in] loaded_all_participants_ True, if all group call participants are loaded. [in] recent_speakers_ At most 3 recently speaking users in the group call. [in] is_my_video_enabled_ True, if the current user's video is enabled. [in] is_my_video_paused_ True, if the current user's video is paused. [in] can_enable_video_ True, if the current user can broadcast video or share screen. [in] mute_new_participants_ True, if only group call administrators can unmute new participants; for video chats only. [in] can_toggle_mute_new_participants_ True, if the current user can enable or disable mute_new_participants setting; for video chats only. [in] record_duration_ 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. [in] is_video_recorded_ True, if a video file is being recorded for the call. [in] duration_ Call duration, in seconds; for ended calls only.
Method Documentation
◆ store()
|
finalvirtual |
The documentation for this class was generated from the following file:
- td/generate/auto/td/telegram/td_api.h