View Source Membrane.RTC.Engine.Endpoint.WebRTC.SimulcastConfig (Membrane RTC Engine WebRTC Endpoint v0.8.0)

Module representing simulcast configuration for WebRTC endpoint.

Summary

Types

t()

Simulcast configuration.

Functions

Default implementation of initial_target_variant function in t/0.

Types

@type t() :: %Membrane.RTC.Engine.Endpoint.WebRTC.SimulcastConfig{
  enabled: boolean(),
  initial_target_variant:
    (Membrane.RTC.Engine.Track.t() -> Membrane.RTC.Engine.Track.variant())
}

Simulcast configuration.

  • enabled - whether to accept simulcast tracks or not. Setting this to false will result in rejecting all incoming simulcast tracks i.e. client will not send them.
  • initial_target_variant - function used to determine initial target variant this endpoint is willing to receive for given track. It is called for each track this endpoint subscribes for. If not provided, the highest possible variant will be used.

Functions

Link to this function

initial_target_variant(track)

View Source
@spec initial_target_variant(Membrane.RTC.Engine.Track.t()) :: :high

Default implementation of initial_target_variant function in t/0.

Returns :high, which will result in choosing the highest possible encoding.