View Source Jellyfish.Peer (Jellyfish Server SDK v0.4.0)

Defines Jellyfish.Peer.t/0.

Peer is an entity that connects to the server to publish, subscribe to or publish and subscribe to tracks published by components and other peers. For more information refer to Jellyfish documentation.

Summary

Types

Id of the peer, unique across within the room.

Peer-specific options.

Status of the peer.

t()

Stores information about the peer.

Type of the peer.

Types

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

Id of the peer, unique across within the room.

@type options() :: Jellyfish.Peer.WebRTC.t()

Peer-specific options.

@type status() :: :disconnected | :connected

Status of the peer.

@type t() :: %Jellyfish.Peer{
  id: id(),
  metadata: any(),
  status: status(),
  tracks: [Jellyfish.Track.t()],
  type: type()
}

Stores information about the peer.

@type type() :: Jellyfish.Peer.WebRTC

Type of the peer.

Functions

Link to this function

status_from_string(status)

View Source