View Source Membrane.WebRTC.PhoenixSignaling (Membrane WebRTC plugin v0.25.0)

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

signaling_id()

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

A type representing an unique identifier that is used to distinguish between different Phoenix Signaling instances.

Functions

new(signaling_id)

Returns an instance of a Phoenix Signaling associated with given signaling ID.

register_channel(signaling_id, channel_pid \\ nil)

@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.

signal(signaling_id, msg)

Sends a signal message via the Phoenix Signaling instance associated with given signaling ID.