[Enhancement]Implement proximity policies #770

ipavlidakis · 2025-04-24T08:54:21Z

🔗 Issue Links

Resolves https://linear.app/stream/issue/IOS-827/[feature-request]proximity-for-calls

🎯 Goal

Provide proximity based operations during a call.

🛠 Implementation

We introduce a new protocol ProximityPolicy that can be used to define what will happen when the device's proximity change during a call. You can attach ProximityPolicy instances on any Call object.

Out of the box, the SDK ships with the following ProximityPolicy implementations:

SpeakerProximityPolicy: If speaker is enabled when proximity changes to near the policy will switch to earpiece. It will then restore speaker when proximity changes to far.
VideoProximityPolicy: The policy disables all video (remote and local) when proximity changes to near and restores everything back when proximity changes to far.

☑️ Contributor Checklist

I have signed the Stream CLA (required)
This change follows zero ⚠️ policy (required)
This change should receive manual QA
Changelog is updated with client-facing changes
New code is covered by unit tests
Comparison screenshots added for visual changes
Affected documentation updated (tutorial, CMS)

Stream-SDK-Bot · 2025-04-24T09:05:12Z

SDK Size

`title`	`develop`	`branch`	`diff`	`status`
StreamVideo	7.48 MB	7.52 MB	+41 KB	🟢
StreamVideoSwiftUI	2.25 MB	2.25 MB	0 KB	🟢
StreamVideoUIKit	2.37 MB	2.37 MB	0 KB	🟢
StreamWebRTC	9.85 MB	9.85 MB	0 KB	🟢

github-actions · 2025-04-24T09:06:49Z

Public Interface

+ public final class SpeakerProximityPolicy: ProximityPolicy, Hashable, @unchecked Sendable  
+ 
+   public let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public static func ==(lhs: SpeakerProximityPolicy,rhs: SpeakerProximityPolicy)-> Bool
+   public func hash(into hasher: inout Hasher)
+   public func attach(on call: Call)
+   public func detach()

+ public final class VideoProximityPolicy: ProximityPolicy, Hashable, @unchecked Sendable  
+ 
+   public let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public static func ==(lhs: VideoProximityPolicy,rhs: VideoProximityPolicy)-> Bool
+   public func hash(into hasher: inout Hasher)
+   public func attach(on call: Call)
+   public func detach()

+ public enum ProximityState: Hashable, Sendable  
+ 
+   case near, far

+ public protocol ProximityPolicy: Sendable, Hashable



 public class Call: @unchecked Sendable, WSEventsSubscriber  
-   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws
+   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws 
+   public func addProximityPolicy(_ policy: any ProximityPolicy)
+   public func removeProximityPolicy(_ policy: any ProximityPolicy)

 public final class CurrentDevice: @unchecked Sendable  
-   
+   @MainActor public var isProximityMonitoringEnabled: Bool
- 
+   
-   public enum DeviceType: Sendable  
+ 
-   
+   public enum DeviceType: Sendable  
-     case unspecified
+   
-     case phone
+     case unspecified
-     case pad
+     case phone
-     case tv
+     case pad
-     case carPlay
+     case tv
-     case mac
+     case carPlay
-     case vision
+     case mac
+     case vision

github-actions · 2025-04-24T09:06:52Z

	1 Warning
⚠️	Big PR

Generated by 🚫 Danger

github-actions · 2025-04-24T10:35:59Z

Public Interface

+ public final class SpeakerProximityPolicy: ProximityPolicy, Hashable, @unchecked Sendable  
+ 
+   public let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public static func ==(lhs: SpeakerProximityPolicy,rhs: SpeakerProximityPolicy)-> Bool
+   public func hash(into hasher: inout Hasher)
+   public func attach(on call: Call)
+   public func detach()

+ public enum ProximityState: Hashable, Sendable  
+ 
+   case near, far

+ public final class VideoProximityPolicy: ProximityPolicy, Hashable, @unchecked Sendable  
+ 
+   public let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public static func ==(lhs: VideoProximityPolicy,rhs: VideoProximityPolicy)-> Bool
+   public func hash(into hasher: inout Hasher)
+   public func attach(on call: Call)
+   public func detach()

+ extension ProximityMonitor: InjectionKey  
+ 
+   nonisolated public static var currentValue: ProximityMonitor

