livekit-server-sdk 0.5.4 → 0.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37c0af8d011a1a96a75436dd27ce5c7b589742a2ba2d8b92783800900b77ed9a
-  data.tar.gz: '08f6fba37c2a8caa53199222983bcc9fc68fceb21c77c9983dd5aafd64a75de5'
+  metadata.gz: 30b87638631ee89f1b6b2ded0ce5721cf208f78a10ff8b51a690f17ac131b916
+  data.tar.gz: 59e49a093e0c480ecacf1efaebe3e82bf621498de579640afe3c5f1dfc476ffd
 SHA512:
-  metadata.gz: a56e5d01778aee68272c42385c4c201a3ea6328643086ce16f608414c44f9664f6a9e717f16c2daaea8d6e2aba26f293d0a172777d1e1555e578bb250674b484
-  data.tar.gz: 387588e04efaf6b702d0998128ba322890093900e7d53981b5f8426e5e63968b7f010a69d29c4934dc110c4a6a83f2514503e167cfc7b56a6bad7d0d484c34eb
+  metadata.gz: 3c283b0bda45f3d688184fbb1d29cb43ae6135a1ea3478632acbdb8faca9dff87b3d9f62b6909477a41440cd3f3a54b480f2098d2e22dd09728f6b1989f7245c
+  data.tar.gz: 8685dd0d4c1f35f4999faa9b88370088102870a91929bb44b58d788ad5938a225223af09ecbefde73ac08768152e2f410caba6165d9a6d99eb8d8ea32160745d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    livekit-server-sdk (0.5.0)
+    livekit-server-sdk (0.5.3)
       google-protobuf (>= 3.21.0, < 4.0)
       jwt (>= 2.2.3, < 3.0)
       rack (>= 2.2.3, < 3.0)
@@ -17,7 +17,6 @@ GEM
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
     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)

data/README.md

@@ -1,6 +1,14 @@
+<!--BEGIN_BANNER_IMAGE-->
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="/.github/banner_dark.png">
+    <source media="(prefers-color-scheme: light)" srcset="/.github/banner_light.png">
+    <img style="width:100%;" alt="The LiveKit icon, the name of the repository and some sample code in the background." src="/.github/banner_light.png">
+  </picture>
+  <!--END_BANNER_IMAGE-->
+
 # LiveKit Server API for Ruby
 
-Ruby API for server-side integrations with LiveKit. This gem provides the ability to create access tokens as well as access RoomService.
+<!--BEGIN_DESCRIPTION-->Use this SDK to manage <a href="https://livekit.io/">LiveKit</a> rooms and create access tokens from your Ruby backend.<!--END_DESCRIPTION-->
 
 This library is designed to work with Ruby 2.6.0 and above.
 
@@ -122,3 +130,16 @@ You may store credentials in environment variables. If api-key or api-secret is
 ## License
 
 The gem is available as open source under the terms of Apache 2.0 License.
+
+<!--BEGIN_REPO_NAV-->
+<br/><table>
+<thead><tr><th colspan="2">LiveKit Ecosystem</th></tr></thead>
+<tbody>
+<tr><td>Client SDKs</td><td><a href="https://github.com/livekit/components-js">Components</a> · <a href="https://github.com/livekit/client-sdk-js">JavaScript</a> · <a href="https://github.com/livekit/client-sdk-swift">iOS/macOS</a> · <a href="https://github.com/livekit/client-sdk-android">Android</a> · <a href="https://github.com/livekit/client-sdk-flutter">Flutter</a> · <a href="https://github.com/livekit/client-sdk-react-native">React Native</a> · <a href="https://github.com/livekit/client-sdk-rust">Rust</a> · <a href="https://github.com/livekit/client-sdk-python">Python</a> · <a href="https://github.com/livekit/client-sdk-unity-web">Unity (web)</a> · <a href="https://github.com/livekit/client-sdk-unity">Unity (beta)</a></td></tr><tr></tr>
+<tr><td>Server SDKs</td><td><a href="https://github.com/livekit/server-sdk-js">Node.js</a> · <a href="https://github.com/livekit/server-sdk-go">Golang</a> · <b>Ruby</b> · <a href="https://github.com/livekit/server-sdk-kotlin">Java/Kotlin</a> · <a href="https://github.com/agence104/livekit-server-sdk-php">PHP (community)</a> · <a href="https://github.com/tradablebits/livekit-server-sdk-python">Python (community)</a></td></tr><tr></tr>
+<tr><td>Services</td><td><a href="https://github.com/livekit/livekit">Livekit server</a> · <a href="https://github.com/livekit/egress">Egress</a> · <a href="https://github.com/livekit/ingress">Ingress</a></td></tr><tr></tr>
+<tr><td>Resources</td><td><a href="https://docs.livekit.io">Docs</a> · <a href="https://github.com/livekit-examples">Example apps</a> · <a href="https://livekit.io/cloud">Cloud</a> · <a href="https://docs.livekit.io/oss/deployment">Self-hosting</a> · <a href="https://github.com/livekit/livekit-cli">CLI</a></td></tr>
+</tbody>
+</table>
+<!--END_REPO_NAV-->
+

