Add foregroundService for Android 11.

Author: cloudwebrtc

.gitignore

@@ -19,3 +19,8 @@ doc/api/
 *.js_
 *.js.deps
 *.js.map
+.DS_Store
+.idea
+.vscode
+android/gradle*
+example/ios/Podfile.lock

README.md

@@ -15,7 +15,6 @@ Callkeep acts as an intermediate between your call system (RTC, VOIP...) and the
 
 This allows you (for example) to answer calls when your device is locked even if your app is terminated.
 
-
 ## Initial setup
 
 Basic configuration. In Android a popup is displayed before starting requesting some permissions to work properly.
@@ -31,6 +30,13 @@ final callSetup = <String, dynamic>{
     'This application needs to access your phone accounts',
     'cancelButton': 'Cancel',
     'okButton': 'ok',
+    // Required to get audio in background when using Android 11
+    'foregroundService': {
+      'channelId': 'com.company.my',
+      'channelName': 'Foreground service for my app',
+      'notificationTitle': 'My app is running on background',
+      'notificationIcon': 'Path to the resource icon of the notification',
+    }, 
   },
 };
 

android/src/main/java/io/wazo/callkeep/CallKeepModule.java

@@ -79,7 +79,6 @@ public class CallKeepModule {
     private static final String TAG = "FLT:CallKeepModule";
     private static TelecomManager telecomManager;
     private static TelephonyManager telephonyManager;
-    private static MethodChannel.Result hasPhoneAccountPromise;
     private Context _context;
     public static PhoneAccountHandle handle;
     private boolean isReceiverRegistered = false;
@@ -207,6 +206,11 @@ public boolean HandleMethodCall(@NonNull MethodCall call, @NonNull Result result
                 backToForeground(result);
             }
             break;
+            case "foregroundService": {
+                VoiceConnectionService.setSettings(new ConstraintsMap((Map<String, Object>)call.argument("settings")));
+                result.success(null);
+            }
+            break;
             default:
                 return false;
         }
@@ -222,8 +226,9 @@ public void setup(ConstraintsMap options) {
             this.registerEvents();
             VoiceConnectionService.setAvailable(true);
         }
-    }
 
