Module responsible for interacting with a WebRTC peer.

New tracks are specified by SDP negotiation conducted by messages signal_message/0, and then linking corresponding :input and :output pads with ids reported via new_track_notification/0

The tracks can be manipulated by sending track_message/0.

To initiate or modify the connection, the bin sends and expects to receive signal_message/0.

bin-options

Bin options

Passed via struct Membrane.WebRTC.EndpointBin.t/0

• direction

  direction()

  Default value: :sendrecv
  Direction of EndpointBin. Determines whether EndpointBin can send, receive or both send and receive media. For more information refer to t:direction/0.

• handshake_opts

  Keyword.t()

  Default value: []
  Keyword list with options for handshake module. For more information please refer to ExDTLS.opts_t/0

• rtcp_receiver_report_interval

  Membrane.Time.t() | nil

  Default value: nil
  Receiver reports's generation interval, set to nil to avoid reports generation

• rtcp_sender_report_interval

  Membrane.Time.t() | nil

  Default value: nil
  Sender reports's generation interval, set to nil to avoid reports generation

• filter_codecs

  (Membrane.WebRTC.Track.Encoding.t() -> boolean())

  Default value: &Membrane.WebRTC.SDP.filter_encodings/1
  Defines function which will filter SDP m-line by codecs

• extensions

  [Extension.t()]

  Default value: []
  List of WebRTC extensions that should be enabled

• log_metadata

  :list

  Default value: []
  Logger metadata used for endpoint bin and all its descendants

• integrated_turn_options

  [ICE.Endpoint.integrated_turn_options_t()]

  Default value: []
  Integrated TURN Options

• simulcast?

  boolean()

  Default value: true
  Whether to accept simulcast tracks or not. If set to false, simulcast tracks will be disabled i.e. sender will not send them.

• trace_metadata

  :list

  Default value: []
  A list of tuples to merge into Otel spans

• trace_context

  :list | any()

  Default value: []
  Trace context for otel propagation

• parent_span

  :opentelemetry.span_ctx() | nil

  Default value: nil
  Parent span of endpoint_bin.life_span

• telemetry_label

  Membrane.TelemetryMetrics.label()

  Default value: []
  Label passed to Membrane.TelemetryMetrics functions

pads

Pads

input

:input

Accepted formats:

_any

Pad options:

• use_payloader?

  boolean()

  Default value: true
  Defines if incoming stream should be payloaded based on given encoding. Otherwise the stream is assumed be in RTP format.

output

:output

Accepted formats:

_any

Pad options:

• extensions

  [Membrane.RTP.SessionBin.extension_t()]

  Default value: []
  List of general extensions that will be applied to the SessionBin's output pad

• use_depayloader?

  boolean()

  Default value: true
  Defines if the outgoing stream should get depayloaded.

  This option should be used as a convenience, it is not necessary as the new track notification returns a depayloading filter's definition that can be attached to the output pad to work the same way as with the option set to true.