data/lib/livekit/egress_service_client.rb

@@ -108,7 +108,9 @@ module LiveKit
       # true to record only audio
       audio_only: false,
       # true to record only video
-      video_only: false
+      video_only: false,
+      # true to await START_RECORDING chrome log
+      await_start_signal: false
     )
       request = Proto::WebEgressRequest.new(
         url: url,
@@ -116,6 +118,7 @@ module LiveKit
         advanced: advanced,
         audio_only: audio_only,
         video_only: video_only,
+        await_start_signal: await_start_signal,
       )
       self.set_output(request, output)
       self.rpc(

data/lib/livekit/grants.rb

@@ -34,8 +34,8 @@ module LiveKit
 
   class VideoGrant
     attr_accessor :roomCreate, :roomJoin, :roomList, :roomRecord, :roomAdmin,
-      :room, :canPublish, :canSubscribe, :canPublishData, :hidden, :recorder,
-      :ingressAdmin
+      :room, :canPublish, :canPublishSources, :canSubscribe, :canPublishData,
+      :canUpdateOwnMetadata, :hidden, :recorder, :ingressAdmin
 
     def initialize(
       # true if can create or delete rooms
@@ -52,10 +52,14 @@ module LiveKit
       room: nil,
       # for join tokens, can participant publish, true by default
       canPublish: nil,
+      # TrackSource types that a participant may publish
+      canPublishSources: nil,
       # for join tokens, can participant subscribe, true by default
       canSubscribe: nil,
       # for join tokens, can participant publish data messages, true by default
       canPublishData: nil,
+      # by default, a participant is not allowed to update its own metadata
+      canUpdateOwnMetadata: nil,
       # if participant should remain invisible to others
       hidden: nil,
       # if participant is recording the room
@@ -70,8 +74,10 @@ module LiveKit
       @roomAdmin = roomAdmin
       @room = room
       @canPublish = canPublish
+      @canPublishSources = canPublishSources
       @canSubscribe = canSubscribe
       @canPublishData = canPublishData
+      @canUpdateOwnMetadata = canUpdateOwnMetadata
       @hidden = hidden
       @recorder = recorder
       @ingressAdmin = ingressAdmin
@@ -90,8 +96,10 @@ module LiveKit
         roomAdmin: hash["roomAdmin"],
         room: hash["room"],
         canPublish: hash["canPublish"],
+        canPublishSources: hash["canPublishSources"],
         canSubscribe: hash["canSubscribe"],
         canPublishData: hash["canPublishData"],
+        canUpdateOwnMetadata: hash["canUpdateOwnMetadata"],
         hidden: hash["hidden"],
         recorder: hash["recorder"],
         ingressAdmin: hash["ingressAdmin"]

data/lib/livekit/ingress_service_client.rb

@@ -14,7 +14,6 @@ module LiveKit
     end
 
     def create_ingress(
-      # currently :RTMP_INPUT is the only supported type
       input_type,
       # optional, name to identify the ingress
       name: nil,
@@ -27,7 +26,11 @@ module LiveKit
       # optional, LiveKit::Proto::IngressAudioOptions
       audio: nil,
       # optional, LiveKit::Proto::IngressVideoOptions
-      video: nil
+      video: nil,
+      # optional, whether to forward input media unprocessed, for WHIP only
+      bypass_transcoding: nil,
+      # optional, needed for ingresses of type URL, provides the URL to fetch media from
+      url: nil
     )
       request = Proto::CreateIngressRequest.new(
         input_type: input_type,
@@ -37,6 +40,8 @@ module LiveKit
         participant_name: participant_name,
         audio: audio,
         video: video,
+        bypass_transcoding: bypass_transcoding,
+        url: url,
       )
       self.rpc(
         :CreateIngress,
@@ -58,7 +63,9 @@ module LiveKit
       # optional, LiveKit::Proto::IngressAudioOptions
       audio: nil,
       # optional, LiveKit::Proto::IngressVideoOptions
-      video: nil
+      video: nil,
+      # optional, whether to forward input media unprocessed, for WHIP only
+      bypass_transcoding: nil
     )
       request = Proto::UpdateIngressRequest.new(
         ingress_id: ingress_id,
@@ -68,6 +75,7 @@ module LiveKit
         participant_name: participant_name,
         audio: audio,
         video: video,
+        bypass_transcoding: bypass_transcoding,
       )
       self.rpc(
         :UpdateIngress,

data/lib/livekit/proto/livekit_egress_pb.rb

@@ -30,6 +30,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :url, :string, 1
       optional :audio_only, :bool, 2
       optional :video_only, :bool, 3
+      optional :await_start_signal, :bool, 12
       repeated :file_outputs, :message, 9, "livekit.EncodedFileOutput"
       repeated :stream_outputs, :message, 10, "livekit.StreamOutput"
       repeated :segment_outputs, :message, 11, "livekit.SegmentedFileOutput"
@@ -172,6 +173,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :status, :enum, 3, "livekit.EgressStatus"
       optional :started_at, :int64, 10
       optional :ended_at, :int64, 11
+      optional :updated_at, :int64, 18
       optional :error, :string, 9
       repeated :stream_results, :message, 15, "livekit.StreamInfo"
       repeated :file_results, :message, 16, "livekit.FileInfo"

data/lib/livekit/proto/livekit_egress_twirp.rb

@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_egress_pb.rb'
 

data/lib/livekit/proto/livekit_ingress_pb.rb

@@ -9,10 +9,12 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("livekit_ingress.proto", :syntax => :proto3) do
     add_message "livekit.CreateIngressRequest" do
       optional :input_type, :enum, 1, "livekit.IngressInput"
+      optional :url, :string, 9
       optional :name, :string, 2
       optional :room_name, :string, 3
       optional :participant_identity, :string, 4
       optional :participant_name, :string, 5
+      optional :bypass_transcoding, :bool, 8
       optional :audio, :message, 6, "livekit.IngressAudioOptions"
       optional :video, :message, 7, "livekit.IngressVideoOptions"
     end
@@ -49,6 +51,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :stream_key, :string, 3
       optional :url, :string, 4
       optional :input_type, :enum, 5, "livekit.IngressInput"
+      optional :bypass_transcoding, :bool, 13
       optional :audio, :message, 6, "livekit.IngressAudioOptions"
       optional :video, :message, 7, "livekit.IngressVideoOptions"
       optional :room_name, :string, 8
@@ -65,6 +68,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :room_id, :string, 5
       optional :started_at, :int64, 7
       optional :ended_at, :int64, 8
+      optional :resource_id, :string, 9
       repeated :tracks, :message, 6, "livekit.TrackInfo"
     end
     add_enum "livekit.IngressState.Status" do
@@ -75,12 +79,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "livekit.InputVideoState" do
       optional :mime_type, :string, 1
+      optional :average_bitrate, :uint32, 2
       optional :width, :uint32, 3
       optional :height, :uint32, 4
-      optional :framerate, :uint32, 5
+      optional :framerate, :double, 5
     end
     add_message "livekit.InputAudioState" do
       optional :mime_type, :string, 1
+      optional :average_bitrate, :uint32, 2
       optional :channels, :uint32, 3
       optional :sample_rate, :uint32, 4
     end
@@ -90,11 +96,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :room_name, :string, 3
       optional :participant_identity, :string, 4
       optional :participant_name, :string, 5
+      proto3_optional :bypass_transcoding, :bool, 8
       optional :audio, :message, 6, "livekit.IngressAudioOptions"
       optional :video, :message, 7, "livekit.IngressVideoOptions"
     end
     add_message "livekit.ListIngressRequest" do
       optional :room_name, :string, 1
+      optional :ingress_id, :string, 2
     end
     add_message "livekit.ListIngressResponse" do
       repeated :items, :message, 1, "livekit.IngressInfo"
@@ -104,6 +112,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_enum "livekit.IngressInput" do
       value :RTMP_INPUT, 0
+      value :WHIP_INPUT, 1
+      value :URL_INPUT, 2
     end
     add_enum "livekit.IngressAudioEncodingPreset" do
       value :OPUS_STEREO_96KBPS, 0

data/lib/livekit/proto/livekit_ingress_twirp.rb

@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_ingress_pb.rb'
 

data/lib/livekit/proto/livekit_models_pb.rb

@@ -17,12 +17,18 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :enabled_codecs, :message, 7, "livekit.Codec"
       optional :metadata, :string, 8
       optional :num_participants, :uint32, 9
+      optional :num_publishers, :uint32, 11
       optional :active_recording, :bool, 10
+      optional :playout_delay, :message, 12, "livekit.PlayoutDelay"
     end
     add_message "livekit.Codec" do
       optional :mime, :string, 1
       optional :fmtp_line, :string, 2
     end
+    add_message "livekit.PlayoutDelay" do
+      optional :enabled, :bool, 1
+      optional :min, :uint32, 2
+    end
     add_message "livekit.ParticipantPermission" do
       optional :can_subscribe, :bool, 1
       optional :can_publish, :bool, 2
@@ -81,6 +87,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :stereo, :bool, 14
       optional :disable_red, :bool, 15
       optional :encryption, :enum, 16, "livekit.Encryption.Type"
+      optional :stream, :string, 17
     end
     add_message "livekit.VideoLayer" do
       optional :quality, :enum, 1, "livekit.VideoQuality"
@@ -152,6 +159,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :UNITY, 6
       value :REACT_NATIVE, 7
       value :RUST, 8
+      value :PYTHON, 9
+      value :CPP, 10
     end
     add_message "livekit.ClientConfiguration" do
       optional :video, :message, 1, "livekit.VideoConfiguration"
@@ -165,6 +174,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "livekit.DisabledCodecs" do
       repeated :codecs, :message, 1, "livekit.Codec"
+      repeated :publish, :message, 2, "livekit.Codec"
     end
     add_message "livekit.RTPStats" do
       optional :start_time, :message, 1, "google.protobuf.Timestamp"
@@ -208,6 +218,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :last_key_frame, :message, 34, "google.protobuf.Timestamp"
       optional :layer_lock_plis, :uint32, 35
       optional :last_layer_lock_pli, :message, 36, "google.protobuf.Timestamp"
+      optional :sample_rate, :double, 42
+      optional :drift_ms, :double, 43
     end
     add_message "livekit.TimedVersion" do
       optional :unix_micro, :int64, 1
@@ -264,12 +276,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :JOIN_FAILURE, 7
     end
     add_enum "livekit.ReconnectReason" do
-      value :RR_UNKOWN, 0
+      value :RR_UNKNOWN, 0
       value :RR_SIGNAL_DISCONNECTED, 1
       value :RR_PUBLISHER_FAILED, 2
       value :RR_SUBSCRIBER_FAILED, 3
       value :RR_SWITCH_CANDIDATE, 4
     end
+    add_enum "livekit.SubscriptionError" do
+      value :SE_UNKNOWN, 0
+      value :SE_CODEC_UNSUPPORTED, 1
+      value :SE_TRACK_NOTFOUND, 2
+    end
   end
 end
 
@@ -277,6 +294,7 @@ module LiveKit
   module Proto
     Room = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.Room").msgclass
     Codec = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.Codec").msgclass
+    PlayoutDelay = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.PlayoutDelay").msgclass
     ParticipantPermission = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.ParticipantPermission").msgclass
     ParticipantInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.ParticipantInfo").msgclass
     ParticipantInfo::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.ParticipantInfo.State").enummodule
@@ -309,5 +327,6 @@ module LiveKit
     ClientConfigSetting = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.ClientConfigSetting").enummodule
     DisconnectReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.DisconnectReason").enummodule
     ReconnectReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.ReconnectReason").enummodule
+    SubscriptionError = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("livekit.SubscriptionError").enummodule
   end
 end

data/lib/livekit/proto/livekit_models_twirp.rb

@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_models_pb.rb'
 

data/lib/livekit/proto/livekit_room_pb.rb

@@ -15,6 +15,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :node_id, :string, 4
       optional :metadata, :string, 5
       optional :egress, :message, 6, "livekit.RoomEgress"
+      optional :min_playout_delay, :uint32, 7
     end
     add_message "livekit.RoomEgress" do
       optional :room, :message, 1, "livekit.RoomCompositeEgressRequest"

data/lib/livekit/proto/livekit_room_twirp.rb

@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.11.0, DO NOT EDIT.
 require 'twirp'
 require_relative 'livekit_room_pb.rb'
 

data/lib/livekit/proto/livekit_webhook_pb.rb

@@ -18,6 +18,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :track, :message, 8, "livekit.TrackInfo"
       optional :id, :string, 6
       optional :created_at, :int64, 7
+      optional :num_dropped, :int32, 11
     end
   end
 end

data/lib/livekit/proto/livekit_webhook_twirp.rb

@@ -1,4 +1,4 @@
-# Code generated by protoc-gen-twirp_ruby 1.10.0, DO NOT EDIT.
+# Code generated by protoc-gen-twirp_ruby 1.11.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.4"
+  VERSION = "0.5.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: livekit-server-sdk
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.6
 platform: ruby
 authors:
 - Omri Gabay
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-22 00:00:00.000000000 Z
+date: 2023-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-protobuf
@@ -100,6 +100,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/banner_dark.png"
+- ".github/banner_light.png"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".gitmodules"
@@ -170,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: LiveKit Server SDK for Ruby