+ public final class ProximityMonitor: ObservableObject, @unchecked Sendable  
+ 
+   @MainActor public func startObservation()
+   public func stopObservation()

+ public protocol ProximityPolicy: Sendable, Hashable



 public final class CurrentDevice: @unchecked Sendable  
-   
+   @MainActor public var isProximityMonitoringEnabled: Bool
- 
+   
-   public enum DeviceType: Sendable  
+ 
-   
+   public enum DeviceType: Sendable  
-     case unspecified
+   
-     case phone
+     case unspecified
-     case pad
+     case phone
-     case tv
+     case pad
-     case carPlay
+     case tv
-     case mac
+     case carPlay
-     case vision
+     case mac
+     case vision

 public class Call: @unchecked Sendable, WSEventsSubscriber  
-   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws
+   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws 
+   public func addProximityPolicy(_ policy: any ProximityPolicy)
+   public func removeProximityPolicy(_ policy: any ProximityPolicy)

github-actions · 2025-04-25T10:23:12Z

Public Interface

+ public final class SpeakerProximityPolicy: ProximityPolicy, @unchecked Sendable  
+ 
+   public static let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public func didUpdateProximity(_ proximity: ProximityState,on call: Call)

+ public final class VideoProximityPolicy: ProximityPolicy, @unchecked Sendable  
+ 
+   public static let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public func didUpdateProximity(_ proximity: ProximityState,on call: Call)

+ public protocol ProximityPolicy: Sendable, CustomStringConvertible

+ public final class ProximityMonitor: ObservableObject, @unchecked Sendable  
+ 
+   @MainActor public func startObservation()
+   public func stopObservation()

+ extension ProximityPolicy  
+ 
+   public var description: String

+ public enum ProximityState: Hashable, Sendable  
+ 
+   case near, far

+ extension ProximityMonitor: InjectionKey  
+ 
+   nonisolated public static var currentValue: ProximityMonitor



 public class Call: @unchecked Sendable, WSEventsSubscriber  
-   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws
+   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws 
+   public func addProximityPolicy(_ policy: any ProximityPolicy)throws 
+   public func removeProximityPolicy(_ policy: any ProximityPolicy)

 public final class CurrentDevice: @unchecked Sendable  
-   
+   @MainActor public var isProximityMonitoringEnabled: Bool
- 
+   
-   public enum DeviceType: Sendable  
+ 
-   
+   public enum DeviceType: Sendable  
-     case unspecified
+   
-     case phone
+     case unspecified
-     case pad
+     case phone
-     case tv
+     case pad
-     case carPlay
+     case tv
-     case mac
+     case carPlay
-     case vision
+     case mac
+     case vision

github-actions · 2025-04-25T14:59:01Z

Public Interface

+ public enum ProximityState: Hashable, Sendable  
+ 
+   case near
+   case far

+ public protocol ProximityProviding

+ public final class VideoProximityPolicy: ProximityPolicy, @unchecked Sendable  
+ 
+   public static let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public func didUpdateProximity(_ proximity: ProximityState,on call: Call)

+ public final class SpeakerProximityPolicy: ProximityPolicy, @unchecked Sendable  
+ 
+   public static let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public func didUpdateProximity(_ proximity: ProximityState,on call: Call)

+ public protocol ProximityPolicy: Sendable, CustomStringConvertible

+ extension ProximityPolicy  
+ 
+   public var description: String



 public final class CurrentDevice: @unchecked Sendable  
-   
+   @MainActor public var isProximityMonitoringEnabled: Bool
- 
+   
-   public enum DeviceType: Sendable  
+ 
-   
+   public enum DeviceType: Sendable  
-     case unspecified
+   
-     case phone
+     case unspecified
-     case pad
+     case phone
-     case tv
+     case pad
-     case carPlay
+     case tv
-     case mac
+     case carPlay
-     case vision
+     case mac
+     case vision

 public class Call: @unchecked Sendable, WSEventsSubscriber  
-   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws
+   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws 
+   public func addProximityPolicy(_ policy: any ProximityPolicy)throws 
+   public func removeProximityPolicy(_ policy: any ProximityPolicy)

github-actions · 2025-04-29T11:23:57Z

Public Interface

+ public enum ProximityState: Hashable, Sendable  
+ 
+   case near
+   case far

