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

Inherits Object.

Description

Represents a group call participant.

Public Fields

object_ptr< MessageSenderparticipant_id_
 Identifier of the group call participant.
 
int32 audio_source_id_
 User's audio channel synchronization source identifier.
 
int32 screen_sharing_audio_source_id_
 User's screen sharing audio channel synchronization source identifier.
 
object_ptr< groupCallParticipantVideoInfovideo_info_
 Information about user's video channel; may be null if there is no active video.
 
object_ptr< groupCallParticipantVideoInfoscreen_sharing_video_info_
 Information about user's screen sharing video channel; may be null if there is no active screen sharing video.
 
string bio_
 The participant user's bio or the participant chat's description.
 
bool is_current_user_
 True, if the participant is the current user.
 
bool is_speaking_
 True, if the participant is speaking as set by setGroupCallParticipantIsSpeaking.
 
bool is_hand_raised_
 True, if the participant hand is raised.
 
bool can_be_muted_for_all_users_
 True, if the current user can mute the participant for all other group call participants.
 
bool can_be_unmuted_for_all_users_
 True, if the current user can allow the participant to unmute themselves or unmute the participant (if the participant is the current user).
 
bool can_be_muted_for_current_user_
 True, if the current user can mute the participant only for self.
 
bool can_be_unmuted_for_current_user_
 True, if the current user can unmute the participant for self.
 
bool is_muted_for_all_users_
 True, if the participant is muted for all users.
 
bool is_muted_for_current_user_
 True, if the participant is muted for the current user.
 
bool can_unmute_self_
 True, if the participant is muted for all users, but can unmute themselves.
 
int32 volume_level_
 Participant's volume level; 1-20000 in hundreds of percents.
 
string order_
 User's order in the group call participant list. Orders must be compared lexicographically. The bigger is order, the higher is user in the list. If order is empty, the user must be removed from the participant list.
 

Public Instance Methods

 groupCallParticipant ()
 
 groupCallParticipant (object_ptr< MessageSender > &&participant_id_, int32 audio_source_id_, int32 screen_sharing_audio_source_id_, object_ptr< groupCallParticipantVideoInfo > &&video_info_, object_ptr< groupCallParticipantVideoInfo > &&screen_sharing_video_info_, string const &bio_, bool is_current_user_, bool is_speaking_, bool is_hand_raised_, bool can_be_muted_for_all_users_, bool can_be_unmuted_for_all_users_, bool can_be_muted_for_current_user_, bool can_be_unmuted_for_current_user_, bool is_muted_for_all_users_, bool is_muted_for_current_user_, bool can_unmute_self_, int32 volume_level_, string const &order_)
 
std::int32_t get_id () const final
 
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 = 2059182571
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ groupCallParticipant() [1/2]

Represents a group call participant.

◆ groupCallParticipant() [2/2]

groupCallParticipant ( object_ptr< MessageSender > &&  participant_id_,
int32  audio_source_id_,
int32  screen_sharing_audio_source_id_,
object_ptr< groupCallParticipantVideoInfo > &&  video_info_,
object_ptr< groupCallParticipantVideoInfo > &&  screen_sharing_video_info_,
string const &  bio_,
bool  is_current_user_,
bool  is_speaking_,
bool  is_hand_raised_,
bool  can_be_muted_for_all_users_,
bool  can_be_unmuted_for_all_users_,
bool  can_be_muted_for_current_user_,
bool  can_be_unmuted_for_current_user_,
bool  is_muted_for_all_users_,
bool  is_muted_for_current_user_,
bool  can_unmute_self_,
int32  volume_level_,
string const &  order_ 
)

Represents a group call participant.

Parameters
[in]participant_id_Identifier of the group call participant.
[in]audio_source_id_User's audio channel synchronization source identifier.
[in]screen_sharing_audio_source_id_User's screen sharing audio channel synchronization source identifier.
[in]video_info_Information about user's video channel; may be null if there is no active video.
[in]screen_sharing_video_info_Information about user's screen sharing video channel; may be null if there is no active screen sharing video.
[in]bio_The participant user's bio or the participant chat's description.
[in]is_current_user_True, if the participant is the current user.
[in]is_speaking_True, if the participant is speaking as set by setGroupCallParticipantIsSpeaking.
[in]is_hand_raised_True, if the participant hand is raised.
[in]can_be_muted_for_all_users_True, if the current user can mute the participant for all other group call participants.
[in]can_be_unmuted_for_all_users_True, if the current user can allow the participant to unmute themselves or unmute the participant (if the participant is the current user).
[in]can_be_muted_for_current_user_True, if the current user can mute the participant only for self.
[in]can_be_unmuted_for_current_user_True, if the current user can unmute the participant for self.
[in]is_muted_for_all_users_True, if the participant is muted for all users.
[in]is_muted_for_current_user_True, if the participant is muted for the current user.
[in]can_unmute_self_True, if the participant is muted for all users, but can unmute themselves.
[in]volume_level_Participant's volume level; 1-20000 in hundreds of percents.
[in]order_User's order in the group call participant list. Orders must be compared lexicographically. The bigger is order, the higher is user in the list. If order is empty, the user must be removed from the participant list.

Method Documentation

◆ get_id()

std::int32_t get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements TlObject.

◆ 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: