Class: TD::Types::GroupCall

Inherits:
Base
  • Object
show all
Defined in:
lib/tdlib/types/group_call.rb

Overview

Describes a group call.

Instance Attribute Summary collapse

Method Summary

Methods inherited from Base

#to_hash, #to_json

Instance Attribute Details

#can_be_managed ⇒ Boolean

True, if the current user can manage the group call.

Returns:

  • (Boolean) —

    the current value of can_be_managed



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def can_be_managed
  @can_be_managed
end

#can_enable_video ⇒ Boolean

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

Returns:

  • (Boolean) —

    the current value of can_enable_video



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def can_enable_video
  @can_enable_video
end

#can_toggle_mute_new_participants ⇒ Boolean

True, if the current user can enable or disable mute_new_participants setting.

Returns:

  • (Boolean) —

    the current value of can_toggle_mute_new_participants



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def can_toggle_mute_new_participants
  @can_toggle_mute_new_participants
end

#duration ⇒ Integer

Call duration, in seconds; for ended calls only.

Returns:

  • (Integer) —

    the current value of duration



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def duration
  @duration
end

#enabled_start_notification ⇒ Boolean

True, if the group call is scheduled and the current user will receive a notification when the group call starts.

Returns:

  • (Boolean) —

    the current value of enabled_start_notification



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def enabled_start_notification
  @enabled_start_notification
end

#has_hidden_listeners ⇒ Boolean

True, if group call participants, which are muted, aren’t returned in participant list.

Returns:

  • (Boolean) —

    the current value of has_hidden_listeners



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def has_hidden_listeners
  @has_hidden_listeners
end

#id ⇒ Integer

Group call identifier.

Returns:

  • (Integer) —

    the current value of id



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def id
  @id
end

#is_active ⇒ Boolean

True, if the call is active.

Returns:

  • (Boolean) —

    the current value of is_active



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def is_active
  @is_active
end

#is_joined ⇒ Boolean

True, if the call is joined.

Returns:

  • (Boolean) —

    the current value of is_joined



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def is_joined
  @is_joined
end

#is_my_video_enabled ⇒ Boolean

True, if the current user’s video is enabled.

Returns:

  • (Boolean) —

    the current value of is_my_video_enabled



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def is_my_video_enabled
  @is_my_video_enabled
end

#is_my_video_paused ⇒ Boolean

True, if the current user’s video is paused.

Returns:

  • (Boolean) —

    the current value of is_my_video_paused



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def is_my_video_paused
  @is_my_video_paused
end

#is_rtmp_stream ⇒ Boolean

True, if the chat is an RTMP stream instead of an ordinary video chat.

Returns:

  • (Boolean) —

    the current value of is_rtmp_stream



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def is_rtmp_stream
  @is_rtmp_stream
end

#is_video_recorded ⇒ Boolean

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

Returns:

  • (Boolean) —

    the current value of is_video_recorded



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def is_video_recorded
  @is_video_recorded
end

#loaded_all_participants ⇒ Boolean

True, if all group call participants are loaded.

Returns:

  • (Boolean) —

    the current value of loaded_all_participants



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def loaded_all_participants
  @loaded_all_participants
end

#mute_new_participants ⇒ Boolean

True, if only group call administrators can unmute new participants.

Returns:

  • (Boolean) —

    the current value of mute_new_participants



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def mute_new_participants
  @mute_new_participants
end

#need_rejoin ⇒ Boolean

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

Returns:

  • (Boolean) —

    the current value of need_rejoin



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def need_rejoin
  @need_rejoin
end

#participant_count ⇒ Integer

Number of participants in the group call.

Returns:

  • (Integer) —

    the current value of participant_count



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def participant_count
  @participant_count
end

#recent_speakers ⇒ Array<TD::Types::GroupCallRecentSpeaker>

At most 3 recently speaking users in the group call.

Returns:



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def recent_speakers
  @recent_speakers
end

#record_duration ⇒ Integer

Duration of the ongoing group call recording, in seconds; 0 if none. An Update::GroupCall update is not triggered when value of this field changes, but the same recording goes on.

Returns:

  • (Integer) —

    the current value of record_duration



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def record_duration
  @record_duration
end

#scheduled_start_date ⇒ Integer

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.

Returns:

  • (Integer) —

    the current value of scheduled_start_date



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def scheduled_start_date
  @scheduled_start_date
end

#title ⇒ TD::Types::String

Group call title.

Returns:

  • (TD::Types::String) —

    the current value of title



33
34
35
 
# File 'lib/tdlib/types/group_call.rb', line 33

def title
  @title
end