Method Detail

• getSipTrunkId

   abstract String getSipTrunkId()

  string sip_trunk_id = 1;

• getSipTrunkIdBytes

   abstract ByteString getSipTrunkIdBytes()

  string sip_trunk_id = 1;

• getName

   abstract String getName()

  Human-readable name for the Trunk.
  

  string name = 2;

• getNameBytes

   abstract ByteString getNameBytes()

  Human-readable name for the Trunk.
  

  string name = 2;

• getMetadata

   abstract String getMetadata()

  User-defined metadata for the Trunk.
  

  string metadata = 3;

• getMetadataBytes

   abstract ByteString getMetadataBytes()

  User-defined metadata for the Trunk.
  

  string metadata = 3;

• getAddress

   abstract String getAddress()

  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.
  

  string address = 4;

• getAddressBytes

   abstract ByteString getAddressBytes()

  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.
  

  string address = 4;

• getDestinationCountry

   abstract String getDestinationCountry()

  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.
  

  string destination_country = 14;

• getDestinationCountryBytes

   abstract ByteString getDestinationCountryBytes()

  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.
  

  string destination_country = 14;

• getTransportValue

   abstract int getTransportValue()

  SIP Transport used for outbound call.
  

  .livekit.SIPTransport transport = 5;

• getTransport

   abstract LivekitSip.SIPTransport getTransport()

  SIP Transport used for outbound call.
  

  .livekit.SIPTransport transport = 5;

• getNumbersList

   abstract List<String> getNumbersList()

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

  repeated string numbers = 6;

• getNumbersCount

   abstract int getNumbersCount()

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

  repeated string numbers = 6;

• getNumbers

   abstract String getNumbers(int index)

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

  repeated string numbers = 6;

  Parameters:

  index - The index of the element to return.

• getNumbersBytes

   abstract ByteString getNumbersBytes(int index)

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

  repeated string numbers = 6;

  Parameters:

  index - The index of the element to return.

• getAuthUsername

   abstract String getAuthUsername()

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

  string auth_username = 7;

• getAuthUsernameBytes

   abstract ByteString getAuthUsernameBytes()

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

  string auth_username = 7;

• getAuthPassword

   abstract String getAuthPassword()

  string auth_password = 8;

• getAuthPasswordBytes

   abstract ByteString getAuthPasswordBytes()

  string auth_password = 8;

• getHeadersCount

   abstract int getHeadersCount()

  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.
  

  map<string, string> headers = 9;

• containsHeaders

   abstract boolean containsHeaders(String key)

  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.
  

  map<string, string> headers = 9;

• getHeaders

  @Deprecated() abstract Map<String, String> getHeaders()

  Use getHeadersMap instead.

• getHeadersMap

   abstract Map<String, String> getHeadersMap()

  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.
  

  map<string, string> headers = 9;

• getHeadersOrDefault

   abstract String getHeadersOrDefault(String key, String defaultValue)

  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.
  

  map<string, string> headers = 9;

• getHeadersOrThrow

   abstract String getHeadersOrThrow(String key)

  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.
  

  map<string, string> headers = 9;

• getHeadersToAttributesCount

   abstract int getHeadersToAttributesCount()

  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.
  

  map<string, string> headers_to_attributes = 10;

• containsHeadersToAttributes

   abstract boolean containsHeadersToAttributes(String key)

  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.
  

  map<string, string> headers_to_attributes = 10;

• getHeadersToAttributes

  @Deprecated() abstract Map<String, String> getHeadersToAttributes()

  Use getHeadersToAttributesMap instead.

• getHeadersToAttributesMap

   abstract Map<String, String> getHeadersToAttributesMap()

  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.
  

  map<string, string> headers_to_attributes = 10;

• getHeadersToAttributesOrDefault

   abstract String getHeadersToAttributesOrDefault(String key, String defaultValue)

  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.
  

  map<string, string> headers_to_attributes = 10;

• getHeadersToAttributesOrThrow

   abstract String getHeadersToAttributesOrThrow(String key)

  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.
  

  map<string, string> headers_to_attributes = 10;

• getAttributesToHeadersCount

   abstract int getAttributesToHeadersCount()

  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.
  

  map<string, string> attributes_to_headers = 11;

• containsAttributesToHeaders

   abstract boolean containsAttributesToHeaders(String key)

  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.
  

  map<string, string> attributes_to_headers = 11;

• getAttributesToHeaders

  @Deprecated() abstract Map<String, String> getAttributesToHeaders()

  Use getAttributesToHeadersMap instead.

• getAttributesToHeadersMap

   abstract Map<String, String> getAttributesToHeadersMap()

  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.
  

  map<string, string> attributes_to_headers = 11;

• getAttributesToHeadersOrDefault

   abstract String getAttributesToHeadersOrDefault(String key, String defaultValue)

  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.
  

  map<string, string> attributes_to_headers = 11;

• getAttributesToHeadersOrThrow

   abstract String getAttributesToHeadersOrThrow(String key)

  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.
  

  map<string, string> attributes_to_headers = 11;

• getIncludeHeadersValue

   abstract int getIncludeHeadersValue()

  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.
  

  .livekit.SIPHeaderOptions include_headers = 12;

• getIncludeHeaders

   abstract LivekitSip.SIPHeaderOptions getIncludeHeaders()

  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.
  

  .livekit.SIPHeaderOptions include_headers = 12;

• getMediaEncryptionValue

   abstract int getMediaEncryptionValue()

  .livekit.SIPMediaEncryption media_encryption = 13;

• getMediaEncryption

   abstract LivekitSip.SIPMediaEncryption getMediaEncryption()

  .livekit.SIPMediaEncryption media_encryption = 13;