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

View Source

An Endpoint responsible for communicatiing with WebRTC client.

Bin options

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

  • rtc_engine 

    pid()

    Required
    Pid of parent Engine

  • video_codec 

    video_codec

    Default value: :H264
    Allowed video codec

  • metadata 

    any()

    Default value: nil
    Endpoint metadata

  • telemetry_label 

    Membrane.TelemetryMetrics.label()

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

  • event_serialization 

    :json | :protobuf

    Required
    Serialization method for encoding and decoding Media Events

Pads

:input

Accepted formats:

_any
Direction::input
Availability::on_request

:output

Accepted formats:

_any
Direction::output
Availability::on_request

Summary

Types

rid()

"l" | "m" | "h"

t()

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

track_variant()
video_codec()

Functions

options()

Returns description of options available for this module

to_rid(atom)
to_track_variant(rid)

Types

rid()

@type rid() :: String.t()

"l" | "m" | "h"

t()

@type t() :: %Membrane.RTC.Engine.Endpoint.ExWebRTC{
  event_serialization: :json | :protobuf,
  metadata: any(),
  rtc_engine: pid(),
  telemetry_label: Membrane.TelemetryMetrics.label(),
  video_codec: video_codec()
}

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

track_variant()

@type track_variant() :: :low | :medium | :high

video_codec()

@type video_codec() :: :H264 | :VP8 | nil

Functions

options()

@spec options() :: keyword()

Returns description of options available for this module

to_rid(atom)

@spec to_rid(track_variant()) :: rid()

to_track_variant(rid)

@spec to_track_variant(rid() | nil) :: track_variant()