feat: add deinitPlugin method to restore audio session settings

riderx · riderx · commit 05caaeeaba5d · 2025-10-27T03:33:53.000Z
diff --git a/README.md b/README.md
@@ -572,6 +572,21 @@ Get the native Capacitor plugin version
 --------------------
 
 
+### deinitPlugin()
+
+```typescript
+deinitPlugin() => Promise<void>
+```
+
+Deinitialize the plugin and restore original audio session settings
+This method stops all playing audio and reverts any audio session changes made by the plugin
+Use this when you need to ensure compatibility with other audio plugins
+
+**Since:** 7.7.0
+
+--------------------
+
+
 ### Interfaces
 
 
diff --git a/android/src/main/java/ee/forgr/audio/NativeAudio.java b/android/src/main/java/ee/forgr/audio/NativeAudio.java
@@ -59,6 +59,8 @@ public class NativeAudio extends Plugin implements AudioManager.OnAudioFocusChan
     private static ArrayList<AudioAsset> resumeList;
     private AudioManager audioManager;
     private boolean fadeMusic = false;
+    private boolean audioFocusRequested = false;
+    private int originalAudioMode = AudioManager.MODE_INVALID;
 
     private final Map<String, PluginCall> pendingDurationCalls = new HashMap<>();
 
@@ -69,6 +71,11 @@ public void load() {
         this.audioManager = (AudioManager) this.getActivity().getSystemService(Context.AUDIO_SERVICE);
 
         audioAssetList = new HashMap<>();
+
+        // Store the original audio mode but don't request focus yet
+        if (this.audioManager != null) {
+            originalAudioMode = this.audioManager.getMode();
+        }
     }
 
     @Override
@@ -153,6 +160,11 @@ public void configure(PluginCall call) {
             return;
         }
 
+        // Save original audio mode if not already saved
+        if (originalAudioMode == AudioManager.MODE_INVALID) {
+            originalAudioMode = this.audioManager.getMode();
+        }
+
         boolean focus = call.getBoolean(OPT_FOCUS_AUDIO, false);
         boolean background = call.getBoolean("background", false);
         this.fadeMusic = call.getBoolean("fade", false);
@@ -165,8 +177,10 @@ public void configure(PluginCall call) {
                     AudioManager.STREAM_MUSIC,
                     AudioManager.AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK
                 ); // Allow other audio to play quietly
-            } else {
+                audioFocusRequested = true;
+            } else if (audioFocusRequested) {
                 this.audioManager.abandonAudioFocus(this);
+                audioFocusRequested = false;
             }
 
             if (background) {
@@ -719,4 +733,35 @@ public void getPluginVersion(final PluginCall call) {
             call.reject("Could not get plugin version", e);
         }
     }
+
+    @PluginMethod
+    public void deinitPlugin(final PluginCall call) {
+        try {
+            // Stop all playing audio
+            if (audioAssetList != null) {
+                for (AudioAsset asset : audioAssetList.values()) {
+                    if (asset != null) {
+                        asset.stop();
+                    }
+                }
+            }
+
+            // Release audio focus if we requested it
+            if (audioFocusRequested && this.audioManager != null) {
+                this.audioManager.abandonAudioFocus(this);
+                audioFocusRequested = false;
+            }
+
+            // Restore original audio mode if we changed it
+            if (originalAudioMode != AudioManager.MODE_INVALID && this.audioManager != null) {
+                this.audioManager.setMode(originalAudioMode);
+                originalAudioMode = AudioManager.MODE_INVALID;
+            }
+
+            call.resolve();
+        } catch (Exception e) {
+            Log.e(TAG, "Error in deinitPlugin", e);
+            call.reject("Error deinitializing plugin: " + e.getMessage());
+        }
+    }
 }
diff --git a/ios/Sources/NativeAudioPlugin/Plugin.swift b/ios/Sources/NativeAudioPlugin/Plugin.swift
@@ -31,7 +31,8 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
         CAPPluginMethod(name: "resume", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "setCurrentTime", returnType: CAPPluginReturnPromise),
         CAPPluginMethod(name: "clearCache", returnType: CAPPluginReturnPromise),
