Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 1 | /* |
| 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 Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 17 | package android.telecom; |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 18 | |
Tyler Gunn | 2ac4010 | 2014-08-18 16:23:10 -0700 | [diff] [blame] | 19 | import android.annotation.SdkConstant; |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 20 | import android.annotation.SystemApi; |
Santos Cordon | 2f42b11 | 2014-07-19 13:19:37 -0700 | [diff] [blame] | 21 | import android.app.Service; |
| 22 | import android.content.Intent; |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 23 | import android.hardware.camera2.CameraManager; |
Yorke Lee | 32f2473 | 2015-05-12 16:18:03 -0700 | [diff] [blame] | 24 | import android.net.Uri; |
Tyler Gunn | 876dbfb | 2016-03-14 15:18:07 -0700 | [diff] [blame] | 25 | import android.os.Bundle; |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 26 | import android.os.Handler; |
| 27 | import android.os.IBinder; |
| 28 | import android.os.Looper; |
| 29 | import android.os.Message; |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 30 | import android.view.Surface; |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 31 | |
Ihab Awad | 2f23664 | 2014-03-10 15:33:45 -0700 | [diff] [blame] | 32 | import com.android.internal.os.SomeArgs; |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 33 | import com.android.internal.telecom.IInCallAdapter; |
| 34 | import com.android.internal.telecom.IInCallService; |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 35 | |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 36 | import java.lang.String; |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 37 | import java.util.Collections; |
| 38 | import java.util.List; |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 39 | |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 40 | /** |
| 41 | * This service is implemented by any app that wishes to provide the user-interface for managing |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 42 | * phone calls. Telecom binds to this service while there exists a live (active or incoming) call, |
Santos Cordon | f2600eb | 2015-06-22 15:02:20 -0700 | [diff] [blame] | 43 | * 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 Fuller | 71fbb81 | 2015-11-30 09:51:33 +0000 | [diff] [blame] | 52 | * <service android:name="your.package.YourInCallServiceImplementation" |
Sailesh Nepal | 78f3ba6 | 2015-12-28 16:20:56 -0800 | [diff] [blame] | 53 | * android:permission="android.permission.BIND_INCALL_SERVICE"> |
Neil Fuller | 71fbb81 | 2015-11-30 09:51:33 +0000 | [diff] [blame] | 54 | * <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 Cordon | f2600eb | 2015-06-22 15:02:20 -0700 | [diff] [blame] | 59 | * } |
| 60 | * </pre> |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 61 | */ |
Santos Cordon | 2f42b11 | 2014-07-19 13:19:37 -0700 | [diff] [blame] | 62 | public abstract class InCallService extends Service { |
Tyler Gunn | 2ac4010 | 2014-08-18 16:23:10 -0700 | [diff] [blame] | 63 | |
| 64 | /** |
| 65 | * The {@link Intent} that must be declared as handled by the service. |
| 66 | */ |
| 67 | @SdkConstant(SdkConstant.SdkConstantType.SERVICE_ACTION) |
Tyler Gunn | ef9f6f9 | 2014-09-12 22:16:17 -0700 | [diff] [blame] | 68 | public static final String SERVICE_INTERFACE = "android.telecom.InCallService"; |
Tyler Gunn | 2ac4010 | 2014-08-18 16:23:10 -0700 | [diff] [blame] | 69 | |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 70 | private static final int MSG_SET_IN_CALL_ADAPTER = 1; |
| 71 | private static final int MSG_ADD_CALL = 2; |
Sailesh Nepal | 6043793 | 2014-04-05 16:44:55 -0700 | [diff] [blame] | 72 | private static final int MSG_UPDATE_CALL = 3; |
Ihab Awad | 5d0410f | 2014-07-30 10:07:40 -0700 | [diff] [blame] | 73 | private static final int MSG_SET_POST_DIAL_WAIT = 4; |
Yorke Lee | 4af5935 | 2015-05-13 14:14:54 -0700 | [diff] [blame] | 74 | private static final int MSG_ON_CALL_AUDIO_STATE_CHANGED = 5; |
Ihab Awad | 5d0410f | 2014-07-30 10:07:40 -0700 | [diff] [blame] | 75 | private static final int MSG_BRING_TO_FOREGROUND = 6; |
Santos Cordon | 6c912b7 | 2014-11-07 16:05:09 -0800 | [diff] [blame] | 76 | private static final int MSG_ON_CAN_ADD_CALL_CHANGED = 7; |
Sailesh Nepal | 9c2618b | 2016-01-23 16:28:22 -0800 | [diff] [blame] | 77 | private static final int MSG_SILENCE_RINGER = 8; |
Tyler Gunn | 876dbfb | 2016-03-14 15:18:07 -0700 | [diff] [blame] | 78 | private static final int MSG_ON_CONNECTION_EVENT = 9; |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 79 | |
| 80 | /** Default Handler used to consolidate binder method calls onto a single thread. */ |
| 81 | private final Handler mHandler = new Handler(Looper.getMainLooper()) { |
| 82 | @Override |
| 83 | public void handleMessage(Message msg) { |
Jay Shrauner | 5e6162d | 2014-09-22 20:47:45 -0700 | [diff] [blame] | 84 | if (mPhone == null && msg.what != MSG_SET_IN_CALL_ADAPTER) { |
| 85 | return; |
| 86 | } |
| 87 | |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 88 | switch (msg.what) { |
| 89 | case MSG_SET_IN_CALL_ADAPTER: |
Tyler Gunn | bf9c6fd | 2016-11-09 10:19:23 -0800 | [diff] [blame] | 90 | String callingPackage = getApplicationContext().getOpPackageName(); |
| 91 | mPhone = new Phone(new InCallAdapter((IInCallAdapter) msg.obj), callingPackage); |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 92 | mPhone.addListener(mPhoneListener); |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 93 | onPhoneCreated(mPhone); |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 94 | break; |
| 95 | case MSG_ADD_CALL: |
Santos Cordon | 88b771d | 2014-07-19 13:10:40 -0700 | [diff] [blame] | 96 | mPhone.internalAddCall((ParcelableCall) msg.obj); |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 97 | break; |
Sailesh Nepal | 6043793 | 2014-04-05 16:44:55 -0700 | [diff] [blame] | 98 | case MSG_UPDATE_CALL: |
Santos Cordon | 88b771d | 2014-07-19 13:10:40 -0700 | [diff] [blame] | 99 | mPhone.internalUpdateCall((ParcelableCall) msg.obj); |
Ihab Awad | 2f23664 | 2014-03-10 15:33:45 -0700 | [diff] [blame] | 100 | break; |
Ihab Awad | 2f23664 | 2014-03-10 15:33:45 -0700 | [diff] [blame] | 101 | case MSG_SET_POST_DIAL_WAIT: { |
| 102 | SomeArgs args = (SomeArgs) msg.obj; |
| 103 | try { |
| 104 | String callId = (String) args.arg1; |
| 105 | String remaining = (String) args.arg2; |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 106 | mPhone.internalSetPostDialWait(callId, remaining); |
Ihab Awad | 2f23664 | 2014-03-10 15:33:45 -0700 | [diff] [blame] | 107 | } finally { |
| 108 | args.recycle(); |
| 109 | } |
| 110 | break; |
| 111 | } |
Yorke Lee | 4af5935 | 2015-05-13 14:14:54 -0700 | [diff] [blame] | 112 | case MSG_ON_CALL_AUDIO_STATE_CHANGED: |
| 113 | mPhone.internalCallAudioStateChanged((CallAudioState) msg.obj); |
Sailesh Nepal | b632e5b | 2014-04-03 12:54:33 -0700 | [diff] [blame] | 114 | break; |
Santos Cordon | 3534ede | 2014-05-29 13:07:10 -0700 | [diff] [blame] | 115 | case MSG_BRING_TO_FOREGROUND: |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 116 | mPhone.internalBringToForeground(msg.arg1 == 1); |
Santos Cordon | 3534ede | 2014-05-29 13:07:10 -0700 | [diff] [blame] | 117 | break; |
Santos Cordon | 6c912b7 | 2014-11-07 16:05:09 -0800 | [diff] [blame] | 118 | case MSG_ON_CAN_ADD_CALL_CHANGED: |
| 119 | mPhone.internalSetCanAddCall(msg.arg1 == 1); |
| 120 | break; |
Sailesh Nepal | 9c2618b | 2016-01-23 16:28:22 -0800 | [diff] [blame] | 121 | case MSG_SILENCE_RINGER: |
| 122 | mPhone.internalSilenceRinger(); |
| 123 | break; |
Tyler Gunn | 876dbfb | 2016-03-14 15:18:07 -0700 | [diff] [blame] | 124 | case MSG_ON_CONNECTION_EVENT: { |
| 125 | SomeArgs args = (SomeArgs) msg.obj; |
| 126 | try { |
| 127 | String callId = (String) args.arg1; |
| 128 | String event = (String) args.arg2; |
| 129 | Bundle extras = (Bundle) args.arg3; |
| 130 | mPhone.internalOnConnectionEvent(callId, event, extras); |
| 131 | } finally { |
| 132 | args.recycle(); |
| 133 | } |
| 134 | break; |
| 135 | } |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 136 | default: |
| 137 | break; |
| 138 | } |
| 139 | } |
| 140 | }; |
| 141 | |
| 142 | /** Manages the binder calls so that the implementor does not need to deal with it. */ |
| 143 | private final class InCallServiceBinder extends IInCallService.Stub { |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 144 | @Override |
| 145 | public void setInCallAdapter(IInCallAdapter inCallAdapter) { |
| 146 | mHandler.obtainMessage(MSG_SET_IN_CALL_ADAPTER, inCallAdapter).sendToTarget(); |
| 147 | } |
| 148 | |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 149 | @Override |
Santos Cordon | 88b771d | 2014-07-19 13:10:40 -0700 | [diff] [blame] | 150 | public void addCall(ParcelableCall call) { |
Sailesh Nepal | 6043793 | 2014-04-05 16:44:55 -0700 | [diff] [blame] | 151 | mHandler.obtainMessage(MSG_ADD_CALL, call).sendToTarget(); |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 152 | } |
| 153 | |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 154 | @Override |
Santos Cordon | 88b771d | 2014-07-19 13:10:40 -0700 | [diff] [blame] | 155 | public void updateCall(ParcelableCall call) { |
Sailesh Nepal | 6043793 | 2014-04-05 16:44:55 -0700 | [diff] [blame] | 156 | mHandler.obtainMessage(MSG_UPDATE_CALL, call).sendToTarget(); |
Ihab Awad | 2f23664 | 2014-03-10 15:33:45 -0700 | [diff] [blame] | 157 | } |
| 158 | |
| 159 | @Override |
| 160 | public void setPostDial(String callId, String remaining) { |
Ihab Awad | 5d0410f | 2014-07-30 10:07:40 -0700 | [diff] [blame] | 161 | // TODO: Unused |
Ihab Awad | 2f23664 | 2014-03-10 15:33:45 -0700 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | @Override |
| 165 | public void setPostDialWait(String callId, String remaining) { |
| 166 | SomeArgs args = SomeArgs.obtain(); |
| 167 | args.arg1 = callId; |
| 168 | args.arg2 = remaining; |
| 169 | mHandler.obtainMessage(MSG_SET_POST_DIAL_WAIT, args).sendToTarget(); |
| 170 | } |
Sailesh Nepal | b632e5b | 2014-04-03 12:54:33 -0700 | [diff] [blame] | 171 | |
| 172 | @Override |
Yorke Lee | 4af5935 | 2015-05-13 14:14:54 -0700 | [diff] [blame] | 173 | public void onCallAudioStateChanged(CallAudioState callAudioState) { |
| 174 | mHandler.obtainMessage(MSG_ON_CALL_AUDIO_STATE_CHANGED, callAudioState).sendToTarget(); |
Sailesh Nepal | b632e5b | 2014-04-03 12:54:33 -0700 | [diff] [blame] | 175 | } |
Santos Cordon | 3534ede | 2014-05-29 13:07:10 -0700 | [diff] [blame] | 176 | |
Santos Cordon | 3534ede | 2014-05-29 13:07:10 -0700 | [diff] [blame] | 177 | @Override |
| 178 | public void bringToForeground(boolean showDialpad) { |
| 179 | mHandler.obtainMessage(MSG_BRING_TO_FOREGROUND, showDialpad ? 1 : 0, 0).sendToTarget(); |
| 180 | } |
Santos Cordon | 6c912b7 | 2014-11-07 16:05:09 -0800 | [diff] [blame] | 181 | |
| 182 | @Override |
| 183 | public void onCanAddCallChanged(boolean canAddCall) { |
| 184 | mHandler.obtainMessage(MSG_ON_CAN_ADD_CALL_CHANGED, canAddCall ? 1 : 0, 0) |
| 185 | .sendToTarget(); |
| 186 | } |
Sailesh Nepal | 9c2618b | 2016-01-23 16:28:22 -0800 | [diff] [blame] | 187 | |
| 188 | @Override |
| 189 | public void silenceRinger() { |
| 190 | mHandler.obtainMessage(MSG_SILENCE_RINGER).sendToTarget(); |
| 191 | } |
Tyler Gunn | 876dbfb | 2016-03-14 15:18:07 -0700 | [diff] [blame] | 192 | |
| 193 | @Override |
| 194 | public void onConnectionEvent(String callId, String event, Bundle extras) { |
| 195 | SomeArgs args = SomeArgs.obtain(); |
| 196 | args.arg1 = callId; |
| 197 | args.arg2 = event; |
| 198 | args.arg3 = extras; |
| 199 | mHandler.obtainMessage(MSG_ON_CONNECTION_EVENT, args).sendToTarget(); |
| 200 | } |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 201 | } |
| 202 | |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 203 | private Phone.Listener mPhoneListener = new Phone.Listener() { |
| 204 | /** ${inheritDoc} */ |
| 205 | @Override |
| 206 | public void onAudioStateChanged(Phone phone, AudioState audioState) { |
| 207 | InCallService.this.onAudioStateChanged(audioState); |
| 208 | } |
| 209 | |
Yorke Lee | 4af5935 | 2015-05-13 14:14:54 -0700 | [diff] [blame] | 210 | public void onCallAudioStateChanged(Phone phone, CallAudioState callAudioState) { |
| 211 | InCallService.this.onCallAudioStateChanged(callAudioState); |
| 212 | }; |
| 213 | |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 214 | /** ${inheritDoc} */ |
| 215 | @Override |
| 216 | public void onBringToForeground(Phone phone, boolean showDialpad) { |
| 217 | InCallService.this.onBringToForeground(showDialpad); |
| 218 | } |
| 219 | |
| 220 | /** ${inheritDoc} */ |
| 221 | @Override |
| 222 | public void onCallAdded(Phone phone, Call call) { |
| 223 | InCallService.this.onCallAdded(call); |
| 224 | } |
| 225 | |
| 226 | /** ${inheritDoc} */ |
| 227 | @Override |
| 228 | public void onCallRemoved(Phone phone, Call call) { |
| 229 | InCallService.this.onCallRemoved(call); |
| 230 | } |
| 231 | |
| 232 | /** ${inheritDoc} */ |
| 233 | @Override |
| 234 | public void onCanAddCallChanged(Phone phone, boolean canAddCall) { |
| 235 | InCallService.this.onCanAddCallChanged(canAddCall); |
| 236 | } |
| 237 | |
Sailesh Nepal | 9c2618b | 2016-01-23 16:28:22 -0800 | [diff] [blame] | 238 | /** ${inheritDoc} */ |
| 239 | @Override |
| 240 | public void onSilenceRinger(Phone phone) { |
| 241 | InCallService.this.onSilenceRinger(); |
| 242 | } |
| 243 | |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 244 | }; |
| 245 | |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 246 | private Phone mPhone; |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 247 | |
Santos Cordon | 2f42b11 | 2014-07-19 13:19:37 -0700 | [diff] [blame] | 248 | public InCallService() { |
| 249 | } |
Evan Charlton | 924748f | 2014-04-03 08:36:38 -0700 | [diff] [blame] | 250 | |
Santos Cordon | 2f42b11 | 2014-07-19 13:19:37 -0700 | [diff] [blame] | 251 | @Override |
| 252 | public IBinder onBind(Intent intent) { |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 253 | return new InCallServiceBinder(); |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 254 | } |
| 255 | |
Santos Cordon | f30d7e9 | 2014-08-26 09:54:33 -0700 | [diff] [blame] | 256 | @Override |
| 257 | public boolean onUnbind(Intent intent) { |
Santos Cordon | 619b3c0 | 2014-09-02 17:13:45 -0700 | [diff] [blame] | 258 | if (mPhone != null) { |
| 259 | Phone oldPhone = mPhone; |
| 260 | mPhone = null; |
Santos Cordon | f30d7e9 | 2014-08-26 09:54:33 -0700 | [diff] [blame] | 261 | |
Santos Cordon | 619b3c0 | 2014-09-02 17:13:45 -0700 | [diff] [blame] | 262 | oldPhone.destroy(); |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 263 | // destroy sets all the calls to disconnected if any live ones still exist. Therefore, |
| 264 | // it is important to remove the Listener *after* the call to destroy so that |
| 265 | // InCallService.on* callbacks are appropriately called. |
| 266 | oldPhone.removeListener(mPhoneListener); |
| 267 | |
Santos Cordon | 619b3c0 | 2014-09-02 17:13:45 -0700 | [diff] [blame] | 268 | onPhoneDestroyed(oldPhone); |
| 269 | } |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 270 | |
Santos Cordon | f30d7e9 | 2014-08-26 09:54:33 -0700 | [diff] [blame] | 271 | return false; |
| 272 | } |
| 273 | |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 274 | /** |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 275 | * Obtain the {@code Phone} associated with this {@code InCallService}. |
| 276 | * |
| 277 | * @return The {@code Phone} object associated with this {@code InCallService}, or {@code null} |
Santos Cordon | 2f42b11 | 2014-07-19 13:19:37 -0700 | [diff] [blame] | 278 | * if the {@code InCallService} is not in a state where it has an associated |
| 279 | * {@code Phone}. |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 280 | * @hide |
Santos Cordon | 29886d8 | 2015-04-16 15:34:07 -0700 | [diff] [blame] | 281 | * @deprecated Use direct methods on InCallService instead of {@link Phone}. |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 282 | */ |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 283 | @SystemApi |
Santos Cordon | 29886d8 | 2015-04-16 15:34:07 -0700 | [diff] [blame] | 284 | @Deprecated |
| 285 | public Phone getPhone() { |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 286 | return mPhone; |
Evan Charlton | 924748f | 2014-04-03 08:36:38 -0700 | [diff] [blame] | 287 | } |
| 288 | |
| 289 | /** |
Santos Cordon | 895d4b8 | 2015-06-25 16:41:48 -0700 | [diff] [blame] | 290 | * Obtains the current list of {@code Call}s to be displayed by this in-call service. |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 291 | * |
| 292 | * @return A list of the relevant {@code Call}s. |
| 293 | */ |
| 294 | public final List<Call> getCalls() { |
| 295 | return mPhone == null ? Collections.<Call>emptyList() : mPhone.getCalls(); |
| 296 | } |
| 297 | |
| 298 | /** |
| 299 | * Returns if the device can support additional calls. |
| 300 | * |
| 301 | * @return Whether the phone supports adding more calls. |
| 302 | */ |
| 303 | public final boolean canAddCall() { |
| 304 | return mPhone == null ? false : mPhone.canAddCall(); |
| 305 | } |
| 306 | |
| 307 | /** |
| 308 | * Obtains the current phone call audio state. |
| 309 | * |
| 310 | * @return An object encapsulating the audio state. Returns null if the service is not |
| 311 | * fully initialized. |
Yorke Lee | 4af5935 | 2015-05-13 14:14:54 -0700 | [diff] [blame] | 312 | * @deprecated Use {@link #getCallAudioState()} instead. |
| 313 | * @hide |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 314 | */ |
Yorke Lee | 4af5935 | 2015-05-13 14:14:54 -0700 | [diff] [blame] | 315 | @Deprecated |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 316 | public final AudioState getAudioState() { |
| 317 | return mPhone == null ? null : mPhone.getAudioState(); |
| 318 | } |
| 319 | |
| 320 | /** |
Yorke Lee | 4af5935 | 2015-05-13 14:14:54 -0700 | [diff] [blame] | 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. |
| 325 | */ |
| 326 | public final CallAudioState getCallAudioState() { |
| 327 | return mPhone == null ? null : mPhone.getCallAudioState(); |
| 328 | } |
| 329 | |
| 330 | /** |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 331 | * Sets the microphone mute state. When this request is honored, there will be change to |
Yorke Lee | 4af5935 | 2015-05-13 14:14:54 -0700 | [diff] [blame] | 332 | * the {@link #getCallAudioState()}. |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 333 | * |
| 334 | * @param state {@code true} if the microphone should be muted; {@code false} otherwise. |
| 335 | */ |
| 336 | public final void setMuted(boolean state) { |
| 337 | if (mPhone != null) { |
| 338 | mPhone.setMuted(state); |
| 339 | } |
| 340 | } |
| 341 | |
| 342 | /** |
| 343 | * Sets the audio route (speaker, bluetooth, etc...). When this request is honored, there will |
Yorke Lee | 4af5935 | 2015-05-13 14:14:54 -0700 | [diff] [blame] | 344 | * be change to the {@link #getCallAudioState()}. |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 345 | * |
| 346 | * @param route The audio route to use. |
| 347 | */ |
| 348 | public final void setAudioRoute(int route) { |
| 349 | if (mPhone != null) { |
| 350 | mPhone.setAudioRoute(route); |
| 351 | } |
| 352 | } |
| 353 | |
| 354 | /** |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 355 | * Invoked when the {@code Phone} has been created. This is a signal to the in-call experience |
| 356 | * to start displaying in-call information to the user. Each instance of {@code InCallService} |
Santos Cordon | 2f42b11 | 2014-07-19 13:19:37 -0700 | [diff] [blame] | 357 | * will have only one {@code Phone}, and this method will be called exactly once in the lifetime |
| 358 | * of the {@code InCallService}. |
Evan Charlton | 924748f | 2014-04-03 08:36:38 -0700 | [diff] [blame] | 359 | * |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 360 | * @param phone The {@code Phone} object associated with this {@code InCallService}. |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 361 | * @hide |
Santos Cordon | 29886d8 | 2015-04-16 15:34:07 -0700 | [diff] [blame] | 362 | * @deprecated Use direct methods on InCallService instead of {@link Phone}. |
Evan Charlton | 924748f | 2014-04-03 08:36:38 -0700 | [diff] [blame] | 363 | */ |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 364 | @SystemApi |
Santos Cordon | 29886d8 | 2015-04-16 15:34:07 -0700 | [diff] [blame] | 365 | @Deprecated |
Santos Cordon | 2f42b11 | 2014-07-19 13:19:37 -0700 | [diff] [blame] | 366 | public void onPhoneCreated(Phone phone) { |
| 367 | } |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 368 | |
| 369 | /** |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 370 | * Invoked when a {@code Phone} has been destroyed. This is a signal to the in-call experience |
| 371 | * to stop displaying in-call information to the user. This method will be called exactly once |
| 372 | * in the lifetime of the {@code InCallService}, and it will always be called after a previous |
| 373 | * call to {@link #onPhoneCreated(Phone)}. |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 374 | * |
Ihab Awad | e63fadb | 2014-07-09 21:52:04 -0700 | [diff] [blame] | 375 | * @param phone The {@code Phone} object associated with this {@code InCallService}. |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 376 | * @hide |
Santos Cordon | 29886d8 | 2015-04-16 15:34:07 -0700 | [diff] [blame] | 377 | * @deprecated Use direct methods on InCallService instead of {@link Phone}. |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 378 | */ |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 379 | @SystemApi |
Santos Cordon | 29886d8 | 2015-04-16 15:34:07 -0700 | [diff] [blame] | 380 | @Deprecated |
Santos Cordon | 2f42b11 | 2014-07-19 13:19:37 -0700 | [diff] [blame] | 381 | public void onPhoneDestroyed(Phone phone) { |
| 382 | } |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 383 | |
| 384 | /** |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 385 | * Called when the audio state changes. |
| 386 | * |
| 387 | * @param audioState The new {@link AudioState}. |
Yorke Lee | 4af5935 | 2015-05-13 14:14:54 -0700 | [diff] [blame] | 388 | * @deprecated Use {@link #onCallAudioStateChanged(CallAudioState) instead}. |
| 389 | * @hide |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 390 | */ |
Yorke Lee | 4af5935 | 2015-05-13 14:14:54 -0700 | [diff] [blame] | 391 | @Deprecated |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 392 | public void onAudioStateChanged(AudioState audioState) { |
| 393 | } |
| 394 | |
| 395 | /** |
Yorke Lee | 4af5935 | 2015-05-13 14:14:54 -0700 | [diff] [blame] | 396 | * Called when the audio state changes. |
| 397 | * |
| 398 | * @param audioState The new {@link CallAudioState}. |
| 399 | */ |
| 400 | public void onCallAudioStateChanged(CallAudioState audioState) { |
| 401 | } |
| 402 | |
| 403 | /** |
Santos Cordon | a249281 | 2015-04-15 11:05:16 -0700 | [diff] [blame] | 404 | * Called to bring the in-call screen to the foreground. The in-call experience should |
| 405 | * respond immediately by coming to the foreground to inform the user of the state of |
| 406 | * ongoing {@code Call}s. |
| 407 | * |
| 408 | * @param showDialpad If true, put up the dialpad when the screen is shown. |
| 409 | */ |
| 410 | public void onBringToForeground(boolean showDialpad) { |
| 411 | } |
| 412 | |
| 413 | /** |
| 414 | * Called when a {@code Call} has been added to this in-call session. The in-call user |
| 415 | * experience should add necessary state listeners to the specified {@code Call} and |
| 416 | * immediately start to show the user information about the existence |
| 417 | * and nature of this {@code Call}. Subsequent invocations of {@link #getCalls()} will |
| 418 | * include this {@code Call}. |
| 419 | * |
| 420 | * @param call A newly added {@code Call}. |
| 421 | */ |
| 422 | public void onCallAdded(Call call) { |
| 423 | } |
| 424 | |
| 425 | /** |
| 426 | * Called when a {@code Call} has been removed from this in-call session. The in-call user |
| 427 | * experience should remove any state listeners from the specified {@code Call} and |
| 428 | * immediately stop displaying any information about this {@code Call}. |
| 429 | * Subsequent invocations of {@link #getCalls()} will no longer include this {@code Call}. |
| 430 | * |
| 431 | * @param call A newly removed {@code Call}. |
| 432 | */ |
| 433 | public void onCallRemoved(Call call) { |
| 434 | } |
| 435 | |
| 436 | /** |
| 437 | * Called when the ability to add more calls changes. If the phone cannot |
| 438 | * support more calls then {@code canAddCall} is set to {@code false}. If it can, then it |
| 439 | * is set to {@code true}. This can be used to control the visibility of UI to add more calls. |
| 440 | * |
| 441 | * @param canAddCall Indicates whether an additional call can be added. |
| 442 | */ |
| 443 | public void onCanAddCallChanged(boolean canAddCall) { |
| 444 | } |
| 445 | |
| 446 | /** |
Sailesh Nepal | 9c2618b | 2016-01-23 16:28:22 -0800 | [diff] [blame] | 447 | * Called to silence the ringer if a ringing call exists. |
| 448 | */ |
| 449 | public void onSilenceRinger() { |
| 450 | } |
| 451 | |
| 452 | /** |
Tyler Gunn | 06f3fa6 | 2016-08-25 09:26:15 -0700 | [diff] [blame] | 453 | * Unused; to handle connection events issued by a {@link ConnectionService}, implement the |
| 454 | * {@link android.telecom.Call.Callback#onConnectionEvent(Call, String, Bundle)} callback. |
Tyler Gunn | 876dbfb | 2016-03-14 15:18:07 -0700 | [diff] [blame] | 455 | * <p> |
| 456 | * See {@link Connection#sendConnectionEvent(String, Bundle)}. |
| 457 | * |
| 458 | * @param call The call the event is associated with. |
| 459 | * @param event The event. |
| 460 | * @param extras Any associated extras. |
| 461 | */ |
| 462 | public void onConnectionEvent(Call call, String event, Bundle extras) { |
| 463 | } |
| 464 | |
| 465 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 466 | * Used to issue commands to the {@link Connection.VideoProvider} associated with a |
| 467 | * {@link Call}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 468 | */ |
| 469 | public static abstract class VideoCall { |
| 470 | |
Andrew Lee | 011728f | 2015-04-23 15:47:06 -0700 | [diff] [blame] | 471 | /** @hide */ |
| 472 | public abstract void destroy(); |
| 473 | |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 474 | /** |
Andrew Lee | 7c9ee2b | 2015-04-16 15:26:08 -0700 | [diff] [blame] | 475 | * Registers a callback to receive commands and state changes for video calls. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 476 | * |
Andrew Lee | 7c9ee2b | 2015-04-16 15:26:08 -0700 | [diff] [blame] | 477 | * @param callback The video call callback. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 478 | */ |
Andrew Lee | da80c87 | 2015-04-15 14:09:50 -0700 | [diff] [blame] | 479 | public abstract void registerCallback(VideoCall.Callback callback); |
| 480 | |
| 481 | /** |
Andrew Lee | 011728f | 2015-04-23 15:47:06 -0700 | [diff] [blame] | 482 | * Registers a callback to receive commands and state changes for video calls. |
| 483 | * |
| 484 | * @param callback The video call callback. |
| 485 | * @param handler A handler which commands and status changes will be delivered to. |
| 486 | */ |
| 487 | public abstract void registerCallback(VideoCall.Callback callback, Handler handler); |
| 488 | |
| 489 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 490 | * Clears the video call callback set via {@link #registerCallback}. |
Tyler Gunn | 295f5d7 | 2015-06-04 11:08:54 -0700 | [diff] [blame] | 491 | * |
| 492 | * @param callback The video call callback to clear. |
Tyler Gunn | 7595842 | 2015-04-15 14:23:42 -0700 | [diff] [blame] | 493 | */ |
Andrew Lee | 011728f | 2015-04-23 15:47:06 -0700 | [diff] [blame] | 494 | public abstract void unregisterCallback(VideoCall.Callback callback); |
Tyler Gunn | 7595842 | 2015-04-15 14:23:42 -0700 | [diff] [blame] | 495 | |
| 496 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 497 | * Sets the camera to be used for the outgoing video. |
| 498 | * <p> |
| 499 | * Handled by {@link Connection.VideoProvider#onSetCamera(String)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 500 | * |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 501 | * @param cameraId The id of the camera (use ids as reported by |
| 502 | * {@link CameraManager#getCameraIdList()}). |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 503 | */ |
| 504 | public abstract void setCamera(String cameraId); |
| 505 | |
| 506 | /** |
| 507 | * Sets the surface to be used for displaying a preview of what the user's camera is |
| 508 | * currently capturing. When video transmission is enabled, this is the video signal which |
| 509 | * is sent to the remote device. |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 510 | * <p> |
| 511 | * Handled by {@link Connection.VideoProvider#onSetPreviewSurface(Surface)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 512 | * |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 513 | * @param surface The {@link Surface}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 514 | */ |
| 515 | public abstract void setPreviewSurface(Surface surface); |
| 516 | |
| 517 | /** |
| 518 | * Sets the surface to be used for displaying the video received from the remote device. |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 519 | * <p> |
| 520 | * Handled by {@link Connection.VideoProvider#onSetDisplaySurface(Surface)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 521 | * |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 522 | * @param surface The {@link Surface}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 523 | */ |
| 524 | public abstract void setDisplaySurface(Surface surface); |
| 525 | |
| 526 | /** |
| 527 | * Sets the device orientation, in degrees. Assumes that a standard portrait orientation of |
| 528 | * the device is 0 degrees. |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 529 | * <p> |
| 530 | * Handled by {@link Connection.VideoProvider#onSetDeviceOrientation(int)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 531 | * |
| 532 | * @param rotation The device orientation, in degrees. |
| 533 | */ |
| 534 | public abstract void setDeviceOrientation(int rotation); |
| 535 | |
| 536 | /** |
| 537 | * Sets camera zoom ratio. |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 538 | * <p> |
| 539 | * Handled by {@link Connection.VideoProvider#onSetZoom(float)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 540 | * |
| 541 | * @param value The camera zoom ratio. |
| 542 | */ |
| 543 | public abstract void setZoom(float value); |
| 544 | |
| 545 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 546 | * Issues a request to modify the properties of the current video session. |
| 547 | * <p> |
| 548 | * Example scenarios include: requesting an audio-only call to be upgraded to a |
| 549 | * bi-directional video call, turning on or off the user's camera, sending a pause signal |
| 550 | * when the {@link InCallService} is no longer the foreground application. |
| 551 | * <p> |
| 552 | * Handled by |
| 553 | * {@link Connection.VideoProvider#onSendSessionModifyRequest(VideoProfile, VideoProfile)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 554 | * |
| 555 | * @param requestProfile The requested call video properties. |
| 556 | */ |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 557 | public abstract void sendSessionModifyRequest(VideoProfile requestProfile); |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 558 | |
| 559 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 560 | * Provides a response to a request to change the current call video session |
| 561 | * properties. This should be called in response to a request the {@link InCallService} has |
| 562 | * received via {@link VideoCall.Callback#onSessionModifyRequestReceived}. |
| 563 | * <p> |
| 564 | * Handled by |
| 565 | * {@link Connection.VideoProvider#onSendSessionModifyResponse(VideoProfile)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 566 | * |
| 567 | * @param responseProfile The response call video properties. |
| 568 | */ |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 569 | public abstract void sendSessionModifyResponse(VideoProfile responseProfile); |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 570 | |
| 571 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 572 | * Issues a request to the {@link Connection.VideoProvider} to retrieve the capabilities |
| 573 | * of the current camera. The current camera is selected using |
| 574 | * {@link VideoCall#setCamera(String)}. |
| 575 | * <p> |
| 576 | * Camera capabilities are reported to the caller via |
| 577 | * {@link VideoCall.Callback#onCameraCapabilitiesChanged(VideoProfile.CameraCapabilities)}. |
| 578 | * <p> |
| 579 | * Handled by {@link Connection.VideoProvider#onRequestCameraCapabilities()}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 580 | */ |
| 581 | public abstract void requestCameraCapabilities(); |
| 582 | |
| 583 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 584 | * Issues a request to the {@link Connection.VideoProvider} to retrieve the cumulative data |
| 585 | * usage for the video component of the current call (in bytes). Data usage is reported |
| 586 | * to the caller via {@link VideoCall.Callback#onCallDataUsageChanged}. |
| 587 | * <p> |
| 588 | * Handled by {@link Connection.VideoProvider#onRequestConnectionDataUsage()}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 589 | */ |
| 590 | public abstract void requestCallDataUsage(); |
| 591 | |
| 592 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 593 | * Provides the {@link Connection.VideoProvider} with the {@link Uri} of an image to be |
| 594 | * displayed to the peer device when the video signal is paused. |
| 595 | * <p> |
| 596 | * Handled by {@link Connection.VideoProvider#onSetPauseImage(Uri)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 597 | * |
| 598 | * @param uri URI of image to display. |
| 599 | */ |
Yorke Lee | 32f2473 | 2015-05-12 16:18:03 -0700 | [diff] [blame] | 600 | public abstract void setPauseImage(Uri uri); |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 601 | |
| 602 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 603 | * The {@link InCallService} extends this class to provide a means of receiving callbacks |
Tyler Gunn | 295f5d7 | 2015-06-04 11:08:54 -0700 | [diff] [blame] | 604 | * from the {@link Connection.VideoProvider}. |
| 605 | * <p> |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 606 | * When the {@link InCallService} receives the |
| 607 | * {@link Call.Callback#onVideoCallChanged(Call, VideoCall)} callback, it should create an |
| 608 | * instance its {@link VideoCall.Callback} implementation and set it on the |
| 609 | * {@link VideoCall} using {@link VideoCall#registerCallback(Callback)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 610 | */ |
Andrew Lee | da80c87 | 2015-04-15 14:09:50 -0700 | [diff] [blame] | 611 | public static abstract class Callback { |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 612 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 613 | * Called when the {@link Connection.VideoProvider} receives a session modification |
Tyler Gunn | 295f5d7 | 2015-06-04 11:08:54 -0700 | [diff] [blame] | 614 | * request from the peer device. |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 615 | * <p> |
| 616 | * The {@link InCallService} may potentially prompt the user to confirm whether they |
| 617 | * wish to accept the request, or decide to automatically accept the request. In either |
| 618 | * case the {@link InCallService} should call |
| 619 | * {@link VideoCall#sendSessionModifyResponse(VideoProfile)} to indicate the video |
| 620 | * profile agreed upon. |
| 621 | * <p> |
| 622 | * Callback originates from |
| 623 | * {@link Connection.VideoProvider#receiveSessionModifyRequest(VideoProfile)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 624 | * |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 625 | * @param videoProfile The requested video profile. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 626 | */ |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 627 | public abstract void onSessionModifyRequestReceived(VideoProfile videoProfile); |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 628 | |
| 629 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 630 | * Called when the {@link Connection.VideoProvider} receives a response to a session |
| 631 | * modification request previously sent to the peer device. |
| 632 | * <p> |
| 633 | * The new video state should not be considered active by the {@link InCallService} |
| 634 | * until the {@link Call} video state changes (the |
| 635 | * {@link Call.Callback#onDetailsChanged(Call, Call.Details)} callback is triggered |
| 636 | * when the video state changes). |
| 637 | * <p> |
| 638 | * Callback originates from |
| 639 | * {@link Connection.VideoProvider#receiveSessionModifyResponse(int, VideoProfile, |
| 640 | * VideoProfile)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 641 | * |
| 642 | * @param status Status of the session modify request. Valid values are |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 643 | * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_SUCCESS}, |
| 644 | * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_FAIL}, |
| 645 | * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_INVALID}, |
| 646 | * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_TIMED_OUT}, |
| 647 | * {@link Connection.VideoProvider#SESSION_MODIFY_REQUEST_REJECTED_BY_REMOTE}. |
| 648 | * @param requestedProfile The original request which was sent to the peer device. |
| 649 | * @param responseProfile The actual profile changes made by the peer device. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 650 | */ |
| 651 | public abstract void onSessionModifyResponseReceived(int status, |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 652 | VideoProfile requestedProfile, VideoProfile responseProfile); |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 653 | |
| 654 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 655 | * Handles events related to the current video session which the {@link InCallService} |
| 656 | * may wish to handle. These are separate from requested changes to the session due to |
| 657 | * the underlying protocol or connection. |
| 658 | * <p> |
| 659 | * Callback originates from |
| 660 | * {@link Connection.VideoProvider#handleCallSessionEvent(int)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 661 | * |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 662 | * @param event The event. Valid values are: |
| 663 | * {@link Connection.VideoProvider#SESSION_EVENT_RX_PAUSE}, |
| 664 | * {@link Connection.VideoProvider#SESSION_EVENT_RX_RESUME}, |
| 665 | * {@link Connection.VideoProvider#SESSION_EVENT_TX_START}, |
| 666 | * {@link Connection.VideoProvider#SESSION_EVENT_TX_STOP}, |
| 667 | * {@link Connection.VideoProvider#SESSION_EVENT_CAMERA_FAILURE}, |
Tyler Gunn | bf9c6fd | 2016-11-09 10:19:23 -0800 | [diff] [blame] | 668 | * {@link Connection.VideoProvider#SESSION_EVENT_CAMERA_READY}, |
| 669 | * {@link Connection.VideoProvider#SESSION_EVENT_CAMERA_PERMISSION_ERROR}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 670 | */ |
| 671 | public abstract void onCallSessionEvent(int event); |
| 672 | |
| 673 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 674 | * Handles a change to the video dimensions from the peer device. This could happen if, |
| 675 | * for example, the peer changes orientation of their device, or switches cameras. |
| 676 | * <p> |
| 677 | * Callback originates from |
| 678 | * {@link Connection.VideoProvider#changePeerDimensions(int, int)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 679 | * |
| 680 | * @param width The updated peer video width. |
| 681 | * @param height The updated peer video height. |
| 682 | */ |
| 683 | public abstract void onPeerDimensionsChanged(int width, int height); |
| 684 | |
| 685 | /** |
Rekha Kumar | 0736681 | 2015-03-24 16:42:31 -0700 | [diff] [blame] | 686 | * Handles a change to the video quality. |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 687 | * <p> |
| 688 | * Callback originates from {@link Connection.VideoProvider#changeVideoQuality(int)}. |
Rekha Kumar | 0736681 | 2015-03-24 16:42:31 -0700 | [diff] [blame] | 689 | * |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 690 | * @param videoQuality The updated peer video quality. Valid values: |
| 691 | * {@link VideoProfile#QUALITY_HIGH}, |
| 692 | * {@link VideoProfile#QUALITY_MEDIUM}, |
| 693 | * {@link VideoProfile#QUALITY_LOW}, |
| 694 | * {@link VideoProfile#QUALITY_DEFAULT}. |
Rekha Kumar | 0736681 | 2015-03-24 16:42:31 -0700 | [diff] [blame] | 695 | */ |
| 696 | public abstract void onVideoQualityChanged(int videoQuality); |
| 697 | |
| 698 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 699 | * Handles an update to the total data used for the current video session. |
| 700 | * <p> |
| 701 | * Used by the {@link Connection.VideoProvider} in response to |
| 702 | * {@link VideoCall#requestCallDataUsage()}. May also be called periodically by the |
| 703 | * {@link Connection.VideoProvider}. |
| 704 | * <p> |
| 705 | * Callback originates from {@link Connection.VideoProvider#setCallDataUsage(long)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 706 | * |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 707 | * @param dataUsage The updated data usage (in bytes). |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 708 | */ |
Rekha Kumar | 0736681 | 2015-03-24 16:42:31 -0700 | [diff] [blame] | 709 | public abstract void onCallDataUsageChanged(long dataUsage); |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 710 | |
| 711 | /** |
Tyler Gunn | b702ef8 | 2015-05-29 11:51:53 -0700 | [diff] [blame] | 712 | * Handles a change in the capabilities of the currently selected camera. |
| 713 | * <p> |
| 714 | * Used by the {@link Connection.VideoProvider} in response to |
| 715 | * {@link VideoCall#requestCameraCapabilities()}. The {@link Connection.VideoProvider} |
| 716 | * may also report the camera capabilities after a call to |
| 717 | * {@link VideoCall#setCamera(String)}. |
| 718 | * <p> |
| 719 | * Callback originates from |
| 720 | * {@link Connection.VideoProvider#changeCameraCapabilities( |
| 721 | * VideoProfile.CameraCapabilities)}. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 722 | * |
Ihab Awad | b19a0bc | 2014-08-07 19:46:01 -0700 | [diff] [blame] | 723 | * @param cameraCapabilities The changed camera capabilities. |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 724 | */ |
Yorke Lee | 400470f | 2015-05-12 13:31:25 -0700 | [diff] [blame] | 725 | public abstract void onCameraCapabilitiesChanged( |
| 726 | VideoProfile.CameraCapabilities cameraCapabilities); |
Andrew Lee | 50aca23 | 2014-07-22 16:41:54 -0700 | [diff] [blame] | 727 | } |
| 728 | } |
Sailesh Nepal | ab5d282 | 2014-03-08 18:01:06 -0800 | [diff] [blame] | 729 | } |