Implement handling for audioOutputOn

Author: ipavlidakis

DemoApp/Sources/ViewModifiers/MoreControls/DemoMoreControlsViewModifier.swift

@@ -52,6 +52,17 @@ struct DemoMoreControlsViewModifier: ViewModifier {
                                 )
                             }
 
+                            DemoMoreControlListButtonView(
+                                action: { viewModel.toggleAudioOutput() },
+                                label: viewModel.callSettings.audioOutputOn ? "Disable audio output" : "Enable audio output"
+                            ) {
+                                Image(
+                                    systemName: viewModel.callSettings.audioOutputOn
+                                        ? "speaker.fill"
+                                        : "speaker.slash"
+                                )
+                            }
+
                             DemoTranscriptionAndClosedCaptionsButtonView(viewModel: viewModel)
 
                             DemoMoreThermalStateButtonView()

Sources/StreamVideo/Utils/AudioSession/AudioSessionConfiguration.swift

@@ -6,6 +6,7 @@ import AVFoundation
 
 /// Represents the audio session configuration.
 public struct AudioSessionConfiguration: ReflectiveStringConvertible, Equatable, Sendable {
+    var isActive: Bool
     /// The audio session category.
     var category: AVAudioSession.Category
     /// The audio session mode.
@@ -17,7 +18,8 @@ public struct AudioSessionConfiguration: ReflectiveStringConvertible, Equatable,
 
     /// Compares two `AudioSessionConfiguration` instances for equality.
     public static func == (lhs: Self, rhs: Self) -> Bool {
-        lhs.category == rhs.category &&
+        lhs.isActive == rhs.isActive &&
+            lhs.category == rhs.category &&
             lhs.mode == rhs.mode &&
             lhs.options.rawValue == rhs.options.rawValue &&
             lhs.overrideOutputAudioPort?.rawValue ==

Sources/StreamVideo/Utils/AudioSession/CallAudioSession.swift

@@ -129,15 +129,17 @@ final class CallAudioSession: @unchecked Sendable, Encodable {
         }
 
         do {
-            try await audioStore.dispatchAsync(
-                .audioSession(
-                    .setCategory(
-                        configuration.category,
-                        mode: configuration.mode,
-                        options: configuration.options
+            if configuration.isActive {
+                try await audioStore.dispatchAsync(
+                    .audioSession(
+                        .setCategory(
+                            configuration.category,
+                            mode: configuration.mode,
+                            options: configuration.options
+                        )
                     )
                 )
-            )
+            }
         } catch {
             log.error(
                 "Unable to apply configuration category:\(configuration.category) mode:\(configuration.mode) options:\(configuration.options).",
@@ -146,7 +148,7 @@ final class CallAudioSession: @unchecked Sendable, Encodable {
             )
         }
 
-        if let overrideOutputAudioPort = configuration.overrideOutputAudioPort {
+        if configuration.isActive, let overrideOutputAudioPort = configuration.overrideOutputAudioPort {
             do {
                 try await audioStore.dispatchAsync(
                     .audioSession(
@@ -161,10 +163,81 @@ final class CallAudioSession: @unchecked Sendable, Encodable {
                 )
             }
         }
+        
+        await handleAudioOutputUpdateIfRequired(configuration)
 
         statsAdapter?.trace(.init(audioSession: self))
     }
 
+    private func handleAudioOutputUpdateIfRequired(
+        _ configuration: AudioSessionConfiguration
+    ) async {
+        guard
+            configuration.isActive != audioStore.state.isActive
+        else {
+            return
+        }
+        do {
+            /// In the case where audioOutputOn has changed the order of actions matters
+            /// When activating we need:
+            /// 1. activate AVAudioSession
+            /// 2. set isAudioEnabled = true
+            /// 3. set RTCAudioSession.isActive = true
+            ///
+            /// When deactivating we need:
+            /// 1. set RTCAudioSession.isActive = false
+            /// 2. set isAudioEnabled = false
+            /// 3. deactivate AVAudioSession
+            if configuration.isActive {
+
+                try AVAudioSession.sharedInstance().setActive(true)
+
+                try await audioStore.dispatchAsync(
+                    .audioSession(
+                        .isAudioEnabled(true)
+                    )
+                )
+
+                try await audioStore.dispatchAsync(
+                    .audioSession(
+                        .isActive(true)
+                    )
+                )
+
+                log.debug(
+                    "AudioSession audioOutput has been enabled.",
+                    subsystems: .audioSession
+                )
+            } else {
+
+                try await audioStore.dispatchAsync(
+                    .audioSession(
+                        .isActive(false)
+                    )
+                )
+
+                try await audioStore.dispatchAsync(
+                    .audioSession(
+                        .isAudioEnabled(false)
+                    )
+                )
+
+                try AVAudioSession.sharedInstance().setActive(false)
+
+                log.debug(
+                    "AudioSession audioOutput has been disabled.",
+                    subsystems: .audioSession
+                )
+            }
+        } catch {
+            log.error(
+                "Failed while to applying AudioSession isActive:\(configuration.isActive) in order to match CallSettings.audioOutputOn.",
+                subsystems: .audioSession,
+                error: error
+            )
+        }
+    }
+
     /// - Important: This method runs whenever an CallAudioSession is created and ensures that
     /// the configuration is correctly for calling. This is quite important for CallKit as if the category and
     /// mode aren't set correctly it won't activate the audioSession.

Sources/StreamVideo/Utils/AudioSession/Policies/DefaultAudioSessionPolicy.swift

@@ -25,6 +25,7 @@ public struct DefaultAudioSessionPolicy: AudioSessionPolicy {
     ) -> AudioSessionConfiguration {
         guard applicationStateAdapter.state == .foreground else {
             return .init(
+                isActive: callSettings.audioOutputOn,
                 category: .playAndRecord,
                 mode: callSettings.videoOn ? .videoChat : .voiceChat,
                 options: .playAndRecord(
@@ -39,6 +40,7 @@ public struct DefaultAudioSessionPolicy: AudioSessionPolicy {
         }
 
         return .init(
+            isActive: callSettings.audioOutputOn,
             category: .playAndRecord,
             mode: callSettings.videoOn && callSettings.speakerOn ? .videoChat : .voiceChat,
             options: .playAndRecord(

Sources/StreamVideo/Utils/AudioSession/Policies/OwnCapabilitiesAudioSessionPolicy.swift

@@ -37,6 +37,7 @@ public struct OwnCapabilitiesAudioSessionPolicy: AudioSessionPolicy {
     ) -> AudioSessionConfiguration {
         guard ownCapabilities.contains(.sendAudio) else {
             return .init(
+                isActive: callSettings.audioOutputOn,
                 category: .playback,
                 mode: .default,
                 options: .playback,
@@ -71,6 +72,7 @@ public struct OwnCapabilitiesAudioSessionPolicy: AudioSessionPolicy {
             : nil
 
         return .init(
+            isActive: callSettings.audioOutputOn,
             category: category,
             mode: mode,
             options: categoryOptions,