Link Search Menu Expand Document
⭐️ 1.8k 🌞 🌚

danog\MadelineProto\EventHandler\Calls\CallStreams

Back to index

Author: Daniil Gentili daniil@daniil.it

The streams a participant of a call sends (their microphone, camera and screen share, see

{@see CallStream}) or their codecs changed, or a recording of them started or ended.

Emitted for every call type: the other party of a one-to-one {@see PrivateCall}, and every participant of a {@see GroupCall}, {@see LiveStory} or {@see ConferenceCall}. In stream mode » the mixed stream is reported as participant 0.

Use {@see self::$streams} to decide what to record with {@see Call::setOutput()}: the file’s tracks are fixed when it is opened, so a stream that becomes available afterwards is not added to it — call {@see Call::setOutput()} again to start a new file with it.

Properties

  • $call: danog\MadelineProto\EventHandler\Call The call.
  • $participant: int Bot API id of the participant whose streams these are (0 for the mixed stream of a stream-mode group call).
  • $streams: int The streams the participant currently sends: a bitmask of {@see CallStream::AUDIO}, {@see CallStream::VIDEO} and {@see CallStream::SCREEN}.
  • $codecs: array<int, string> The codec of every stream media was received for so far, as a Matroska codec ID (A_OPUS, V_VP8, V_VP9, V_MPEG4/ISO/AVC, V_MPEGH/ISO/HEVC, V_AV1), keyed by stream: {@see CallStream::AUDIO}, {@see CallStream::VIDEO} or {@see CallStream::SCREEN}. A stream that is on but whose first frame has not arrived yet is not listed.
  • $recording: ?danog\MadelineProto\RecordingEvent Whether a recording of this participant started or ended, or null if the streams merely changed.
  • $file: ?danog\MadelineProto\LocalFile The file the recording that started or ended is written to, if it is a local file: the one passed to {@see Call::setOutput()}, or the file {@see Call::setOutputFolder()} opened for the participant. Null for a recording into a stream, or if no recording event is reported.

Method list:

Methods:

has(int $stream): bool

Whether the participant currently sends a given stream ({@see CallStream::AUDIO}, {@see CallStream::VIDEO} or {@see CallStream::SCREEN}).

Parameters:

  • $stream: int

Generated by danog/phpdoc