Membrane.RTC.Engine.Endpoint.Forwarder (Membrane RTC Engine Forwarder Endpoint v0.1.0)

View Source

An Endpoint responsible for forwarding single stream to an external broadcaster using WHIP standard.

Bin options

Passed via struct Membrane.RTC.Engine.Endpoint.Forwarder.t/0

  • rtc_engine

    pid()

    Required
    Pid of parent Engine

  • telemetry_label

    Membrane.TelemetryMetrics.label()

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

  • broadcaster_url

    String.t()

    Required
    Address under which broadcaster is spawned

  • broadcaster_token

    String.t()

    Required
    Token allowing for streaming into broadcaster

  • stream_id

    String.t()

    Required
    Id of forwarded stream

Pads

:input

Accepted formats:

_any
Direction::input
Availability::on_request

Summary

Types

t()

Struct containing options for Membrane.RTC.Engine.Endpoint.Forwarder

Functions

Returns description of options available for this module

Types

t()

@type t() :: %Membrane.RTC.Engine.Endpoint.Forwarder{
  broadcaster_token: String.t(),
  broadcaster_url: String.t(),
  rtc_engine: pid(),
  stream_id: String.t(),
  telemetry_label: Membrane.TelemetryMetrics.label()
}

Struct containing options for Membrane.RTC.Engine.Endpoint.Forwarder

Functions

options()

@spec options() :: keyword()

Returns description of options available for this module