Improve the routeChange reporting

Author: ipavlidakis

Sources/StreamVideo/Utils/AudioSession/CallAudioSession.swift

@@ -148,10 +148,7 @@ final class CallAudioSession: @unchecked Sendable {
         audioStore
             .publisher(\.currentRoute)
             .removeDuplicates()
-            // We want to start listening on route changes **once** we have
-            // expressed our initial preference.
-            .drop { [weak self] _ in self?.lastCallSettings == nil }
-            .throttle(for: 0.5, scheduler: processingQueue, latest: true)
+            .debounce(for: .milliseconds(500), scheduler: processingQueue)
             .receive(on: processingQueue)
             .sink { [weak self] in
                 guard let self, let lastCallSettings, let lastOwnCapabilities else { return }

Sources/StreamVideo/Utils/AudioSession/Extensions/AVAudioSession.RouteChangeReason+Convenience.swift

@@ -0,0 +1,21 @@
+//
+// Copyright © 2025 Stream.io Inc. All rights reserved.
+//
+
+import AVFoundation
+import Foundation
+
+extension AVAudioSession.RouteChangeReason {
+
+    /// Taken from https://chromium.googlesource.com/external/webrtc/+/34911ad55c4c4c549fe60e1b4cc127420b15666b/webrtc/modules/audio_device/ios/audio_device_ios.mm#557
+    /// in the routeChange logic. Useful to ignore route changes that don't really matter for our
+    /// webrtc sessions.
+    var isValidRouteChange: Bool {
+        switch self {
+        case .categoryChange, .routeConfigurationChange:
+            return false
+        default:
+            return true
+        }
+    }
+}

Sources/StreamVideo/Utils/AudioSession/RTCAudioStore/Namespace/Effects/RTCAudioStore+RouteChangeEffect.swift

@@ -28,7 +28,7 @@ extension RTCAudioStore {
             cancellable = audioSessionObserver
                 .publisher
                 .compactMap {
-                    if case let .didChangeRoute(reason, from, to) = $0 {
+                    if case let .didChangeRoute(reason, from, to) = $0, reason.isValidRouteChange {
                         return (
                             reason,
                             RTCAudioStore.StoreState.AudioRoute(from),

StreamVideo.xcodeproj/project.pbxproj

@@ -873,6 +873,7 @@
 		40E9B3B32BCD93AE00ACF18F /* JoinCallResponse+Dummy.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40E9B3B22BCD93AE00ACF18F /* JoinCallResponse+Dummy.swift */; };
 		40E9B3B52BCD93F500ACF18F /* Credentials+Dummy.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40E9B3B42BCD93F500ACF18F /* Credentials+Dummy.swift */; };
 		40E9B3B72BCD941600ACF18F /* SFUResponse+Dummy.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40E9B3B62BCD941600ACF18F /* SFUResponse+Dummy.swift */; };
+		40ED20E92EC64B78004FF2F0 /* AVAudioSession.RouteChangeReason+Convenience.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40ED20E82EC64B78004FF2F0 /* AVAudioSession.RouteChangeReason+Convenience.swift */; };
 		40ED6D4B2B14F0E600FB5F69 /* Launch Screen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 40ED6D4A2B14F0E600FB5F69 /* Launch Screen.storyboard */; };
 		40EDA17C2C13792D00583A65 /* View+AlertWithTextField.swift in Sources */ = {isa = PBXBuildFile; fileRef = 408937902C134305000EEB69 /* View+AlertWithTextField.swift */; };
 		40EE9D2B2E969F010000EA92 /* AudioDeviceModule.swift in Sources */ = {isa = PBXBuildFile; fileRef = 40EE9D282E969F010000EA92 /* AudioDeviceModule.swift */; };
@@ -2528,6 +2529,7 @@
 		40E9B3B22BCD93AE00ACF18F /* JoinCallResponse+Dummy.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "JoinCallResponse+Dummy.swift"; sourceTree = "<group>"; };
 		40E9B3B42BCD93F500ACF18F /* Credentials+Dummy.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Credentials+Dummy.swift"; sourceTree = "<group>"; };
 		40E9B3B62BCD941600ACF18F /* SFUResponse+Dummy.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "SFUResponse+Dummy.swift"; sourceTree = "<group>"; };
+		40ED20E82EC64B78004FF2F0 /* AVAudioSession.RouteChangeReason+Convenience.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "AVAudioSession.RouteChangeReason+Convenience.swift"; sourceTree = "<group>"; };
 		40ED6D4A2B14F0E600FB5F69 /* Launch Screen.storyboard */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; path = "Launch Screen.storyboard"; sourceTree = "<group>"; };
 		40EE9D282E969F010000EA92 /* AudioDeviceModule.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AudioDeviceModule.swift; sourceTree = "<group>"; };
 		40EE9D292E969F010000EA92 /* AudioEngineLevelNodeAdapter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AudioEngineLevelNodeAdapter.swift; sourceTree = "<group>"; };
@@ -4310,6 +4312,7 @@
 		4067F3092CDA330E002E28BD /* Extensions */ = {
 			isa = PBXGroup;
 			children = (
+				40ED20E82EC64B78004FF2F0 /* AVAudioSession.RouteChangeReason+Convenience.swift */,
 				4067F3122CDA33C4002E28BD /* AVAudioSession.CategoryOptions+Convenience.swift */,
 				4067F30E2CDA3394002E28BD /* AVAudioSessionCategoryOptions+Convenience.swift */,
 				4067F30C2CDA3377002E28BD /* AVAudioSessionRouteChangeReason+Convenience.swift */,
@@ -8530,6 +8533,7 @@
 				4029E94E2CB8162900E1D571 /* IncomingVideoQualitySettings.swift in Sources */,
 				40AAD1802D27FC5E00D10330 /* RTCPeerConnectionTrackInfoCollectionType.swift in Sources */,
 				846D16242A52C3D50036CE4C /* CameraManager.swift in Sources */,
+				40ED20E92EC64B78004FF2F0 /* AVAudioSession.RouteChangeReason+Convenience.swift in Sources */,
 				848CCCE52AB8ED8F002E83A2 /* StopHLSBroadcastingResponse.swift in Sources */,
 				84F07BD12CB4804900422E58 /* NoiseCancellationSettingsRequest.swift in Sources */,
 				84DC389729ADFCFD00946713 /* StopLiveResponse.swift in Sources */,