Membrane WebRTC plugin v0.1.0-alpha

Membrane.WebRTC.Endpoint (Membrane WebRTC plugin v0.1.0-alpha) View Source

Module representing a WebRTC connection.

Link to this section Summary

Types

id()
t()
type()

Functions

get_audio_tracks(endpoint)
get_context(endpoint)
get_track_by_id(endpoint, id)
get_tracks(endpoint)
get_video_tracks(endpoint)
new(id, type, inbound_tracks, ctx)
put_context(endpoint, ctx)
update_track_encoding(endpoint, track_id, value)

Link to this section Types

Link to this type

id()

View Source

Specs

id() :: any()
Link to this type

t()

View Source

Specs

t() :: %Membrane.WebRTC.Endpoint{
  ctx: any(),
  id: id(),
  inbound_tracks: %{
    required(Membrane.WebRTC.Track.id()) => Membrane.WebRTC.Track.t()
  },
  type: :participant | :screensharing
}
Link to this type

type()

View Source

Specs

type() :: :screensharing | :participant

Link to this section Functions

Link to this function

get_audio_tracks(endpoint)

View Source

Specs

get_audio_tracks(endpoint :: t()) :: [Membrane.WebRTC.Track.t()]
Link to this function

get_context(endpoint)

View Source

Specs

get_context(endpoint :: t()) :: any()
Link to this function

get_track_by_id(endpoint, id)

View Source

Specs

get_track_by_id(endpoint :: t(), id :: Membrane.WebRTC.Track.id()) ::
  Membrane.WebRTC.Track.t() | nil
Link to this function

get_tracks(endpoint)

View Source

Specs

get_tracks(endpoint :: t()) :: [Membrane.WebRTC.Track.t()]
Link to this function

get_video_tracks(endpoint)

View Source

Specs

get_video_tracks(endpoint :: t()) :: [Membrane.WebRTC.Track.t()]
Link to this function

new(id, type, inbound_tracks, ctx)

View Source

Specs

new(
  id :: id(),
  type :: type(),
  inbound_tracks :: [Membrane.WebRTC.Track.t()],
  ctx :: any()
) :: Endpoint.t()
Link to this function

put_context(endpoint, ctx)

View Source

Specs

put_context(endpoint :: t(), ctx :: any()) :: Endpoint.t()
Link to this function

update_track_encoding(endpoint, track_id, value)

View Source

Specs

update_track_encoding(
  endpoint :: Endpoint.t(),
  track_id :: Membrane.WebRTC.Track.id(),
  encoding :: atom()
) :: Endpoint.t()