+        VoiceConnectionService.setSettings(options);
+    }
 
     public void registerPhoneAccount() {
         if (!isConnectionServiceAvailable()) {

android/src/main/java/io/wazo/callkeep/Constants.java

@@ -16,4 +16,6 @@ public class Constants {
     public static final String EXTRA_CALL_NUMBER = "EXTRA_CALL_NUMBER";
     public static final String EXTRA_CALL_UUID = "EXTRA_CALL_UUID";
     public static final String EXTRA_CALLER_NAME = "EXTRA_CALLER_NAME";
+
+    public static final int FOREGROUND_SERVICE_TYPE_MICROPHONE = 128;
 }

android/src/main/java/io/wazo/callkeep/VoiceConnectionService.java

@@ -20,9 +20,13 @@
 import android.annotation.TargetApi;
 import android.app.ActivityManager;
 import android.app.ActivityManager.RunningTaskInfo;
+import android.app.Notification;
+import android.app.NotificationChannel;
+import android.app.NotificationManager;
 import android.content.ComponentName;
 import android.content.Context;
 import android.content.Intent;
+import android.content.res.Resources;
 import android.net.Uri;
 import android.os.Build;
 import android.os.Bundle;
@@ -31,11 +35,14 @@
 import android.telecom.ConnectionRequest;
 import android.telecom.ConnectionService;
 import android.telecom.DisconnectCause;
+import android.telecom.PhoneAccount;
 import android.telecom.PhoneAccountHandle;
 import android.telecom.TelecomManager;
 import android.util.Log;
 
 import androidx.annotation.Nullable;
+import androidx.annotation.RequiresApi;
+import androidx.core.app.NotificationCompat;
 import androidx.localbroadcastmanager.content.LocalBroadcastManager;
 
 import java.util.ArrayList;
@@ -46,7 +53,9 @@
 import java.util.Set;
 import java.util.UUID;
 
+import io.wazo.callkeep.utils.ConstraintsMap;
 import static io.wazo.callkeep.Constants.*;
+import static io.wazo.callkeep.Constants.FOREGROUND_SERVICE_TYPE_MICROPHONE;
 
 // @see https://github.com/kbagchiGWC/voice-quickstart-android/blob/9a2aff7fbe0d0a5ae9457b48e9ad408740dfb968/exampleConnectionService/src/main/java/com/twilio/voice/examples/connectionservice/VoiceConnectionService.java
 @TargetApi(Build.VERSION_CODES.M)
@@ -61,6 +70,7 @@ public class VoiceConnectionService extends ConnectionService {
     public static Map<String, VoiceConnection> currentConnections = new HashMap<>();
     public static Boolean hasOutgoingCall = false;
     public static VoiceConnectionService currentConnectionService = null;
+    public static ConstraintsMap _settings = null;
 
     public static Connection getConnection(String connectionId) {
         if (currentConnections.containsKey(connectionId)) {
@@ -92,6 +102,10 @@ public static void setAvailable(Boolean value) {
         isAvailable = value;
     }
 
+    public static void setSettings(ConstraintsMap settings) {
+        _settings = settings;
+    }
+
     public static void setReachable() {
         Log.d(TAG, "setReachable");
         isReachable = true;
@@ -102,6 +116,8 @@ public static void deinitConnection(String connectionId) {
         Log.d(TAG, "deinitConnection:" + connectionId);
         VoiceConnectionService.hasOutgoingCall = false;
 
+        currentConnectionService.stopForegroundService();
+
         if (currentConnections.containsKey(connectionId)) {
             currentConnections.remove(connectionId);
         }
@@ -116,6 +132,8 @@ public Connection onCreateIncomingConnection(PhoneAccountHandle connectionManage
         incomingCallConnection.setRinging();
         incomingCallConnection.setInitialized();
 
+        startForegroundService();
+
         return incomingCallConnection;
     }
 
@@ -164,6 +182,8 @@ private Connection makeOutgoingCall(ConnectionRequest request, String uuid, Bool
         outgoingCallConnection.setAudioModeIsVoip(true);
         outgoingCallConnection.setCallerDisplayName(displayName, TelecomManager.PRESENTATION_ALLOWED);
 
+        startForegroundService();
+
         // ‍️Weirdly on some Samsung phones (A50, S9...) using `setInitialized` will not display the native UI ...
         // when making a call from the native Phone application. The call will still be displayed correctly without it.
         if (!Build.MANUFACTURER.equalsIgnoreCase("Samsung")) {
@@ -180,6 +200,54 @@ private Connection makeOutgoingCall(ConnectionRequest request, String uuid, Bool
         return outgoingCallConnection;
     }
 
+    private void startForegroundService() {
+        if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) {
+            // Foreground services not required before SDK 28
+            return;
+        }
+        Log.d(TAG, "[VoiceConnectionService] startForegroundService");
+        if (_settings == null || !_settings.hasKey("foregroundService")) {
+            Log.w(TAG, "[VoiceConnectionService] Not creating foregroundService because not configured");
+            return;
+        }
+        ConstraintsMap foregroundSettings = _settings.getMap("foregroundService");
+        String NOTIFICATION_CHANNEL_ID = foregroundSettings.getString("channelId");
+        String channelName = foregroundSettings.getString("channelName");
+        NotificationChannel chan = new NotificationChannel(NOTIFICATION_CHANNEL_ID, channelName, NotificationManager.IMPORTANCE_NONE);
+        chan.setLockscreenVisibility(Notification.VISIBILITY_PRIVATE);
+        NotificationManager manager = (NotificationManager) getSystemService(Context.NOTIFICATION_SERVICE);
+        assert manager != null;
+        manager.createNotificationChannel(chan);
+
+        NotificationCompat.Builder notificationBuilder = new NotificationCompat.Builder(this, NOTIFICATION_CHANNEL_ID);
+        notificationBuilder.setOngoing(true)
+                .setContentTitle(foregroundSettings.getString("notificationTitle"))
+                .setPriority(NotificationManager.IMPORTANCE_MIN)
+                .setCategory(Notification.CATEGORY_SERVICE);
+        
+        if (foregroundSettings.hasKey("notificationIcon")) {
+            Context context = this.getApplicationContext();
+            Resources res = context.getResources();
+            String smallIcon = foregroundSettings.getString("notificationIcon");
+            notificationBuilder.setSmallIcon(res.getIdentifier(smallIcon, "mipmap", context.getPackageName()));
+        }
+
+        Log.d(TAG, "[VoiceConnectionService] Starting foreground service");
+
+        Notification notification = notificationBuilder.build();
+        startForeground(FOREGROUND_SERVICE_TYPE_MICROPHONE, notification);
+    }
+
+    @RequiresApi(api = Build.VERSION_CODES.N)
+    private void stopForegroundService() {
+        Log.d(TAG, "[VoiceConnectionService] stopForegroundService");
+        if (_settings == null || !_settings.hasKey("foregroundService")) {
+            Log.d(TAG, "[VoiceConnectionService] Discarding stop foreground service, no service configured");
+            return;
+        }
+        stopForeground(FOREGROUND_SERVICE_TYPE_MICROPHONE);
+    }
+
     private void wakeUpApplication(String uuid, String number, String displayName) {
         Intent headlessIntent = new Intent(
             this.getApplicationContext(),
@@ -233,6 +301,22 @@ private Connection createConnection(ConnectionRequest request) {
         extrasMap.put(EXTRA_CALL_NUMBER, request.getAddress().toString());
         VoiceConnection connection = new VoiceConnection(this, extrasMap);
         connection.setConnectionCapabilities(Connection.CAPABILITY_MUTE | Connection.CAPABILITY_SUPPORT_HOLD);
+
+        if(Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
+            Context context = getApplicationContext();
+            TelecomManager telecomManager = (TelecomManager) context.getSystemService(context.TELECOM_SERVICE);
+            PhoneAccount phoneAccount = telecomManager.getPhoneAccount(request.getAccountHandle());
+
+            //If the phone account is self managed, then this connection must also be self managed.
+            if((phoneAccount.getCapabilities() & PhoneAccount.CAPABILITY_SELF_MANAGED) == PhoneAccount.CAPABILITY_SELF_MANAGED) {
+                Log.d(TAG, "[VoiceConnectionService] PhoneAccount is SELF_MANAGED, so connection will be too");
+                connection.setConnectionProperties(Connection.PROPERTY_SELF_MANAGED);
+            }
+            else {
+                Log.d(TAG, "[VoiceConnectionService] PhoneAccount is not SELF_MANAGED, so connection won't be either");
+            }
+        }
+
         connection.setInitializing();
         connection.setExtras(extras);
         currentConnections.put(extras.getString(EXTRA_CALL_UUID), connection);

example/android/app/build.gradle

@@ -32,7 +32,7 @@ dependencies {
 }
 
 android {
-    compileSdkVersion 28
+    compileSdkVersion 30
 
     lintOptions {
         disable 'InvalidPackage'
@@ -42,7 +42,7 @@ android {
         // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
         applicationId "com.github.cloudwebrtc.flutter_callkeep_example"
         minSdkVersion 23
-        targetSdkVersion 28
+        targetSdkVersion 30
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName
     }

example/android/app/src/main/AndroidManifest.xml

@@ -66,6 +66,7 @@
             android:value="2" />
         <service android:name="io.wazo.callkeep.VoiceConnectionService"
           android:label="Wazo"
+          android:foregroundServiceType="camera|microphone"
           android:permission="android.permission.BIND_TELECOM_CONNECTION_SERVICE">
           <intent-filter>
               <action android:name="android.telecom.ConnectionService" />

example/android/settings_aar.gradle

@@ -0,0 +1 @@
+include ':app'

example/ios/Runner.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -54,7 +54,7 @@ Future<dynamic> myBackgroundMessageHandler(Map<String, dynamic> message) {
     print('backgroundMessage: CallKeepPerformEndCallAction ${event.callUUID}');
   });
   if (!_callKeepInited) {
-    _callKeep.setup(<String, dynamic>{
+    _callKeep.setup(null, <String, dynamic>{
       'ios': {
         'appName': 'CallKeepDemo',
       },
@@ -64,6 +64,12 @@ Future<dynamic> myBackgroundMessageHandler(Map<String, dynamic> message) {
             'This application needs to access your phone accounts',
         'cancelButton': 'Cancel',
         'okButton': 'ok',
+        'foregroundService': {
+          'channelId': 'com.company.my',
+          'channelName': 'Foreground service for my app',
+          'notificationTitle': 'My app is running on background',
+          'notificationIcon': 'Path to the resource icon of the notification',
+        },
       },
     });
     _callKeepInited = true;
@@ -263,6 +269,12 @@ class _MyAppState extends State<HomePage> {
             'This application needs to access your phone accounts',
         'cancelButton': 'Cancel',
         'okButton': 'ok',
+        'foregroundService': {
+          'channelId': 'com.company.my',
+          'channelName': 'Foreground service for my app',
+          'notificationTitle': 'My app is running on background',
+          'notificationIcon': 'Path to the resource icon of the notification',
+        },
       });
     }
 
@@ -298,7 +310,7 @@ class _MyAppState extends State<HomePage> {
     _callKeep.on(CallKeepPerformEndCallAction(), endCall);
     _callKeep.on(CallKeepPushKitToken(), onPushKitToken);
 
-    _callKeep.setup(<String, dynamic>{
+    _callKeep.setup(context, <String, dynamic>{
       'ios': {
         'appName': 'CallKeepDemo',
       },