View Source Mediasoup.Router (mediasoup_elixir v0.14.4)

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

Summary

Types

create_option()

event_type()

media_codec()

rtpCapabilities()

t()

Functions

can_consume?(router, producer_id, rtp_capabilities)

Whether the given RTP capabilities are valid to consume the given producer. https://mediasoup.org/documentation/v3/mediasoup/api/#router-canConsume

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

close(router)

Closes the router.

closed?(router)

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

create_pipe_transport(router, option)

Creates a new pipe transport. https://mediasoup.org/documentation/v3/mediasoup/api/#router-createPipeTransport

create_plain_transport(router, option)

Creates a new webrtc transport. https://mediasoup.org/documentation/v3/mediasoup/api/#router-createPlainTransport

create_webrtc_transport(router, option)

Creates a new webrtc transport. https://mediasoup.org/documentation/v3/mediasoup/api/#router-createWebRtcTransport

dump(router)

Dump internal stat for Router.

event(router, listener, event_types \\ [:on_close, :on_dead])

Starts observing event.

id(router)

Router identifier.

pipe_data_producer_to_router(router, data_producer_id, option)

Pipes the given data producer into another router. https://mediasoup.org/documentation/v3/mediasoup/api/#router-pipeToRouter

pipe_producer_to_router(router, producer_id, option)

Pipes the given media producer into another router. https://mediasoup.org/documentation/v3/mediasoup/api/#router-pipeToRouter

rtp_capabilities(router)

An Object with the RTP capabilities of the router. https://mediasoup.org/documentation/v3/mediasoup/api/#router-rtpCapabilities

start_link(opt)

struct_from_pid(pid)

struct_from_pid_and_ref(pid, reference)

Types

create_option()

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

event_type()

@type event_type() :: :on_close | :on_dead

media_codec()

@type media_codec() :: %{
  :kind => :audio | :video | String.t(),
  :mimeType => String.t(),
  :clockRate => integer(),
  :channels => integer(),
  :parameters => map(),
  :rtcpFeedback => [map()],
  optional(:payloadType) => integer(),
  optional(:preferredPayloadType) => integer()
}

rtpCapabilities()

@type rtpCapabilities() :: any()

t()

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

Functions

can_consume?(router, producer_id, rtp_capabilities)

@spec can_consume?(t(), String.t(), rtpCapabilities()) :: boolean()

Whether the given RTP capabilities are valid to consume the given producer. https://mediasoup.org/documentation/v3/mediasoup/api/#router-canConsume

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

close(router)

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

Closes the router.

closed?(router)

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

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

create_pipe_transport(router, option)

@spec create_pipe_transport(
  t(),
  Mediasoup.PipeTransport.Options.t()
) :: {:ok, Mediasoup.PipeTransport.t()} | {:error, String.t()}

Creates a new pipe transport. https://mediasoup.org/documentation/v3/mediasoup/api/#router-createPipeTransport

create_plain_transport(router, option)

@spec create_plain_transport(t(), Mediasoup.PlainTransport.create_option()) ::
  {:ok, Mediasoup.PlainTransport.t()} | {:error, String.t()}

Creates a new webrtc transport. https://mediasoup.org/documentation/v3/mediasoup/api/#router-createPlainTransport

create_webrtc_transport(router, option)

@spec create_webrtc_transport(t(), Mediasoup.WebRtcTransport.create_option()) ::
  {:ok, Mediasoup.WebRtcTransport.t()} | {:error, String.t()}

Creates a new webrtc transport. https://mediasoup.org/documentation/v3/mediasoup/api/#router-createWebRtcTransport

dump(router)

@spec dump(t()) :: map() | {:error}

Dump internal stat for Router.

event(router, listener, event_types \\ [:on_close, :on_dead])

@spec event(t(), pid(), event_types :: [event_type()]) ::
  {:ok} | {:error, :terminated}

Starts observing event.

id(router)

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

Router identifier.

pipe_data_producer_to_router(router, data_producer_id, option)

@spec pipe_data_producer_to_router(
  t(),
  data_producer_id :: String.t(),
  Mediasoup.Router.PipeToRouterOptions.t()
) :: {:ok, Mediasoup.Router.PipeToRouterResult.t()} | {:error, String.t()}

Pipes the given data producer into another router. https://mediasoup.org/documentation/v3/mediasoup/api/#router-pipeToRouter

pipe_producer_to_router(router, producer_id, option)

@spec pipe_producer_to_router(
  t(),
  producer_id :: String.t(),
  Mediasoup.Router.PipeToRouterOptions.t()
) ::
  {:ok, Mediasoup.Router.PipeToRouterResult.t()} | {:error, String.t()}

Pipes the given media producer into another router. https://mediasoup.org/documentation/v3/mediasoup/api/#router-pipeToRouter

rtp_capabilities(router)

@spec rtp_capabilities(t()) :: rtpCapabilities()

An Object with the RTP capabilities of the router. https://mediasoup.org/documentation/v3/mediasoup/api/#router-rtpCapabilities

start_link(opt)

struct_from_pid(pid)

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

struct_from_pid_and_ref(pid, reference)