feat: add abandonAudioFocus() API (QAP-4557)

android/src/main/java/com/doublesymmetry/kotlinaudio/players/BaseAudioPlayer.kt

@@ -260,6 +260,21 @@ abstract class BaseAudioPlayer internal constructor(
         exoPlayer.pauseAtEndOfMediaItems = pause
     }
 
+    /**
+     * Abandons audio focus so other apps can restore their volume.
+     * Uses ExoPlayer's setAudioAttributes toggle when handleAudioFocus is true,
+     * otherwise uses the custom FocusManager.
+     */
+    fun abandonAudioFocus() {
+        if (options.handleAudioFocus) {
+            val attrs = exoPlayer.audioAttributes
+            exoPlayer.setAudioAttributes(attrs, false)
+            exoPlayer.setAudioAttributes(attrs, true)
+        } else {
+            focusManager.abandonAudioFocusIfHeld()
+        }
+    }
+
     /**
      * Stops and destroys the player. Only call this when you are finished using the player, otherwise use [pause].
      */

android/src/main/java/com/doublesymmetry/trackplayer/module/MusicModule.kt

@@ -556,6 +556,12 @@ class MusicModule(reactContext: ReactApplicationContext) : NativeTrackPlayerSpec
         callback.resolve(null)
     }
 
+    override fun abandonAudioFocus(callback: Promise) = launchInScope {
+        if (verifyServiceBoundOrReject(callback)) return@launchInScope
+        musicService.abandonAudioFocus()
+        callback.resolve(null)
+    }
+
     override fun validateOnStartCommandIntent(callback: Promise) = launchInScope {
         if (verifyServiceBoundOrReject(callback)) return@launchInScope
         callback.resolve(musicService.onStartCommandIntentValid)

android/src/main/java/com/doublesymmetry/trackplayer/service/MusicService.kt

@@ -78,6 +78,11 @@ class MusicService : HeadlessJsMediaService() {
         sWakeLock?.release()
     }
 
+    @MainThread
+    fun abandonAudioFocus() {
+        player.abandonAudioFocus()
+    }
+
     fun getBitmapLoader(): BitmapLoader {
         return mediaSession.bitmapLoader
     }

ios/TrackPlayer.mm

@@ -199,6 +199,9 @@ - (void)validateOnStartCommandIntent:(nonnull RCTPromiseResolveBlock)resolve rej
 - (void)abandonWakeLock:(nonnull RCTPromiseResolveBlock)resolve reject:(nonnull RCTPromiseRejectBlock)reject {
   resolve(nil);
 }
+- (void)abandonAudioFocus:(nonnull RCTPromiseResolveBlock)resolve reject:(nonnull RCTPromiseRejectBlock)reject {
+  resolve(nil);
+}
 - (void)acquireWakeLock:(nonnull RCTPromiseResolveBlock)resolve reject:(nonnull RCTPromiseRejectBlock)reject {
   resolve(nil);
 }

src/NativeTrackPlayer.ts

@@ -99,6 +99,7 @@ export interface Spec extends TurboModule {
   // android methods
   acquireWakeLock(): Promise<void>;
   abandonWakeLock(): Promise<void>;
+  abandonAudioFocus(): Promise<void>;
   validateOnStartCommandIntent(): Promise<boolean>;
 }
 

src/trackPlayer.ts

@@ -446,6 +446,14 @@ export async function abandonWakeLock() {
   TrackPlayer.abandonWakeLock();
 }
 
+/**
+ * Abandons audio focus so other apps can restore their volume (android only.)
+ */
+export async function abandonAudioFocus(): Promise<void> {
+  if (!isAndroid) return;
+  return TrackPlayer.abandonAudioFocus();
+}
+
 /**
  * get onStartCommandIntent is null or not (Android only.). this is used to identify
  * if musicservice is restarted or not.