+ extension ProximityPolicy  
+ 
+   public var description: String

+ public protocol ProximityProviding

+ public final class SpeakerProximityPolicy: ProximityPolicy, @unchecked Sendable  
+ 
+   public static let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public func didUpdateProximity(_ proximity: ProximityState,on call: Call)

+ public protocol ProximityPolicy: Sendable, CustomStringConvertible

+ public final class VideoProximityPolicy: ProximityPolicy, @unchecked Sendable  
+ 
+   public static let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public func didUpdateProximity(_ proximity: ProximityState,on call: Call)



 public class Call: @unchecked Sendable, WSEventsSubscriber  
-   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws
+   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws 
+   public func addProximityPolicy(_ policy: any ProximityPolicy)throws 
+   public func removeProximityPolicy(_ policy: any ProximityPolicy)

 public final class CurrentDevice: @unchecked Sendable  
-   
+   @MainActor public var isProximityMonitoringEnabled: Bool
- 
+   
-   public enum DeviceType: Sendable  
+ 
-   
+   public enum DeviceType: Sendable  
-     case unspecified
+   
-     case phone
+     case unspecified
-     case pad
+     case phone
-     case tv
+     case pad
-     case carPlay
+     case tv
-     case mac
+     case carPlay
-     case vision
+     case mac
+     case vision

github-actions · 2025-04-29T16:33:13Z

Public Interface

+ public protocol ProximityProviding

+ public final class VideoProximityPolicy: ProximityPolicy, @unchecked Sendable  
+ 
+   public static let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public func didUpdateProximity(_ proximity: ProximityState,on call: Call)

+ extension ProximityPolicy  
+ 
+   public var description: String

+ public enum ProximityState: Hashable, Sendable  
+ 
+   case near
+   case far

+ public protocol ProximityPolicy: Sendable, CustomStringConvertible

+ public final class SpeakerProximityPolicy: ProximityPolicy, @unchecked Sendable  
+ 
+   public static let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public func didUpdateProximity(_ proximity: ProximityState,on call: Call)



 public final class CurrentDevice: @unchecked Sendable  
-   
+   @MainActor public var isProximityMonitoringEnabled: Bool
- 
+   
-   public enum DeviceType: Sendable  
+ 
-   
+   public enum DeviceType: Sendable  
-     case unspecified
+   
-     case phone
+     case unspecified
-     case pad
+     case phone
-     case tv
+     case pad
-     case carPlay
+     case tv
-     case mac
+     case carPlay
-     case vision
+     case mac
+     case vision

 public class Call: @unchecked Sendable, WSEventsSubscriber  
-   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws
+   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws 
+   public func addProximityPolicy(_ policy: any ProximityPolicy)throws 
+   public func removeProximityPolicy(_ policy: any ProximityPolicy)

github-actions · 2025-04-29T18:47:54Z

Public Interface

+ public enum ProximityState: Hashable, Sendable  
+ 
+   case near
+   case far

+ public final class SpeakerProximityPolicy: ProximityPolicy, @unchecked Sendable  
+ 
+   public static let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public func didUpdateProximity(_ proximity: ProximityState,on call: Call)

+ extension ProximityPolicy  
+ 
+   public var description: String

+ public protocol ProximityPolicy: Sendable, CustomStringConvertible

+ public protocol ProximityProviding

+ public final class VideoProximityPolicy: ProximityPolicy, @unchecked Sendable  
+ 
+   public static let identifier: ObjectIdentifier
+   
+ 
+   public init()
+   
+ 
+   public func didUpdateProximity(_ proximity: ProximityState,on call: Call)



 public final class CurrentDevice: @unchecked Sendable  
-   
+   @MainActor public var isProximityMonitoringEnabled: Bool
- 
+   
-   public enum DeviceType: Sendable  
+ 
-   
+   public enum DeviceType: Sendable  
-     case unspecified
+   
-     case phone
+     case unspecified
-     case pad
+     case phone
-     case tv
+     case pad
-     case carPlay
+     case tv
-     case mac
+     case carPlay
-     case vision
+     case mac
+     case vision

 public class Call: @unchecked Sendable, WSEventsSubscriber  
-   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws
+   public func updateAudioSessionPolicy(_ policy: AudioSessionPolicy)async throws 
+   public func addProximityPolicy(_ policy: any ProximityPolicy)throws 
+   public func removeProximityPolicy(_ policy: any ProximityPolicy)

