List of all members | Public Fields | Public Instance Methods | Static Public Attributes
groupCall Class Referencefinal

Inherits Object.

Description

Describes a group call.

Public Fields

int32 id_
 Group call identifier.
 
string title_
 Group call title.
 
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.
 
bool enabled_start_notification_
 True, if the group call is scheduled and the current user will receive a notification when the group call starts.
 
bool is_active_
 True, if the call is active.
 
bool is_rtmp_stream_
 True, if the chat is an RTMP stream instead of an ordinary video chat.
 
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 can_be_managed_
 True, if the current user can manage the group call.
 
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.
 
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.
 
bool can_toggle_mute_new_participants_
 True, if the current user can enable or disable mute_new_participants setting.
 
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

 groupCall ()
 
 groupCall (int32 id_, string const &title_, int32 scheduled_start_date_, bool enabled_start_notification_, bool is_active_, bool is_rtmp_stream_, bool is_joined_, bool need_rejoin_, 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_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Instance Methods inherited from TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Static Public Attributes

static const std::int32_t ID = -123443355
 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_,
int32  scheduled_start_date_,
bool  enabled_start_notification_,
bool  is_active_,
bool  is_rtmp_stream_,
bool  is_joined_,
bool  need_rejoin_,
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.
[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.
[in]enabled_start_notification_True, if the group call is scheduled and the current user will receive a notification when the group call starts.
[in]is_active_True, if the call is active.
[in]is_rtmp_stream_True, if the chat is an RTMP stream instead of an ordinary video chat.
[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]can_be_managed_True, if the current user can manage the group call.
[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.
[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.
[in]can_toggle_mute_new_participants_True, if the current user can enable or disable mute_new_participants setting.
[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()

void store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


The documentation for this class was generated from the following file: