MadelineProtoDocs/docs/API_docs/constructors/groupCall.md
2024-05-01 14:53:46 +02:00

3.1 KiB

title description nav_exclude image
groupCall Info about a group call or livestream true https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Constructor: groupCall

Back to constructors index

Info about a group call or livestream

Attributes:

Name Type Required Description
join_muted Bool Optional Whether the user should be muted upon joining the call
can_change_join_muted Bool Optional Whether the current user can change the value of the join_muted flag using phone.toggleGroupCallSettings
join_date_asc Bool Optional Specifies the ordering to use when locally sorting by date and displaying in the UI group call participants.
schedule_start_subscribed Bool Optional Whether we subscribed to the scheduled call
can_start_video Bool Optional Whether you can start streaming video into the call
record_video_active Bool Optional Whether the group call is currently being recorded
rtmp_stream Bool Optional Whether RTMP streams are allowed
listeners_hidden Bool Optional Whether the listeners list is hidden and cannot be fetched using phone.getGroupParticipants. The phone.groupParticipants.count and groupCall.participants_count counters will still include listeners.
id long Yes Group call ID
access_hash long Yes Group call access hash
participants_count int Yes Participant count
title string Optional Group call title
stream_dc_id int Optional DC ID to be used for livestream chunks
record_start_date int Optional When was the recording started
schedule_date int Optional When is the call scheduled to start
unmuted_video_count int Optional Number of people currently streaming video into the call
unmuted_video_limit int Yes Maximum number of people allowed to stream video into the call
version int Yes Version

Type: GroupCall

Example:

$groupCall = ['_' => 'groupCall', 'join_muted' => Bool, 'can_change_join_muted' => Bool, 'join_date_asc' => Bool, 'schedule_start_subscribed' => Bool, 'can_start_video' => Bool, 'record_video_active' => Bool, 'rtmp_stream' => Bool, 'listeners_hidden' => Bool, 'id' => long, 'access_hash' => long, 'participants_count' => int, 'title' => 'string', 'stream_dc_id' => int, 'record_start_date' => int, 'schedule_date' => int, 'unmuted_video_count' => int, 'unmuted_video_limit' => int, 'version' => int];