View Source Membrane.WebRTC.PhoenixSignaling (Membrane WebRTC plugin v0.25.3)
Provides signaling capabilities for WebRTC connections through Phoenix channels.
Summary
Types
A type representing an unique identifier that is used to distinguish between different Phoenix Signaling instances.
Functions
Returns an instance of a Phoenix Signaling associated with given signaling ID.
Registers Phoenix.Channel process as WebRTC signaling peer so that it can send and receive signaling messages.
Sends a signal message via the Phoenix Signaling instance associated with given signaling ID.
Types
@type signaling_id() :: String.t()
A type representing an unique identifier that is used to distinguish between different Phoenix Signaling instances.
Functions
@spec new(signaling_id()) :: Membrane.WebRTC.Signaling.t()
Returns an instance of a Phoenix Signaling associated with given signaling ID.
@spec register_channel(signaling_id(), pid() | nil) :: :ok
Registers Phoenix.Channel process as WebRTC signaling peer so that it can send and receive signaling messages.
@spec signal(signaling_id(), Membrane.WebRTC.Signaling.message_content()) :: :ok | no_return()
Sends a signal message via the Phoenix Signaling instance associated with given signaling ID.