Class SIPOutboundTrunkInfo

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

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

Inheritance

object

SIPOutboundTrunkInfo

Implements

IMessage<SIPOutboundTrunkInfo>

IEquatable<SIPOutboundTrunkInfo>

IDeepCloneable<SIPOutboundTrunkInfo>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SIPOutboundTrunkInfo()

public SIPOutboundTrunkInfo()

SIPOutboundTrunkInfo(SIPOutboundTrunkInfo)

public SIPOutboundTrunkInfo(SIPOutboundTrunkInfo other)

Parameters

other SIPOutboundTrunkInfo

Fields

AddressFieldNumber

Field number for the "address" field.

public const int AddressFieldNumber = 4

Field Value

int

AttributesToHeadersFieldNumber

Field number for the "attributes_to_headers" field.

public const int AttributesToHeadersFieldNumber = 11

Field Value

int

AuthPasswordFieldNumber

Field number for the "auth_password" field.

public const int AuthPasswordFieldNumber = 8

Field Value

int

AuthUsernameFieldNumber

Field number for the "auth_username" field.

public const int AuthUsernameFieldNumber = 7

Field Value

int

CreatedAtFieldNumber

Field number for the "created_at" field.

public const int CreatedAtFieldNumber = 16

Field Value

int

DestinationCountryFieldNumber

Field number for the "destination_country" field.

public const int DestinationCountryFieldNumber = 14

Field Value

int

FromHostFieldNumber

Field number for the "from_host" field.

public const int FromHostFieldNumber = 15

Field Value

int

HeadersFieldNumber

Field number for the "headers" field.

public const int HeadersFieldNumber = 9

Field Value

int

HeadersToAttributesFieldNumber

Field number for the "headers_to_attributes" field.

public const int HeadersToAttributesFieldNumber = 10

Field Value

int

IncludeHeadersFieldNumber

Field number for the "include_headers" field.

public const int IncludeHeadersFieldNumber = 12

Field Value

int

MediaEncryptionFieldNumber

Field number for the "media_encryption" field.

public const int MediaEncryptionFieldNumber = 13

Field Value

int

MetadataFieldNumber

Field number for the "metadata" field.

public const int MetadataFieldNumber = 3

Field Value

int

NameFieldNumber

Field number for the "name" field.

public const int NameFieldNumber = 2

Field Value

int

NumbersFieldNumber

Field number for the "numbers" field.

public const int NumbersFieldNumber = 6

Field Value

int

SipTrunkIdFieldNumber

Field number for the "sip_trunk_id" field.

public const int SipTrunkIdFieldNumber = 1

Field Value

int

TransportFieldNumber

Field number for the "transport" field.

public const int TransportFieldNumber = 5

Field Value

int

UpdatedAtFieldNumber

Field number for the "updated_at" field.

public const int UpdatedAtFieldNumber = 17

Field Value

int

Properties

Address

Hostname or IP that SIP INVITE is sent too. Note that this is not a SIP URI and should not contain the 'sip:' protocol prefix.

public string Address { get; set; }

Property Value

string

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

CreatedAt

public Timestamp CreatedAt { get; set; }

Property Value

Timestamp

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 in outbound INVITEs. When set, outbound calls from this trunk will use this host instead of the default project SIP domain. Enables originating calls from custom domains.

public string FromHost { get; set; }

Property Value

string

Headers

Include these SIP X-* headers in INVITE request. These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.

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

Property Value

MapField<string, 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>

IncludeHeaders

Map SIP headers from 200 OK to sip.h.* participant attributes automatically.

When the names of required headers is known, using headers_to_attributes is strongly recommended.

When mapping 200 OK headers to follow-up request headers with attributes_to_headers map, lowercase header names should be used, for example: sip.h.x-custom-header.

public SIPHeaderOptions IncludeHeaders { get; set; }

Property Value

SIPHeaderOptions

MediaEncryption

public SIPMediaEncryption MediaEncryption { get; set; }

Property Value

SIPMediaEncryption

Metadata

User-defined metadata for the Trunk.

public string Metadata { get; set; }

Property Value

string

Name

Human-readable name for the Trunk.

public string Name { get; set; }

Property Value

string

Numbers

Numbers used to make the calls. Random one from this list will be selected.

public RepeatedField<string> Numbers { get; }

Property Value

RepeatedField<string>

Parser

public static MessageParser<SIPOutboundTrunkInfo> Parser { get; }

Property Value

MessageParser<SIPOutboundTrunkInfo>

SipTrunkId

public string SipTrunkId { get; set; }

Property Value

string

Transport

SIP Transport used for outbound call.

public SIPTransport Transport { get; set; }

Property Value

SIPTransport

UpdatedAt

public Timestamp UpdatedAt { get; set; }

Property Value

Timestamp

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 SIPOutboundTrunkInfo Clone()

Returns

SIPOutboundTrunkInfo

A deep clone of this object.

Equals(SIPOutboundTrunkInfo)

public bool Equals(SIPOutboundTrunkInfo other)

Parameters

other SIPOutboundTrunkInfo

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(SIPOutboundTrunkInfo)

Merges the given message into this one.

public void MergeFrom(SIPOutboundTrunkInfo other)

Parameters

other SIPOutboundTrunkInfo

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.