blob: c4f5ffc03a59d3e823d97bbb32c99206da740c5b [file] [log] [blame]
Sailesh Nepalab5d2822014-03-08 18:01:06 -08001/*
2 * Copyright (C) 2013 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
Tyler Gunnef9f6f92014-09-12 22:16:17 -070017package android.telecom;
Sailesh Nepalab5d2822014-03-08 18:01:06 -080018
Tyler Gunn2ac40102014-08-18 16:23:10 -070019import android.annotation.SdkConstant;
Santos Cordona2492812015-04-15 11:05:16 -070020import android.annotation.SystemApi;
Santos Cordon2f42b112014-07-19 13:19:37 -070021import android.app.Service;
22import android.content.Intent;
Tyler Gunnb702ef82015-05-29 11:51:53 -070023import android.hardware.camera2.CameraManager;
Yorke Lee32f24732015-05-12 16:18:03 -070024import android.net.Uri;
Tyler Gunn876dbfb2016-03-14 15:18:07 -070025import android.os.Bundle;
Sailesh Nepalab5d2822014-03-08 18:01:06 -080026import android.os.Handler;
27import android.os.IBinder;
28import android.os.Looper;
29import android.os.Message;
Andrew Lee50aca232014-07-22 16:41:54 -070030import android.view.Surface;
Sailesh Nepalab5d2822014-03-08 18:01:06 -080031
Ihab Awad2f236642014-03-10 15:33:45 -070032import com.android.internal.os.SomeArgs;
Tyler Gunnef9f6f92014-09-12 22:16:17 -070033import com.android.internal.telecom.IInCallAdapter;
34import com.android.internal.telecom.IInCallService;
Sailesh Nepalab5d2822014-03-08 18:01:06 -080035
Andrew Lee50aca232014-07-22 16:41:54 -070036import java.lang.String;
Santos Cordona2492812015-04-15 11:05:16 -070037import java.util.Collections;
38import java.util.List;
Andrew Lee50aca232014-07-22 16:41:54 -070039
Sailesh Nepalab5d2822014-03-08 18:01:06 -080040/**
41 * This service is implemented by any app that wishes to provide the user-interface for managing
Tyler Gunnef9f6f92014-09-12 22:16:17 -070042 * phone calls. Telecom binds to this service while there exists a live (active or incoming) call,
Santos Cordonf2600eb2015-06-22 15:02:20 -070043 * and uses it to notify the in-call app of any live and recently disconnected calls. An app must
44 * first be set as the default phone app (See {@link TelecomManager#getDefaultDialerPackage()})
45 * before the telecom service will bind to its {@code InCallService} implementation.
46 * <p>
47 * Below is an example manifest registration for an {@code InCallService}. The meta-data
48 * ({@link TelecomManager#METADATA_IN_CALL_SERVICE_UI}) indicates that this particular
49 * {@code InCallService} implementation intends to replace the built-in in-call UI.
50 * <pre>
51 * {@code
Neil Fuller71fbb812015-11-30 09:51:33 +000052 * <service android:name="your.package.YourInCallServiceImplementation"
Sailesh Nepal78f3ba62015-12-28 16:20:56 -080053 * android:permission="android.permission.BIND_INCALL_SERVICE">
Neil Fuller71fbb812015-11-30 09:51:33 +000054 * <meta-data android:name="android.telecom.IN_CALL_SERVICE_UI" android:value="true" />
55 * <intent-filter>
56 * <action android:name="android.telecom.InCallService"/>
57 * </intent-filter>
58 * </service>
Santos Cordonf2600eb2015-06-22 15:02:20 -070059 * }
60 * </pre>
Sailesh Nepalab5d2822014-03-08 18:01:06 -080061 */
Santos Cordon2f42b112014-07-19 13:19:37 -070062public abstract class InCallService extends Service {
Tyler Gunn2ac40102014-08-18 16:23:10 -070063
64 /**
65 * The {@link Intent} that must be declared as handled by the service.
66 */
67 @SdkConstant(SdkConstant.SdkConstantType.SERVICE_ACTION)
Tyler Gunnef9f6f92014-09-12 22:16:17 -070068 public static final String SERVICE_INTERFACE = "android.telecom.InCallService";
Tyler Gunn2ac40102014-08-18 16:23:10 -070069
Sailesh Nepalab5d2822014-03-08 18:01:06 -080070 private static final int MSG_SET_IN_CALL_ADAPTER = 1;
71 private static final int MSG_ADD_CALL = 2;
Sailesh Nepal60437932014-04-05 16:44:55 -070072 private static final int MSG_UPDATE_CALL = 3;
Ihab Awad5d0410f2014-07-30 10:07:40 -070073 private static final int MSG_SET_POST_DIAL_WAIT = 4;
Yorke Lee4af59352015-05-13 14:14:54 -070074 private static final int MSG_ON_CALL_AUDIO_STATE_CHANGED = 5;
Ihab Awad5d0410f2014-07-30 10:07:40 -070075 private static final int MSG_BRING_TO_FOREGROUND = 6;
Santos Cordon6c912b72014-11-07 16:05:09 -080076 private static final int MSG_ON_CAN_ADD_CALL_CHANGED = 7;
Sailesh Nepal9c2618b2016-01-23 16:28:22 -080077 private static final int MSG_SILENCE_RINGER = 8;
Tyler Gunn876dbfb2016-03-14 15:18:07 -070078 private static final int MSG_ON_CONNECTION_EVENT = 9;
Hall Liu95d55872017-01-25 17:12:49 -080079 private static final int MSG_ON_RTT_UPGRADE_REQUEST = 10;
Sailesh Nepalab5d2822014-03-08 18:01:06 -080080
81 /** Default Handler used to consolidate binder method calls onto a single thread. */
82 private final Handler mHandler = new Handler(Looper.getMainLooper()) {
83 @Override
84 public void handleMessage(Message msg) {
Jay Shrauner5e6162d2014-09-22 20:47:45 -070085 if (mPhone == null && msg.what != MSG_SET_IN_CALL_ADAPTER) {
86 return;
87 }
88
Sailesh Nepalab5d2822014-03-08 18:01:06 -080089 switch (msg.what) {
90 case MSG_SET_IN_CALL_ADAPTER:
Tyler Gunnbf9c6fd2016-11-09 10:19:23 -080091 String callingPackage = getApplicationContext().getOpPackageName();
Tyler Gunn159f35c2017-03-02 09:28:37 -080092 mPhone = new Phone(new InCallAdapter((IInCallAdapter) msg.obj), callingPackage,
93 getApplicationContext().getApplicationInfo().targetSdkVersion);
Santos Cordona2492812015-04-15 11:05:16 -070094 mPhone.addListener(mPhoneListener);
Ihab Awade63fadb2014-07-09 21:52:04 -070095 onPhoneCreated(mPhone);
Sailesh Nepalab5d2822014-03-08 18:01:06 -080096 break;
97 case MSG_ADD_CALL:
Santos Cordon88b771d2014-07-19 13:10:40 -070098 mPhone.internalAddCall((ParcelableCall) msg.obj);
Sailesh Nepalab5d2822014-03-08 18:01:06 -080099 break;
Sailesh Nepal60437932014-04-05 16:44:55 -0700100 case MSG_UPDATE_CALL:
Santos Cordon88b771d2014-07-19 13:10:40 -0700101 mPhone.internalUpdateCall((ParcelableCall) msg.obj);
Ihab Awad2f236642014-03-10 15:33:45 -0700102 break;
Ihab Awad2f236642014-03-10 15:33:45 -0700103 case MSG_SET_POST_DIAL_WAIT: {
104 SomeArgs args = (SomeArgs) msg.obj;
105 try {
106 String callId = (String) args.arg1;
107 String remaining = (String) args.arg2;
Ihab Awade63fadb2014-07-09 21:52:04 -0700108 mPhone.internalSetPostDialWait(callId, remaining);
Ihab Awad2f236642014-03-10 15:33:45 -0700109 } finally {
110 args.recycle();
111 }
112 break;
113 }
Yorke Lee4af59352015-05-13 14:14:54 -0700114 case MSG_ON_CALL_AUDIO_STATE_CHANGED:
115 mPhone.internalCallAudioStateChanged((CallAudioState) msg.obj);
Sailesh Nepalb632e5b2014-04-03 12:54:33 -0700116 break;
Santos Cordon3534ede2014-05-29 13:07:10 -0700117 case MSG_BRING_TO_FOREGROUND:
Ihab Awade63fadb2014-07-09 21:52:04 -0700118 mPhone.internalBringToForeground(msg.arg1 == 1);
Santos Cordon3534ede2014-05-29 13:07:10 -0700119 break;
Santos Cordon6c912b72014-11-07 16:05:09 -0800120 case MSG_ON_CAN_ADD_CALL_CHANGED:
121 mPhone.internalSetCanAddCall(msg.arg1 == 1);
122 break;
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800123 case MSG_SILENCE_RINGER:
124 mPhone.internalSilenceRinger();
125 break;
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700126 case MSG_ON_CONNECTION_EVENT: {
127 SomeArgs args = (SomeArgs) msg.obj;
128 try {
129 String callId = (String) args.arg1;
130 String event = (String) args.arg2;
131 Bundle extras = (Bundle) args.arg3;
132 mPhone.internalOnConnectionEvent(callId, event, extras);
133 } finally {
134 args.recycle();
135 }
136 break;
137 }
Hall Liu95d55872017-01-25 17:12:49 -0800138 case MSG_ON_RTT_UPGRADE_REQUEST: {
139 String callId = (String) msg.obj;
140 int requestId = msg.arg1;
141 mPhone.internalOnRttUpgradeRequest(callId, requestId);
142 break;
143 }
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800144 default:
145 break;
146 }
147 }
148 };
149
150 /** Manages the binder calls so that the implementor does not need to deal with it. */
151 private final class InCallServiceBinder extends IInCallService.Stub {
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800152 @Override
153 public void setInCallAdapter(IInCallAdapter inCallAdapter) {
154 mHandler.obtainMessage(MSG_SET_IN_CALL_ADAPTER, inCallAdapter).sendToTarget();
155 }
156
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800157 @Override
Santos Cordon88b771d2014-07-19 13:10:40 -0700158 public void addCall(ParcelableCall call) {
Sailesh Nepal60437932014-04-05 16:44:55 -0700159 mHandler.obtainMessage(MSG_ADD_CALL, call).sendToTarget();
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800160 }
161
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800162 @Override
Santos Cordon88b771d2014-07-19 13:10:40 -0700163 public void updateCall(ParcelableCall call) {
Sailesh Nepal60437932014-04-05 16:44:55 -0700164 mHandler.obtainMessage(MSG_UPDATE_CALL, call).sendToTarget();
Ihab Awad2f236642014-03-10 15:33:45 -0700165 }
166
167 @Override
168 public void setPostDial(String callId, String remaining) {
Ihab Awad5d0410f2014-07-30 10:07:40 -0700169 // TODO: Unused
Ihab Awad2f236642014-03-10 15:33:45 -0700170 }
171
172 @Override
173 public void setPostDialWait(String callId, String remaining) {
174 SomeArgs args = SomeArgs.obtain();
175 args.arg1 = callId;
176 args.arg2 = remaining;
177 mHandler.obtainMessage(MSG_SET_POST_DIAL_WAIT, args).sendToTarget();
178 }
Sailesh Nepalb632e5b2014-04-03 12:54:33 -0700179
180 @Override
Yorke Lee4af59352015-05-13 14:14:54 -0700181 public void onCallAudioStateChanged(CallAudioState callAudioState) {
182 mHandler.obtainMessage(MSG_ON_CALL_AUDIO_STATE_CHANGED, callAudioState).sendToTarget();
Sailesh Nepalb632e5b2014-04-03 12:54:33 -0700183 }
Santos Cordon3534ede2014-05-29 13:07:10 -0700184
Santos Cordon3534ede2014-05-29 13:07:10 -0700185 @Override
186 public void bringToForeground(boolean showDialpad) {
187 mHandler.obtainMessage(MSG_BRING_TO_FOREGROUND, showDialpad ? 1 : 0, 0).sendToTarget();
188 }
Santos Cordon6c912b72014-11-07 16:05:09 -0800189
190 @Override
191 public void onCanAddCallChanged(boolean canAddCall) {
192 mHandler.obtainMessage(MSG_ON_CAN_ADD_CALL_CHANGED, canAddCall ? 1 : 0, 0)
193 .sendToTarget();
194 }
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800195
196 @Override
197 public void silenceRinger() {
198 mHandler.obtainMessage(MSG_SILENCE_RINGER).sendToTarget();
199 }
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700200
201 @Override
202 public void onConnectionEvent(String callId, String event, Bundle extras) {
203 SomeArgs args = SomeArgs.obtain();
204 args.arg1 = callId;
205 args.arg2 = event;
206 args.arg3 = extras;
207 mHandler.obtainMessage(MSG_ON_CONNECTION_EVENT, args).sendToTarget();
208 }
Hall Liu95d55872017-01-25 17:12:49 -0800209
210 @Override
211 public void onRttUpgradeRequest(String callId, int id) {
212 mHandler.obtainMessage(MSG_ON_RTT_UPGRADE_REQUEST, id, 0, callId).sendToTarget();
213 }
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800214 }
215
Santos Cordona2492812015-04-15 11:05:16 -0700216 private Phone.Listener mPhoneListener = new Phone.Listener() {
217 /** ${inheritDoc} */
218 @Override
219 public void onAudioStateChanged(Phone phone, AudioState audioState) {
220 InCallService.this.onAudioStateChanged(audioState);
221 }
222
Yorke Lee4af59352015-05-13 14:14:54 -0700223 public void onCallAudioStateChanged(Phone phone, CallAudioState callAudioState) {
224 InCallService.this.onCallAudioStateChanged(callAudioState);
225 };
226
Santos Cordona2492812015-04-15 11:05:16 -0700227 /** ${inheritDoc} */
228 @Override
229 public void onBringToForeground(Phone phone, boolean showDialpad) {
230 InCallService.this.onBringToForeground(showDialpad);
231 }
232
233 /** ${inheritDoc} */
234 @Override
235 public void onCallAdded(Phone phone, Call call) {
236 InCallService.this.onCallAdded(call);
237 }
238
239 /** ${inheritDoc} */
240 @Override
241 public void onCallRemoved(Phone phone, Call call) {
242 InCallService.this.onCallRemoved(call);
243 }
244
245 /** ${inheritDoc} */
246 @Override
247 public void onCanAddCallChanged(Phone phone, boolean canAddCall) {
248 InCallService.this.onCanAddCallChanged(canAddCall);
249 }
250
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800251 /** ${inheritDoc} */
252 @Override
253 public void onSilenceRinger(Phone phone) {
254 InCallService.this.onSilenceRinger();
255 }
256
Santos Cordona2492812015-04-15 11:05:16 -0700257 };
258
Ihab Awade63fadb2014-07-09 21:52:04 -0700259 private Phone mPhone;
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800260
Santos Cordon2f42b112014-07-19 13:19:37 -0700261 public InCallService() {
262 }
Evan Charlton924748f2014-04-03 08:36:38 -0700263
Santos Cordon2f42b112014-07-19 13:19:37 -0700264 @Override
265 public IBinder onBind(Intent intent) {
Ihab Awade63fadb2014-07-09 21:52:04 -0700266 return new InCallServiceBinder();
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800267 }
268
Santos Cordonf30d7e92014-08-26 09:54:33 -0700269 @Override
270 public boolean onUnbind(Intent intent) {
Santos Cordon619b3c02014-09-02 17:13:45 -0700271 if (mPhone != null) {
272 Phone oldPhone = mPhone;
273 mPhone = null;
Santos Cordonf30d7e92014-08-26 09:54:33 -0700274
Santos Cordon619b3c02014-09-02 17:13:45 -0700275 oldPhone.destroy();
Santos Cordona2492812015-04-15 11:05:16 -0700276 // destroy sets all the calls to disconnected if any live ones still exist. Therefore,
277 // it is important to remove the Listener *after* the call to destroy so that
278 // InCallService.on* callbacks are appropriately called.
279 oldPhone.removeListener(mPhoneListener);
280
Santos Cordon619b3c02014-09-02 17:13:45 -0700281 onPhoneDestroyed(oldPhone);
282 }
Santos Cordona2492812015-04-15 11:05:16 -0700283
Santos Cordonf30d7e92014-08-26 09:54:33 -0700284 return false;
285 }
286
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800287 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700288 * Obtain the {@code Phone} associated with this {@code InCallService}.
289 *
290 * @return The {@code Phone} object associated with this {@code InCallService}, or {@code null}
Santos Cordon2f42b112014-07-19 13:19:37 -0700291 * if the {@code InCallService} is not in a state where it has an associated
292 * {@code Phone}.
Santos Cordona2492812015-04-15 11:05:16 -0700293 * @hide
Santos Cordon29886d82015-04-16 15:34:07 -0700294 * @deprecated Use direct methods on InCallService instead of {@link Phone}.
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800295 */
Santos Cordona2492812015-04-15 11:05:16 -0700296 @SystemApi
Santos Cordon29886d82015-04-16 15:34:07 -0700297 @Deprecated
298 public Phone getPhone() {
Ihab Awade63fadb2014-07-09 21:52:04 -0700299 return mPhone;
Evan Charlton924748f2014-04-03 08:36:38 -0700300 }
301
302 /**
Santos Cordon895d4b82015-06-25 16:41:48 -0700303 * Obtains the current list of {@code Call}s to be displayed by this in-call service.
Santos Cordona2492812015-04-15 11:05:16 -0700304 *
305 * @return A list of the relevant {@code Call}s.
306 */
307 public final List<Call> getCalls() {
308 return mPhone == null ? Collections.<Call>emptyList() : mPhone.getCalls();
309 }
310
311 /**
312 * Returns if the device can support additional calls.
313 *
314 * @return Whether the phone supports adding more calls.
315 */
316 public final boolean canAddCall() {
317 return mPhone == null ? false : mPhone.canAddCall();
318 }
319
320 /**
321 * Obtains the current phone call audio state.
322 *
323 * @return An object encapsulating the audio state. Returns null if the service is not
324 * fully initialized.
Yorke Lee4af59352015-05-13 14:14:54 -0700325 * @deprecated Use {@link #getCallAudioState()} instead.
326 * @hide
Santos Cordona2492812015-04-15 11:05:16 -0700327 */
Yorke Lee4af59352015-05-13 14:14:54 -0700328 @Deprecated
Santos Cordona2492812015-04-15 11:05:16 -0700329 public final AudioState getAudioState() {
330 return mPhone == null ? null : mPhone.getAudioState();
331 }
332
333 /**
Yorke Lee4af59352015-05-13 14:14:54 -0700334 * Obtains the current phone call audio state.
335 *
336 * @return An object encapsulating the audio state. Returns null if the service is not
337 * fully initialized.
338 */
339 public final CallAudioState getCallAudioState() {
340 return mPhone == null ? null : mPhone.getCallAudioState();
341 }
342
343 /**
Santos Cordona2492812015-04-15 11:05:16 -0700344 * Sets the microphone mute state. When this request is honored, there will be change to
Yorke Lee4af59352015-05-13 14:14:54 -0700345 * the {@link #getCallAudioState()}.
Santos Cordona2492812015-04-15 11:05:16 -0700346 *
347 * @param state {@code true} if the microphone should be muted; {@code false} otherwise.
348 */
349 public final void setMuted(boolean state) {
350 if (mPhone != null) {
351 mPhone.setMuted(state);
352 }
353 }
354
355 /**
356 * Sets the audio route (speaker, bluetooth, etc...). When this request is honored, there will
Yorke Lee4af59352015-05-13 14:14:54 -0700357 * be change to the {@link #getCallAudioState()}.
Santos Cordona2492812015-04-15 11:05:16 -0700358 *
359 * @param route The audio route to use.
360 */
361 public final void setAudioRoute(int route) {
362 if (mPhone != null) {
363 mPhone.setAudioRoute(route);
364 }
365 }
366
367 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700368 * Invoked when the {@code Phone} has been created. This is a signal to the in-call experience
369 * to start displaying in-call information to the user. Each instance of {@code InCallService}
Santos Cordon2f42b112014-07-19 13:19:37 -0700370 * will have only one {@code Phone}, and this method will be called exactly once in the lifetime
371 * of the {@code InCallService}.
Evan Charlton924748f2014-04-03 08:36:38 -0700372 *
Ihab Awade63fadb2014-07-09 21:52:04 -0700373 * @param phone The {@code Phone} object associated with this {@code InCallService}.
Santos Cordona2492812015-04-15 11:05:16 -0700374 * @hide
Santos Cordon29886d82015-04-16 15:34:07 -0700375 * @deprecated Use direct methods on InCallService instead of {@link Phone}.
Evan Charlton924748f2014-04-03 08:36:38 -0700376 */
Santos Cordona2492812015-04-15 11:05:16 -0700377 @SystemApi
Santos Cordon29886d82015-04-16 15:34:07 -0700378 @Deprecated
Santos Cordon2f42b112014-07-19 13:19:37 -0700379 public void onPhoneCreated(Phone phone) {
380 }
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800381
382 /**
Ihab Awade63fadb2014-07-09 21:52:04 -0700383 * Invoked when a {@code Phone} has been destroyed. This is a signal to the in-call experience
384 * to stop displaying in-call information to the user. This method will be called exactly once
385 * in the lifetime of the {@code InCallService}, and it will always be called after a previous
386 * call to {@link #onPhoneCreated(Phone)}.
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800387 *
Ihab Awade63fadb2014-07-09 21:52:04 -0700388 * @param phone The {@code Phone} object associated with this {@code InCallService}.
Santos Cordona2492812015-04-15 11:05:16 -0700389 * @hide
Santos Cordon29886d82015-04-16 15:34:07 -0700390 * @deprecated Use direct methods on InCallService instead of {@link Phone}.
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800391 */
Santos Cordona2492812015-04-15 11:05:16 -0700392 @SystemApi
Santos Cordon29886d82015-04-16 15:34:07 -0700393 @Deprecated
Santos Cordon2f42b112014-07-19 13:19:37 -0700394 public void onPhoneDestroyed(Phone phone) {
395 }
Andrew Lee50aca232014-07-22 16:41:54 -0700396
397 /**
Santos Cordona2492812015-04-15 11:05:16 -0700398 * Called when the audio state changes.
399 *
400 * @param audioState The new {@link AudioState}.
Yorke Lee4af59352015-05-13 14:14:54 -0700401 * @deprecated Use {@link #onCallAudioStateChanged(CallAudioState) instead}.
402 * @hide
Santos Cordona2492812015-04-15 11:05:16 -0700403 */
Yorke Lee4af59352015-05-13 14:14:54 -0700404 @Deprecated
Santos Cordona2492812015-04-15 11:05:16 -0700405 public void onAudioStateChanged(AudioState audioState) {
406 }
407
408 /**
Yorke Lee4af59352015-05-13 14:14:54 -0700409 * Called when the audio state changes.
410 *
411 * @param audioState The new {@link CallAudioState}.
412 */
413 public void onCallAudioStateChanged(CallAudioState audioState) {
414 }
415
416 /**
Santos Cordona2492812015-04-15 11:05:16 -0700417 * Called to bring the in-call screen to the foreground. The in-call experience should
418 * respond immediately by coming to the foreground to inform the user of the state of
419 * ongoing {@code Call}s.
420 *
421 * @param showDialpad If true, put up the dialpad when the screen is shown.
422 */
423 public void onBringToForeground(boolean showDialpad) {
424 }
425
426 /**
427 * Called when a {@code Call} has been added to this in-call session. The in-call user
428 * experience should add necessary state listeners to the specified {@code Call} and
429 * immediately start to show the user information about the existence
430 * and nature of this {@code Call}. Subsequent invocations of {@link #getCalls()} will
431 * include this {@code Call}.
432 *
433 * @param call A newly added {@code Call}.
434 */
435 public void onCallAdded(Call call) {
436 }
437
438 /**
439 * Called when a {@code Call} has been removed from this in-call session. The in-call user
440 * experience should remove any state listeners from the specified {@code Call} and
441 * immediately stop displaying any information about this {@code Call}.
442 * Subsequent invocations of {@link #getCalls()} will no longer include this {@code Call}.
443 *
444 * @param call A newly removed {@code Call}.
445 */
446 public void onCallRemoved(Call call) {
447 }
448
449 /**
450 * Called when the ability to add more calls changes. If the phone cannot
451 * support more calls then {@code canAddCall} is set to {@code false}. If it can, then it
452 * is set to {@code true}. This can be used to control the visibility of UI to add more calls.
453 *
454 * @param canAddCall Indicates whether an additional call can be added.
455 */
456 public void onCanAddCallChanged(boolean canAddCall) {
457 }
458
459 /**
Sailesh Nepal9c2618b2016-01-23 16:28:22 -0800460 * Called to silence the ringer if a ringing call exists.
461 */
462 public void onSilenceRinger() {
463 }
464
465 /**
Tyler Gunn06f3fa62016-08-25 09:26:15 -0700466 * Unused; to handle connection events issued by a {@link ConnectionService}, implement the
467 * {@link android.telecom.Call.Callback#onConnectionEvent(Call, String, Bundle)} callback.
Tyler Gunn876dbfb2016-03-14 15:18:07 -0700468 * <p>
469 * See {@link Connection#sendConnectionEvent(String, Bundle)}.
470 *
471 * @param call The call the event is associated with.
472 * @param event The event.
473 * @param extras Any associated extras.
474 */
475 public void onConnectionEvent(Call call, String event, Bundle extras) {
476 }
477
478 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700479 * Used to issue commands to the {@link Connection.VideoProvider} associated with a
480 * {@link Call}.
Andrew Lee50aca232014-07-22 16:41:54 -0700481 */
482 public static abstract class VideoCall {
483
Andrew Lee011728f2015-04-23 15:47:06 -0700484 /** @hide */
485 public abstract void destroy();
486
Andrew Lee50aca232014-07-22 16:41:54 -0700487 /**
Andrew Lee7c9ee2b2015-04-16 15:26:08 -0700488 * Registers a callback to receive commands and state changes for video calls.
Andrew Lee50aca232014-07-22 16:41:54 -0700489 *
Andrew Lee7c9ee2b2015-04-16 15:26:08 -0700490 * @param callback The video call callback.
Andrew Lee50aca232014-07-22 16:41:54 -0700491 */
Andrew Leeda80c872015-04-15 14:09:50 -0700492 public abstract void registerCallback(VideoCall.Callback callback);
493
494 /**
Andrew Lee011728f2015-04-23 15:47:06 -0700495 * Registers a callback to receive commands and state changes for video calls.
496 *
497 * @param callback The video call callback.
498 * @param handler A handler which commands and status changes will be delivered to.
499 */
500 public abstract void registerCallback(VideoCall.Callback callback, Handler handler);
501
502 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700503 * Clears the video call callback set via {@link #registerCallback}.
Tyler Gunn295f5d72015-06-04 11:08:54 -0700504 *
505 * @param callback The video call callback to clear.
Tyler Gunn75958422015-04-15 14:23:42 -0700506 */
Andrew Lee011728f2015-04-23 15:47:06 -0700507 public abstract void unregisterCallback(VideoCall.Callback callback);
Tyler Gunn75958422015-04-15 14:23:42 -0700508
509 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700510 * Sets the camera to be used for the outgoing video.
511 * <p>
512 * Handled by {@link Connection.VideoProvider#onSetCamera(String)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700513 *
Tyler Gunnb702ef82015-05-29 11:51:53 -0700514 * @param cameraId The id of the camera (use ids as reported by
515 * {@link CameraManager#getCameraIdList()}).
Andrew Lee50aca232014-07-22 16:41:54 -0700516 */
517 public abstract void setCamera(String cameraId);
518
519 /**
520 * Sets the surface to be used for displaying a preview of what the user's camera is
521 * currently capturing. When video transmission is enabled, this is the video signal which
522 * is sent to the remote device.
Tyler Gunnb702ef82015-05-29 11:51:53 -0700523 * <p>
524 * Handled by {@link Connection.VideoProvider#onSetPreviewSurface(Surface)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700525 *
Tyler Gunnb702ef82015-05-29 11:51:53 -0700526 * @param surface The {@link Surface}.
Andrew Lee50aca232014-07-22 16:41:54 -0700527 */
528 public abstract void setPreviewSurface(Surface surface);
529
530 /**
531 * Sets the surface to be used for displaying the video received from the remote device.
Tyler Gunnb702ef82015-05-29 11:51:53 -0700532 * <p>
533 * Handled by {@link Connection.VideoProvider#onSetDisplaySurface(Surface)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700534 *
Tyler Gunnb702ef82015-05-29 11:51:53 -0700535 * @param surface The {@link Surface}.
Andrew Lee50aca232014-07-22 16:41:54 -0700536 */
537 public abstract void setDisplaySurface(Surface surface);
538
539 /**
540 * Sets the device orientation, in degrees. Assumes that a standard portrait orientation of
541 * the device is 0 degrees.
Tyler Gunnb702ef82015-05-29 11:51:53 -0700542 * <p>
543 * Handled by {@link Connection.VideoProvider#onSetDeviceOrientation(int)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700544 *
545 * @param rotation The device orientation, in degrees.
546 */
547 public abstract void setDeviceOrientation(int rotation);
548
549 /**
550 * Sets camera zoom ratio.
Tyler Gunnb702ef82015-05-29 11:51:53 -0700551 * <p>
552 * Handled by {@link Connection.VideoProvider#onSetZoom(float)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700553 *
554 * @param value The camera zoom ratio.
555 */
556 public abstract void setZoom(float value);
557
558 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700559 * Issues a request to modify the properties of the current video session.
560 * <p>
561 * Example scenarios include: requesting an audio-only call to be upgraded to a
562 * bi-directional video call, turning on or off the user's camera, sending a pause signal
563 * when the {@link InCallService} is no longer the foreground application.
564 * <p>
565 * Handled by
566 * {@link Connection.VideoProvider#onSendSessionModifyRequest(VideoProfile, VideoProfile)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700567 *
568 * @param requestProfile The requested call video properties.
569 */
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700570 public abstract void sendSessionModifyRequest(VideoProfile requestProfile);
Andrew Lee50aca232014-07-22 16:41:54 -0700571
572 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700573 * Provides a response to a request to change the current call video session
574 * properties. This should be called in response to a request the {@link InCallService} has
575 * received via {@link VideoCall.Callback#onSessionModifyRequestReceived}.
576 * <p>
577 * Handled by
578 * {@link Connection.VideoProvider#onSendSessionModifyResponse(VideoProfile)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700579 *
580 * @param responseProfile The response call video properties.
581 */
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700582 public abstract void sendSessionModifyResponse(VideoProfile responseProfile);
Andrew Lee50aca232014-07-22 16:41:54 -0700583
584 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700585 * Issues a request to the {@link Connection.VideoProvider} to retrieve the capabilities
586 * of the current camera. The current camera is selected using
587 * {@link VideoCall#setCamera(String)}.
588 * <p>
589 * Camera capabilities are reported to the caller via
590 * {@link VideoCall.Callback#onCameraCapabilitiesChanged(VideoProfile.CameraCapabilities)}.
591 * <p>
592 * Handled by {@link Connection.VideoProvider#onRequestCameraCapabilities()}.
Andrew Lee50aca232014-07-22 16:41:54 -0700593 */
594 public abstract void requestCameraCapabilities();
595
596 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700597 * Issues a request to the {@link Connection.VideoProvider} to retrieve the cumulative data
598 * usage for the video component of the current call (in bytes). Data usage is reported
599 * to the caller via {@link VideoCall.Callback#onCallDataUsageChanged}.
600 * <p>
601 * Handled by {@link Connection.VideoProvider#onRequestConnectionDataUsage()}.
Andrew Lee50aca232014-07-22 16:41:54 -0700602 */
603 public abstract void requestCallDataUsage();
604
605 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700606 * Provides the {@link Connection.VideoProvider} with the {@link Uri} of an image to be
607 * displayed to the peer device when the video signal is paused.
608 * <p>
609 * Handled by {@link Connection.VideoProvider#onSetPauseImage(Uri)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700610 *
611 * @param uri URI of image to display.
612 */
Yorke Lee32f24732015-05-12 16:18:03 -0700613 public abstract void setPauseImage(Uri uri);
Andrew Lee50aca232014-07-22 16:41:54 -0700614
615 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700616 * The {@link InCallService} extends this class to provide a means of receiving callbacks
Tyler Gunn295f5d72015-06-04 11:08:54 -0700617 * from the {@link Connection.VideoProvider}.
618 * <p>
Tyler Gunnb702ef82015-05-29 11:51:53 -0700619 * When the {@link InCallService} receives the
620 * {@link Call.Callback#onVideoCallChanged(Call, VideoCall)} callback, it should create an
621 * instance its {@link VideoCall.Callback} implementation and set it on the
622 * {@link VideoCall} using {@link VideoCall#registerCallback(Callback)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700623 */
Andrew Leeda80c872015-04-15 14:09:50 -0700624 public static abstract class Callback {
Andrew Lee50aca232014-07-22 16:41:54 -0700625 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700626 * Called when the {@link Connection.VideoProvider} receives a session modification
Tyler Gunn295f5d72015-06-04 11:08:54 -0700627 * request from the peer device.
Tyler Gunnb702ef82015-05-29 11:51:53 -0700628 * <p>
629 * The {@link InCallService} may potentially prompt the user to confirm whether they
630 * wish to accept the request, or decide to automatically accept the request. In either
631 * case the {@link InCallService} should call
632 * {@link VideoCall#sendSessionModifyResponse(VideoProfile)} to indicate the video
633 * profile agreed upon.
634 * <p>
635 * Callback originates from
636 * {@link Connection.VideoProvider#receiveSessionModifyRequest(VideoProfile)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700637 *
Tyler Gunnb702ef82015-05-29 11:51:53 -0700638 * @param videoProfile The requested video profile.
Andrew Lee50aca232014-07-22 16:41:54 -0700639 */
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700640 public abstract void onSessionModifyRequestReceived(VideoProfile videoProfile);
Andrew Lee50aca232014-07-22 16:41:54 -0700641
642 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700643 * Called when the {@link Connection.VideoProvider} receives a response to a session
644 * modification request previously sent to the peer device.
645 * <p>
646 * The new video state should not be considered active by the {@link InCallService}
647 * until the {@link Call} video state changes (the
648 * {@link Call.Callback#onDetailsChanged(Call, Call.Details)} callback is triggered
649 * when the video state changes).
650 * <p>
651 * Callback originates from
652 * {@link Connection.VideoProvider#receiveSessionModifyResponse(int, VideoProfile,
653 * VideoProfile)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700654 *
655 * @param status Status of the session modify request. Valid values are
Tyler Gunnb702ef82015-05-29 11:51:53 -0700656 * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_SUCCESS},
657 * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_FAIL},
658 * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_INVALID},
659 * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_TIMED_OUT},
660 * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_REJECTED_BY_REMOTE}.
661 * @param requestedProfile The original request which was sent to the peer device.
662 * @param responseProfile The actual profile changes made by the peer device.
Andrew Lee50aca232014-07-22 16:41:54 -0700663 */
664 public abstract void onSessionModifyResponseReceived(int status,
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700665 VideoProfile requestedProfile, VideoProfile responseProfile);
Andrew Lee50aca232014-07-22 16:41:54 -0700666
667 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700668 * Handles events related to the current video session which the {@link InCallService}
669 * may wish to handle. These are separate from requested changes to the session due to
670 * the underlying protocol or connection.
671 * <p>
672 * Callback originates from
673 * {@link Connection.VideoProvider#handleCallSessionEvent(int)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700674 *
Tyler Gunnb702ef82015-05-29 11:51:53 -0700675 * @param event The event. Valid values are:
676 * {@link Connection.VideoProvider#SESSION_EVENT_RX_PAUSE},
677 * {@link Connection.VideoProvider#SESSION_EVENT_RX_RESUME},
678 * {@link Connection.VideoProvider#SESSION_EVENT_TX_START},
679 * {@link Connection.VideoProvider#SESSION_EVENT_TX_STOP},
680 * {@link Connection.VideoProvider#SESSION_EVENT_CAMERA_FAILURE},
Tyler Gunnbf9c6fd2016-11-09 10:19:23 -0800681 * {@link Connection.VideoProvider#SESSION_EVENT_CAMERA_READY},
682 * {@link Connection.VideoProvider#SESSION_EVENT_CAMERA_PERMISSION_ERROR}.
Andrew Lee50aca232014-07-22 16:41:54 -0700683 */
684 public abstract void onCallSessionEvent(int event);
685
686 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700687 * Handles a change to the video dimensions from the peer device. This could happen if,
688 * for example, the peer changes orientation of their device, or switches cameras.
689 * <p>
690 * Callback originates from
691 * {@link Connection.VideoProvider#changePeerDimensions(int, int)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700692 *
693 * @param width The updated peer video width.
694 * @param height The updated peer video height.
695 */
696 public abstract void onPeerDimensionsChanged(int width, int height);
697
698 /**
Rekha Kumar07366812015-03-24 16:42:31 -0700699 * Handles a change to the video quality.
Tyler Gunnb702ef82015-05-29 11:51:53 -0700700 * <p>
701 * Callback originates from {@link Connection.VideoProvider#changeVideoQuality(int)}.
Rekha Kumar07366812015-03-24 16:42:31 -0700702 *
Tyler Gunnb702ef82015-05-29 11:51:53 -0700703 * @param videoQuality The updated peer video quality. Valid values:
704 * {@link VideoProfile#QUALITY_HIGH},
705 * {@link VideoProfile#QUALITY_MEDIUM},
706 * {@link VideoProfile#QUALITY_LOW},
707 * {@link VideoProfile#QUALITY_DEFAULT}.
Rekha Kumar07366812015-03-24 16:42:31 -0700708 */
709 public abstract void onVideoQualityChanged(int videoQuality);
710
711 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700712 * Handles an update to the total data used for the current video session.
713 * <p>
714 * Used by the {@link Connection.VideoProvider} in response to
715 * {@link VideoCall#requestCallDataUsage()}. May also be called periodically by the
716 * {@link Connection.VideoProvider}.
717 * <p>
718 * Callback originates from {@link Connection.VideoProvider#setCallDataUsage(long)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700719 *
Tyler Gunnb702ef82015-05-29 11:51:53 -0700720 * @param dataUsage The updated data usage (in bytes).
Andrew Lee50aca232014-07-22 16:41:54 -0700721 */
Rekha Kumar07366812015-03-24 16:42:31 -0700722 public abstract void onCallDataUsageChanged(long dataUsage);
Andrew Lee50aca232014-07-22 16:41:54 -0700723
724 /**
Tyler Gunnb702ef82015-05-29 11:51:53 -0700725 * Handles a change in the capabilities of the currently selected camera.
726 * <p>
727 * Used by the {@link Connection.VideoProvider} in response to
728 * {@link VideoCall#requestCameraCapabilities()}. The {@link Connection.VideoProvider}
729 * may also report the camera capabilities after a call to
730 * {@link VideoCall#setCamera(String)}.
731 * <p>
732 * Callback originates from
733 * {@link Connection.VideoProvider#changeCameraCapabilities(
734 * VideoProfile.CameraCapabilities)}.
Andrew Lee50aca232014-07-22 16:41:54 -0700735 *
Ihab Awadb19a0bc2014-08-07 19:46:01 -0700736 * @param cameraCapabilities The changed camera capabilities.
Andrew Lee50aca232014-07-22 16:41:54 -0700737 */
Yorke Lee400470f2015-05-12 13:31:25 -0700738 public abstract void onCameraCapabilitiesChanged(
739 VideoProfile.CameraCapabilities cameraCapabilities);
Andrew Lee50aca232014-07-22 16:41:54 -0700740 }
741 }
Sailesh Nepalab5d2822014-03-08 18:01:06 -0800742}