How to reliably fetch and detect changes to the active audio route on Android?

Question

I have a feature where I need to fetch current AND detect switch of the active audio output device of the system. Something like:

• run app -> fetch current device (which might be embedded speakers)
• connect bluetooth speaker -> detect switch to bluetooth speaker
• connect audio jack -> detect switch from bluetooth speaker to audio jack

It seems to me there should be one API for this but it seems there are several. The one that makes the most sense seems to be MediaRouter but there are two large issues with it that prevent me from using it as described above:

• There are at least 2 scenarios in which it fetches the wrong device as the active route and on other scenarios it straight up doesn't detect route switches at all. For details on this please check out the ticket I opened on the google issue tracker
• I need certain information on the current active output device, most importantly a universal identifier. For bluetooth devices, the Complete Local Name can be used for this, which is available from BluetoothDevice types but this is not obtainable from the MediaRouter. Instead, MediaRouter makes a productName available, which sometimes can be an alias of the bluetooth devices, and not the static name.

I have since abandoned this API and moved on to find other solutions, let me know if anyone thinks there's a way around the problems above, most importantly the first one. I will note that I have used both the android.media.MediaRouter and the androidx one, they both have these issues.

I am now leveraging a combination of other APIs. It works but it is a far from acceptable solution:

• Using AudioManager.registerAudioDeviceCallback(object : AudioDeviceCallback) for non-bluetooth devices detection (AudioDeviceInfo.TYPE_WIRED_HEADPHONES, AudioDeviceInfo.TYPE_BUILTIN_SPEAKER)). I'm getting callbacks when any of these devices get added or removed and then I can check if a wired type device is present then that's the active one 100% of the time, if it's not, then the embedded-type is active. It's kind of hacky but it works.

• More interestingly, for detection of Bluetooth output devices I use a private API, that Android itself uses in the Settings app to display the current audio output device.

  • BluetoothA2dp::class.java.getDeclaredMethod("getActiveDevice") to get the current active output device. This is done by getting the profile proxy service bluetoothAdapter.getProfileProxy
  • register a receiver for this action BluetoothA2dp::class.java.getField("ACTION_ACTIVE_DEVICE_CHANGED").get(null) in order to detect switches of the bluetooth active audio device.

This solution works but also has a few limitations:

• they are obvious private APIs, subjected to sudden change and potential breaks
• the active device APIs mentioned above are not available < Android 9. I have yet to investigate what Android is using pre-Android9 in the Settings app
• On Samsung devices the active device API works incorrectly.

So, the million dollar question. How do I fetch and detect the current audio route on Android, reliably?