| /* | |
| * Copyright (C) 2013 The Android Open Source Project | |
| * | |
| * Licensed under the Apache License, Version 2.0 (the "License"); | |
| * you may not use this file except in compliance with the License. | |
| * You may obtain a copy of the License at | |
| * | |
| * http://www.apache.org/licenses/LICENSE-2.0 | |
| * | |
| * Unless required by applicable law or agreed to in writing, software | |
| * distributed under the License is distributed on an "AS IS" BASIS, | |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| * See the License for the specific language governing permissions and | |
| * limitations under the License. | |
| */ | |
| package android.telecom; | |
| import android.annotation.CallbackExecutor; | |
| import android.annotation.NonNull; | |
| import android.annotation.SdkConstant; | |
| import android.annotation.SystemApi; | |
| import android.app.Service; | |
| import android.app.UiModeManager; | |
| import android.bluetooth.BluetoothDevice; | |
| import android.content.ComponentName; | |
| import android.content.Intent; | |
| import android.hardware.camera2.CameraManager; | |
| import android.net.Uri; | |
| import android.os.Bundle; | |
| import android.os.Handler; | |
| import android.os.IBinder; | |
| import android.os.Looper; | |
| import android.os.Message; | |
| import android.os.OutcomeReceiver; | |
| import android.view.Surface; | |
| import com.android.internal.os.SomeArgs; | |
| import com.android.internal.telecom.IInCallAdapter; | |
| import com.android.internal.telecom.IInCallService; | |
| import java.util.Collections; | |
| import java.util.List; | |
| import java.util.Objects; | |
| import java.util.concurrent.Executor; | |
| /** | |
| * This service is implemented by an app that wishes to provide functionality for managing | |
| * phone calls. | |
| * <h2>Becoming the Default Phone App</h2> | |
| * The default dialer/phone app is one which provides the in-call user interface while the device is | |
| * in a call. It also provides the user with a means to initiate calls and see a history of calls | |
| * on their device. A device is bundled with a system provided default dialer/phone app. The user | |
| * may choose a single app to take over this role from the system app. An app which wishes to | |
| * fulfill this role uses the {@link android.app.role.RoleManager} to request that they fill the | |
| * {@link android.app.role.RoleManager#ROLE_DIALER} role. | |
| * <p> | |
| * The default phone app provides a user interface while the device is in a call, and the device is | |
| * not in car mode (i.e. {@link UiModeManager#getCurrentModeType()} is not | |
| * {@link android.content.res.Configuration#UI_MODE_TYPE_CAR}). | |
| * <p> | |
| * In order to fill the {@link android.app.role.RoleManager#ROLE_DIALER} role, an app must meet a | |
| * number of requirements: | |
| * <ul> | |
| * <li>It must handle the {@link Intent#ACTION_DIAL} intent. This means the app must provide | |
| * a dial pad UI for the user to initiate outgoing calls.</li> | |
| * <li>It must fully implement the {@link InCallService} API and provide both an incoming call | |
| * UI, as well as an ongoing call UI.</li> | |
| * </ul> | |
| * <p> | |
| * Note: If the app filling the {@link android.app.role.RoleManager#ROLE_DIALER} returns a | |
| * {@code null} {@link InCallService} during binding, the Telecom framework will automatically fall | |
| * back to using the dialer app preloaded on the device. The system will display a notification to | |
| * the user to let them know that their call was continued using the preloaded dialer app. Your | |
| * app should never return a {@code null} binding; doing so means it does not fulfil the | |
| * requirements of {@link android.app.role.RoleManager#ROLE_DIALER}. | |
| * <p> | |
| * Note: If your app fills {@link android.app.role.RoleManager#ROLE_DIALER} and makes changes at | |
| * runtime which cause it to no longer fulfil the requirements of this role, | |
| * {@link android.app.role.RoleManager} will automatically remove your app from the role and close | |
| * your app. For example, if you use | |
| * {@link android.content.pm.PackageManager#setComponentEnabledSetting(ComponentName, int, int)} to | |
| * programmatically disable the {@link InCallService} your app declares in its manifest, your app | |
| * will no longer fulfil the requirements expected of | |
| * {@link android.app.role.RoleManager#ROLE_DIALER}. | |
| * <p> | |
| * The preloaded dialer will ALWAYS be used when the user places an emergency call, even if your | |
| * app fills the {@link android.app.role.RoleManager#ROLE_DIALER} role. To ensure an optimal | |
| * experience when placing an emergency call, the default dialer should ALWAYS use | |
| * {@link android.telecom.TelecomManager#placeCall(Uri, Bundle)} to place calls (including | |
| * emergency calls). This ensures that the platform is able to verify that the request came from | |
| * the default dialer. If a non-preloaded dialer app uses {@link Intent#ACTION_CALL} to place an | |
| * emergency call, it will be raised to the preloaded dialer app using {@link Intent#ACTION_DIAL} | |
| * for confirmation; this is a suboptimal user experience. | |
| * <p> | |
| * Below is an example manifest registration for an {@code InCallService}. The meta-data | |
| * {@link TelecomManager#METADATA_IN_CALL_SERVICE_UI} indicates that this particular | |
| * {@code InCallService} implementation intends to replace the built-in in-call UI. | |
| * The meta-data {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING} indicates that this | |
| * {@link InCallService} will play the ringtone for incoming calls. See | |
| * <a href="#incomingCallNotification">below</a> for more information on showing the incoming call | |
| * UI and playing the ringtone in your app. | |
| * <pre> | |
| * {@code | |
| * <service android:name="your.package.YourInCallServiceImplementation" | |
| * android:permission="android.permission.BIND_INCALL_SERVICE" | |
| * android:exported="true"> | |
| * <meta-data android:name="android.telecom.IN_CALL_SERVICE_UI" android:value="true" /> | |
| * <meta-data android:name="android.telecom.IN_CALL_SERVICE_RINGING" | |
| * android:value="true" /> | |
| * <intent-filter> | |
| * <action android:name="android.telecom.InCallService"/> | |
| * </intent-filter> | |
| * </service> | |
| * } | |
| * </pre> | |
| * | |
| * <em>Note: You should NOT mark your {@link InCallService} with the attribute | |
| * {@code android:exported="false"}; doing so can result in a failure to bind to your implementation | |
| * during calls.</em> | |
| * <p> | |
| * In addition to implementing the {@link InCallService} API, you must also declare an activity in | |
| * your manifest which handles the {@link Intent#ACTION_DIAL} intent. The example below illustrates | |
| * how this is done: | |
| * <pre> | |
| * {@code | |
| * <activity android:name="your.package.YourDialerActivity" | |
| * android:label="@string/yourDialerActivityLabel"> | |
| * <intent-filter> | |
| * <action android:name="android.intent.action.DIAL" /> | |
| * <category android:name="android.intent.category.DEFAULT" /> | |
| * </intent-filter> | |
| * <intent-filter> | |
| * <action android:name="android.intent.action.DIAL" /> | |
| * <category android:name="android.intent.category.DEFAULT" /> | |
| * <data android:scheme="tel" /> | |
| * </intent-filter> | |
| * </activity> | |
| * } | |
| * </pre> | |
| * <p> | |
| * When a user installs your application and runs it for the first time, you should use the | |
| * {@link android.app.role.RoleManager} to prompt the user to see if they would like your app to | |
| * be the new default phone app. | |
| * <p id="requestRole"> | |
| * The code below shows how your app can request to become the default phone/dialer app: | |
| * <pre> | |
| * {@code | |
| * private static final int REQUEST_ID = 1; | |
| * | |
| * public void requestRole() { | |
| * RoleManager roleManager = (RoleManager) getSystemService(ROLE_SERVICE); | |
| * Intent intent = roleManager.createRequestRoleIntent(RoleManager.ROLE_DIALER); | |
| * startActivityForResult(intent, REQUEST_ID); | |
| * } | |
| * | |
| * @Override | |
| * public void onActivityResult(int requestCode, int resultCode, Intent data) { | |
| * if (requestCode == REQUEST_ID) { | |
| * if (resultCode == android.app.Activity.RESULT_OK) { | |
| * // Your app is now the default dialer app | |
| * } else { | |
| * // Your app is not the default dialer app | |
| * } | |
| * } | |
| * } | |
| * } | |
| * | |
| * </pre> | |
| * <p id="companionInCallService"> | |
| * <h3>Access to InCallService for Wearable Devices</h3> | |
| * <ol> | |
| * If your app is a third-party companion app and wants to access InCallService APIs, what your | |
| * app could do are: | |
| * <p> | |
| * <ol> | |
| * <li> Declare MANAGE_ONGOING_CALLS permission in your manifest | |
| * <li> Associate with a physical wearable device via the | |
| * {@link android.companion.CompanionDeviceManager} API as a companion app. See: | |
| * https://developer.android.com/guide/topics/connectivity/companion-device-pairing | |
| * <li> Implement this InCallService with BIND_INCALL_SERVICE permission | |
| * </ol> | |
| * </ol> | |
| * <p> | |
| * | |
| * </pre> | |
| * <p id="incomingCallNotification"> | |
| * <h3>Showing the Incoming Call Notification</h3> | |
| * When your app receives a new incoming call via {@link InCallService#onCallAdded(Call)}, it is | |
| * responsible for displaying an incoming call UI for the incoming call. It should do this using | |
| * {@link android.app.NotificationManager} APIs to post a new incoming call notification. | |
| * <p> | |
| * Where your app declares the meta-data {@link TelecomManager#METADATA_IN_CALL_SERVICE_RINGING}, it | |
| * is responsible for playing the ringtone for incoming calls. Your app should create a | |
| * {@link android.app.NotificationChannel} which specifies the desired ringtone. For example: | |
| * <pre><code> | |
| * NotificationChannel channel = new NotificationChannel(YOUR_CHANNEL_ID, "Incoming Calls", | |
| * NotificationManager.IMPORTANCE_MAX); | |
| * // other channel setup stuff goes here. | |
| * | |
| * // We'll use the default system ringtone for our incoming call notification channel. You can | |
| * // use your own audio resource here. | |
| * Uri ringtoneUri = RingtoneManager.getDefaultUri(RingtoneManager.TYPE_RINGTONE); | |
| * channel.setSound(ringtoneUri, new AudioAttributes.Builder() | |
| * // Setting the AudioAttributes is important as it identifies the purpose of your | |
| * // notification sound. | |
| * .setUsage(AudioAttributes.USAGE_NOTIFICATION_RINGTONE) | |
| * .setContentType(AudioAttributes.CONTENT_TYPE_SONIFICATION) | |
| * .build()); | |
| * | |
| * NotificationManager mgr = getSystemService(NotificationManager.class); | |
| * mgr.createNotificationChannel(channel); | |
| * </code></pre> | |
| * <p> | |
| * When your app receives a new incoming call, it creates a {@link android.app.Notification} for the | |
| * incoming call and associates it with your incoming call notification channel. You can specify a | |
| * {@link android.app.PendingIntent} on the notification which will launch your full screen | |
| * incoming call UI. The notification manager framework will display your notification as a | |
| * heads-up notification if the user is actively using the phone. When the user is not using the | |
| * phone, your full-screen incoming call UI is used instead. | |
| * For example: | |
| * <pre><code>{@code | |
| * // Create an intent which triggers your fullscreen incoming call user interface. | |
| * Intent intent = new Intent(Intent.ACTION_MAIN, null); | |
| * intent.setFlags(Intent.FLAG_ACTIVITY_NO_USER_ACTION | Intent.FLAG_ACTIVITY_NEW_TASK); | |
| * intent.setClass(context, YourIncomingCallActivity.class); | |
| * PendingIntent pendingIntent = PendingIntent.getActivity(context, 1, intent, PendingIntent.FLAG_MUTABLE_UNAUDITED); | |
| * | |
| * // Build the notification as an ongoing high priority item; this ensures it will show as | |
| * // a heads up notification which slides down over top of the current content. | |
| * final Notification.Builder builder = new Notification.Builder(context); | |
| * builder.setOngoing(true); | |
| * builder.setPriority(Notification.PRIORITY_HIGH); | |
| * | |
| * // Set notification content intent to take user to the fullscreen UI if user taps on the | |
| * // notification body. | |
| * builder.setContentIntent(pendingIntent); | |
| * // Set full screen intent to trigger display of the fullscreen UI when the notification | |
| * // manager deems it appropriate. | |
| * builder.setFullScreenIntent(pendingIntent, true); | |
| * | |
| * // Setup notification content. | |
| * builder.setSmallIcon( yourIconResourceId ); | |
| * builder.setContentTitle("Your notification title"); | |
| * builder.setContentText("Your notification content."); | |
| * | |
| * // Use builder.addAction(..) to add buttons to answer or reject the call. | |
| * | |
| * NotificationManager notificationManager = mContext.getSystemService( | |
| * NotificationManager.class); | |
| * notificationManager.notify(YOUR_CHANNEL_ID, YOUR_TAG, YOUR_ID, builder.build()); | |
| * }</pre> | |
| * <p> | |
| */ | |
| public abstract class InCallService extends Service { | |
| /** | |
| * The {@link Intent} that must be declared as handled by the service. | |
| */ | |
| @SdkConstant(SdkConstant.SdkConstantType.SERVICE_ACTION) | |
| public static final String SERVICE_INTERFACE = "android.telecom.InCallService"; | |
| private static final int MSG_SET_IN_CALL_ADAPTER = 1; | |
| private static final int MSG_ADD_CALL = 2; | |
| private static final int MSG_UPDATE_CALL = 3; | |
| private static final int MSG_SET_POST_DIAL_WAIT = 4; | |
| private static final int MSG_ON_CALL_AUDIO_STATE_CHANGED = 5; | |
| private static final int MSG_BRING_TO_FOREGROUND = 6; | |
| private static final int MSG_ON_CAN_ADD_CALL_CHANGED = 7; | |
| private static final int MSG_SILENCE_RINGER = 8; | |
| private static final int MSG_ON_CONNECTION_EVENT = 9; | |
| private static final int MSG_ON_RTT_UPGRADE_REQUEST = 10; | |
| private static final int MSG_ON_RTT_INITIATION_FAILURE = 11; | |
| private static final int MSG_ON_HANDOVER_FAILED = 12; | |
| private static final int MSG_ON_HANDOVER_COMPLETE = 13; | |
| private static final int MSG_ON_CALL_ENDPOINT_CHANGED = 14; | |
| private static final int MSG_ON_AVAILABLE_CALL_ENDPOINTS_CHANGED = 15; | |
| private static final int MSG_ON_MUTE_STATE_CHANGED = 16; | |
| private CallEndpoint mCallEndpoint; | |
| /** Default Handler used to consolidate binder method calls onto a single thread. */ | |
| private final Handler mHandler = new Handler(Looper.getMainLooper()) { | |
| @Override | |
| public void handleMessage(Message msg) { | |
| if (mPhone == null && msg.what != MSG_SET_IN_CALL_ADAPTER) { | |
| return; | |
| } | |
| switch (msg.what) { | |
| case MSG_SET_IN_CALL_ADAPTER: | |
| if (mPhone != null) { | |
| Log.i(this, "mPhone is already instantiated, ignoring " | |
| + "request to reset adapter."); | |
| break; | |
| } | |
| String callingPackage = getApplicationContext().getOpPackageName(); | |
| mPhone = new Phone(new InCallAdapter((IInCallAdapter) msg.obj), callingPackage, | |
| getApplicationContext().getApplicationInfo().targetSdkVersion); | |
| mPhone.addListener(mPhoneListener); | |
| onPhoneCreated(mPhone); | |
| break; | |
| case MSG_ADD_CALL: | |
| mPhone.internalAddCall((ParcelableCall) msg.obj); | |
| break; | |
| case MSG_UPDATE_CALL: | |
| mPhone.internalUpdateCall((ParcelableCall) msg.obj); | |
| break; | |
| case MSG_SET_POST_DIAL_WAIT: { | |
| SomeArgs args = (SomeArgs) msg.obj; | |
| try { | |
| String callId = (String) args.arg1; | |
| String remaining = (String) args.arg2; | |
| mPhone.internalSetPostDialWait(callId, remaining); | |
| } finally { | |
| args.recycle(); | |
| } | |
| break; | |
| } | |
| case MSG_ON_CALL_AUDIO_STATE_CHANGED: | |
| mPhone.internalCallAudioStateChanged((CallAudioState) msg.obj); | |
| break; | |
| case MSG_BRING_TO_FOREGROUND: | |
| mPhone.internalBringToForeground(msg.arg1 == 1); | |
| break; | |
| case MSG_ON_CAN_ADD_CALL_CHANGED: | |
| mPhone.internalSetCanAddCall(msg.arg1 == 1); | |
| break; | |
| case MSG_SILENCE_RINGER: | |
| mPhone.internalSilenceRinger(); | |
| break; | |
| case MSG_ON_CONNECTION_EVENT: { | |
| SomeArgs args = (SomeArgs) msg.obj; | |
| try { | |
| String callId = (String) args.arg1; | |
| String event = (String) args.arg2; | |
| Bundle extras = (Bundle) args.arg3; | |
| mPhone.internalOnConnectionEvent(callId, event, extras); | |
| } finally { | |
| args.recycle(); | |
| } | |
| break; | |
| } | |
| case MSG_ON_RTT_UPGRADE_REQUEST: { | |
| String callId = (String) msg.obj; | |
| int requestId = msg.arg1; | |
| mPhone.internalOnRttUpgradeRequest(callId, requestId); | |
| break; | |
| } | |
| case MSG_ON_RTT_INITIATION_FAILURE: { | |
| String callId = (String) msg.obj; | |
| int reason = msg.arg1; | |
| mPhone.internalOnRttInitiationFailure(callId, reason); | |
| break; | |
| } | |
| case MSG_ON_HANDOVER_FAILED: { | |
| String callId = (String) msg.obj; | |
| int error = msg.arg1; | |
| mPhone.internalOnHandoverFailed(callId, error); | |
| break; | |
| } | |
| case MSG_ON_HANDOVER_COMPLETE: { | |
| String callId = (String) msg.obj; | |
| mPhone.internalOnHandoverComplete(callId); | |
| break; | |
| } | |
| case MSG_ON_CALL_ENDPOINT_CHANGED: { | |
| CallEndpoint endpoint = (CallEndpoint) msg.obj; | |
| if (!Objects.equals(mCallEndpoint, endpoint)) { | |
| mCallEndpoint = endpoint; | |
| InCallService.this.onCallEndpointChanged(mCallEndpoint); | |
| } | |
| break; | |
| } | |
| case MSG_ON_AVAILABLE_CALL_ENDPOINTS_CHANGED: { | |
| InCallService.this.onAvailableCallEndpointsChanged( | |
| (List<CallEndpoint>) msg.obj); | |
| break; | |
| } | |
| case MSG_ON_MUTE_STATE_CHANGED: { | |
| InCallService.this.onMuteStateChanged((boolean) msg.obj); | |
| break; | |
| } | |
| default: | |
| break; | |
| } | |
| } | |
| }; | |
| /** Manages the binder calls so that the implementor does not need to deal with it. */ | |
| private final class InCallServiceBinder extends IInCallService.Stub { | |
| @Override | |
| public void setInCallAdapter(IInCallAdapter inCallAdapter) { | |
| mHandler.obtainMessage(MSG_SET_IN_CALL_ADAPTER, inCallAdapter).sendToTarget(); | |
| } | |
| @Override | |
| public void addCall(ParcelableCall call) { | |
| mHandler.obtainMessage(MSG_ADD_CALL, call).sendToTarget(); | |
| } | |
| @Override | |
| public void updateCall(ParcelableCall call) { | |
| mHandler.obtainMessage(MSG_UPDATE_CALL, call).sendToTarget(); | |
| } | |
| @Override | |
| public void setPostDial(String callId, String remaining) { | |
| // TODO: Unused | |
| } | |
| @Override | |
| public void setPostDialWait(String callId, String remaining) { | |
| SomeArgs args = SomeArgs.obtain(); | |
| args.arg1 = callId; | |
| args.arg2 = remaining; | |
| mHandler.obtainMessage(MSG_SET_POST_DIAL_WAIT, args).sendToTarget(); | |
| } | |
| @Override | |
| public void onCallAudioStateChanged(CallAudioState callAudioState) { | |
| mHandler.obtainMessage(MSG_ON_CALL_AUDIO_STATE_CHANGED, callAudioState).sendToTarget(); | |
| } | |
| @Override | |
| public void onCallEndpointChanged(CallEndpoint callEndpoint) { | |
| mHandler.obtainMessage(MSG_ON_CALL_ENDPOINT_CHANGED, callEndpoint).sendToTarget(); | |
| } | |
| @Override | |
| public void onAvailableCallEndpointsChanged(List<CallEndpoint> availableEndpoints) { | |
| mHandler.obtainMessage(MSG_ON_AVAILABLE_CALL_ENDPOINTS_CHANGED, availableEndpoints) | |
| .sendToTarget(); | |
| } | |
| @Override | |
| public void onMuteStateChanged(boolean isMuted) { | |
| mHandler.obtainMessage(MSG_ON_MUTE_STATE_CHANGED, isMuted).sendToTarget(); | |
| } | |
| @Override | |
| public void bringToForeground(boolean showDialpad) { | |
| mHandler.obtainMessage(MSG_BRING_TO_FOREGROUND, showDialpad ? 1 : 0, 0).sendToTarget(); | |
| } | |
| @Override | |
| public void onCanAddCallChanged(boolean canAddCall) { | |
| mHandler.obtainMessage(MSG_ON_CAN_ADD_CALL_CHANGED, canAddCall ? 1 : 0, 0) | |
| .sendToTarget(); | |
| } | |
| @Override | |
| public void silenceRinger() { | |
| mHandler.obtainMessage(MSG_SILENCE_RINGER).sendToTarget(); | |
| } | |
| @Override | |
| public void onConnectionEvent(String callId, String event, Bundle extras) { | |
| SomeArgs args = SomeArgs.obtain(); | |
| args.arg1 = callId; | |
| args.arg2 = event; | |
| args.arg3 = extras; | |
| mHandler.obtainMessage(MSG_ON_CONNECTION_EVENT, args).sendToTarget(); | |
| } | |
| @Override | |
| public void onRttUpgradeRequest(String callId, int id) { | |
| mHandler.obtainMessage(MSG_ON_RTT_UPGRADE_REQUEST, id, 0, callId).sendToTarget(); | |
| } | |
| @Override | |
| public void onRttInitiationFailure(String callId, int reason) { | |
| mHandler.obtainMessage(MSG_ON_RTT_INITIATION_FAILURE, reason, 0, callId).sendToTarget(); | |
| } | |
| @Override | |
| public void onHandoverFailed(String callId, int error) { | |
| mHandler.obtainMessage(MSG_ON_HANDOVER_FAILED, error, 0, callId).sendToTarget(); | |
| } | |
| @Override | |
| public void onHandoverComplete(String callId) { | |
| mHandler.obtainMessage(MSG_ON_HANDOVER_COMPLETE, callId).sendToTarget(); | |
| } | |
| } | |
| private Phone.Listener mPhoneListener = new Phone.Listener() { | |
| /** ${inheritDoc} */ | |
| @Override | |
| public void onAudioStateChanged(Phone phone, AudioState audioState) { | |
| InCallService.this.onAudioStateChanged(audioState); | |
| } | |
| public void onCallAudioStateChanged(Phone phone, CallAudioState callAudioState) { | |
| InCallService.this.onCallAudioStateChanged(callAudioState); | |
| }; | |
| /** ${inheritDoc} */ | |
| @Override | |
| public void onBringToForeground(Phone phone, boolean showDialpad) { | |
| InCallService.this.onBringToForeground(showDialpad); | |
| } | |
| /** ${inheritDoc} */ | |
| @Override | |
| public void onCallAdded(Phone phone, Call call) { | |
| InCallService.this.onCallAdded(call); | |
| } | |
| /** ${inheritDoc} */ | |
| @Override | |
| public void onCallRemoved(Phone phone, Call call) { | |
| InCallService.this.onCallRemoved(call); | |
| } | |
| /** ${inheritDoc} */ | |
| @Override | |
| public void onCanAddCallChanged(Phone phone, boolean canAddCall) { | |
| InCallService.this.onCanAddCallChanged(canAddCall); | |
| } | |
| /** ${inheritDoc} */ | |
| @Override | |
| public void onSilenceRinger(Phone phone) { | |
| InCallService.this.onSilenceRinger(); | |
| } | |
| }; | |
| private Phone mPhone; | |
| public InCallService() { | |
| } | |
| @Override | |
| public IBinder onBind(Intent intent) { | |
| return new InCallServiceBinder(); | |
| } | |
| @Override | |
| public boolean onUnbind(Intent intent) { | |
| if (mPhone != null) { | |
| Phone oldPhone = mPhone; | |
| mPhone = null; | |
| oldPhone.destroy(); | |
| // destroy sets all the calls to disconnected if any live ones still exist. Therefore, | |
| // it is important to remove the Listener *after* the call to destroy so that | |
| // InCallService.on* callbacks are appropriately called. | |
| oldPhone.removeListener(mPhoneListener); | |
| onPhoneDestroyed(oldPhone); | |
| } | |
| return false; | |
| } | |
| /** | |
| * Obtain the {@code Phone} associated with this {@code InCallService}. | |
| * | |
| * @return The {@code Phone} object associated with this {@code InCallService}, or {@code null} | |
| * if the {@code InCallService} is not in a state where it has an associated | |
| * {@code Phone}. | |
| * @hide | |
| * @deprecated Use direct methods on InCallService instead of {@link Phone}. | |
| */ | |
| @SystemApi | |
| @Deprecated | |
| public Phone getPhone() { | |
| return mPhone; | |
| } | |
| /** | |
| * Obtains the current list of {@code Call}s to be displayed by this in-call service. | |
| * | |
| * @return A list of the relevant {@code Call}s. | |
| */ | |
| public final List<Call> getCalls() { | |
| return mPhone == null ? Collections.<Call>emptyList() : mPhone.getCalls(); | |
| } | |
| /** | |
| * Returns if the device can support additional calls. | |
| * | |
| * @return Whether the phone supports adding more calls. | |
| */ | |
| public final boolean canAddCall() { | |
| return mPhone == null ? false : mPhone.canAddCall(); | |
| } | |
| /** | |
| * Obtains the current phone call audio state. | |
| * | |
| * @return An object encapsulating the audio state. Returns null if the service is not | |
| * fully initialized. | |
| * @deprecated Use {@link #getCallAudioState()} instead. | |
| * @hide | |
| */ | |
| @Deprecated | |
| public final AudioState getAudioState() { | |
| return mPhone == null ? null : mPhone.getAudioState(); | |
| } | |
| /** | |
| * Obtains the current phone call audio state. | |
| * | |
| * @return An object encapsulating the audio state. Returns null if the service is not | |
| * fully initialized. | |
| * @deprecated Use {@link #getCurrentCallEndpoint()}, | |
| * {@link #onAvailableCallEndpointsChanged(List)} and | |
| * {@link #onMuteStateChanged(boolean)} instead. | |
| */ | |
| @Deprecated | |
| public final CallAudioState getCallAudioState() { | |
| return mPhone == null ? null : mPhone.getCallAudioState(); | |
| } | |
| /** | |
| * Sets the microphone mute state. When this request is honored, there will be change to | |
| * the {@link #getCallAudioState()}. | |
| * | |
| * @param state {@code true} if the microphone should be muted; {@code false} otherwise. | |
| */ | |
| public final void setMuted(boolean state) { | |
| if (mPhone != null) { | |
| mPhone.setMuted(state); | |
| } | |
| } | |
| /** | |
| * Sets the audio route (speaker, bluetooth, etc...). When this request is honored, there will | |
| * be change to the {@link #getCallAudioState()}. | |
| * | |
| * @param route The audio route to use. | |
| * @deprecated Use {@link #requestCallEndpointChange(CallEndpoint, Executor, OutcomeReceiver)} | |
| * instead. | |
| */ | |
| @Deprecated | |
| public final void setAudioRoute(int route) { | |
| if (mPhone != null) { | |
| mPhone.setAudioRoute(route); | |
| } | |
| } | |
| /** | |
| * Request audio routing to a specific bluetooth device. Calling this method may result in | |
| * the device routing audio to a different bluetooth device than the one specified if the | |
| * bluetooth stack is unable to route audio to the requested device. | |
| * A list of available devices can be obtained via | |
| * {@link CallAudioState#getSupportedBluetoothDevices()} | |
| * | |
| * @param bluetoothDevice The bluetooth device to connect to. | |
| * @deprecated Use {@link #requestCallEndpointChange(CallEndpoint, Executor, OutcomeReceiver)} | |
| * instead. | |
| */ | |
| @Deprecated | |
| public final void requestBluetoothAudio(@NonNull BluetoothDevice bluetoothDevice) { | |
| if (mPhone != null) { | |
| mPhone.requestBluetoothAudio(bluetoothDevice.getAddress()); | |
| } | |
| } | |
| /** | |
| * Request audio routing to a specific CallEndpoint. Clients should not define their own | |
| * CallEndpoint when requesting a change. Instead, the new endpoint should be one of the valid | |
| * endpoints provided by {@link #onAvailableCallEndpointsChanged(List)}. | |
| * When this request is honored, there will be change to the {@link #getCurrentCallEndpoint()}. | |
| * | |
| * @param endpoint The call endpoint to use. | |
| * @param executor The executor of where the callback will execute. | |
| * @param callback The callback to notify the result of the endpoint change. | |
| */ | |
| public final void requestCallEndpointChange(@NonNull CallEndpoint endpoint, | |
| @NonNull @CallbackExecutor Executor executor, | |
| @NonNull OutcomeReceiver<Void, CallEndpointException> callback) { | |
| if (mPhone != null) { | |
| mPhone.requestCallEndpointChange(endpoint, executor, callback); | |
| } | |
| } | |
| /** | |
| * Obtains the current CallEndpoint. | |
| * | |
| * @return An object encapsulating the CallEndpoint. | |
| */ | |
| @NonNull | |
| public final CallEndpoint getCurrentCallEndpoint() { | |
| return mCallEndpoint; | |
| } | |
| /** | |
| * Invoked when the {@code Phone} has been created. This is a signal to the in-call experience | |
| * to start displaying in-call information to the user. Each instance of {@code InCallService} | |
| * will have only one {@code Phone}, and this method will be called exactly once in the lifetime | |
| * of the {@code InCallService}. | |
| * | |
| * @param phone The {@code Phone} object associated with this {@code InCallService}. | |
| * @hide | |
| * @deprecated Use direct methods on InCallService instead of {@link Phone}. | |
| */ | |
| @SystemApi | |
| @Deprecated | |
| public void onPhoneCreated(Phone phone) { | |
| } | |
| /** | |
| * Invoked when a {@code Phone} has been destroyed. This is a signal to the in-call experience | |
| * to stop displaying in-call information to the user. This method will be called exactly once | |
| * in the lifetime of the {@code InCallService}, and it will always be called after a previous | |
| * call to {@link #onPhoneCreated(Phone)}. | |
| * | |
| * @param phone The {@code Phone} object associated with this {@code InCallService}. | |
| * @hide | |
| * @deprecated Use direct methods on InCallService instead of {@link Phone}. | |
| */ | |
| @SystemApi | |
| @Deprecated | |
| public void onPhoneDestroyed(Phone phone) { | |
| } | |
| /** | |
| * Called when the audio state changes. | |
| * | |
| * @param audioState The new {@link AudioState}. | |
| * @deprecated Use {@link #onCallAudioStateChanged(CallAudioState) instead}. | |
| * @hide | |
| */ | |
| @Deprecated | |
| public void onAudioStateChanged(AudioState audioState) { | |
| } | |
| /** | |
| * Called when the audio state changes. | |
| * | |
| * @param audioState The new {@link CallAudioState}. | |
| * @deprecated Use {@link #onCallEndpointChanged(CallEndpoint)}, | |
| * {@link #onAvailableCallEndpointsChanged(List)} and | |
| * {@link #onMuteStateChanged(boolean)} instead. | |
| */ | |
| @Deprecated | |
| public void onCallAudioStateChanged(CallAudioState audioState) { | |
| } | |
| /** | |
| * Called when the current CallEndpoint changes. | |
| * | |
| * @param callEndpoint The current CallEndpoint {@link CallEndpoint}. | |
| */ | |
| public void onCallEndpointChanged(@NonNull CallEndpoint callEndpoint) { | |
| } | |
| /** | |
| * Called when the available CallEndpoint changes. | |
| * | |
| * @param availableEndpoints The set of available CallEndpoint {@link CallEndpoint}. | |
| */ | |
| public void onAvailableCallEndpointsChanged(@NonNull List<CallEndpoint> availableEndpoints) { | |
| } | |
| /** | |
| * Called when the mute state changes. | |
| * | |
| * @param isMuted The current mute state. | |
| */ | |
| public void onMuteStateChanged(boolean isMuted) { | |
| } | |
| /** | |
| * Called to bring the in-call screen to the foreground. The in-call experience should | |
| * respond immediately by coming to the foreground to inform the user of the state of | |
| * ongoing {@code Call}s. | |
| * | |
| * @param showDialpad If true, put up the dialpad when the screen is shown. | |
| */ | |
| public void onBringToForeground(boolean showDialpad) { | |
| } | |
| /** | |
| * Called when a {@code Call} has been added to this in-call session. The in-call user | |
| * experience should add necessary state listeners to the specified {@code Call} and | |
| * immediately start to show the user information about the existence | |
| * and nature of this {@code Call}. Subsequent invocations of {@link #getCalls()} will | |
| * include this {@code Call}. | |
| * | |
| * @param call A newly added {@code Call}. | |
| */ | |
| public void onCallAdded(Call call) { | |
| } | |
| /** | |
| * Called when a {@code Call} has been removed from this in-call session. The in-call user | |
| * experience should remove any state listeners from the specified {@code Call} and | |
| * immediately stop displaying any information about this {@code Call}. | |
| * Subsequent invocations of {@link #getCalls()} will no longer include this {@code Call}. | |
| * | |
| * @param call A newly removed {@code Call}. | |
| */ | |
| public void onCallRemoved(Call call) { | |
| } | |
| /** | |
| * Called when the ability to add more calls changes. If the phone cannot | |
| * support more calls then {@code canAddCall} is set to {@code false}. If it can, then it | |
| * is set to {@code true}. This can be used to control the visibility of UI to add more calls. | |
| * | |
| * @param canAddCall Indicates whether an additional call can be added. | |
| */ | |
| public void onCanAddCallChanged(boolean canAddCall) { | |
| } | |
| /** | |
| * Called to silence the ringer if a ringing call exists. | |
| */ | |
| public void onSilenceRinger() { | |
| } | |
| /** | |
| * Unused; to handle connection events issued by a {@link ConnectionService}, implement the | |
| * {@link android.telecom.Call.Callback#onConnectionEvent(Call, String, Bundle)} callback. | |
| * <p> | |
| * See {@link Connection#sendConnectionEvent(String, Bundle)}. | |
| * | |
| * @param call The call the event is associated with. | |
| * @param event The event. | |
| * @param extras Any associated extras. | |
| */ | |
| public void onConnectionEvent(Call call, String event, Bundle extras) { | |
| } | |
| /** | |
| * Used to issue commands to the {@link Connection.VideoProvider} associated with a | |
| * {@link Call}. | |
| */ | |
| public static abstract class VideoCall { | |
| /** @hide */ | |
| @SuppressWarnings("HiddenAbstractMethod") | |
| public abstract void destroy(); | |
| /** | |
| * Registers a callback to receive commands and state changes for video calls. | |
| * | |
| * @param callback The video call callback. | |
| */ | |
| public abstract void registerCallback(VideoCall.Callback callback); | |
| /** | |
| * Registers a callback to receive commands and state changes for video calls. | |
| * | |
| * @param callback The video call callback. | |
| * @param handler A handler which commands and status changes will be delivered to. | |
| */ | |
| public abstract void registerCallback(VideoCall.Callback callback, Handler handler); | |
| /** | |
| * Clears the video call callback set via {@link #registerCallback}. | |
| * | |
| * @param callback The video call callback to clear. | |
| */ | |
| public abstract void unregisterCallback(VideoCall.Callback callback); | |
| /** | |
| * Sets the camera to be used for the outgoing video. | |
| * <p> | |
| * Handled by {@link Connection.VideoProvider#onSetCamera(String)}. | |
| * | |
| * @param cameraId The id of the camera (use ids as reported by | |
| * {@link CameraManager#getCameraIdList()}). | |
| */ | |
| public abstract void setCamera(String cameraId); | |
| /** | |
| * Sets the surface to be used for displaying a preview of what the user's camera is | |
| * currently capturing. When video transmission is enabled, this is the video signal which | |
| * is sent to the remote device. | |
| * <p> | |
| * Handled by {@link Connection.VideoProvider#onSetPreviewSurface(Surface)}. | |
| * | |
| * @param surface The {@link Surface}. | |
| */ | |
| public abstract void setPreviewSurface(Surface surface); | |
| /** | |
| * Sets the surface to be used for displaying the video received from the remote device. | |
| * <p> | |
| * Handled by {@link Connection.VideoProvider#onSetDisplaySurface(Surface)}. | |
| * | |
| * @param surface The {@link Surface}. | |
| */ | |
| public abstract void setDisplaySurface(Surface surface); | |
| /** | |
| * Sets the device orientation, in degrees. Assumes that a standard portrait orientation of | |
| * the device is 0 degrees. | |
| * <p> | |
| * Handled by {@link Connection.VideoProvider#onSetDeviceOrientation(int)}. | |
| * | |
| * @param rotation The device orientation, in degrees. | |
| */ | |
| public abstract void setDeviceOrientation(int rotation); | |
| /** | |
| * Sets the camera zoom ratio. | |
| * <p> | |
| * Handled by {@link Connection.VideoProvider#onSetZoom(float)}. | |
| * | |
| * @param value The camera zoom ratio; for the current camera, should be a value in the | |
| * range defined by | |
| * {@link android.hardware.camera2.CameraCharacteristics#CONTROL_ZOOM_RATIO_RANGE}. | |
| */ | |
| public abstract void setZoom(float value); | |
| /** | |
| * Issues a request to modify the properties of the current video session. | |
| * <p> | |
| * Example scenarios include: requesting an audio-only call to be upgraded to a | |
| * bi-directional video call, turning on or off the user's camera, sending a pause signal | |
| * when the {@link InCallService} is no longer the foreground application. | |
| * <p> | |
| * Handled by | |
| * {@link Connection.VideoProvider#onSendSessionModifyRequest(VideoProfile, VideoProfile)}. | |
| * | |
| * @param requestProfile The requested call video properties. | |
| */ | |
| public abstract void sendSessionModifyRequest(VideoProfile requestProfile); | |
| /** | |
| * Provides a response to a request to change the current call video session | |
| * properties. This should be called in response to a request the {@link InCallService} has | |
| * received via {@link VideoCall.Callback#onSessionModifyRequestReceived}. | |
| * <p> | |
| * Handled by | |
| * {@link Connection.VideoProvider#onSendSessionModifyResponse(VideoProfile)}. | |
| * | |
| * @param responseProfile The response call video properties. | |
| */ | |
| public abstract void sendSessionModifyResponse(VideoProfile responseProfile); | |
| /** | |
| * Issues a request to the {@link Connection.VideoProvider} to retrieve the capabilities | |
| * of the current camera. The current camera is selected using | |
| * {@link VideoCall#setCamera(String)}. | |
| * <p> | |
| * Camera capabilities are reported to the caller via | |
| * {@link VideoCall.Callback#onCameraCapabilitiesChanged(VideoProfile.CameraCapabilities)}. | |
| * <p> | |
| * Handled by {@link Connection.VideoProvider#onRequestCameraCapabilities()}. | |
| */ | |
| public abstract void requestCameraCapabilities(); | |
| /** | |
| * Issues a request to the {@link Connection.VideoProvider} to retrieve the cumulative data | |
| * usage for the video component of the current call (in bytes). Data usage is reported | |
| * to the caller via {@link VideoCall.Callback#onCallDataUsageChanged}. | |
| * <p> | |
| * Handled by {@link Connection.VideoProvider#onRequestConnectionDataUsage()}. | |
| */ | |
| public abstract void requestCallDataUsage(); | |
| /** | |
| * Provides the {@link Connection.VideoProvider} with the {@link Uri} of an image to be | |
| * displayed to the peer device when the video signal is paused. | |
| * <p> | |
| * Handled by {@link Connection.VideoProvider#onSetPauseImage(Uri)}. | |
| * | |
| * @param uri URI of image to display. | |
| */ | |
| public abstract void setPauseImage(Uri uri); | |
| /** | |
| * The {@link InCallService} extends this class to provide a means of receiving callbacks | |
| * from the {@link Connection.VideoProvider}. | |
| * <p> | |
| * When the {@link InCallService} receives the | |
| * {@link Call.Callback#onVideoCallChanged(Call, VideoCall)} callback, it should create an | |
| * instance its {@link VideoCall.Callback} implementation and set it on the | |
| * {@link VideoCall} using {@link VideoCall#registerCallback(Callback)}. | |
| */ | |
| public static abstract class Callback { | |
| /** | |
| * Called when the {@link Connection.VideoProvider} receives a session modification | |
| * request from the peer device. | |
| * <p> | |
| * The {@link InCallService} may potentially prompt the user to confirm whether they | |
| * wish to accept the request, or decide to automatically accept the request. In either | |
| * case the {@link InCallService} should call | |
| * {@link VideoCall#sendSessionModifyResponse(VideoProfile)} to indicate the video | |
| * profile agreed upon. | |
| * <p> | |
| * Callback originates from | |
| * {@link Connection.VideoProvider#receiveSessionModifyRequest(VideoProfile)}. | |
| * | |
| * @param videoProfile The requested video profile. | |
| */ | |
| public abstract void onSessionModifyRequestReceived(VideoProfile videoProfile); | |
| /** | |
| * Called when the {@link Connection.VideoProvider} receives a response to a session | |
| * modification request previously sent to the peer device. | |
| * <p> | |
| * The new video state should not be considered active by the {@link InCallService} | |
| * until the {@link Call} video state changes (the | |
| * {@link Call.Callback#onDetailsChanged(Call, Call.Details)} callback is triggered | |
| * when the video state changes). | |
| * <p> | |
| * Callback originates from | |
| * {@link Connection.VideoProvider#receiveSessionModifyResponse(int, VideoProfile, | |
| * VideoProfile)}. | |
| * | |
| * @param status Status of the session modify request. Valid values are | |
| * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_SUCCESS}, | |
| * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_FAIL}, | |
| * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_INVALID}, | |
| * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_TIMED_OUT}, | |
| * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_REJECTED_BY_REMOTE}. | |
| * @param requestedProfile The original request which was sent to the peer device. | |
| * @param responseProfile The actual profile changes made by the peer device. | |
| */ | |
| public abstract void onSessionModifyResponseReceived(int status, | |
| VideoProfile requestedProfile, VideoProfile responseProfile); | |
| /** | |
| * Handles events related to the current video session which the {@link InCallService} | |
| * may wish to handle. These are separate from requested changes to the session due to | |
| * the underlying protocol or connection. | |
| * <p> | |
| * Callback originates from | |
| * {@link Connection.VideoProvider#handleCallSessionEvent(int)}. | |
| * | |
| * @param event The event. Valid values are: | |
| * {@link Connection.VideoProvider#SESSION_EVENT_RX_PAUSE}, | |
| * {@link Connection.VideoProvider#SESSION_EVENT_RX_RESUME}, | |
| * {@link Connection.VideoProvider#SESSION_EVENT_TX_START}, | |
| * {@link Connection.VideoProvider#SESSION_EVENT_TX_STOP}, | |
| * {@link Connection.VideoProvider#SESSION_EVENT_CAMERA_FAILURE}, | |
| * {@link Connection.VideoProvider#SESSION_EVENT_CAMERA_READY}, | |
| * {@link Connection.VideoProvider#SESSION_EVENT_CAMERA_PERMISSION_ERROR}. | |
| */ | |
| public abstract void onCallSessionEvent(int event); | |
| /** | |
| * Handles a change to the video dimensions from the peer device. This could happen if, | |
| * for example, the peer changes orientation of their device, or switches cameras. | |
| * <p> | |
| * Callback originates from | |
| * {@link Connection.VideoProvider#changePeerDimensions(int, int)}. | |
| * | |
| * @param width The updated peer video width. | |
| * @param height The updated peer video height. | |
| */ | |
| public abstract void onPeerDimensionsChanged(int width, int height); | |
| /** | |
| * Handles a change to the video quality. | |
| * <p> | |
| * Callback originates from {@link Connection.VideoProvider#changeVideoQuality(int)}. | |
| * | |
| * @param videoQuality The updated peer video quality. Valid values: | |
| * {@link VideoProfile#QUALITY_HIGH}, | |
| * {@link VideoProfile#QUALITY_MEDIUM}, | |
| * {@link VideoProfile#QUALITY_LOW}, | |
| * {@link VideoProfile#QUALITY_DEFAULT}. | |
| */ | |
| public abstract void onVideoQualityChanged(int videoQuality); | |
| /** | |
| * Handles an update to the total data used for the current video session. | |
| * <p> | |
| * Used by the {@link Connection.VideoProvider} in response to | |
| * {@link VideoCall#requestCallDataUsage()}. May also be called periodically by the | |
| * {@link Connection.VideoProvider}. | |
| * <p> | |
| * Callback originates from {@link Connection.VideoProvider#setCallDataUsage(long)}. | |
| * | |
| * @param dataUsage The updated data usage (in bytes). | |
| */ | |
| public abstract void onCallDataUsageChanged(long dataUsage); | |
| /** | |
| * Handles a change in the capabilities of the currently selected camera. | |
| * <p> | |
| * Used by the {@link Connection.VideoProvider} in response to | |
| * {@link VideoCall#requestCameraCapabilities()}. The {@link Connection.VideoProvider} | |
| * may also report the camera capabilities after a call to | |
| * {@link VideoCall#setCamera(String)}. | |
| * <p> | |
| * Callback originates from | |
| * {@link Connection.VideoProvider#changeCameraCapabilities( | |
| * VideoProfile.CameraCapabilities)}. | |
| * | |
| * @param cameraCapabilities The changed camera capabilities. | |
| */ | |
| public abstract void onCameraCapabilitiesChanged( | |
| VideoProfile.CameraCapabilities cameraCapabilities); | |
| } | |
| } | |
| } |