livekit-server-sdk 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eef78517d0f95246b2b76f12768eb22f556b44fb3cd2c2fee731e9ee302e623
-  data.tar.gz: 34bfd7e878f6f1a413c5ad22e060c92aa7c8026f5235710637df87240d9ab176
+  metadata.gz: 34926d0d468c544020abdd289ae87b9ef930b02af326b18ff1b412c3079222ae
+  data.tar.gz: 035442c257c4d5fed8ff590df031234bdf0d30264bd231c825f5da2103e282ac
 SHA512:
-  metadata.gz: 6acc80ab3108cb089962a3559b6361dd1143d63ebe12088bf4fb12dc58bf99522355d6fe16f844b28c805a0a71296c08334319c06188c5b9e0b855f6dfcb61aa
-  data.tar.gz: 6bd9016ec045247a5549090b7600d3424325cad853e9e77721d24255c95556a5ba6a87c4cd2989400a7907af3903572798af0d30e1d93b00450940899a78623d
+  metadata.gz: bb91065950d48efc26837576503724d8bbf26af84a5c224e216cd4002f4eee75a3b5fe64e9b942131ef3be7cbe30ae9d7b1ca1d9d164264f4c78527f24c2fdc9
+  data.tar.gz: 247cbd14c9bd44653ca64b370b884c421c63ba577979e1ed5895fbbd1f10f95eb8b249408c955fd4e4b67ce38bca36303738f36fdc65985d46656e02899a9710

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    livekit-server-sdk (0.4.0)
+    livekit-server-sdk (0.5.0)
       google-protobuf (>= 3.21.0, < 4.0)
       jwt (>= 2.2.3, < 3.0)
-      rack (>= 2.2.3)
+      rack (>= 2.2.3, < 3.0)
       twirp (>= 1.10.0, < 2.0)
 
 GEM
@@ -16,8 +16,8 @@ GEM
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
-    google-protobuf (3.21.12)
-    google-protobuf (3.21.12-x86_64-linux)
+    google-protobuf (3.22.2)
+    google-protobuf (3.22.2-x86_64-linux)
     jwt (2.7.0)
     method_source (1.0.0)
     pry (0.14.2)
@@ -26,7 +26,7 @@ GEM
     pry-doc (1.4.0)
       pry (~> 0.11)
       yard (~> 0.9.11)
-    rack (3.0.4.1)
+    rack (2.2.6.4)
     rake (13.0.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)

data/bin/bootstrap.sh

@@ -2,4 +2,4 @@
 
 echo "Ensure protoc and Go are installed"
 
-go install github.com/twitchtv/twirp-ruby/protoc-gen-twirp_ruby@latest
+go install github.com/github/twirp-ruby/protoc-gen-twirp_ruby@latest

data/lib/livekit/egress_service_client.rb

