API Reference Membrane RTC Engine v0.8.1
modules
Modules
RTC Engine implementation.
An Endpoint responsible for converting incoming tracks to HLS playlist.
Module representing transcoding configuration for the HLS endpoint.
An Endpoint responsible for communicatiing with WebRTC peer.
Behavior defining a set of functions for managing connection allocations for TrackReceivers.
Message sent by ConnectionProber to TrackReceiver whenever new allocation is granted
Implementation of Membrane.RTC.Engine.Endpoint.WebRTC.ConnectionAllocator
that grants all allocations immediately.
Module representing simulcast configuration for WebRTC endpoint.
Element responsible for handling WebRTC track.
Event for changing track variant that is currently being received.
Event sent whenever track variant was paused.
Event sent whenever track variant was resumed.
Event sent whenever Engine starts sending a new track variant.
Module describing messages RTC Engine can emit.
Message emitted when an endpoint crashes.
Message emitted when RTC Engine needs to send some Media Event to the Client Library.
Message emitted when a new peer from Client Library tries to join RTC Engine.
Message emitted when a peer left RTC Engine.
Defines list of metrics, that Reporter instance can aggregate by listening on events emitted in RTC Engine.
Suggested Reporter implementation is Membrane.TelemetryMetrics.Reporter
from membrane_telemetry_metrics
.
Membrane.TelemetryMetrics.Reporter
started with metrics returned by metrics/1
function will be able to generate reports, that matches type Membrane.RTC.Engine.Metrics.rtc_engine_report()
You can see usage example in (membrane_videoroom
)[github.com/membraneframework/membrane_videoroom].
Struct describing a track notification sent to the instance of Membrane.RTC.Engine
by Endpoints.
Module describing Peer.
Module representing media track.
Struct describing bitrate estimation.