Class SIPOutboundConfig

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.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)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SIPOutboundConfig()

public SIPOutboundConfig()

SIPOutboundConfig(SIPOutboundConfig)

public SIPOutboundConfig(SIPOutboundConfig other)

Parameters

other SIPOutboundConfig

Fields

AttributesToHeadersFieldNumber

Field number for the "attributes_to_headers" field.

public const int AttributesToHeadersFieldNumber = 6

Field Value

int

AuthPasswordFieldNumber

Field number for the "auth_password" field.

public const int AuthPasswordFieldNumber = 4

Field Value

int

AuthUsernameFieldNumber

Field number for the "auth_username" field.

public const int AuthUsernameFieldNumber = 3

Field Value

int

DestinationCountryFieldNumber

Field number for the "destination_country" field.

public const int DestinationCountryFieldNumber = 7

Field Value

int

FromHostFieldNumber

Field number for the "from_host" field.

public const int FromHostFieldNumber = 8

Field Value

int

HeadersToAttributesFieldNumber

Field number for the "headers_to_attributes" field.

public const int HeadersToAttributesFieldNumber = 5

Field Value

int

HostnameFieldNumber

Field number for the "hostname" field.

public const int HostnameFieldNumber = 1

Field Value

int

TransportFieldNumber

Field number for the "transport" field.

public const int TransportFieldNumber = 2

Field Value

int

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

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

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

Parser

public static MessageParser<SIPOutboundConfig> Parser { get; }

Property Value

MessageParser<SIPOutboundConfig>

Transport

SIP Transport used for outbound call.

public SIPTransport Transport { get; set; }

Property Value

SIPTransport

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public SIPOutboundConfig Clone()

Returns

SIPOutboundConfig

A deep clone of this object.

Equals(SIPOutboundConfig)

public bool Equals(SIPOutboundConfig other)

Parameters

other SIPOutboundConfig

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(SIPOutboundConfig)

Merges the given message into this one.

public void MergeFrom(SIPOutboundConfig other)

Parameters

other SIPOutboundConfig

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.