Allow to switch audio device module #650
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /* | ||
| * Copyright 2025 LiveKit | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| #if swift(>=5.9) | ||
| internal import LiveKitWebRTC | ||
| #else | ||
| @_implementationOnly import LiveKitWebRTC | ||
| #endif | ||
|
|
||
| public enum AudioDeviceModuleType { | ||
| /// Use AVAudioEngine-based AudioDeviceModule internally which will be used for all platforms. | ||
| case audioEngine | ||
| /// Use WebRTC's default AudioDeviceModule internally, which uses AudioUnit for iOS, HAL APIs for macOS. | ||
| case platformDefault | ||
| } | ||
|
|
||
| extension AudioDeviceModuleType { | ||
| func toRTCType() -> RTCAudioDeviceModuleType { | ||
| switch self { | ||
| case .audioEngine: return RTCAudioDeviceModuleType.audioEngine | ||
| case .platformDefault: return RTCAudioDeviceModuleType.platformDefault | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public extension AudioManager { | ||
| /// Sets the desired `AudioDeviceModuleType` to be used which handles all audio input / output. | ||
| /// | ||
| /// This method must be called before the peer connection is initialized. Changing the module type after | ||
| /// initialization is not supported and will result in an error. | ||
| /// | ||
| /// Note: When using .platformDefault, AVAudioSession will not be automatically managed. | ||
| /// Ensure to set session category when accessing the mic: | ||
| /// `try AVAudioSession.sharedInstance().setCategory(.playAndRecord, mode: .videoChat, options: [])` | ||
| static func set(audioDeviceModuleType: AudioDeviceModuleType) throws { | ||
| // Throw if pc factory is already initialized. | ||
| guard !RTC.pcFactoryState.isInitialized else { | ||
| throw LiveKitError(.invalidState, message: "Cannot set this property after the peer connection has been initialized") | ||
| } | ||
| RTC.pcFactoryState.mutate { $0.admType = audioDeviceModuleType } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| /* | ||
| * Copyright 2025 LiveKit | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| @preconcurrency import AVFoundation | ||
| @testable import LiveKit | ||
| import LiveKitWebRTC | ||
| import XCTest | ||
|
|
||
| class AudioManagerTests: LKTestCase { | ||
| // Test legacy audio device module's startLocalRecording(). | ||
| func testStartLocalRecordingLegacyADM() async throws { | ||
| // Use legacy ADM | ||
| try AudioManager.set(audioDeviceModuleType: .platformDefault) | ||
|
|
||
| // Ensure audio session category is `.playAndRecord`. | ||
| #if os(iOS) || os(tvOS) || os(visionOS) | ||
| try AVAudioSession.sharedInstance().setCategory(.playAndRecord, mode: .videoChat, options: []) | ||
| #endif | ||
|
|
||
| let recorder = try TestAudioRecorder() | ||
|
|
||
| let audioTrack = LocalAudioTrack.createTrack() | ||
| audioTrack.add(audioRenderer: recorder) | ||
|
|
||
| // Start recording | ||
| try AudioManager.shared.startLocalRecording() | ||
|
|
||
| // Record for 5 seconds... | ||
| try? await Task.sleep(nanoseconds: 5 * 1_000_000_000) | ||
|
|
||
| recorder.close() | ||
| AudioManager.shared.stopRecording() | ||
|
|
||
| // Play the recorded file... | ||
| let player = try AVAudioPlayer(contentsOf: recorder.filePath) | ||
| XCTAssertTrue(player.play(), "Failed to start audio playback") | ||
| while player.isPlaying { | ||
| try? await Task.sleep(nanoseconds: 1 * 100_000_000) // 10ms | ||
| } | ||
| } | ||
|
|
||
| // Confirm different behavior of Voice-Processing-Mute between macOS and other platforms. | ||
| func testConfirmGlobalVpMuteStateOniOS() async throws { | ||
| // Ensure audio session category is `.playAndRecord`. | ||
| #if !os(macOS) | ||
| try AVAudioSession.sharedInstance().setCategory(.playAndRecord, mode: .videoChat, options: []) | ||
| #endif | ||
|
|
||
| let e1 = AVAudioEngine() | ||
| try e1.inputNode.setVoiceProcessingEnabled(true) | ||
|
|
||
| let e2 = AVAudioEngine() | ||
| try e2.inputNode.setVoiceProcessingEnabled(true) | ||
|
|
||
| // e1, e2 both un-muted | ||
| XCTAssert(!e1.inputNode.isVoiceProcessingInputMuted) | ||
| XCTAssert(!e2.inputNode.isVoiceProcessingInputMuted) | ||
|
|
||
| // Mute e1, but e2 should be unaffected. | ||
| e1.inputNode.isVoiceProcessingInputMuted = true | ||
| XCTAssert(e1.inputNode.isVoiceProcessingInputMuted) | ||
|
|
||
| #if os(macOS) | ||
| // On macOS, e2 isn't affected by e1's muted state. | ||
| XCTAssert(!e2.inputNode.isVoiceProcessingInputMuted) | ||
| #else | ||
| // On Other platforms, e2 is affected by e1's muted state. | ||
| XCTAssert(e2.inputNode.isVoiceProcessingInputMuted) | ||
| #endif | ||
| } | ||
|
|
||
| // The Voice-Processing-Input-Muted state appears to be a global state within the app. | ||
| // We make sure that after the Room gets cleaned up, this state is back to un-muted since | ||
| // it will interfere with audio recording later in the app. | ||
| // | ||
| // Previous RTC libs would fail this test since, RTC was always invoking AudioDeviceModule::SetMicrophoneMuted(true) | ||
| func testVoiceProcessingInputMuted() async throws { | ||
| // Set VP muted state. | ||
| func setVoiceProcessingInputMuted(_ muted: Bool) throws { | ||
| let e = AVAudioEngine() | ||
| // VP always needs to be enabled to read / write the vp muted state | ||
| try e.inputNode.setVoiceProcessingEnabled(true) | ||
| e.inputNode.isVoiceProcessingInputMuted = muted | ||
| XCTAssert(e.inputNode.isVoiceProcessingInputMuted == muted) | ||
| print("Set vp muted to \(muted), and verified it is \(e.inputNode.isVoiceProcessingInputMuted)") | ||
| } | ||
|
|
||
| // Confirm if is VP muted. | ||
| func isVoiceProcessingInputMuted() throws -> Bool { | ||
| let e = AVAudioEngine() | ||
| // VP always needs to be enabled to read / write the vp muted state | ||
| try e.inputNode.setVoiceProcessingEnabled(true) | ||
| return e.inputNode.isVoiceProcessingInputMuted | ||
| } | ||
|
|
||
| // Ensure audio session category is `.playAndRecord`. | ||
| #if os(iOS) || os(tvOS) || os(visionOS) | ||
| try AVAudioSession.sharedInstance().setCategory(.playAndRecord, mode: .videoChat, options: []) | ||
| #endif | ||
|
|
||
| do { | ||
| // Should *not* be VP-muted at this point. | ||
| let isVpMuted = try isVoiceProcessingInputMuted() | ||
| print("isVpMuted: \(isVpMuted)") | ||
| XCTAssert(!isVpMuted) | ||
| } | ||
|
|
||
| let adm = AudioManager.shared | ||
|
|
||
| // Start recording, mic indicator should turn on. | ||
| print("Starting local recording...") | ||
| try adm.startLocalRecording() | ||
|
|
||
| // Wait for 3 seconds... | ||
| try? await Task.sleep(nanoseconds: 3 * 1_000_000_000) | ||
|
|
||
| // Set mute, mic indicator should turn off. | ||
| adm.isMicrophoneMuted = true | ||
|
|
||
| // Wait for 3 seconds... | ||
| try? await Task.sleep(nanoseconds: 3 * 1_000_000_000) | ||
|
|
||
| try adm.stopLocalRecording() | ||
|
|
||
| // Wait for 1 second... | ||
| try? await Task.sleep(nanoseconds: 1 * 1_000_000_000) | ||
|
|
||
| do { | ||
| // Should *not* be VP-muted at this point. | ||
| let isVpMuted = try isVoiceProcessingInputMuted() | ||
| print("isVpMuted: \(isVpMuted)") | ||
| XCTAssert(!isVpMuted) | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It effectively means you need to call this one before accessing
AudioManager.shared, so somewhere inApp.init()etc.Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it only works when called early at the moment. Even before AudioManager.shared, since peerConnection gets initialized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I mean e.g. in our example app even if you put it before
.sharede.g. here:// here AudioManager.shared.onDeviceUpdate = { [weak self] _ init's not enough as SwiftUI may create
.sharedfor you (e.g. in form of computed props).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it needs to be earlier at the moment. For our example app, it works here.
