Method Detail

• getSipTrunkId

   abstract String getSipTrunkId()

  What SIP Trunk should be used to dial the user
  

  string sip_trunk_id = 1;

• getSipTrunkIdBytes

   abstract ByteString getSipTrunkIdBytes()

  What SIP Trunk should be used to dial the user
  

  string sip_trunk_id = 1;

• hasTrunk

   abstract boolean hasTrunk()

  .livekit.SIPOutboundConfig trunk = 20;

• getTrunk

   abstract LivekitSip.SIPOutboundConfig getTrunk()

  .livekit.SIPOutboundConfig trunk = 20;

• getSipCallTo

   abstract String getSipCallTo()

  What number should be dialed via SIP
  

  string sip_call_to = 2;

• getSipCallToBytes

   abstract ByteString getSipCallToBytes()

  What number should be dialed via SIP
  

  string sip_call_to = 2;

• getSipNumber

   abstract String getSipNumber()

  Optional SIP From number to use. If empty, trunk number is used.
  

  string sip_number = 15;

• getSipNumberBytes

   abstract ByteString getSipNumberBytes()

  Optional SIP From number to use. If empty, trunk number is used.
  

  string sip_number = 15;

• getRoomName

   abstract String getRoomName()

  What LiveKit room should this participant be connected too
  

  string room_name = 3;

• getRoomNameBytes

   abstract ByteString getRoomNameBytes()

  What LiveKit room should this participant be connected too
  

  string room_name = 3;

• getParticipantIdentity

   abstract String getParticipantIdentity()

  Optional identity of the participant in LiveKit room
  

  string participant_identity = 4;

• getParticipantIdentityBytes

   abstract ByteString getParticipantIdentityBytes()

  Optional identity of the participant in LiveKit room
  

  string participant_identity = 4;

• getParticipantName

   abstract String getParticipantName()

  Optional name of the participant in LiveKit room
  

  string participant_name = 7;

• getParticipantNameBytes

   abstract ByteString getParticipantNameBytes()

  Optional name of the participant in LiveKit room
  

  string participant_name = 7;

• getParticipantMetadata

   abstract String getParticipantMetadata()

  Optional user-defined metadata. Will be attached to a created Participant in the room.
  

  string participant_metadata = 8;

• getParticipantMetadataBytes

   abstract ByteString getParticipantMetadataBytes()

  Optional user-defined metadata. Will be attached to a created Participant in the room.
  

  string participant_metadata = 8;

• getParticipantAttributesCount

   abstract int getParticipantAttributesCount()

  Optional user-defined attributes. Will be attached to a created Participant in the room.
  

  map<string, string> participant_attributes = 9;

• containsParticipantAttributes

   abstract boolean containsParticipantAttributes(String key)

  Optional user-defined attributes. Will be attached to a created Participant in the room.
  

  map<string, string> participant_attributes = 9;

• getParticipantAttributes

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

  Use getParticipantAttributesMap instead.

• getParticipantAttributesMap

   abstract Map<String, String> getParticipantAttributesMap()

  Optional user-defined attributes. Will be attached to a created Participant in the room.
  

  map<string, string> participant_attributes = 9;

• getParticipantAttributesOrDefault

   abstract String getParticipantAttributesOrDefault(String key, String defaultValue)

  Optional user-defined attributes. Will be attached to a created Participant in the room.
  

  map<string, string> participant_attributes = 9;

• getParticipantAttributesOrThrow

   abstract String getParticipantAttributesOrThrow(String key)

  Optional user-defined attributes. Will be attached to a created Participant in the room.
  

  map<string, string> participant_attributes = 9;

• getDtmf

   abstract String getDtmf()

  Optionally send following DTMF digits (extension codes) when making a call.
  Character 'w' can be used to add a 0.5 sec delay.
  

  string dtmf = 5;

• getDtmfBytes

   abstract ByteString getDtmfBytes()

  Optionally send following DTMF digits (extension codes) when making a call.
  Character 'w' can be used to add a 0.5 sec delay.
  

  string dtmf = 5;

• getPlayRingtone

  @Deprecated() abstract boolean getPlayRingtone()

  Optionally play dialtone in the room as an audible indicator for existing participants. The `play_ringtone` option is deprectated but has the same effect.
  

  bool play_ringtone = 6 [deprecated = true];

• getPlayDialtone

   abstract boolean getPlayDialtone()

  bool play_dialtone = 13;

• getHidePhoneNumber

   abstract boolean getHidePhoneNumber()

  By default the From value (Phone number) is used for participant name/identity (if not set) and added to attributes.
  If true, a random value for identity will be used and numbers will be omitted from attributes.
  

  bool hide_phone_number = 10;

• getHeadersCount

   abstract int getHeadersCount()

  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 = 16;

• containsHeaders

   abstract boolean containsHeaders(String key)

  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 = 16;

• getHeaders

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

  Use getHeadersMap instead.

• getHeadersMap

   abstract Map<String, String> getHeadersMap()

  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 = 16;

• getHeadersOrDefault

   abstract String getHeadersOrDefault(String key, String defaultValue)

  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 = 16;

• getHeadersOrThrow

   abstract String getHeadersOrThrow(String key)

  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 = 16;

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

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

• hasRingingTimeout

   abstract boolean hasRingingTimeout()

  Max time for the callee to answer the call.
  

  .google.protobuf.Duration ringing_timeout = 11;

• getRingingTimeout

   abstract Duration getRingingTimeout()

  Max time for the callee to answer the call.
  

  .google.protobuf.Duration ringing_timeout = 11;

• hasMaxCallDuration

   abstract boolean hasMaxCallDuration()

  Max call duration.
  

  .google.protobuf.Duration max_call_duration = 12;

• getMaxCallDuration

   abstract Duration getMaxCallDuration()

  Max call duration.
  

  .google.protobuf.Duration max_call_duration = 12;

• getKrispEnabled

   abstract boolean getKrispEnabled()

  Enable voice isolation for the callee.
  

  bool krisp_enabled = 14;

• getMediaEncryptionValue

   abstract int getMediaEncryptionValue()

  .livekit.SIPMediaEncryption media_encryption = 18;

• getMediaEncryption

   abstract LivekitSip.SIPMediaEncryption getMediaEncryption()

  .livekit.SIPMediaEncryption media_encryption = 18;

• getWaitUntilAnswered

   abstract boolean getWaitUntilAnswered()

  Wait for the answer for the call before returning.
  

  bool wait_until_answered = 19;

• hasDisplayName

   abstract boolean hasDisplayName()

  Optional display name for the 'From' SIP header.
  
  Cases:
  1) Unspecified: Use legacy behavior - display name will be set to be the caller's number.
  2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream.
  3) Non-empty: Use the specified value as the display name.
  

  optional string display_name = 21;

• getDisplayName

   abstract String getDisplayName()

  Optional display name for the 'From' SIP header.
  
  Cases:
  1) Unspecified: Use legacy behavior - display name will be set to be the caller's number.
  2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream.
  3) Non-empty: Use the specified value as the display name.
  

  optional string display_name = 21;

• getDisplayNameBytes

   abstract ByteString getDisplayNameBytes()

  Optional display name for the 'From' SIP header.
  
  Cases:
  1) Unspecified: Use legacy behavior - display name will be set to be the caller's number.
  2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream.
  3) Non-empty: Use the specified value as the display name.
  

  optional string display_name = 21;