Membrane WebRTC plugin

View Source Membrane.WebRTC.Track (Membrane WebRTC plugin v0.15.0)

Module representing a WebRTC track.

Link to this section Summary

Types

encoding_key()
id()
rid()
status()
t()

Functions

from_sdp_media(sdp_media)

Creates t/0 from SDP m-line with random track id and stream id.

from_sdp_media(sdp_media, id, stream_id)

Creates t/0 from SDP m-line with specific track id and stream id.

new(type, stream_id, opts \\ [])

Creates a new track.

set_constraints(track, track_type, constraints)

Modifies track properties according to provided constraints.

simulcast?(track)

Determines if the track is using simulcast

stream_id()

Generates stream id, that can be used to mark tracks belonging to the same stream.

to_otel_data(track)

Link to this section Types

Link to this type

encoding_key()

View Source 
@type encoding_key() :: :OPUS | :H264 | :VP8
Link to this type

id()

View Source 
@type id() :: String.t()
Link to this type

rid()

View Source 
@type rid() :: String.t()
Link to this type

status()

View Source 
@type status() :: :pending | :ready | :linked | :disabled
Link to this type

t()

View Source 
@type t() :: %Membrane.WebRTC.Track{
  extmaps: [ExSDP.Attribute.Extmap],
  id: id(),
  mid: binary(),
  name: String.t(),
  offered_encodings: [Membrane.WebRTC.Track.Encoding.t()],
  rid_to_ssrc: %{},
  rids: [rid()] | nil,
  rtx_ssrc: Membrane.RTP.ssrc_t() | [Membrane.RTP.ssrc_t()] | nil,
  selected_encoding: term(),
  selected_encoding_key: encoding_key(),
  ssrc: Membrane.RTP.ssrc_t() | [Membrane.RTP.ssrc_t()],
  status: status(),
  stream_id: String.t(),
  type: :audio | :video
}

Link to this section Functions

Link to this function

from_sdp_media(sdp_media)

View Source 
@spec from_sdp_media(ExSDP.Media.t()) :: t()

Creates t/0 from SDP m-line with random track id and stream id.

Link to this function

from_sdp_media(sdp_media, id, stream_id)

View Source 
@spec from_sdp_media(ExSDP.Media.t(), id(), String.t()) :: t()

Creates t/0 from SDP m-line with specific track id and stream id.

Link to this function

new(type, stream_id, opts \\ [])

View Source 
@spec new(:audio | :video, stream_id :: String.t(),
  id: String.t(),
  name: String.t(),
  ssrc: Membrane.RTP.ssrc_t() | [Membrane.RTP.ssrc_t()] | nil,
  rtx_ssrc: Membrane.RTP.ssrc_t() | nil,
  selected_encoding_key: encoding_key(),
  offered_encodings: [Membrane.WebRTC.Track.Encoding.t()],
  mid: non_neg_integer(),
  rids: [String.t()] | nil,
  status: status(),
  extmaps: [ExSDP.Attribute.Extmap]
) :: t()

Creates a new track.

Tracks belonging to the same stream should have the same stream_id, that can be generated with stream_id/0.

Link to this function

set_constraints(track, track_type, constraints)

View Source 
@spec set_constraints(t(), :inbound | :outbound, map()) :: t()

Modifies track properties according to provided constraints.

In particular, after setting constraints, track can be disabled.

Link to this function

simulcast?(track)

View Source 
@spec simulcast?(t()) :: boolean()

Determines if the track is using simulcast

Link to this function

stream_id()

View Source 
@spec stream_id() :: String.t()

Generates stream id, that can be used to mark tracks belonging to the same stream.

Link to this function

to_otel_data(track)

View Source 
@spec to_otel_data(t()) :: String.t()