Class SIPOutboundConfig

Namespace

Livekit.Server.Sdk.Dotnet

Assembly

LivekitApi.dll

public sealed class SIPOutboundConfig : IMessage<SIPOutboundConfig>, IEquatable<SIPOutboundConfig>, IDeepCloneable<SIPOutboundConfig>, IBufferMessage, IMessage

Inheritance

object

SIPOutboundConfig

Implements

IMessage<SIPOutboundConfig>

IEquatable<SIPOutboundConfig>

IDeepCloneable<SIPOutboundConfig>

IBufferMessage

IMessage

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SIPOutboundConfig()

public SIPOutboundConfig()

SIPOutboundConfig(SIPOutboundConfig)

public SIPOutboundConfig(SIPOutboundConfig other)

Parameters

other SIPOutboundConfig

Properties

AttributesToHeaders

Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests. Keys are the names of attributes and values are the names of X-* headers they will be mapped to.

public MapField<string, string> AttributesToHeaders { get; }

Property Value

MapField<string, string>

AuthPassword

public string AuthPassword { get; set; }

Property Value

string

AuthUsername

Username and password used to authenticate with SIP server. May be empty to have no authentication.

public string AuthUsername { get; set; }

Property Value

string

DestinationCountry

country where the call terminates as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will be used by the livekit infrastructure to route calls.

public string DestinationCountry { get; set; }

Property Value

string

FromHost

Optional custom hostname for the 'From' SIP header. When set, outbound calls use this host instead of the default project SIP domain.

public string FromHost { get; set; }

Property Value

string

HeadersToAttributes

Map SIP X-* headers from 200 OK to SIP participant attributes. Keys are the names of X-* headers and values are the names of attributes they will be mapped to.

public MapField<string, string> HeadersToAttributes { get; }

Property Value

MapField<string, string>

Hostname

SIP server address

public string Hostname { get; set; }

Property Value

string

Transport

SIP Transport used for outbound call.

public SIPTransport Transport { get; set; }

Property Value

SIPTransport