View Source Mediasoup.WebRtcServer (mediasoup_elixir v0.14.4)

https://mediasoup.org/documentation/v3/mediasoup/api/#WebRtcServer

Summary

Types

create_option()

t()

webrtc_server_listen_info()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

close(web_rtc_server)

Closes the WebRtcServer.

closed?(web_rtc_server)

Tells whether the given WebRtcServer is closed on the local node.

dump(web_rtc_server)

Dump internal stat for WebRtcServer.

id(web_rtc_server)

WebRtcTransport identifier.

start_link(opt)

struct_from_pid(pid)

struct_from_pid_and_ref(pid, reference)

to_ref(web_rtc_server)

Types

create_option()

@type create_option() :: map() | Mediasoup.WebRtcServer.Options.t()

t()

@type t() :: %Mediasoup.WebRtcServer{id: String.t(), pid: pid()}

webrtc_server_listen_info()

@type webrtc_server_listen_info() :: %{
  :protocol => :udp | :tcp,
  :ip => String.t(),
  optional(:announcedAddress) => String.t() | nil,
  port: integer() | nil
}

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

close(web_rtc_server)

@spec close(t()) :: :ok

Closes the WebRtcServer.

closed?(web_rtc_server)

@spec closed?(t()) :: boolean()

Tells whether the given WebRtcServer is closed on the local node.

dump(web_rtc_server)

@spec dump(t()) :: any() | {:error, :terminated}

Dump internal stat for WebRtcServer.

id(web_rtc_server)

WebRtcTransport identifier.

start_link(opt)

struct_from_pid(pid)

@spec struct_from_pid(pid()) :: t()

struct_from_pid_and_ref(pid, reference)

to_ref(web_rtc_server)