tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::groupCall Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::groupCall:
td::td_api::Object td::TlObject

Public Member Functions

 groupCall ()
 
 groupCall (int32 id_, int64 unique_id_, string const &title_, string const &invite_link_, int53 paid_message_star_count_, int32 scheduled_start_date_, bool enabled_start_notification_, bool is_active_, bool is_video_chat_, bool is_live_story_, 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_, object_ptr< MessageSender > &&message_sender_id_, 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_, bool can_send_messages_, bool are_messages_allowed_, bool can_toggle_are_messages_allowed_, bool can_delete_messages_, int32 record_duration_, bool is_video_recorded_, int32 duration_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::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
 

Public Attributes

int32 id_
 Group call identifier.
 
int64 unique_id_
 Persistent unique 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&#x27;t bound to a chat. For video chats call getVideoChatInviteLink to get the link. For live stories in chats with username call getInternalLink with internalLinkTypeLiveStory.
 
int53 paid_message_star_count_
 The minimum number of Telegram Stars that must be paid by general participant for each sent message to the call; for live stories only.
 
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_live_story_
 True, if the call is a live story of a chat.
 
bool is_rtmp_stream_
 True, if the call is an RTMP stream instead of an ordinary video chat; for video chats and live stories 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&#x27;t bound to a chat.
 
bool can_be_managed_
 True, if the current user can manage the group call; for video chats and live stories only.
 
int32 participant_count_
 Number of participants in the group call.
 
bool has_hidden_listeners_
 True, if group call participants, which are muted, aren&#x27;t returned in participant list; for video chats only.
 
bool loaded_all_participants_
 True, if all group call participants are loaded.
 
object_ptr< MessageSendermessage_sender_id_
 Message sender chosen to send messages to the group call; for live stories only; may be null if the call isn&#x27;t a live story.
 
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&#x27;s video is enabled.
 
bool is_my_video_paused_
 True, if the current user&#x27;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.
 
bool can_send_messages_
 True, if the current user can send messages to the group call.
 
bool are_messages_allowed_
 True, if sending of messages is allowed in the group call.
 
bool can_toggle_are_messages_allowed_
 True, if the current user can enable or disable sending of messages in the group call.
 
bool can_delete_messages_
 True, if the user can delete messages in the group call.
 
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.
 

Static Public Attributes

static const std::int32_t ID = 1673382770
 Identifier uniquely determining a type of the object.
 

Detailed Description

Describes a group call.

Definition at line 24596 of file td_api.h.

Constructor & Destructor Documentation

◆ groupCall() [1/2]

td::td_api::groupCall::groupCall ( )

Describes a group call.

◆ groupCall() [2/2]

td::td_api::groupCall::groupCall ( int32  id_,
int64  unique_id_,
string const &  title_,
string const &  invite_link_,
int53  paid_message_star_count_,
int32  scheduled_start_date_,
bool  enabled_start_notification_,
bool  is_active_,
bool  is_video_chat_,
bool  is_live_story_,
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_,
object_ptr< MessageSender > &&  message_sender_id_,
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_,
bool  can_send_messages_,
bool  are_messages_allowed_,
bool  can_toggle_are_messages_allowed_,
bool  can_delete_messages_,
int32  record_duration_,
bool  is_video_recorded_,
int32  duration_ 
)

Describes a group call.

Parameters
[in]id_Group call identifier.
[in]unique_id_Persistent unique 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&#x27;t bound to a chat. For video chats call getVideoChatInviteLink to get the link. For live stories in chats with username call getInternalLink with internalLinkTypeLiveStory.
[in]paid_message_star_count_The minimum number of Telegram Stars that must be paid by general participant for each sent message to the call; for live stories only.
[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_live_story_True, if the call is a live story of a chat.
[in]is_rtmp_stream_True, if the call is an RTMP stream instead of an ordinary video chat; for video chats and live stories 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&#x27;t bound to a chat.
[in]can_be_managed_True, if the current user can manage the group call; for video chats and live stories only.
[in]participant_count_Number of participants in the group call.
[in]has_hidden_listeners_True, if group call participants, which are muted, aren&#x27;t returned in participant list; for video chats only.
[in]loaded_all_participants_True, if all group call participants are loaded.
[in]message_sender_id_Message sender chosen to send messages to the group call; for live stories only; may be null if the call isn&#x27;t a live story.
[in]recent_speakers_At most 3 recently speaking users in the group call.
[in]is_my_video_enabled_True, if the current user&#x27;s video is enabled.
[in]is_my_video_paused_True, if the current user&#x27;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]can_send_messages_True, if the current user can send messages to the group call.
[in]are_messages_allowed_True, if sending of messages is allowed in the group call.
[in]can_toggle_are_messages_allowed_True, if the current user can enable or disable sending of messages in the group call.
[in]can_delete_messages_True, if the user can delete messages in the group call.
[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.

Member Function Documentation

◆ store()

void td::td_api::groupCall::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 td::TlObject.

Member Data Documentation

◆ are_messages_allowed_

bool td::td_api::groupCall::are_messages_allowed_

True, if sending of messages is allowed in the group call.

Definition at line 24659 of file td_api.h.

◆ can_be_managed_

bool td::td_api::groupCall::can_be_managed_

True, if the current user can manage the group call; for video chats and live stories only.

Definition at line 24635 of file td_api.h.

◆ can_delete_messages_

bool td::td_api::groupCall::can_delete_messages_

True, if the user can delete messages in the group call.

Definition at line 24663 of file td_api.h.

◆ can_enable_video_

bool td::td_api::groupCall::can_enable_video_

True, if the current user can broadcast video or share screen.

Definition at line 24651 of file td_api.h.

◆ can_send_messages_

bool td::td_api::groupCall::can_send_messages_

True, if the current user can send messages to the group call.

Definition at line 24657 of file td_api.h.

◆ can_toggle_are_messages_allowed_

bool td::td_api::groupCall::can_toggle_are_messages_allowed_

True, if the current user can enable or disable sending of messages in the group call.

Definition at line 24661 of file td_api.h.

◆ can_toggle_mute_new_participants_

bool td::td_api::groupCall::can_toggle_mute_new_participants_

True, if the current user can enable or disable mute_new_participants setting; for video chats only.

Definition at line 24655 of file td_api.h.

◆ duration_

int32 td::td_api::groupCall::duration_

Call duration, in seconds; for ended calls only.

Definition at line 24669 of file td_api.h.

◆ enabled_start_notification_

bool td::td_api::groupCall::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.

Definition at line 24619 of file td_api.h.

◆ has_hidden_listeners_

bool td::td_api::groupCall::has_hidden_listeners_

True, if group call participants, which are muted, aren&#x27;t returned in participant list; for video chats only.

Definition at line 24639 of file td_api.h.

◆ ID

const std::int32_t td::td_api::groupCall::ID = 1673382770
static

Identifier uniquely determining a type of the object.

Definition at line 24715 of file td_api.h.

◆ id_

int32 td::td_api::groupCall::id_

Group call identifier.

Definition at line 24607 of file td_api.h.

◆ invite_link_

string td::td_api::groupCall::invite_link_

Invite link for the group call; for group calls that aren&#x27;t bound to a chat. For video chats call getVideoChatInviteLink to get the link. For live stories in chats with username call getInternalLink with internalLinkTypeLiveStory.

Definition at line 24613 of file td_api.h.

◆ is_active_

bool td::td_api::groupCall::is_active_

True, if the call is active.

Definition at line 24621 of file td_api.h.

◆ is_joined_

bool td::td_api::groupCall::is_joined_

True, if the call is joined.

Definition at line 24629 of file td_api.h.

◆ is_live_story_

bool td::td_api::groupCall::is_live_story_

True, if the call is a live story of a chat.

Definition at line 24625 of file td_api.h.

◆ is_my_video_enabled_

bool td::td_api::groupCall::is_my_video_enabled_

True, if the current user&#x27;s video is enabled.

Definition at line 24647 of file td_api.h.

◆ is_my_video_paused_

bool td::td_api::groupCall::is_my_video_paused_

True, if the current user&#x27;s video is paused.

Definition at line 24649 of file td_api.h.

◆ is_owned_

bool td::td_api::groupCall::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&#x27;t bound to a chat.

Definition at line 24633 of file td_api.h.

◆ is_rtmp_stream_

bool td::td_api::groupCall::is_rtmp_stream_

True, if the call is an RTMP stream instead of an ordinary video chat; for video chats and live stories only.

Definition at line 24627 of file td_api.h.

◆ is_video_chat_

bool td::td_api::groupCall::is_video_chat_

True, if the call is bound to a chat.

Definition at line 24623 of file td_api.h.

◆ is_video_recorded_

bool td::td_api::groupCall::is_video_recorded_

True, if a video file is being recorded for the call.

Definition at line 24667 of file td_api.h.

◆ loaded_all_participants_

bool td::td_api::groupCall::loaded_all_participants_

True, if all group call participants are loaded.

Definition at line 24641 of file td_api.h.

◆ message_sender_id_

object_ptr<MessageSender> td::td_api::groupCall::message_sender_id_

Message sender chosen to send messages to the group call; for live stories only; may be null if the call isn&#x27;t a live story.

Definition at line 24643 of file td_api.h.

◆ mute_new_participants_

bool td::td_api::groupCall::mute_new_participants_

True, if only group call administrators can unmute new participants; for video chats only.

Definition at line 24653 of file td_api.h.

◆ need_rejoin_

bool td::td_api::groupCall::need_rejoin_

True, if user was kicked from the call because of network loss and the call needs to be rejoined.

Definition at line 24631 of file td_api.h.

◆ paid_message_star_count_

int53 td::td_api::groupCall::paid_message_star_count_

The minimum number of Telegram Stars that must be paid by general participant for each sent message to the call; for live stories only.

Definition at line 24615 of file td_api.h.

◆ participant_count_

int32 td::td_api::groupCall::participant_count_

Number of participants in the group call.

Definition at line 24637 of file td_api.h.

◆ recent_speakers_

array<object_ptr<groupCallRecentSpeaker> > td::td_api::groupCall::recent_speakers_

At most 3 recently speaking users in the group call.

Definition at line 24645 of file td_api.h.

◆ record_duration_

int32 td::td_api::groupCall::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.

Definition at line 24665 of file td_api.h.

◆ scheduled_start_date_

int32 td::td_api::groupCall::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.

Definition at line 24617 of file td_api.h.

◆ title_

string td::td_api::groupCall::title_

Group call title; for video chats only.

Definition at line 24611 of file td_api.h.

◆ unique_id_

int64 td::td_api::groupCall::unique_id_

Persistent unique group call identifier.

Definition at line 24609 of file td_api.h.


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