Class SIPInboundTrunkInfo

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

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

Inheritance

object

SIPInboundTrunkInfo

Implements

IMessage<SIPInboundTrunkInfo>

IEquatable<SIPInboundTrunkInfo>

IDeepCloneable<SIPInboundTrunkInfo>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SIPInboundTrunkInfo()

public SIPInboundTrunkInfo()

SIPInboundTrunkInfo(SIPInboundTrunkInfo)

public SIPInboundTrunkInfo(SIPInboundTrunkInfo other)

Parameters

other SIPInboundTrunkInfo

Fields

AllowedAddressesFieldNumber

Field number for the "allowed_addresses" field.

public const int AllowedAddressesFieldNumber = 5

Field Value

int

AllowedNumbersFieldNumber

Field number for the "allowed_numbers" field.

public const int AllowedNumbersFieldNumber = 6

Field Value

int

AttributesToHeadersFieldNumber

Field number for the "attributes_to_headers" field.

public const int AttributesToHeadersFieldNumber = 14

Field Value

int

AuthPasswordFieldNumber

Field number for the "auth_password" field.

public const int AuthPasswordFieldNumber = 8

Field Value

int

AuthRealmFieldNumber

Field number for the "auth_realm" field.

public const int AuthRealmFieldNumber = 19

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 = 17

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 = 15

Field Value

int

KrispEnabledFieldNumber

Field number for the "krisp_enabled" field.

public const int KrispEnabledFieldNumber = 13

Field Value

int

MaxCallDurationFieldNumber

Field number for the "max_call_duration" field.

public const int MaxCallDurationFieldNumber = 12

Field Value

int

MediaEncryptionFieldNumber

Field number for the "media_encryption" field.

public const int MediaEncryptionFieldNumber = 16

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 = 4

Field Value

int

RingingTimeoutFieldNumber

Field number for the "ringing_timeout" field.

public const int RingingTimeoutFieldNumber = 11

Field Value

int

SipTrunkIdFieldNumber

Field number for the "sip_trunk_id" field.

public const int SipTrunkIdFieldNumber = 1

Field Value

int

UpdatedAtFieldNumber

Field number for the "updated_at" field.

public const int UpdatedAtFieldNumber = 18

Field Value

int

Properties

AllowedAddresses

CIDR or IPs that traffic is accepted from. An empty list means all inbound traffic is accepted.

public RepeatedField<string> AllowedAddresses { get; }

Property Value

RepeatedField<string>

AllowedNumbers

Numbers that are allowed to make calls to this Trunk. An empty list means calls from any phone number is accepted.

public RepeatedField<string> AllowedNumbers { get; }

Property Value

RepeatedField<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

AuthRealm

public string AuthRealm { get; set; }

Property Value

string

AuthUsername

Username and password used to authenticate inbound SIP invites. 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

Headers

Include these SIP X-* headers in 200 OK responses.

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

Property Value

MapField<string, string>

HeadersToAttributes

Map SIP X-* headers from INVITE to SIP participant attributes.

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

Property Value

MapField<string, string>

IncludeHeaders

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

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

When mapping INVITE headers to response 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

KrispEnabled

public bool KrispEnabled { get; set; }

Property Value

bool

MaxCallDuration

Max call duration.

public Duration MaxCallDuration { get; set; }

Property Value

Duration

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 associated with LiveKit SIP. The Trunk will only accept calls made to these numbers. Creating multiple Trunks with different phone numbers allows having different rules for a single provider.

public RepeatedField<string> Numbers { get; }

Property Value

RepeatedField<string>

Parser

public static MessageParser<SIPInboundTrunkInfo> Parser { get; }

Property Value

MessageParser<SIPInboundTrunkInfo>

RingingTimeout

Max time for the caller to wait for track subscription.

public Duration RingingTimeout { get; set; }

Property Value

Duration

SipTrunkId

public string SipTrunkId { get; set; }

Property Value

string

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

Returns

SIPInboundTrunkInfo

A deep clone of this object.

Equals(SIPInboundTrunkInfo)

public bool Equals(SIPInboundTrunkInfo other)

Parameters

other SIPInboundTrunkInfo

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

Merges the given message into this one.

public void MergeFrom(SIPInboundTrunkInfo other)

Parameters

other SIPInboundTrunkInfo

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.