-        CAPPluginMethod(name: "getPluginVersion", returnType: CAPPluginReturnPromise)
+        CAPPluginMethod(name: "getPluginVersion", returnType: CAPPluginReturnPromise),
+        CAPPluginMethod(name: "deinitPlugin", returnType: CAPPluginReturnPromise)
     ]
     internal let audioQueue = DispatchQueue(label: "ee.forgr.audio.queue", qos: .userInitiated, attributes: .concurrent)
     private var audioList: [String: Any] = [:] {
@@ -44,6 +45,12 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
     var fadeMusic = false
     var session = AVAudioSession.sharedInstance()
 
+    // Track if audio session has been initialized
+    private var audioSessionInitialized = false
+    // Store the original audio category to restore on deinit
+    private var originalAudioCategory: AVAudioSession.Category?
+    private var originalAudioOptions: AVAudioSession.CategoryOptions?
+
     // Add observer for audio session interruptions
     private var interruptionObserver: Any?
 
@@ -53,7 +60,8 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
 
         self.fadeMusic = false
 
-        setupAudioSession()
+        // Don't setup audio session on load - defer until first use
+        // setupAudioSession()
         setupInterruptionHandling()
 
         NotificationCenter.default.addObserver(forName: UIApplication.didEnterBackgroundNotification, object: nil, queue: .main) { [weak self] _ in
@@ -84,6 +92,13 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
     }
 
     private func setupAudioSession() {
+        // Save the original audio session category before making changes
+        if !audioSessionInitialized {
+            originalAudioCategory = session.category
+            originalAudioOptions = session.categoryOptions
+            audioSessionInitialized = true
+        }
+
         do {
             // Only set the category without immediately activating/deactivating
             try self.session.setCategory(AVAudioSession.Category.playback, options: .mixWithOthers)
@@ -127,6 +142,13 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
     }
 
     @objc func configure(_ call: CAPPluginCall) {
+        // Save original category on first configure call
+        if !audioSessionInitialized {
+            originalAudioCategory = session.category
+            originalAudioOptions = session.categoryOptions
+            audioSessionInitialized = true
+        }
+
         if let fade = call.getBool(Constant.FadeKey) {
             self.fadeMusic = fade
         }
@@ -234,6 +256,11 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
         let time = max(call.getDouble("time") ?? 0, 0) // Ensure non-negative time
         let delay = max(call.getDouble("delay") ?? 0, 0) // Ensure non-negative delay
 
+        // Ensure audio session is initialized before first play
+        if !audioSessionInitialized {
+            setupAudioSession()
+        }
+
         // Use sync for operations that need to be blocking
         audioQueue.sync {
             guard !audioList.isEmpty else {
@@ -608,4 +635,36 @@ public class NativeAudio: CAPPlugin, AVAudioPlayerDelegate, CAPBridgedPlugin {
         call.resolve(["version": self.PLUGIN_VERSION])
     }
 
+    @objc func deinitPlugin(_ call: CAPPluginCall) {
+        // Stop all playing audio
+        audioQueue.sync(flags: .barrier) {
+            for (_, asset) in self.audioList {
+                if let audioAsset = asset as? AudioAsset {
+                    audioAsset.stop()
+                }
+            }
+        }
+
+        // Restore original audio session settings if we changed them
+        if audioSessionInitialized, let originalCategory = originalAudioCategory {
+            do {
+                // Deactivate our audio session
+                try self.session.setActive(false, options: .notifyOthersOnDeactivation)
+
+                // Restore original category and options
+                if let originalOptions = originalAudioOptions {
+                    try self.session.setCategory(originalCategory, options: originalOptions)
+                } else {
+                    try self.session.setCategory(originalCategory)
+                }
+
+                audioSessionInitialized = false
+            } catch {
+                print("Failed to restore audio session: \(error)")
+            }
+        }
+
+        call.resolve()
+    }
+
 }
diff --git a/src/definitions.ts b/src/definitions.ts
@@ -249,4 +249,14 @@ export interface NativeAudio {
    * @throws An error if the something went wrong
    */
   getPluginVersion(): Promise<{ version: string }>;
+
+  /**
+   * Deinitialize the plugin and restore original audio session settings
+   * This method stops all playing audio and reverts any audio session changes made by the plugin
+   * Use this when you need to ensure compatibility with other audio plugins
+   *
+   * @since 7.7.0
+   * @returns {Promise<void>}
+   */
+  deinitPlugin(): Promise<void>;
 }
diff --git a/src/web.ts b/src/web.ts
@@ -164,6 +164,14 @@ export class NativeAudioWeb extends WebPlugin implements NativeAudio {
   async getPluginVersion(): Promise<{ version: string }> {
     return { version: 'web' };
   }
+
+  async deinitPlugin(): Promise<void> {
+    // Stop and unload all audio assets
+    for (const [assetId] of NativeAudioWeb.AUDIO_ASSET_BY_ASSET_ID) {
+      await this.unload({ assetId });
+    }
+    return;
+  }
 }
 
 const NativeAudio = new NativeAudioWeb();

Original file line number	Diff line number	Diff line change
`@@ -164,6 +164,14 @@ export class NativeAudioWeb extends WebPlugin implements NativeAudio {`
`164`	`164`	`async getPluginVersion(): Promise<{ version: string }> {`
`165`	`165`	`return { version: 'web' };`
`166`	`166`	`}`
	`167`	`+`
	`168`	`+ async deinitPlugin(): Promise<void> {`
	`169`	`+ // Stop and unload all audio assets`
	`170`	`+ for (const [assetId] of NativeAudioWeb.AUDIO_ASSET_BY_ASSET_ID) {`
	`171`	`+ await this.unload({ assetId });`
	`172`	`+ }`
	`173`	`+ return;`
	`174`	`+ }`
`167`	`175`	`}`
`168`	`176`
`169`	`177`	`const NativeAudio = new NativeAudioWeb();`