Merge remote-tracking branch 'upstream/main' into broadcast-ipc

Author: ladvoc

LiveKitClient.podspec

@@ -1,6 +1,6 @@
 Pod::Spec.new do |spec|
   spec.name = "LiveKitClient"
-  spec.version = "2.1.0"
+  spec.version = "2.1.1"
   spec.summary = "LiveKit Swift Client SDK. Easily build live audio or video experiences into your mobile app, game or website."
   spec.homepage = "https://github.com/livekit/client-sdk-swift"
   spec.license = {:type => "Apache 2.0", :file => "LICENSE"}
@@ -10,7 +10,7 @@ Pod::Spec.new do |spec|
   spec.osx.deployment_target = "10.15"
 
   spec.swift_versions = ["5.7"]
-  spec.source = {:git => "https://github.com/livekit/client-sdk-swift.git", :tag => "2.1.0"}
+  spec.source = {:git => "https://github.com/livekit/client-sdk-swift.git", :tag => "2.1.1"}
 
   spec.source_files = "Sources/**/*"
 

Package.swift

@@ -18,7 +18,7 @@ let package = Package(
     ],
     dependencies: [
         // LK-Prefixed Dynamic WebRTC XCFramework
-        .package(url: "https://github.com/livekit/webrtc-xcframework.git", exact: "125.6422.16"),
+        .package(url: "https://github.com/livekit/webrtc-xcframework.git", exact: "125.6422.18"),
         .package(url: "https://github.com/apple/swift-protobuf.git", from: "1.26.0"),
         .package(url: "https://github.com/apple/swift-log.git", from: "1.5.4"),
         // Only used for DocC generation

[email protected]

@@ -20,7 +20,7 @@ let package = Package(
     ],
     dependencies: [
         // LK-Prefixed Dynamic WebRTC XCFramework
-        .package(url: "https://github.com/livekit/webrtc-xcframework.git", exact: "125.6422.16"),
+        .package(url: "https://github.com/livekit/webrtc-xcframework.git", exact: "125.6422.18"),
         .package(url: "https://github.com/apple/swift-protobuf.git", from: "1.26.0"),
         .package(url: "https://github.com/apple/swift-log.git", from: "1.5.4"),
         // Only used for DocC generation

README.md

@@ -38,7 +38,7 @@ Add the dependency and also to your target
 let package = Package(
   ...
   dependencies: [
-    .package(name: "LiveKit", url: "https://github.com/livekit/client-sdk-swift.git", .upToNextMajor("2.1.0")),
+    .package(name: "LiveKit", url: "https://github.com/livekit/client-sdk-swift.git", .upToNextMajor("2.1.1")),
   ],
   targets: [
     .target(

Sources/LiveKit/Core/RPC.swift

@@ -22,19 +22,19 @@ import Foundation
 /// serialized and sent across the wire. The sender will receive an equivalent error on the other side.
 ///
 /// Built-in types are included but developers may use any message string, with a max length of 256 bytes.
-struct RpcError: Error {
+public struct RpcError: Error {
     /// The error code of the RPC call. Error codes 1001-1999 are reserved for built-in errors.
     ///
     /// See `RpcError.BuiltInError` for built-in error information.
-    let code: Int
+    public let code: Int
 
     /// A message to include. Strings over 256 bytes will be truncated.
-    let message: String
+    public let message: String
 
     /// An optional data payload. Must be smaller than 15KB in size, or else will be truncated.
-    let data: String
+    public let data: String
 
-    enum BuiltInError {
+    public enum BuiltInError {
         case applicationError
         case connectionTimeout
         case responseTimeout
@@ -47,7 +47,7 @@ struct RpcError: Error {
         case unsupportedServer
         case unsupportedVersion
 
-        var code: Int {
+        public var code: Int {
             switch self {
             case .applicationError: return 1500
             case .connectionTimeout: return 1501
@@ -63,7 +63,7 @@ struct RpcError: Error {
             }
         }
 
-        var message: String {
+        public var message: String {
             switch self {
             case .applicationError: return "Application error in method handler"
             case .connectionTimeout: return "Connection timeout"
@@ -124,16 +124,16 @@ public typealias RpcHandler = (RpcInvocationData) async throws -> String
 
 public struct RpcInvocationData {
     /// A unique identifier for this RPC request
-    let requestId: String
+    public let requestId: String
 
     /// The identity of the RemoteParticipant who initiated the RPC call
-    let callerIdentity: Participant.Identity
+    public let callerIdentity: Participant.Identity
 
     /// The data sent by the caller (as a string)
-    let payload: String
+    public let payload: String
 
     /// The maximum time available to return a response
-    let responseTimeout: TimeInterval
+    public let responseTimeout: TimeInterval
 }
 
 struct PendingRpcResponse {

Sources/LiveKit/LiveKit.swift

@@ -39,7 +39,7 @@ let logger = Logger(label: "LiveKitSDK")
 @objc
 public class LiveKitSDK: NSObject {
     @objc(sdkVersion)
-    public static let version = "2.1.0"
+    public static let version = "2.1.1"
 
     @objc
     public static func setLoggerStandardOutput() {

Sources/LiveKit/Track/AudioManager.swift

@@ -241,6 +241,9 @@ public class AudioManager: Loggable {
     /// Starts mic input to the SDK even without any ``Room`` or a connection.
     /// Audio buffers will flow into ``LocalAudioTrack/add(audioRenderer:)`` and ``capturePostProcessingDelegate``.
     public func startLocalRecording() {
+        // Always unmute APM if muted by last session.
+        RTC.audioProcessingModule.isMuted = false
+        // Start recording on the ADM.
         RTC.audioDeviceModule.initAndStartRecording()
     }
 
@@ -255,8 +258,33 @@ public class AudioManager: Loggable {
         _state.mutate { $0.engineObservers = engineObservers }
     }
 
+    /// Set to `true` to enable legacy mic mute mode.
+    ///
+    /// - Default: Uses `AVAudioEngine`'s `isVoiceProcessingInputMuted` internally.
+    ///   This is fast, and muted speaker detection works. However, iOS will play a sound effect.
+    /// - Legacy: Restarts the internal `AVAudioEngine` without mic input when muted.
+    ///   This is slower, and muted speaker detection does not work. No sound effect is played.
+    public var isLegacyMuteMode: Bool {
+        get { RTC.audioDeviceModule.muteMode == .restartEngine }
+        set { RTC.audioDeviceModule.muteMode = newValue ? .restartEngine : .voiceProcessing }
+    }
+
     // MARK: - For testing
 
+    var isEngineRunning: Bool {
+        RTC.audioDeviceModule.isEngineRunning
+    }
+
+    var isMicrophoneMuted: Bool {
+        get { RTC.audioDeviceModule.isMicrophoneMuted }
+        set { RTC.audioDeviceModule.isMicrophoneMuted = newValue }
+    }
+
+    var engineState: RTCAudioEngineState {
+        get { RTC.audioDeviceModule.engineState }
+        set { RTC.audioDeviceModule.engineState = newValue }
+    }
+
     var isPlayoutInitialized: Bool {
         RTC.audioDeviceModule.isPlayoutInitialized
     }

Tests/LiveKitTests/AudioEngineTests.swift

@@ -106,32 +106,55 @@ class AudioEngineTests: XCTestCase {
     }
 
     // Test start generating local audio buffer without joining to room.
-    func testPrejoinLocalAudioBuffer() async throws {
-        // Set up expectation...
-        let didReceiveAudioFrame = expectation(description: "Did receive audio frame")
-        didReceiveAudioFrame.assertForOverFulfill = false
-
-        // Start watching for audio frame...
-        let audioFrameWatcher = AudioTrackWatcher(id: "notifier01") { _ in
-            didReceiveAudioFrame.fulfill()
+    func testPreconnectAudioBuffer() async throws {
+        print("Setting recording always prepared mode...")
+        AudioManager.shared.isRecordingAlwaysPrepared = true
+
+        var counter = 0
+        // Executes 10 times by default.
+        measure {
+            counter += 1
+            print("Measuring attempt \(counter)...")
+            // Set up expectation...
+            let didReceiveAudioFrame = expectation(description: "Did receive audio frame")
+            didReceiveAudioFrame.assertForOverFulfill = false
+
+            let didConnectToRoom = expectation(description: "Did connect to room")
+            didConnectToRoom.assertForOverFulfill = false
+
+            // Create an audio frame watcher...
+            let audioFrameWatcher = AudioTrackWatcher(id: "notifier01") { _ in
+                didReceiveAudioFrame.fulfill()
+            }
+
+            let localMicTrack = LocalAudioTrack.createTrack()
+            // Attach audio frame watcher...
+            localMicTrack.add(audioRenderer: audioFrameWatcher)
+
+            Task.detached {
+                print("Starting local recording...")
+                AudioManager.shared.startLocalRecording()
+            }
+
+            // Wait for audio frame...
+            print("Waiting for first audio frame...")
+            // await fulfillment(of: [didReceiveAudioFrame], timeout: 10)
+            wait(for: [didReceiveAudioFrame], timeout: 30)
+
+            Task.detached {
+                print("Connecting to room...")
+                try await self.withRooms([RoomTestingOptions(canPublish: true)]) { rooms in
+                    print("Publishing mic...")
+                    try await rooms[0].localParticipant.setMicrophone(enabled: true)
+                    didConnectToRoom.fulfill()
+                }
+            }
+
+            print("Waiting for room to connect & disconnect...")
+            wait(for: [didConnectToRoom], timeout: 30)
+
+            localMicTrack.remove(audioRenderer: audioFrameWatcher)
         }
-
-        let localMicTrack = LocalAudioTrack.createTrack()
-        // Attach audio frame watcher...
-        localMicTrack.add(audioRenderer: audioFrameWatcher)
-
-        Task.detached {
-            print("Starting audio track in 3 seconds...")
-            try? await Task.sleep(nanoseconds: 3 * 1_000_000_000)
-            AudioManager.shared.startLocalRecording()
-        }
-
-        // Wait for audio frame...
-        print("Waiting for first audio frame...")
-        await fulfillment(of: [didReceiveAudioFrame], timeout: 10)
-
-        // Remove audio frame watcher...
-        localMicTrack.remove(audioRenderer: audioFrameWatcher)
     }
 
     // Test the manual rendering mode (no-device mode) of AVAudioEngine based AudioDeviceModule.