Merge branch 'develop' into enhancement/increase-spm-swift-version

Author: testableapple

CHANGELOG.md

@@ -4,7 +4,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 # Upcoming
 
-### 🔄 Changed
+### ✅ Added
+- You can now configure policies based on the the device's proximity information. Those policies can be used to toggle speaker and video. [#770](https://github.com/GetStream/stream-video-swift/pull/770)
+
+### 🐞 Fixed
+- Fix ringing flow issues. [#792](https://github.com/GetStream/stream-video-swift/pull/792)
 
 # [1.21.1](https://github.com/GetStream/stream-video-swift/releases/tag/1.21.1)
 _April 25, 2025_

DemoApp/Sources/Components/AppEnvironment.swift

@@ -591,6 +591,35 @@ extension AppEnvironment {
     static var preferredCallType: String?
 }
 
+extension AppEnvironment {
+
+    enum ProximityPolicyDebugConfiguration: Hashable, Debuggable, Sendable, CaseIterable {
+        case speaker, video
+
+        var title: String {
+            switch self {
+            case .speaker:
+                return "Speaker"
+            case .video:
+                return "Video"
+            }
+        }
+
+        var value: ProximityPolicy {
+            switch self {
+            case .speaker:
+                return SpeakerProximityPolicy()
+            case .video:
+                return VideoProximityPolicy()
+            }
+        }
+    }
+
+    static var proximityPolicies: Set<ProximityPolicyDebugConfiguration> = {
+        [.speaker, .video]
+    }()
+}
+
 extension String: Debuggable {
     var title: String {
         self

DemoApp/Sources/Views/CallView/CallingView/SimpleCallingView.swift

@@ -188,6 +188,15 @@ struct SimpleCallingView: View {
         try await call.updateAudioSessionPolicy(AppEnvironment.audioSessionPolicy.value)
     }
 
+    private func setProximityPolicies(for callId: String) throws {
+        let policies = AppEnvironment.proximityPolicies.map(\.value)
+        guard !policies.isEmpty else {
+            return
+        }
+        let call = streamVideo.call(callType: callType, callId: callId)
+        try policies.forEach { try call.addProximityPolicy($0) }
+    }
+
     private func parseURLIfRequired(_ text: String) {
         let adapter = DeeplinkAdapter()
         guard
@@ -224,6 +233,7 @@ struct SimpleCallingView: View {
         case .lobby:
             await setPreferredVideoCodec(for: text)
             try? await setAudioSessionPolicyOverride(for: text)
+            try? setProximityPolicies(for: text)
             viewModel.enterLobby(
                 callType: callType,
                 callId: text,
@@ -232,10 +242,12 @@ struct SimpleCallingView: View {
         case .join:
             await setPreferredVideoCodec(for: text)
             try? await setAudioSessionPolicyOverride(for: text)
+            try? setProximityPolicies(for: text)
             viewModel.joinCall(callType: callType, callId: text)
         case let .start(callId):
             await setPreferredVideoCodec(for: callId)
             try? await setAudioSessionPolicyOverride(for: callId)
+            try? setProximityPolicies(for: text)
             viewModel.startCall(
                 callType: callType,
                 callId: callId,

DemoApp/Sources/Views/Login/DebugMenu.swift

@@ -125,6 +125,10 @@ struct DebugMenu: View {
         didSet { AppEnvironment.audioSessionPolicy = audioSessionPolicy }
     }
 
+    @State private var proximityPolicies = AppEnvironment.proximityPolicies {
+        didSet { AppEnvironment.proximityPolicies = proximityPolicies }
+    }
+
     var body: some View {
         Menu {
             makeMenu(
@@ -190,6 +194,18 @@ struct DebugMenu: View {
                 label: "AudioSession policy"
             ) { self.audioSessionPolicy = $0 }
 
+            makeMultipleSelectMenu(
+                for: AppEnvironment.ProximityPolicyDebugConfiguration.allCases,
+                currentValues: proximityPolicies,
+                label: "Proximity policies"
+            ) { item, isSelected in
+                if isSelected {
+                    proximityPolicies = proximityPolicies.filter { item != $0 }
+                } else {
+                    proximityPolicies.insert(item)
+                }
+            }
+
             makeMenu(
                 for: [.default, .lastParticipant],
                 currentValue: autoLeavePolicy,

DocumentationTests/DocumentationTests/DocumentationTests.xcodeproj/project.pbxproj

@@ -28,6 +28,7 @@
 		409C396F2B67CDF30090044C /* 09-broadcasting.swift in Sources */ = {isa = PBXBuildFile; fileRef = 409C396E2B67CDF30090044C /* 09-broadcasting.swift */; };
 		409F10EA2BE11698000A984B /* StreamVideoNoiseCancellation in Frameworks */ = {isa = PBXBuildFile; productRef = 409F10E92BE11698000A984B /* StreamVideoNoiseCancellation */; };
 		40AB356B2B73965D00E465CC /* 16-snapshot.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40AB356A2B73965D00E465CC /* 16-snapshot.swift */; };
+		40AD64BB2DC2671E0077AE15 /* 05-proximity-policies.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40AD64BA2DC2671B0077AE15 /* 05-proximity-policies.swift */; };
 		40B468982B67B6DF009B5B3E /* 01-deeplinking.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40B468972B67B6DF009B5B3E /* 01-deeplinking.swift */; };
 		40CB9FA92B7FC7DB006BED93 /* 17-camera-zoom.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40CB9FA82B7FC7DB006BED93 /* 17-camera-zoom.swift */; };
 		40E23B9B2B67BA4100D11FC1 /* 02-push-notifications.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40E23B9A2B67BA4100D11FC1 /* 02-push-notifications.swift */; };
@@ -108,6 +109,7 @@
 		409C396C2B67CD780090044C /* 08-recording.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "08-recording.swift"; sourceTree = "<group>"; };
 		409C396E2B67CDF30090044C /* 09-broadcasting.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "09-broadcasting.swift"; sourceTree = "<group>"; };
 		40AB356A2B73965D00E465CC /* 16-snapshot.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "16-snapshot.swift"; sourceTree = "<group>"; };
+		40AD64BA2DC2671B0077AE15 /* 05-proximity-policies.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "05-proximity-policies.swift"; sourceTree = "<group>"; };
 		40B468972B67B6DF009B5B3E /* 01-deeplinking.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "01-deeplinking.swift"; sourceTree = "<group>"; };
 		40CB9FA82B7FC7DB006BED93 /* 17-camera-zoom.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "17-camera-zoom.swift"; sourceTree = "<group>"; };
 		40E23B9A2B67BA4100D11FC1 /* 02-push-notifications.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "02-push-notifications.swift"; sourceTree = "<group>"; };
@@ -298,6 +300,7 @@
 				409C39682B67CC5C0090044C /* 04-screensharing.swift */,
 				409C396A2B67CD0B0090044C /* 05-picture-in-picture.swift */,
 				404CAED72B8E3874007087BC /* 06-apply-video-filters.swift */,
+				40AD64BA2DC2671B0077AE15 /* 05-proximity-policies.swift */,
 				409C396C2B67CD780090044C /* 08-recording.swift */,
 				409C396E2B67CDF30090044C /* 09-broadcasting.swift */,
 			);
@@ -440,6 +443,7 @@
 			files = (
 				40FFDC5A2B63F08D004DA7A2 /* 01-call-participant.swift in Sources */,
 				40FFDC9A2B6405C7004DA7A2 /* 10-network-quality-indicator.swift in Sources */,
+				40AD64BB2DC2671E0077AE15 /* 05-proximity-policies.swift in Sources */,
 				400D91D12B63DEA200EBA47D /* 04-camera-and-microphone.swift in Sources */,
 				40FFDC4F2B63EE50004DA7A2 /* 04-active-call.swift in Sources */,
 				40FFDCA02B640676004DA7A2 /* 13-pinning-users.swift in Sources */,

DocumentationTests/DocumentationTests/DocumentationTests/06-advanced/05-proximity-policies.swift

@@ -0,0 +1,49 @@
+//
+//  05-proximity-policies.swift
+//  DocumentationTests
+//
+//  Created by Ilias Pavlidakis on 30/4/25.
+//
+
+import StreamVideo
+import StreamVideoSwiftUI
+import SwiftUI
+import Combine
+
+@MainActor
+fileprivate func content() {
+    container {
+        let call = streamVideo.call(callType: "default", callId: "chat-123")
+        let policy = VideoProximityPolicy()
+
+        do {
+            try call.addProximityPolicy(policy)
+        } catch {
+            log.error(error)
+        }
+    }
+
+    container {
+        let call = streamVideo.call(callType: "default", callId: "team-meet")
+        let policy = SpeakerProximityPolicy()
+
+        do {
+            try call.addProximityPolicy(policy)
+        } catch {
+            log.error(error)
+        }
+    }
+
+    container {
+        let call = streamVideo.call(callType: "default", callId: "chat-123")
+        let videoPolicy = VideoProximityPolicy()
+        let speakerPolicy = SpeakerProximityPolicy()
+
+        do {
+            try call.addProximityPolicy(videoPolicy)
+            try call.addProximityPolicy(speakerPolicy)
+        } catch {
+            log.error(error)
+        }
+    }
+}

Gemfile.lock

@@ -210,7 +210,7 @@ GEM
       bundler
       fastlane
       pry
-    fastlane-plugin-stream_actions (0.3.78)
+    fastlane-plugin-stream_actions (0.3.79)
       xctest_list (= 1.2.1)
     fastlane-plugin-versioning (0.7.1)
     fastlane-sirp (1.0.0)
@@ -443,7 +443,7 @@ DEPENDENCIES
   fastlane
   fastlane-plugin-create_xcframework
   fastlane-plugin-lizard
-  fastlane-plugin-stream_actions (= 0.3.78)
+  fastlane-plugin-stream_actions (= 0.3.79)
   fastlane-plugin-versioning
   jazzy
   json

Sources/StreamVideo/Call.swift

@@ -48,6 +48,8 @@ public class Call: @unchecked Sendable, WSEventsSubscriber {
     public let camera: CameraManager
     /// Provides access to the speaker.
     public let speaker: SpeakerManager
+    /// Provides access to device's proximity
+    private lazy var proximity: ProximityManager = .init(self)
 
     internal let callController: CallController
     internal let coordinatorClient: DefaultAPI
@@ -1232,7 +1234,7 @@ public class Call: @unchecked Sendable, WSEventsSubscriber {
     /// Sets the disconnection timeout for a user who has temporarily lost connection.
     ///
     /// This method defines the duration a user, who has already joined the call, can remain
-    /// in a disconnected state due to temporary internet issues. If the user’s connection
+    /// in a disconnected state due to temporary internet issues. If the user's connection
     /// remains disrupted beyond the specified timeout period, they will be dropped from the call.
     /// This timeout helps ensure that users with unstable connections do not stay in the call
     /// indefinitely if they cannot reconnect.
@@ -1367,6 +1369,20 @@ public class Call: @unchecked Sendable, WSEventsSubscriber {
         try await callController.updateAudioSessionPolicy(policy)
     }
 
+    /// Adds a proximity policy to manage device proximity behavior during the call.
+    /// Only supported on phone devices.
+    /// - Parameter policy: Policy to add for managing proximity behavior
+    /// - Throws: ClientError if the call is not in a valid state
+    public func addProximityPolicy(_ policy: any ProximityPolicy) throws {
+        try proximity.add(policy)
+    }
+
+    /// Removes a previously added proximity policy from the call.
+    /// - Parameter policy: Policy to remove
+    public func removeProximityPolicy(_ policy: any ProximityPolicy) {
+        proximity.remove(policy)
+    }
+
     // MARK: - Internal
 
     internal func update(reconnectionStatus: ReconnectionStatus) {

Sources/StreamVideo/CallSettings/ProximityManager.swift

@@ -0,0 +1,116 @@
+//
+// Copyright © 2025 Stream.io Inc. All rights reserved.
+//
+
+import Combine
+import Foundation
+
+/// Manages proximity-related functionality for a call, including policy management
+/// and proximity state observation. Only active on phone devices.
+final class ProximityManager: @unchecked Sendable {
+
+    @Injected(\.streamVideo) private var streamVideo
+    @Injected(\.currentDevice) private var currentDevice
+    @Injected(\.proximityMonitor) private var proximityMonitor
+
+    /// Whether proximity monitoring is supported on the current device
+    var isSupported: Bool { currentDevice.deviceType == .phone }
+
+    /// Weak reference to the associated call
+    private weak var call: Call?
+    /// Thread-safe storage for registered proximity policies
+    @Atomic private var policies: [ObjectIdentifier: any ProximityPolicy] = [:]
+
+    /// Cancellable for active call observation
+    private var activeCallCancellable: AnyCancellable?
+    /// Cancellable for proximity state observation
+    private var observationCancellable: AnyCancellable?
+
+    /// Creates a new proximity manager for the specified call
+    /// - Parameter call: Call instance to manage proximity for
+    init(_ call: Call) {
+        self.call = call
+
+        if isSupported {
+            activeCallCancellable = streamVideo
+                .state
+                .$activeCall
+                .sinkTask { @MainActor [weak self] in self?.didUpdateActiveCall($0) }
+        }
+    }
+
+    deinit {
+        activeCallCancellable?.cancel()
+        observationCancellable?.cancel()
+    }
+
+    // MARK: - Policies
+
+    /// Adds a proximity policy to be managed by this instance
+    /// - Parameter policy: Policy to add
+    /// - Throws: ClientError if call is nil
+    func add(_ policy: any ProximityPolicy) throws {
+        guard isSupported else { return }
+
+        guard let call else {
+            throw ClientError("ProximityPolicy identifier:\(policy) cannot be attached while Call is nil.")
+        }
+        policies[type(of: policy).identifier] = policy
+        log.info("ProximityPolicy identifier:\(policy) has been attached on Call id:\(call.callId) type:\(call.callType).")
+    }
+
+    /// Removes a proximity policy from management
+    /// - Parameter policy: Policy to remove
+    func remove(_ policy: any ProximityPolicy) {
+        guard isSupported else { return }
+
+        policies[type(of: policy).identifier] = nil
+
+        guard let call else {
+            return
+        }
+        log.info("ProximityPolicy identifier:\(policy) has been removed from Call id:\(call.callId) type:\(call.callType).")
+    }
+
+    // MARK: - Private Helpers
+
+    /// Handles active call changes by starting/stopping proximity observation
+    /// - Parameter activeCall: New active call or nil if no active call
+    @MainActor
+    private func didUpdateActiveCall(_ activeCall: Call?) {
+        if
+            let activeCall,
+            call?.cId == activeCall.cId,
+            policies.isEmpty == false,
+            observationCancellable == nil {
+            proximityMonitor.startObservation()
+            observationCancellable = proximityMonitor
+                .statePublisher
+                .removeDuplicates()
+                .sink { [weak self] in self?.didUpdateProximity($0) }
+            log.info("Proximity observation has started.")
+        } else if
+            activeCall == nil,
+            observationCancellable != nil
+        {
+            observationCancellable?.cancel()
+            observationCancellable = nil
+            proximityMonitor.stopObservation()
+            log.info("Proximity observation has stopped.")
+        } else {
+            /* No-op */
+        }
+    }
+
+    /// Notifies all registered policies of a proximity state change
+    /// - Parameter proximity: New proximity state
+    private func didUpdateProximity(_ proximity: ProximityState) {
+        guard let call else {
+            return
+        }
+
+        for policy in policies {
+            policy.value.didUpdateProximity(proximity, on: call)
+        }
+    }
+}