danog\MadelineProto\EventHandler\Calls\RtmpStream: What is played, published to an RTMP server as an RTMP encoder would (OBS, ffmpeg...): to the RTMP

Back to index

Author: Daniil Gentili daniil@daniil.it

What is played, published to an RTMP server as an RTMP encoder would (OBS, ffmpeg…): to the RTMP

livestream or live story of any group, channel or user that gave us its URL and stream key, to YouTube, Twitch, or any other RTMP(S) server.

Only H.264 video and AAC audio can be published, in MP4 or Matroska (WebM) files, see {@see \danog\MadelineProto\GroupCall\Rtmp\RtmpPublisher}. Started by {@see \danog\MadelineProto\API::startRtmpStream()}, it keeps publishing (reconnecting if needed, and across restarts) until {@see self::close()}d. Only the {@see MediaDestination::Camera} stream exists.

Properties

• $id: int The ID of the stream in this session.
• $url: string The URL of the RTMP application, without the stream key, e.g. rtmps://dc4-1.rtmp.t.me/s/.

Method list:

• play(\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream $file, \danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static
• playBlocking(\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream $file, \danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static
• then(\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream $file, \danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static
• playOnHold(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera, \danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream ...$files): static
• skip(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static
• stop(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static
• pause(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static
• isPaused(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): bool
• resume(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static
• getCurrent(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): \danog\MadelineProto\RemoteUrl|\danog\MadelineProto\LocalFile|string|null
• isConnected(): bool
• close(): void

Methods:

play(\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream $file, \danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static

Parameters:

• $file: \danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream
• $dest: \danog\MadelineProto\MediaDestination

See also:

• \danog\MadelineProto\LocalFile: Indicates a local file to upload.
• \danog\MadelineProto\RemoteUrl: Indicates a remote URL to upload.
• \Amp\ByteStream\ReadableStream
• \danog\MadelineProto\MediaDestination: Which media stream of a call a playback or recording operation targets.

playBlocking(\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream $file, \danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static

Parameters:

• $file: \danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream
• $dest: \danog\MadelineProto\MediaDestination

See also:

• \danog\MadelineProto\LocalFile: Indicates a local file to upload.
• \danog\MadelineProto\RemoteUrl: Indicates a remote URL to upload.
• \Amp\ByteStream\ReadableStream
• \danog\MadelineProto\MediaDestination: Which media stream of a call a playback or recording operation targets.

then(\danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream $file, \danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static

Parameters:

• $file: \danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream
• $dest: \danog\MadelineProto\MediaDestination

See also:

• \danog\MadelineProto\LocalFile: Indicates a local file to upload.
• \danog\MadelineProto\RemoteUrl: Indicates a remote URL to upload.
• \Amp\ByteStream\ReadableStream
• \danog\MadelineProto\MediaDestination: Which media stream of a call a playback or recording operation targets.

playOnHold(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera, \danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream ...$files): static

Parameters:

• $dest: \danog\MadelineProto\MediaDestination
• ...$files: \danog\MadelineProto\LocalFile|\danog\MadelineProto\RemoteUrl|\Amp\ByteStream\ReadableStream

See also:

• \danog\MadelineProto\MediaDestination: Which media stream of a call a playback or recording operation targets.
• \danog\MadelineProto\LocalFile: Indicates a local file to upload.
• \danog\MadelineProto\RemoteUrl: Indicates a remote URL to upload.
• \Amp\ByteStream\ReadableStream

skip(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static

Parameters:

• $dest: \danog\MadelineProto\MediaDestination

See also:

• \danog\MadelineProto\MediaDestination: Which media stream of a call a playback or recording operation targets.

stop(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static

Parameters:

• $dest: \danog\MadelineProto\MediaDestination

See also:

• \danog\MadelineProto\MediaDestination: Which media stream of a call a playback or recording operation targets.

pause(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static

Parameters:

• $dest: \danog\MadelineProto\MediaDestination

See also:

• \danog\MadelineProto\MediaDestination: Which media stream of a call a playback or recording operation targets.

isPaused(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): bool

Parameters:

• $dest: \danog\MadelineProto\MediaDestination

See also:

• \danog\MadelineProto\MediaDestination: Which media stream of a call a playback or recording operation targets.

resume(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): static

Parameters:

• $dest: \danog\MadelineProto\MediaDestination

See also:

• \danog\MadelineProto\MediaDestination: Which media stream of a call a playback or recording operation targets.

getCurrent(\danog\MadelineProto\MediaDestination $dest = \danog\MadelineProto\MediaDestination::Camera): \danog\MadelineProto\RemoteUrl|\danog\MadelineProto\LocalFile|string|null

Parameters:

• $dest: \danog\MadelineProto\MediaDestination

See also:

• \danog\MadelineProto\MediaDestination: Which media stream of a call a playback or recording operation targets.
• \danog\MadelineProto\RemoteUrl: Indicates a remote URL to upload.
• \danog\MadelineProto\LocalFile: Indicates a local file to upload.

isConnected(): bool

Whether we are connected to the RTMP server right now (we connect again when something is played, if the server dropped us while nothing was).

close(): void

Stop publishing for good, and forget the stream.

Generated by danog/phpdoc