feat: add Twilio AudioSwitch to Android

fabriziomoscon · fabriziomoscon · commit 07d125f22a53 · 2021-07-03T16:56:30.000+01:00
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ Tested with:
 
 The most updated branch is [feat/twilio-android-sdk-5](https://github.com/hoxfon/react-native-twilio-programmable-voice/tree/feat/twilio-android-sdk-5) which is aligned with:
 
-- Android 5.1.1
+- Android 5.2.0
 - iOS 5.2.0
 
 It contains breaking changes from `react-native-twilio-programmable-voice` v4, and it will be released as v5.
@@ -54,17 +54,19 @@ Allow Android to use the built in Android telephony service to make and receive
 - Android 4.5.0
 - iOS 5.2.0
 
-
 ### Breaking changes in v5.0.0
 
-Changes on [Android Twilio Voice SDK v5](https://www.twilio.com/docs/voice/voip-sdk/android/3x-changelog#500) are reflected in the JavaScript API, the way call invites are handled and ...
+Changes on [Android Twilio Voice SDK v5](https://www.twilio.com/docs/voice/voip-sdk/android/3x-changelog#500) are reflected in the JavaScript API, the way call invites are handled has changed and other v5 features like `audioSwitch` have been implemented.
+`setSpeakerPhone()` has been removed, use selectAudioDevice(name: string) instead.
+
+#### Background incoming calls
 
-- when the app is not in foreground incoming calls result in a heads-up notification with action to "ACCEPT" and "REJECT"
-- ReactMethod `accept` does not dispatch any event. Previously it would dispatch `connectionDidDisconnect`
-- ReactMethod `reject` dispatch a `callInviteCancelled` event instead of `connectionDidDisconnect`
-- ReactMethod `ignore` does not dispatch any event. Previously it would dispatch `connectionDidDisconnect`
+- When the app is not in foreground incoming calls result in a heads-up notification with action to "ACCEPT" and "REJECT".
+- ReactMethod `accept` does not dispatch any event. In v4 it dispatched `connectionDidDisconnect`.
+- ReactMethod `reject` dispatches a `callInviteCancelled` event instead of `connectionDidDisconnect`.
+- ReactMethod `ignore` does not dispatch any event. In v4 it dispatched `connectionDidDisconnect`.
 
-To allow the library to show heads up notifications you must add the following lines to your application `android/app/src/main/AndroidManifest.xml`:
+To show heads up notifications, you must add the following lines to your application's `android/app/src/main/AndroidManifest.xml`:
 
 ```xml
     <!-- receive calls when the app is in the background-->
@@ -97,22 +99,22 @@ To allow the library to show heads up notifications you must add the following l
     </application>
 ```
 
-Firebase Messaging 19.0.+ is imported by this module, so there is no need to import it in your app.
+Firebase Messaging 19.0.+ is imported by this module, so there is no need to import it in your app's `bundle.gradle` file.
 
-Previously, in order to launch the app when receiving a call, the flow was:
+In v4 the flow to launch the app when receiving a call was:
 
-1. the module would launch the app
-2. after the React app is initialised, it would always ask to the native module whether there were incoming call invites
-3. if there where any incoming call invites the module would send an event to the React app with the incoming call invite parameters
-4. the Reach app would listen to the event and launch the view with the appropriate incoming call answer/reject controls
+1. the module launched the app
+2. after the React app is initialised, it always asked to the native module whether there were incoming call invites
+3. if there were any incoming call invites, the module would have sent an event to the React app with the incoming call invite parameters
+4. the Reach app would have listened to the event and would have launched the view with the appropriate incoming call answer/reject controls
 
-This loop was long and prone to race conditions. In case the event was sent before the React main view was completely initialised, it would not be handled at all.
+This loop was long and prone to race conditions. For example,when the event was sent before the React main view was completely initialised, it would not be handled at all.
 
-Version 5.0.0 replaces the previous flow by using `getLaunchOptions()` to pass initial properties from native to React when receiving a call invite as explained here: https://reactnative.dev/docs/communication-android.
+V5 replaces the previous flow by using `getLaunchOptions()` to pass initial properties from the native module to React, when receiving a call invite as explained here: https://reactnative.dev/docs/communication-android.
 
-The React app will be launched with the initial properties `callInvite` or `call`.
+The React app is launched with the initial properties `callInvite` or `call`.
 
-Add the following blocks to your app's `MainActivity`:
+To handle correctly `lauchedOptions`, you must add the following blocks to your app's `MainActivity`:
 
 ```java
 
@@ -154,6 +156,25 @@ public class MainActivity extends ReactActivity {
 }
 ```
 
+#### Audio Switch
+
+Access to native Twilio SDK AudioSwitch module has been added to the JavaScript API:
+
+```javascript
+// getAudioDevices returns all audio devices connected
+// {
+//     "Speakerphone": false,
+//     "Earnpiece": true, // true indicates the selected device
+// }
+getAudioDevices()
+
+// getSelectedAudioDevice returns the selected audio device
+getSelectedAudioDevice()
+
+// selectAudioDevice selects the passed audio device for the current active call
+selectAudioDevice(name: string)
+```
+
 ## ICE
 
 See https://www.twilio.com/docs/stun-turn
diff --git a/android/build.gradle b/android/build.gradle
@@ -4,6 +4,7 @@ buildscript {
     repositories {
         google()
         jcenter()
+        mavenCentral()
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:4.1.3'
@@ -55,7 +56,8 @@ dependencies {
     def supportLibVersion = rootProject.hasProperty('supportLibVersion') ? rootProject.supportLibVersion : DEFAULT_SUPPORT_LIB_VERSION
 
     implementation fileTree(include: ['*.jar'], dir: 'libs')
-    implementation 'com.twilio:voice-android:5.1.1'
+    implementation 'com.twilio:audioswitch:1.1.2'
+    implementation 'com.twilio:voice-android:5.2.0'
     implementation "com.android.support:appcompat-v7:$supportLibVersion"
     implementation 'com.facebook.react:react-native:+'
     implementation 'com.google.firebase:firebase-messaging:19.0.+'
diff --git a/android/src/main/java/com/hoxfon/react/RNTwilioVoice/Constants.java b/android/src/main/java/com/hoxfon/react/RNTwilioVoice/Constants.java
@@ -35,4 +35,5 @@ public class Constants {
     public static final String CALL_KEY = "call";
     public static final String CALL_INVITE_KEY = "callInvite";
     public static final String CALL_STATE_CONNECTED = Call.State.CONNECTED.toString();
-}
+    public static final String SELECTED_AUDIO_DEVICE = "selected_audio_device";
+}
diff --git a/android/src/main/java/com/hoxfon/react/RNTwilioVoice/EventManager.java b/android/src/main/java/com/hoxfon/react/RNTwilioVoice/EventManager.java
@@ -25,7 +25,7 @@ public class EventManager {
     public static final String EVENT_CALL_INVITE_CANCELLED = "callInviteCancelled";
     public static final String EVENT_CONNECTION_IS_RECONNECTING = "connectionIsReconnecting";
     public static final String EVENT_CONNECTION_DID_RECONNECT = "connectionDidReconnect";
-
+    public static final String EVENT_AUDIO_DEVICES_UPDATED = "audioDevicesUpdated";
 
     public EventManager(ReactApplicationContext context) {
         mContext = context;
diff --git a/android/src/main/java/com/hoxfon/react/RNTwilioVoice/TwilioVoiceModule.java b/android/src/main/java/com/hoxfon/react/RNTwilioVoice/TwilioVoiceModule.java
@@ -9,20 +9,17 @@
 import android.content.IntentFilter;
 import android.content.SharedPreferences;
 import android.content.pm.PackageManager;
-import android.media.AudioAttributes;
-import android.media.AudioFocusRequest;
 import android.media.AudioManager;
 import android.os.Build;
 
 import androidx.annotation.NonNull;
 import androidx.core.app.ActivityCompat;
 import androidx.core.content.ContextCompat;
 import androidx.localbroadcastmanager.content.LocalBroadcastManager;
+import kotlin.Unit;
 
 import android.os.Bundle;
 import android.util.Log;
-import android.view.Window;
-import android.view.WindowManager;
 
 import com.facebook.react.bridge.JSApplicationIllegalArgumentException;
 import com.facebook.react.bridge.AssertionException;
@@ -41,6 +38,9 @@
 import com.facebook.react.bridge.ReactMethod;
 
 import com.google.firebase.iid.FirebaseInstanceId;
+
+import com.twilio.audioswitch.AudioDevice;
+import com.twilio.audioswitch.AudioSwitch;
 import com.twilio.voice.AcceptOptions;
 import com.twilio.voice.Call;
 import com.twilio.voice.CallException;
@@ -54,6 +54,7 @@
 
 import java.util.HashMap;
 import java.util.Map;
+import java.util.List;
 
 import static com.hoxfon.react.RNTwilioVoice.EventManager.EVENT_CONNECTION_DID_CONNECT;
 import static com.hoxfon.react.RNTwilioVoice.EventManager.EVENT_CONNECTION_DID_DISCONNECT;
@@ -64,16 +65,14 @@
 import static com.hoxfon.react.RNTwilioVoice.EventManager.EVENT_CALL_INVITE_CANCELLED;
 import static com.hoxfon.react.RNTwilioVoice.EventManager.EVENT_CONNECTION_IS_RECONNECTING;
 import static com.hoxfon.react.RNTwilioVoice.EventManager.EVENT_CONNECTION_DID_RECONNECT;
+import static com.hoxfon.react.RNTwilioVoice.EventManager.EVENT_AUDIO_DEVICES_UPDATED;
 
 public class TwilioVoiceModule extends ReactContextBaseJavaModule implements ActivityEventListener, LifecycleEventListener {
 
     public static String TAG = "RNTwilioVoice";
 
     private static final int MIC_PERMISSION_REQUEST_CODE = 1;
 
-    private AudioManager audioManager;
-    private int savedAudioMode = AudioManager.MODE_NORMAL;
-
     private boolean isReceiverRegistered = false;
     private VoiceBroadcastReceiver voiceBroadcastReceiver;
 
@@ -96,13 +95,20 @@ public class TwilioVoiceModule extends ReactContextBaseJavaModule implements Act
     private CallInvite activeCallInvite;
     private Call activeCall;
 
-    private AudioFocusRequest focusRequest;
     private HeadsetManager headsetManager;
     private EventManager eventManager;
     private int existingCallInviteIntent;
 
+    /*
+     * Audio device management
+     */
+    private AudioSwitch audioSwitch;
+    private int savedVolumeControlStream;
+    AudioDevice selectedAudioDevice;
+    Map<String, AudioDevice> availableAudioDevices;
+
     public TwilioVoiceModule(ReactApplicationContext reactContext,
-    boolean shouldAskForMicPermission) {
+                             boolean shouldAskForMicPermission) {
         super(reactContext);
 
         if (BuildConfig.DEBUG) {
@@ -127,10 +133,8 @@ public TwilioVoiceModule(ReactApplicationContext reactContext,
 
         TwilioVoiceModule.callNotificationMap = new HashMap<>();
 
-        /*
-         * Needed for setting/abandoning audio focus during a call
-         */
-        audioManager = (AudioManager) reactContext.getSystemService(Context.AUDIO_SERVICE);
+        audioSwitch = new AudioSwitch(reactContext);
+        availableAudioDevices = new HashMap<>();
 
         /*
          * Ensure the microphone permission is enabled
@@ -142,6 +146,7 @@ public TwilioVoiceModule(ReactApplicationContext reactContext,
 
     @Override
     public void onHostResume() {
+        savedVolumeControlStream = getCurrentActivity().getVolumeControlStream();
         /*
          * Enable changing the volume using the up/down keys during a conversation
          */
@@ -184,7 +189,11 @@ public void onHostPause() {
     public void onHostDestroy() {
         disconnect();
         callNotificationManager.removeHangupNotification(getReactApplicationContext());
-        unsetAudioFocus();
+        /*
+         * Tear down audio device management and restore previous volume stream
+         */
+        audioSwitch.stop();
+        getCurrentActivity().setVolumeControlStream(savedVolumeControlStream);
     }
 
     @Override
@@ -257,7 +266,7 @@ public void onConnected(@NonNull Call call) {
                 if (BuildConfig.DEBUG) {
                     Log.d(TAG, "Call.Listener().onConnected(). Call state: " + call.getState());
                 }
-                setAudioFocus();
+                audioSwitch.activate();
                 proximityManager.startProximitySensor();
                 headsetManager.startWiredHeadsetEvent(getReactApplicationContext());
 
@@ -316,7 +325,7 @@ public void onDisconnected(@NonNull Call call, CallException error) {
                 if (BuildConfig.DEBUG) {
                     Log.d(TAG, "Call.Listener().onDisconnected(). Call state: " + call.getState());
                 }
-                unsetAudioFocus();
+                audioSwitch.deactivate();
                 proximityManager.stopProximitySensor();
                 headsetManager.stopWiredHeadsetEvent(getReactApplicationContext());
 
@@ -347,11 +356,11 @@ public void onConnectFailure(@NonNull Call call, CallException error) {
                 if (BuildConfig.DEBUG) {
                     Log.d(TAG, "Call.Listener().onConnectFailure(). Call state: " + call.getState());
                 }
-                unsetAudioFocus();
+                audioSwitch.deactivate();
                 proximityManager.stopProximitySensor();
 
                 Log.e(TAG, String.format("CallListener onConnectFailure error: %d, %s",
-                    error.getErrorCode(), error.getMessage()));
+                        error.getErrorCode(), error.getMessage()));
 
                 WritableMap params = Arguments.createMap();
                 params.putString(Constants.ERROR, error.getMessage());
@@ -587,6 +596,7 @@ public void initWithAccessToken(final String accessToken, Promise promise) {
         WritableMap params = Arguments.createMap();
         params.putBoolean("initialized", true);
         promise.resolve(params);
+        startAudioSwitch();
     }
 
     /*
@@ -778,73 +788,51 @@ public void getCallInvite(Promise promise) {
         promise.resolve(params);
     }
 
-    @ReactMethod
-    public void setSpeakerPhone(Boolean value) {
-        // TODO check whether it is necessary to call setAudioFocus again
-//        setAudioFocus();
-        audioManager.setSpeakerphoneOn(value);
-    }
-
     @ReactMethod
     public void setOnHold(Boolean value) {
         if (activeCall != null) {
             activeCall.hold(value);
         }
     }
 
-    private void setAudioFocus() {
-        if (audioManager == null) {
-            audioManager.setMode(savedAudioMode);
-            audioManager.abandonAudioFocus(null);
-            return;
-        }
-        savedAudioMode = audioManager.getMode();
-        // Request audio focus before making any device switch
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
-            AudioAttributes playbackAttributes = new AudioAttributes.Builder()
-                .setUsage(AudioAttributes.USAGE_VOICE_COMMUNICATION)
-                .setContentType(AudioAttributes.CONTENT_TYPE_SPEECH)
-                .build();
-            focusRequest = new AudioFocusRequest.Builder(AudioManager.AUDIOFOCUS_GAIN_TRANSIENT)
-                .setAudioAttributes(playbackAttributes)
-                .setAcceptsDelayedFocusGain(true)
-                .setOnAudioFocusChangeListener(new AudioManager.OnAudioFocusChangeListener() {
-                    @Override
-                    public void onAudioFocusChange(int i) { }
-                })
-                .build();
-            audioManager.requestAudioFocus(focusRequest);
-        } else {
-            int focusRequestResult = audioManager.requestAudioFocus(new AudioManager.OnAudioFocusChangeListener() {
-                @Override
-                public void onAudioFocusChange(int focusChange) {}
-            },
-            AudioManager.STREAM_VOICE_CALL,
-            AudioManager.AUDIOFOCUS_GAIN_TRANSIENT);
+    @ReactMethod
+    public void getAudioDevices(Promise promise) {
+        List<AudioDevice> availableAudioDevices = audioSwitch.getAvailableAudioDevices();
+
+        WritableMap devices = Arguments.createMap();
+        for (AudioDevice a : availableAudioDevices) {
+            devices.putBoolean(a.getName(), selectedAudioDevice.getName().equals(a.getName()));
         }
-        /*
-         * Start by setting MODE_IN_COMMUNICATION as default audio mode. It is
-         * required to be in this mode when playout and/or recording starts for
-         * best possible VoIP performance. Some devices have difficulties with speaker mode
-         * if this is not set.
-         */
-        audioManager.setMode(AudioManager.MODE_IN_COMMUNICATION);
+        promise.resolve(devices);
     }
 
-    private void unsetAudioFocus() {
-        if (audioManager == null) {
-            audioManager.setMode(savedAudioMode);
-            audioManager.abandonAudioFocus(null);
+    @ReactMethod
+    public void getSelectedAudioDevice(Promise promise) {
+        WritableMap device = Arguments.createMap();
+        device.putString(Constants.SELECTED_AUDIO_DEVICE, selectedAudioDevice.getName());
+        promise.resolve(device);
+    }
+
+    @ReactMethod
+    public void selectAudioDevice(String name) {
+        AudioDevice selected = availableAudioDevices.get(name);
+        if (selected == null) {
             return;
         }
-        audioManager.setMode(savedAudioMode);
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
-            if (focusRequest != null) {
-                audioManager.abandonAudioFocusRequest(focusRequest);
+        audioSwitch.selectDevice(selected);
+    }
+
+    private void startAudioSwitch() {
+        audioSwitch.start((devices, device) -> {
+            selectedAudioDevice = device;
+            WritableMap params = Arguments.createMap();
+            for (AudioDevice a : devices) {
+                params.putBoolean(a.getName(), device.getName().equals(a.getName()));
+                availableAudioDevices.put(a.getName(), a);
             }
-        } else {
-            audioManager.abandonAudioFocus(null);
-        }
+            eventManager.sendEvent(EVENT_AUDIO_DEVICES_UPDATED, params);
+            return Unit.INSTANCE;
+        });
     }
 
     private boolean checkPermissionForMicrophone() {
@@ -868,6 +856,7 @@ public static Bundle getActivityLaunchOption(Intent intent) {
         if (intent == null || intent.getAction() == null) {
             return initialProperties;
         }
+
         Bundle callBundle = new Bundle();
         switch (intent.getAction()) {
             case Constants.ACTION_INCOMING_CALL_NOTIFICATION:
diff --git a/index.js b/index.js