@@ -15,7 +15,7 @@ module LiveKit
 
     def start_room_composite_egress(
       room_name,
-      # one of EncodedFileOutput, SegmentedFileOutput or StreamOutput
+      # EncodedFileOutput, SegmentedFileOutput, StreamOutput, or array containing up to one of each
       output,
       # EncodingOptionsPreset, only one of preset or advanced could be set
       preset: nil,
@@ -49,7 +49,7 @@ module LiveKit
 
     def start_track_composite_egress(
       room_name,
-      # one of EncodedFileOutput, SegmentedFileOutput or StreamOutput
+      # EncodedFileOutput, SegmentedFileOutput, StreamOutput, or array containing up to one of each
       output,
       # TrackID of an audio track
       audio_track_id: nil,
@@ -99,7 +99,7 @@ module LiveKit
 
     def start_web_egress(
       url,
-      # one of EncodedFileOutput, SegmentedFileOutput or StreamOutput
+      # EncodedFileOutput, SegmentedFileOutput, StreamOutput, or array containing up to one of each
       output,
       # EncodingOptionsPreset, only one of preset or advanced could be set
       preset: nil,
@@ -172,15 +172,29 @@ module LiveKit
 
     # helper that sets output to file or stream
     def set_output(request, output)
-      if output.nil?
-        raise "output cannot be nil"
-      end
-      if output.is_a? LiveKit::Proto::EncodedFileOutput or output.is_a? LiveKit::Proto::DirectFileOutput
+      raise "output cannot be nil" if output.nil?
+      if output.is_a? Array
+        output.each do |out|
+          if out.is_a? LiveKit::Proto::EncodedFileOutput
+            raise "cannot add multiple file outputs" if request.file_outputs.any?
+            request.file_outputs = [out]
+          elsif out.is_a? LiveKit::Proto::SegmentedFileOutput
+            raise "cannot add multiple segmented file outputs" if request.segment_outputs.any?
+            request.segment_outputs = [out]
+          elsif out.is_a? Livekit::Proto::StreamOutput
+            raise "cannot add multiple stream outputs" if request.stream_outputs.any?
+            request.stream_outputs = [out]
+          end
+        end
+      elsif output.is_a? LiveKit::Proto::EncodedFileOutput
         request.file = output
+        request.file_outputs = [output]
       elsif output.is_a? LiveKit::Proto::SegmentedFileOutput
         request.segments = output
-      else
+        request.segment_outputs = [output]
+      elsif output.is_a? LiveKit::Proto::StreamOutput
         request.stream = output
+        request.stream_outputs = [output]
       end
     end
   end

data/lib/livekit/proto/livekit_egress_pb.rb

@@ -3,6 +3,8 @@
 
 require 'google/protobuf'
 
+require 'livekit_models_pb'
+
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("livekit_egress.proto", :syntax => :proto3) do
     add_message "livekit.RoomCompositeEgressRequest" do
@@ -82,6 +84,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :filename_prefix, :string, 2
       optional :playlist_name, :string, 3
       optional :segment_duration, :uint32, 4
+      optional :filename_suffix, :enum, 10, "livekit.SegmentedFileSuffix"
       optional :disable_manifest, :bool, 8
       oneof :output do
         optional :s3, :message, 5, "livekit.S3Upload"
@@ -111,7 +114,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :tagging, :string, 8
     end
     add_message "livekit.GCPUpload" do
-      optional :credentials, :bytes, 1
+      optional :credentials, :string, 1
       optional :bucket, :string, 2
     end
     add_message "livekit.AzureBlobUpload" do
@@ -154,6 +157,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "livekit.ListEgressRequest" do
       optional :room_name, :string, 1
       optional :egress_id, :string, 2
+      optional :active, :bool, 3
     end
     add_message "livekit.ListEgressResponse" do
       repeated :items, :message, 1, "livekit.EgressInfo"
@@ -235,21 +239,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :DEFAULT_SEGMENTED_FILE_PROTOCOL, 0
       value :HLS_PROTOCOL, 1
     end
+    add_enum "livekit.SegmentedFileSuffix" do
+      value :INDEX, 0
+      value :TIMESTAMP, 1
+    end
     add_enum "livekit.StreamProtocol" do
       value :DEFAULT_PROTOCOL, 0
       value :RTMP, 1
     end
-    add_enum "livekit.AudioCodec" do
-      value :DEFAULT_AC, 0
-      value :OPUS, 1
-      value :AAC, 2
-    end
-    add_enum "livekit.VideoCodec" do
-      value :DEFAULT_VC, 0
-      value :H264_BASELINE, 1
-      value :H264_MAIN, 2
-      value :H264_HIGH, 3
-    end
     add_enum "livekit.EncodingOptionsPreset" do
       value :H264_720P_30, 0
       value :H264_720P_60, 1
@@ -301,9 +298,8 @@ module LiveKit
     AutoTrackEgress = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.AutoTrackEgress").msgclass
     EncodedFileType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.EncodedFileType").enummodule
     SegmentedFileProtocol = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.SegmentedFileProtocol").enummodule
+    SegmentedFileSuffix = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.SegmentedFileSuffix").enummodule
     StreamProtocol = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.StreamProtocol").enummodule
-    AudioCodec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.AudioCodec").enummodule
-    VideoCodec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.VideoCodec").enummodule
     EncodingOptionsPreset = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.EncodingOptionsPreset").enummodule
     EgressStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.EgressStatus").enummodule
   end

data/lib/livekit/proto/livekit_egress_twirp.rb

@@ -1,10 +1,10 @@
-# Code generated by protoc-gen-twirp_ruby 1.9.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'
 
 module LiveKit
   module Proto
-    class EgressService < Twirp::Service
+    class EgressService < ::Twirp::Service
       package 'livekit'
       service 'Egress'
       rpc :StartRoomCompositeEgress, RoomCompositeEgressRequest, EgressInfo, :ruby_method => :start_room_composite_egress
@@ -17,7 +17,7 @@ module LiveKit
       rpc :StopEgress, StopEgressRequest, EgressInfo, :ruby_method => :stop_egress
     end
 
-    class EgressClient < Twirp::Client
+    class EgressClient < ::Twirp::Client
       client_for EgressService
     end
   end

data/lib/livekit/proto/livekit_ingress_pb.rb

@@ -19,16 +19,29 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "livekit.IngressAudioOptions" do
       optional :name, :string, 1
       optional :source, :enum, 2, "livekit.TrackSource"
-      optional :mime_type, :string, 3
-      optional :bitrate, :uint32, 4
-      optional :disable_dtx, :bool, 5
-      optional :channels, :uint32, 6
+      oneof :encoding_options do
+        optional :preset, :enum, 3, "livekit.IngressAudioEncodingPreset"
+        optional :options, :message, 4, "livekit.IngressAudioEncodingOptions"
+      end
     end
     add_message "livekit.IngressVideoOptions" do
       optional :name, :string, 1
       optional :source, :enum, 2, "livekit.TrackSource"
-      optional :mime_type, :string, 3
-      repeated :layers, :message, 4, "livekit.VideoLayer"
+      oneof :encoding_options do
+        optional :preset, :enum, 3, "livekit.IngressVideoEncodingPreset"
+        optional :options, :message, 4, "livekit.IngressVideoEncodingOptions"
+      end
+    end
+    add_message "livekit.IngressAudioEncodingOptions" do
+      optional :audio_codec, :enum, 1, "livekit.AudioCodec"
+      optional :bitrate, :uint32, 2
+      optional :disable_dtx, :bool, 3
+      optional :channels, :uint32, 4
+    end
+    add_message "livekit.IngressVideoEncodingOptions" do
+      optional :video_codec, :enum, 1, "livekit.VideoCodec"
+      optional :frame_rate, :double, 2
+      repeated :layers, :message, 3, "livekit.VideoLayer"
     end
     add_message "livekit.IngressInfo" do
       optional :ingress_id, :string, 1
@@ -61,13 +74,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :ENDPOINT_ERROR, 3
     end
     add_message "livekit.InputVideoState" do
-      optional :mime_type, :uint32, 1
+      optional :mime_type, :string, 1
       optional :width, :uint32, 3
       optional :height, :uint32, 4
       optional :framerate, :uint32, 5
     end
     add_message "livekit.InputAudioState" do
-      optional :mime_type, :uint32, 1
+      optional :mime_type, :string, 1
       optional :channels, :uint32, 3
       optional :sample_rate, :uint32, 4
     end
@@ -92,6 +105,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_enum "livekit.IngressInput" do
       value :RTMP_INPUT, 0
     end
+    add_enum "livekit.IngressAudioEncodingPreset" do
+      value :OPUS_STEREO_96KBPS, 0
+      value :OPUS_MONO_64KBS, 1
+    end
+    add_enum "livekit.IngressVideoEncodingPreset" do
+      value :H264_720P_30FPS_3_LAYERS, 0
+      value :H264_1080P_30FPS_3_LAYERS, 1
+      value :H264_540P_25FPS_2_LAYERS, 2
+      value :H264_720P_30FPS_1_LAYER, 3
+      value :H264_1080P_30FPS_1_LAYER, 4
+    end
   end
 end
 
@@ -100,6 +124,8 @@ module LiveKit
     CreateIngressRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.CreateIngressRequest").msgclass
     IngressAudioOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.IngressAudioOptions").msgclass
     IngressVideoOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.IngressVideoOptions").msgclass
+    IngressAudioEncodingOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.IngressAudioEncodingOptions").msgclass
+    IngressVideoEncodingOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.IngressVideoEncodingOptions").msgclass
     IngressInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.IngressInfo").msgclass
     IngressState = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.IngressState").msgclass
     IngressState::Status = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.IngressState.Status").enummodule
@@ -110,5 +136,7 @@ module LiveKit
     ListIngressResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.ListIngressResponse").msgclass
     DeleteIngressRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.DeleteIngressRequest").msgclass
     IngressInput = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.IngressInput").enummodule
+    IngressAudioEncodingPreset = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.IngressAudioEncodingPreset").enummodule
+    IngressVideoEncodingPreset = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.IngressVideoEncodingPreset").enummodule
   end
 end

data/lib/livekit/proto/livekit_ingress_twirp.rb

@@ -1,10 +1,10 @@
-# Code generated by protoc-gen-twirp_ruby 1.9.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'
 
 module LiveKit
   module Proto
-    class IngressService < Twirp::Service
+    class IngressService < ::Twirp::Service
       package 'livekit'
       service 'Ingress'
       rpc :CreateIngress, CreateIngressRequest, IngressInfo, :ruby_method => :create_ingress
@@ -13,7 +13,7 @@ module LiveKit
       rpc :DeleteIngress, DeleteIngressRequest, IngressInfo, :ruby_method => :delete_ingress
     end
 
-    class IngressClient < Twirp::Client
+    class IngressClient < ::Twirp::Client
       client_for IngressService
     end
   end

data/lib/livekit/proto/livekit_models_pb.rb

@@ -30,6 +30,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :can_publish_sources, :enum, 9, "livekit.TrackSource"
       optional :hidden, :bool, 7
       optional :recorder, :bool, 8
+      optional :can_update_metadata, :bool, 10
     end
     add_message "livekit.ParticipantInfo" do
       optional :sid, :string, 1
@@ -111,6 +112,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :participant_sid, :string, 1
       optional :payload, :bytes, 2
       repeated :destination_sids, :string, 3
+      proto3_optional :topic, :string, 4
     end
     add_message "livekit.ParticipantTracks" do
       optional :participant_sid, :string, 1
@@ -148,6 +150,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :FLUTTER, 4
       value :GO, 5
       value :UNITY, 6
+      value :REACT_NATIVE, 7
+      value :RUST, 8
     end
     add_message "livekit.ClientConfiguration" do
       optional :video, :message, 1, "livekit.VideoConfiguration"
@@ -209,6 +213,18 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :unix_micro, :int64, 1
       optional :ticks, :int32, 2
     end
+    add_enum "livekit.AudioCodec" do
+      value :DEFAULT_AC, 0
+      value :OPUS, 1
+      value :AAC, 2
+    end
+    add_enum "livekit.VideoCodec" do
+      value :DEFAULT_VC, 0
+      value :H264_BASELINE, 1
+      value :H264_MAIN, 2
+      value :H264_HIGH, 3
+      value :VP8, 4
+    end
     add_enum "livekit.TrackType" do
       value :AUDIO, 0
       value :VIDEO, 1
@@ -284,6 +300,8 @@ module LiveKit
     DisabledCodecs = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.DisabledCodecs").msgclass
     RTPStats = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.RTPStats").msgclass
     TimedVersion = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.TimedVersion").msgclass
+    AudioCodec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.AudioCodec").enummodule
+    VideoCodec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.VideoCodec").enummodule
     TrackType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.TrackType").enummodule
     TrackSource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.TrackSource").enummodule
     VideoQuality = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.VideoQuality").enummodule

data/lib/livekit/proto/livekit_models_twirp.rb

@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.9.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'
 

data/lib/livekit/proto/livekit_room_pb.rb

@@ -73,6 +73,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :data, :bytes, 2
       optional :kind, :enum, 3, "livekit.DataPacket.Kind"
       repeated :destination_sids, :string, 4
+      proto3_optional :topic, :string, 5
     end
     add_message "livekit.SendDataResponse" do
     end

data/lib/livekit/proto/livekit_room_twirp.rb

@@ -1,10 +1,10 @@
-# Code generated by protoc-gen-twirp_ruby 1.9.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'
 
 module LiveKit
   module Proto
-    class RoomServiceService < Twirp::Service
+    class RoomServiceService < ::Twirp::Service
       package 'livekit'
       service 'RoomService'
       rpc :CreateRoom, CreateRoomRequest, Room, :ruby_method => :create_room
@@ -20,7 +20,7 @@ module LiveKit
       rpc :UpdateRoomMetadata, UpdateRoomMetadataRequest, Room, :ruby_method => :update_room_metadata
     end
 
-    class RoomServiceClient < Twirp::Client
+    class RoomServiceClient < ::Twirp::Client
       client_for RoomServiceService
     end
   end

data/lib/livekit/proto/livekit_webhook_twirp.rb

@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.9.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'
 

data/lib/livekit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LiveKit
-  VERSION = "0.5.0"
+  VERSION = "0.5.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: livekit-server-sdk
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Omri Gabay
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -134,7 +134,6 @@ files:
 - lib/livekit/access_token.rb
 - lib/livekit/auth_mixin.rb
 - lib/livekit/egress_service_client.rb
-- lib/livekit/egress_types.rb
 - lib/livekit/grants.rb
 - lib/livekit/ingress_service_client.rb
 - lib/livekit/proto/livekit_egress_pb.rb