added krisp_enabled and other options to SipServiceClient (#74)

davidzhao · web-flow · commit 75f2efb7186e · 2025-02-13T11:28:23.000-06:00
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    livekit-server-sdk (0.8.0)
+    livekit-server-sdk (0.8.3)
       google-protobuf (>= 3.21.0, < 4.0)
       jwt (>= 2.2.3, < 3.0)
       rack (>= 2.2.3)
@@ -21,7 +21,7 @@ GEM
     google-protobuf (3.25.4)
     jwt (2.8.2)
       base64
-    logger (1.6.1)
+    logger (1.6.5)
     method_source (1.0.0)
     net-http (0.4.1)
       uri
diff --git a/lib/livekit/proto/livekit_agent_dispatch_twirp.rb b/lib/livekit/proto/livekit_agent_dispatch_twirp.rb
@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_agent_dispatch_pb.rb'
 
diff --git a/lib/livekit/proto/livekit_agent_twirp.rb b/lib/livekit/proto/livekit_agent_twirp.rb
@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_agent_pb.rb'
 
diff --git a/lib/livekit/proto/livekit_egress_twirp.rb b/lib/livekit/proto/livekit_egress_twirp.rb
@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_egress_pb.rb'
 
diff --git a/lib/livekit/proto/livekit_ingress_twirp.rb b/lib/livekit/proto/livekit_ingress_twirp.rb
@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_ingress_pb.rb'
 
diff --git a/lib/livekit/proto/livekit_metrics_twirp.rb b/lib/livekit/proto/livekit_metrics_twirp.rb
@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_metrics_pb.rb'
 
diff --git a/lib/livekit/proto/livekit_models_pb.rb b/lib/livekit/proto/livekit_models_pb.rb
diff --git a/lib/livekit/proto/livekit_models_twirp.rb b/lib/livekit/proto/livekit_models_twirp.rb
@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_models_pb.rb'
 
diff --git a/lib/livekit/proto/livekit_room_twirp.rb b/lib/livekit/proto/livekit_room_twirp.rb
@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_room_pb.rb'
 
diff --git a/lib/livekit/proto/livekit_sip_pb.rb b/lib/livekit/proto/livekit_sip_pb.rb
diff --git a/lib/livekit/proto/livekit_sip_twirp.rb b/lib/livekit/proto/livekit_sip_twirp.rb
@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_sip_pb.rb'
 
diff --git a/lib/livekit/proto/livekit_webhook_twirp.rb b/lib/livekit/proto/livekit_webhook_twirp.rb
@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_webhook_pb.rb'
 
diff --git a/lib/livekit/sip_service_client.rb b/lib/livekit/sip_service_client.rb
@@ -30,8 +30,12 @@ def create_sip_inbound_trunk(
       auth_password: nil,
       # optional, include these SIP X-* headers in 200 OK responses.
       headers: nil,
-      # optional map SIP X-* headers from INVITE to SIP participant attributes.
-      headers_to_attributes: nil
+      # optional, map SIP X-* headers from INVITE to SIP participant attributes.
+      headers_to_attributes: nil,
+      # optional, map SIP response headers from INVITE to sip.h.* participant attributes automatically.
+      include_headers: Proto::SIPHeaderOptions::SIP_NO_HEADERS,
+      # optional, enable Krisp for this trunk
+      krisp_enabled: false
     )
       request = Proto::CreateSIPInboundTrunkRequest.new(
         trunk: Proto::SIPInboundTrunkInfo.new(
@@ -43,7 +47,9 @@ def create_sip_inbound_trunk(
           auth_username: auth_username,
           auth_password: auth_password,
           headers: headers,
-          headers_to_attributes: headers_to_attributes
+          headers_to_attributes: headers_to_attributes,
+          include_headers: include_headers,
+          krisp_enabled: krisp_enabled
         )
       )
       self.rpc(
@@ -172,31 +178,42 @@ def create_sip_participant(
       sip_trunk_id,
       sip_call_to,
       room_name,
+      # Optional SIP From number to use. If empty, trunk number is used.
+      from_number: nil,
+      # Optional identity of the participant in LiveKit room
       participant_identity: nil,
+      # Optional name of the participant in LiveKit room
       participant_name: nil,
+      # Optional metadata of the participant in LiveKit room
       participant_metadata: nil,
+      # Optional, send following DTMF digits (extension codes) when making a call.
+      # Character 'w' can be used to add a 0.5 sec delay.
       dtmf: nil,
-      play_ringtone: nil, # deprecated, use play_dialtone
-      play_dialtone: nil,
-      hide_phone_number: nil
+      # Optional, play dialtone for the participant
+      play_dialtone: false,
+      # Optional, hide phone number from participant attributes
+      hide_phone_number: nil,
+      # Optional, ringing timeout in seconds
+      ringing_timeout: nil,
+      # Optional, max call duration in seconds
+      max_call_duration: nil,
+      # Optional, enable Krisp for this call
+      krisp_enabled: false
     )
-
-      if (play_ringtone == true || play_dialtone == true)
-        play_dialtone = true
-        play_ringtone = true
-      end
-
       request = Proto::CreateSIPParticipantRequest.new(
         sip_trunk_id: sip_trunk_id,
         sip_call_to: sip_call_to,
+        sip_number: from_number,
         room_name: room_name,
         participant_identity: participant_identity,
         participant_name: participant_name,
         participant_metadata: participant_metadata,
         dtmf: dtmf,
-        play_ringtone: play_ringtone,
         play_dialtone: play_dialtone,
         hide_phone_number: hide_phone_number,
+        ringing_timeout: ringing_timeout,
+        max_call_duration: max_call_duration,
+        krisp_enabled: krisp_enabled
       )
       self.rpc(
         :CreateSIPParticipant,
diff --git a/lib/livekit/version.rb b/lib/livekit/version.rb
@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LiveKit
-  VERSION = "0.8.2"
+  VERSION = "0.8.3"
 end
diff --git a/protocol b/protocol
@@ -1 +1 @@
-Subproject commit 9a579a69ba38704afea5105f409c7538c3fcb127
+Subproject commit 254e040b44d08910a35546320abefa8726c86167

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.`
	`1`	`+# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.`
`2`	`2`	`require 'twirp'`
`3`	`3`	`require_relative 'livekit_agent_dispatch_pb.rb'`
`4`	`4`