Membrane.RTC.Engine.Endpoint.SIP.RegistrarCredentials (Membrane RTC Engine SIP Endpoint v0.6.0)

View Source

Module describing credentials needed to connect with SIP registrar server

Summary

Types

t()

Describes SIP registrar credentials structure.

Functions

new(opts)

Creates a RegistrarCredentials struct from strings.

Types

t()

@type t() :: %Membrane.RTC.Engine.Endpoint.SIP.RegistrarCredentials{
  password: String.t(),
  uri: Sippet.URI.t(),
  username: String.t()
}

Describes SIP registrar credentials structure.

  • uri - URI with address of the registrar server.
  • username - your username in the registrar service
  • password - your password in the registrar service

Functions

new(opts)

@spec new(address: String.t(), username: String.t(), password: String.t()) ::
  t() | no_return()

Creates a RegistrarCredentials struct from strings.

The address is parsed and can be:

  • an FQDN, e.g. "my-sip-registrar.net",
  • an IPv4 in string form, e.g. "1.2.3.4".

Both can have a specified port, e.g. "5.6.7.8:9999". If not given, the default SIP port 5060 will be assumed.