Summary

Types

event_type()

@type event_type() :: :on_close

sctpStreamParameters()

@type sctpStreamParameters() :: map()

https://mediasoup.org/documentation/v3/mediasoup/sctp-parameters/#SctpStreamParameters

t()

@type t() :: %Mediasoup.DataConsumer{
  data_producer_id: String.t(),
  id: String.t(),
  label: String.t(),
  pid: pid(),
  protocol: String.t(),
  sctp_stream_parameters: sctpStreamParameters(),
  type: type()
}

type()

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

https://mediasoup.org/documentation/v3/mediasoup/api/#DataConsumerType "sctp" or "direct"

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

close(data_consumer)

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

closed?(data_consumer)

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

data_producer_id(map)

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

event(data_consumer, listener, event_types \\ [:on_close])

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

id(map)

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

label(map)

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

protocol(map)

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

sctp_stream_parameters(map)

@spec sctp_stream_parameters(t()) :: sctpStreamParameters()

start_link(opt)

struct_from_pid(pid)

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

struct_from_pid_and_ref(pid, reference)

type(map)

@spec type(t()) :: type()