Fix audio recordings not using AirPods automatically (#3884)

nuno-vieira · web-flow · commit 7e59297dd472 · 2025-11-28T11:02:45.000Z
* Fix audio recordings not playing from AirPods automatically

* Update CHANGELOG.md

* Fix not compiling for MacOS

* Fix doc

* Use deprecated `.allowBluetooth` so that it compiles in Xcode 15

* Add comment to explain why using deprecated case

* Fix audio recording not using AirPods automatically

* Update CHANGELOG.md

* Add missing deprecated comment
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,7 +10,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Add `CDNClient.deleteAttachment(remoteUrl:)` [#3883](https://github.com/GetStream/stream-chat-swift/pull/3883)
 - Add `heic`, `heif` and `svg` formats to the supported image file types [#3883](https://github.com/GetStream/stream-chat-swift/pull/3883)
 ### 🐞 Fixed
-- Fix rare crash in WebSocketClient.connectEndpoint [#3882](https://github.com/GetStream/stream-chat-swift/pull/3882)
+- Fix rare crash in `WebSocketClient.connectEndpoint` [#3882](https://github.com/GetStream/stream-chat-swift/pull/3882)
+- Fix audio recordings not playing from AirPods automatically [#3884](https://github.com/GetStream/stream-chat-swift/pull/3884)
+- Fix audio recordings not using AirPods mic automatically [#3884](https://github.com/GetStream/stream-chat-swift/pull/3884)
 
 ## StreamChatUI
 ### 🐞 Fixed
diff --git a/Sources/StreamChat/Audio/AudioSessionConfiguring.swift b/Sources/StreamChat/Audio/AudioSessionConfiguring.swift
@@ -68,15 +68,17 @@ open class StreamAudioSessionConfigurator: AudioSessionConfiguring {
     /// Calling this method should activate the provided `AVAudioSession` for recording and playback.
     ///
     /// - Note: This method is using the `.playAndRecord` category with the `.spokenAudio` mode.
-    /// The preferredInput will be set to `.buildInMic` and overrideOutputAudioPort to `.speaker`.
     open func activateRecordingSession() throws {
         try audioSession.setCategory(
             .playAndRecord,
             mode: .spokenAudio,
             policy: .default,
-            options: []
+            options: [
+                // It is deprecated, but for now we need to use it,
+                // since the newer ones are not available in Xcode 15.
+                .allowBluetooth
+            ]
         )
-        try setUpPreferredInput(.builtInMic)
         try activateSession()
     }
 
@@ -90,16 +92,18 @@ open class StreamAudioSessionConfigurator: AudioSessionConfiguring {
 
     /// Calling this method should activate the provided `AVAudioSession` for playback and record.
     ///
-    /// - Note: The method will check if the audioSession's category contains the `playAndRecord` capability
-    /// and if it doesn't it will activate it using the `.playbackAndRecord` category and `.default` for both mode
-    /// and policy.  OverrideOutputAudioPort is set to `.speaker`. The `record` capability is required
-    /// ensure that the output port can be set to `.speaker`.
+    /// - Note: This method uses the `.playAndRecord` category with `.default` mode and policy.
     open func activatePlaybackSession() throws {
         try audioSession.setCategory(
             .playAndRecord,
             mode: .default,
             policy: .default,
-            options: []
+            options: [
+                .defaultToSpeaker,
+                // It is deprecated, but for now we need to use it,
+                // since the newer ones are not available in Xcode 15.
+                .allowBluetooth
+            ]
         )
         try activateSession()
     }
@@ -130,12 +134,10 @@ open class StreamAudioSessionConfigurator: AudioSessionConfiguring {
     // MARK: - Helpers
 
     private func activateSession() throws {
-        try audioSession.overrideOutputAudioPort(.speaker)
         try audioSession.setActive(true, options: [])
     }
 
     private func deactivateSession() throws {
-        try audioSession.overrideOutputAudioPort(.none)
         try audioSession.setActive(false, options: [])
     }
 
@@ -161,29 +163,5 @@ open class StreamAudioSessionConfigurator: AudioSessionConfiguring {
 
         completionHandler(permissionGranted)
     }
-
-    private func setUpPreferredInput(
-        _ preferredInput: AVAudioSession.Port
-    ) throws {
-        guard
-            let availableInputs = audioSession.availableInputs,
-            let preferredInput = availableInputs.first(where: { $0.portType == preferredInput })
-        else {
-            throw AudioSessionConfiguratorError.noAvailableInputsFound()
-        }
-        try audioSession.setPreferredInput(preferredInput)
-    }
 }
 #endif
-
-// MARK: - Errors
-
-final class AudioSessionConfiguratorError: ClientError {
-    /// An unknown error occurred
-    static func noAvailableInputsFound(
-        file: StaticString = #file,
-        line: UInt = #line
-    ) -> AudioSessionConfiguratorError {
-        .init("No available audio inputs found.", file, line)
-    }
-}
diff --git a/Sources/StreamChat/Audio/AudioSessionProtocol.swift b/Sources/StreamChat/Audio/AudioSessionProtocol.swift
@@ -8,7 +8,6 @@ import AVFoundation
 /// A simple protocol that abstracts the usage of AVAudioSession
 protocol AudioSessionProtocol {
     var category: AVAudioSession.Category { get }
-    var availableInputs: [AVAudioSessionPortDescription]? { get }
 
     func setCategory(
         _ category: AVAudioSession.Category,
@@ -24,8 +23,6 @@ protocol AudioSessionProtocol {
 
     func requestRecordPermission(_ response: @escaping (Bool) -> Void)
 
-    func setPreferredInput(_ inPort: AVAudioSessionPortDescription?) throws
-
     func overrideOutputAudioPort(_ portOverride: AVAudioSession.PortOverride) throws
 }
 
diff --git a/Tests/StreamChatTests/Audio/StreamAudioSessionConfigurator_Tests.swift b/Tests/StreamChatTests/Audio/StreamAudioSessionConfigurator_Tests.swift
@@ -23,60 +23,24 @@ final class StreamAudioSessionConfigurator_Tests: XCTestCase {
 
     func test_activateRecordingSession_setCategoryFailedToComplete() {
         stubAudioSession.stubProperty(\.category, with: .soloAmbient)
-        stubAudioSession.stubProperty(\.availableInputs, with: [makeAvailableInput(with: .builtInMic)])
         stubAudioSession.setCategoryResult = .failure(genericError)
 
         XCTAssertThrowsError(try subject.activateRecordingSession(), genericError)
     }
 
     func test_activateRecordingSession_setCategoryCompletedSuccessfully() throws {
         stubAudioSession.stubProperty(\.category, with: .soloAmbient)
-        stubAudioSession.stubProperty(\.availableInputs, with: [makeAvailableInput(with: .builtInMic)])
 
         try subject.activateRecordingSession()
 
         XCTAssertEqual(stubAudioSession.setCategoryWasCalledWithCategory, .playAndRecord)
         XCTAssertEqual(stubAudioSession.setCategoryWasCalledWithMode, .spokenAudio)
         XCTAssertEqual(stubAudioSession.setCategoryWasCalledWithPolicy, .default)
-        XCTAssertEqual(stubAudioSession.setCategoryWasCalledWithOptions, [])
-    }
-
-    func test_activateRecordingSession_setUpPreferredInputFailedToCompleteDueToNoAvailableInput() {
-        stubAudioSession.stubProperty(\.category, with: .soloAmbient)
-        stubAudioSession.stubProperty(\.availableInputs, with: [])
-
-        XCTAssertThrowsError(try subject.activateRecordingSession()) { error in
-            XCTAssertEqual("No available audio inputs found.", (error as? AudioSessionConfiguratorError)?.message)
-        }
-    }
-
-    func test_activateRecordingSession_setUpPreferredInputCompletedSuccessfully() throws {
-        stubAudioSession.stubProperty(\.category, with: .soloAmbient)
-        stubAudioSession.stubProperty(\.availableInputs, with: [makeAvailableInput(with: .builtInMic)])
-
-        try subject.activateRecordingSession()
-    }
-
-    func test_activateRecordingSession_setOverrideOutputFailed() {
-        stubAudioSession.stubProperty(\.category, with: .soloAmbient)
-        stubAudioSession.stubProperty(\.availableInputs, with: [makeAvailableInput(with: .builtInMic)])
-        stubAudioSession.overrideOutputAudioPortResult = .failure(genericError)
-
-        XCTAssertThrowsError(try subject.activateRecordingSession(), genericError)
-        XCTAssertEqual(stubAudioSession.overrideOutputAudioPortWasCalledWithPortOverride, .speaker)
-    }
-
-    func test_activateRecordingSession_setOverrideOutputCompletedSuccessfully() throws {
-        stubAudioSession.stubProperty(\.category, with: .soloAmbient)
-        stubAudioSession.stubProperty(\.availableInputs, with: [makeAvailableInput(with: .builtInMic)])
-
-        try subject.activateRecordingSession()
-        XCTAssertEqual(stubAudioSession.overrideOutputAudioPortWasCalledWithPortOverride, .speaker)
+        XCTAssertEqual(stubAudioSession.setCategoryWasCalledWithOptions, [.allowBluetooth])
     }
 
     func test_activateRecordingSession_setActiveFailed() {
         stubAudioSession.stubProperty(\.category, with: .soloAmbient)
-        stubAudioSession.stubProperty(\.availableInputs, with: [makeAvailableInput(with: .builtInMic)])
         stubAudioSession.setActiveResult = .failure(genericError)
 
         XCTAssertThrowsError(try subject.activateRecordingSession(), genericError)
@@ -85,30 +49,13 @@ final class StreamAudioSessionConfigurator_Tests: XCTestCase {
 
     func test_activateRecordingSession_setActiveCompletedSuccessfully() throws {
         stubAudioSession.stubProperty(\.category, with: .soloAmbient)
-        stubAudioSession.stubProperty(\.availableInputs, with: [makeAvailableInput(with: .builtInMic)])
 
         try subject.activateRecordingSession()
         XCTAssertTrue(stubAudioSession.setActiveWasCalledWithActive ?? false)
     }
 
     // MARK: - deactivateRecordingSession
 
-    func test_deactivateRecordingSession_categoryIsRecord_setOverrideOutputFailed() {
-        stubAudioSession.stubProperty(\.category, with: .record)
-        stubAudioSession.overrideOutputAudioPortResult = .failure(genericError)
-
-        XCTAssertThrowsError(try subject.deactivateRecordingSession(), genericError)
-        XCTAssertEqual(stubAudioSession.overrideOutputAudioPortWasCalledWithPortOverride, AVAudioSession.PortOverride.none)
-    }
-
-    func test_deactivateRecordingSession_categoryIsRecord_setOverrideOutputCompletedSuccessfully() throws {
-        stubAudioSession.stubProperty(\.category, with: .record)
-
-        try subject.deactivateRecordingSession()
-
-        XCTAssertEqual(stubAudioSession.overrideOutputAudioPortWasCalledWithPortOverride, AVAudioSession.PortOverride.none)
-    }
-
     func test_deactivateRecordingSession_categoryIsRecord_setActiveCompletedSuccesfully() throws {
         stubAudioSession.stubProperty(\.category, with: .record)
 
@@ -141,22 +88,6 @@ final class StreamAudioSessionConfigurator_Tests: XCTestCase {
         XCTAssertFalse(stubAudioSession.setActiveWasCalledWithActive ?? true)
     }
 
-    func test_deactivateRecordingSession_categoryIsPlayAndRecord_setOverrideOutputFailed() {
-        stubAudioSession.stubProperty(\.category, with: .playAndRecord)
-        stubAudioSession.overrideOutputAudioPortResult = .failure(genericError)
-
-        XCTAssertThrowsError(try subject.deactivateRecordingSession(), genericError)
-        XCTAssertEqual(stubAudioSession.overrideOutputAudioPortWasCalledWithPortOverride, AVAudioSession.PortOverride.none)
-    }
-
-    func test_deactivateRecordingSession_categoryIsPlayAndRecord_setOverrideOutputCompletedSuccessfully() throws {
-        stubAudioSession.stubProperty(\.category, with: .playAndRecord)
-
-        try subject.deactivateRecordingSession()
-
-        XCTAssertEqual(stubAudioSession.overrideOutputAudioPortWasCalledWithPortOverride, AVAudioSession.PortOverride.none)
-    }
-
     // MARK: - activatePlaybackSession
 
     func test_activatePlaybackSession_setCategoryFailedToComplete() {
@@ -174,23 +105,7 @@ final class StreamAudioSessionConfigurator_Tests: XCTestCase {
         XCTAssertEqual(stubAudioSession.setCategoryWasCalledWithCategory, .playAndRecord)
         XCTAssertEqual(stubAudioSession.setCategoryWasCalledWithMode, .default)
         XCTAssertEqual(stubAudioSession.setCategoryWasCalledWithPolicy, .default)
-        XCTAssertEqual(stubAudioSession.setCategoryWasCalledWithOptions, [])
-    }
-
-    func test_activatePlaybackSession_setOverrideOutputFailed() {
-        stubAudioSession.stubProperty(\.category, with: .soloAmbient)
-        stubAudioSession.overrideOutputAudioPortResult = .failure(genericError)
-
-        XCTAssertThrowsError(try subject.activatePlaybackSession(), genericError)
-        XCTAssertEqual(stubAudioSession.overrideOutputAudioPortWasCalledWithPortOverride, .speaker)
-    }
-
-    func test_activatePlaybackSession_setOverrideOutputCompletedSuccessfully() throws {
-        stubAudioSession.stubProperty(\.category, with: .soloAmbient)
-
-        try subject.activatePlaybackSession()
-
-        XCTAssertEqual(stubAudioSession.overrideOutputAudioPortWasCalledWithPortOverride, .speaker)
+        XCTAssertEqual(stubAudioSession.setCategoryWasCalledWithOptions, [.defaultToSpeaker, .allowBluetooth])
     }
 
     func test_activatePlaybackSession_setActiveFailed() {
@@ -226,22 +141,6 @@ final class StreamAudioSessionConfigurator_Tests: XCTestCase {
         XCTAssertFalse(stubAudioSession.setActiveWasCalledWithActive ?? true)
     }
 
-    func test_deactivatePlaybackSession_categoryIsPlayback_setOverrideOutputFailed() {
-        stubAudioSession.stubProperty(\.category, with: .playAndRecord)
-        stubAudioSession.overrideOutputAudioPortResult = .failure(genericError)
-
-        XCTAssertThrowsError(try subject.deactivatePlaybackSession(), genericError)
-        XCTAssertEqual(stubAudioSession.overrideOutputAudioPortWasCalledWithPortOverride, AVAudioSession.PortOverride.none)
-    }
-
-    func test_deactivatePlaybackSession_categoryIsPlayback_setOverrideOutputCompletedSuccessfully() throws {
-        stubAudioSession.stubProperty(\.category, with: .playAndRecord)
-
-        try subject.deactivatePlaybackSession()
-
-        XCTAssertEqual(stubAudioSession.overrideOutputAudioPortWasCalledWithPortOverride, AVAudioSession.PortOverride.none)
-    }
-
     func test_deactivatePlaybackSession_categoryIsPlayAndRecord_setActiveCompletedSuccesfully() throws {
         stubAudioSession.stubProperty(\.category, with: .playAndRecord)
 
@@ -265,24 +164,13 @@ final class StreamAudioSessionConfigurator_Tests: XCTestCase {
 
         XCTAssertNotNil(stubAudioSession.requestRecordPermissionWasCalledWithResponse)
     }
-
-    // MARK: - Private Helpers
-
-    private func makeAvailableInput(
-        with portType: AVAudioSession.Port
-    ) -> AVAudioSessionPortDescription {
-        let result = StubAVAudioSessionPortDescription()
-        result.stubProperty(\.portType, with: portType)
-        return result
-    }
 }
 
 @dynamicMemberLookup
 private final class StubAVAudioSession: AudioSessionProtocol, Stub {
     var stubbedProperties: [String: Any] = [:]
 
     @objc var category: AVAudioSession.Category { self[dynamicMember: \.category] }
-    @objc var availableInputs: [AVAudioSessionPortDescription]? { self[dynamicMember: \.availableInputs] }
 
     private(set) var setCategoryWasCalledWithCategory: AVAudioSession.Category?
     private(set) var setCategoryWasCalledWithMode: AVAudioSession.Mode?
@@ -296,9 +184,6 @@ private final class StubAVAudioSession: AudioSessionProtocol, Stub {
     private(set) var requestRecordPermissionWasCalledWithResponse: ((Bool) -> Void)?
     var requestRecordPermissionResult: Bool = false
 
-    private(set) var setPreferredInputWasCalledWithInPort: AVAudioSessionPortDescription?
-    var setPreferredInputResult: Result<Void, Error> = .success(())
-
     private(set) var overrideOutputAudioPortWasCalledWithPortOverride: AVAudioSession.PortOverride?
     var overrideOutputAudioPortResult: Result<Void, Error> = .success(())
 
@@ -340,17 +225,6 @@ private final class StubAVAudioSession: AudioSessionProtocol, Stub {
         response(requestRecordPermissionResult)
     }
 
-    func setPreferredInput(_ inPort: AVAudioSessionPortDescription?) throws {
-        setPreferredInputWasCalledWithInPort = inPort
-
-        switch setCategoryResult {
-        case .success:
-            break
-        case let .failure(error):
-            throw error
-        }
-    }
-
     func overrideOutputAudioPort(_ portOverride: AVAudioSession.PortOverride) throws {
         overrideOutputAudioPortWasCalledWithPortOverride = portOverride
         switch overrideOutputAudioPortResult {
@@ -361,10 +235,3 @@ private final class StubAVAudioSession: AudioSessionProtocol, Stub {
         }
     }
 }
-
-@dynamicMemberLookup
-private final class StubAVAudioSessionPortDescription: AVAudioSessionPortDescription, Stub, @unchecked Sendable {
-    var stubbedProperties: [String: Any] = [:]
-
-    override var portType: AVAudioSession.Port { self[dynamicMember: \.portType] }
-}