sonarqubecloud · 2025-04-29T19:06:48Z

Quality Gate passed

Issues
5 New issues
0 Accepted issues

Measures
0 Security Hotspots
81.9% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

martinmitrevski

Nice addition! Just one question (see comments). Additionally, we should add some docs about this.

martinmitrevski · 2025-04-30T08:09:03Z

Sources/StreamVideoSwiftUI/CallViewModel.swift

@@ -108,7 +108,6 @@ open class CallViewModel: ObservableObject {
    @Published public private(set) var callParticipants = [String: CallParticipant]() {
        didSet {
            updateCallStateIfNeeded()
-            checkCallSettingsForCurrentUser()


I believe we had this for cases where an admin mutes you remotely. Do you think this might break it?

ipavlidakis added the enhancement New feature or request label Apr 24, 2025

ipavlidakis self-assigned this Apr 24, 2025

ipavlidakis force-pushed the enhancement/implement-proximity-audio-output-switch branch from 5c803ab to 1a8a4d4 Compare April 25, 2025 10:09

ipavlidakis force-pushed the enhancement/implement-proximity-audio-output-switch branch from dafcec1 to feacae7 Compare April 25, 2025 14:54

ipavlidakis marked this pull request as ready for review April 25, 2025 14:59

ipavlidakis requested a review from a team as a code owner April 25, 2025 14:59

ipavlidakis force-pushed the enhancement/implement-proximity-audio-output-switch branch from feacae7 to 49130f2 Compare April 29, 2025 11:22

ipavlidakis force-pushed the enhancement/implement-proximity-audio-output-switch branch from 49130f2 to 3ef6705 Compare April 29, 2025 16:31

ipavlidakis added 4 commits April 29, 2025 18:25

[Enhancement]Implement proximity handling for AudioSession

820cfe6

DemoApp integration

20c3432

Fix flakey tests

cbbfe44

Improve logic

8127e8a

ipavlidakis force-pushed the enhancement/implement-proximity-audio-output-switch branch from 3ef6705 to 8127e8a Compare April 29, 2025 18:46

martinmitrevski reviewed Apr 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Enhancement]Implement proximity policies #770

[Enhancement]Implement proximity policies #770

ipavlidakis commented Apr 24, 2025 •

edited

Loading

Stream-SDK-Bot commented Apr 24, 2025 •

edited

Loading

github-actions bot commented Apr 24, 2025

github-actions bot commented Apr 24, 2025 •

edited

Loading

github-actions bot commented Apr 24, 2025

github-actions bot commented Apr 25, 2025

github-actions bot commented Apr 25, 2025

github-actions bot commented Apr 29, 2025

github-actions bot commented Apr 29, 2025

github-actions bot commented Apr 29, 2025

sonarqubecloud bot commented Apr 29, 2025

martinmitrevski left a comment

martinmitrevski Apr 30, 2025

[Enhancement]Implement proximity policies #770

Are you sure you want to change the base?

[Enhancement]Implement proximity policies #770

Conversation

ipavlidakis commented Apr 24, 2025 • edited Loading

🔗 Issue Links

🎯 Goal

🛠 Implementation

☑️ Contributor Checklist

Stream-SDK-Bot commented Apr 24, 2025 • edited Loading

SDK Size

github-actions bot commented Apr 24, 2025

Public Interface

github-actions bot commented Apr 24, 2025 • edited Loading

github-actions bot commented Apr 24, 2025

Public Interface

github-actions bot commented Apr 25, 2025

Public Interface

github-actions bot commented Apr 25, 2025

Public Interface

github-actions bot commented Apr 29, 2025

Public Interface

github-actions bot commented Apr 29, 2025

Public Interface

github-actions bot commented Apr 29, 2025

Public Interface

sonarqubecloud bot commented Apr 29, 2025

Quality Gate passed

martinmitrevski left a comment

Choose a reason for hiding this comment

martinmitrevski Apr 30, 2025

Choose a reason for hiding this comment

ipavlidakis commented Apr 24, 2025 •

edited

Loading

Stream-SDK-Bot commented Apr 24, 2025 •

edited

Loading

github-actions bot commented Apr 24, 2025 •

edited

Loading