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