View Source Jellyfish.Component (Jellyfish Server SDK v0.5.1)

Defines Jellyfish.Component.t/0.

Component is a server-side entity that can publish, subscribe to and process tracks. For more information refer to Jellyfish documentation.

Summary

Types

id()

Id of the component, unique within the room.

options()

Component-specific options.

t()

Stores information about the component.

type()

Type of the component.

Types

id()

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

Id of the component, unique within the room.

options()

@type options() ::
  Jellyfish.Component.HLS.t()
  | Jellyfish.Component.RTSP.t()
  | Jellyfish.Component.File.t()
  | Jellyfish.Component.SIP.t()
  | Jellyfish.Component.Recording.t()

Component-specific options.

t()

@type t() :: %Jellyfish.Component{
  id: id(),
  properties: map(),
  tracks: [Jellyfish.Track.t()],
  type: type()
}

Stores information about the component.

type()

@type type() ::
  Jellyfish.Component.HLS
  | Jellyfish.Component.RTSP
  | Jellyfish.Component.File
  | Jellyfish.Component.SIP
  | Jellyfish.Component.Recording

Type of the component.