/* * Copyright (C) 2013 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.telecom; import android.annotation.SystemApi; import android.util.ArrayMap; import java.util.Collections; import java.util.List; import java.util.Map; import java.util.Objects; import java.util.concurrent.CopyOnWriteArrayList; /** * A unified virtual device providing a means of voice (and other) communication on a device. * * @hide * @deprecated Use {@link InCallService} directly instead of using this class. */ @SystemApi @Deprecated public final class Phone { public abstract static class Listener { /** * Called when the audio state changes. * * @param phone The {@code Phone} calling this method. * @param audioState The new {@link AudioState}. * * @deprecated Use {@link #onCallAudioStateChanged(Phone, CallAudioState)} instead. */ @Deprecated public void onAudioStateChanged(Phone phone, AudioState audioState) { } /** * Called when the audio state changes. * * @param phone The {@code Phone} calling this method. * @param callAudioState The new {@link CallAudioState}. */ public void onCallAudioStateChanged(Phone phone, CallAudioState callAudioState) { } /** * Called to bring the in-call screen to the foreground. The in-call experience should * respond immediately by coming to the foreground to inform the user of the state of * ongoing {@code Call}s. * * @param phone The {@code Phone} calling this method. * @param showDialpad If true, put up the dialpad when the screen is shown. */ public void onBringToForeground(Phone phone, boolean showDialpad) { } /** * Called when a {@code Call} has been added to this in-call session. The in-call user * experience should add necessary state listeners to the specified {@code Call} and * immediately start to show the user information about the existence * and nature of this {@code Call}. Subsequent invocations of {@link #getCalls()} will * include this {@code Call}. * * @param phone The {@code Phone} calling this method. * @param call A newly added {@code Call}. */ public void onCallAdded(Phone phone, Call call) { } /** * Called when a {@code Call} has been removed from this in-call session. The in-call user * experience should remove any state listeners from the specified {@code Call} and * immediately stop displaying any information about this {@code Call}. * Subsequent invocations of {@link #getCalls()} will no longer include this {@code Call}. * * @param phone The {@code Phone} calling this method. * @param call A newly removed {@code Call}. */ public void onCallRemoved(Phone phone, Call call) { } /** * Called when the {@code Phone} ability to add more calls changes. If the phone cannot * support more calls then {@code canAddCall} is set to {@code false}. If it can, then it * is set to {@code true}. * * @param phone The {@code Phone} calling this method. * @param canAddCall Indicates whether an additional call can be added. */ public void onCanAddCallChanged(Phone phone, boolean canAddCall) { } } // A Map allows us to track each Call by its Telecom-specified call ID private final Map<String, Call> mCallByTelecomCallId = new ArrayMap<>(); // A List allows us to keep the Calls in a stable iteration order so that casually developed // user interface components do not incur any spurious jank private final List<Call> mCalls = new CopyOnWriteArrayList<>(); // An unmodifiable view of the above List can be safely shared with subclass implementations private final List<Call> mUnmodifiableCalls = Collections.unmodifiableList(mCalls); private final InCallAdapter mInCallAdapter; private CallAudioState mCallAudioState; private final List<Listener> mListeners = new CopyOnWriteArrayList<>(); private boolean mCanAddCall = true; Phone(InCallAdapter adapter) { mInCallAdapter = adapter; } final void internalAddCall(ParcelableCall parcelableCall) { Call call = new Call(this, parcelableCall.getId(), mInCallAdapter); mCallByTelecomCallId.put(parcelableCall.getId(), call); mCalls.add(call); checkCallTree(parcelableCall); call.internalUpdate(parcelableCall, mCallByTelecomCallId); fireCallAdded(call); } final void internalRemoveCall(Call call) { mCallByTelecomCallId.remove(call.internalGetCallId()); mCalls.remove(call); InCallService.VideoCall videoCall = call.getVideoCall(); if (videoCall != null) { videoCall.destroy(); } fireCallRemoved(call); } final void internalUpdateCall(ParcelableCall parcelableCall) { Call call = mCallByTelecomCallId.get(parcelableCall.getId()); if (call != null) { checkCallTree(parcelableCall); call.internalUpdate(parcelableCall, mCallByTelecomCallId); } } final void internalSetPostDialWait(String telecomId, String remaining) { Call call = mCallByTelecomCallId.get(telecomId); if (call != null) { call.internalSetPostDialWait(remaining); } } final void internalCallAudioStateChanged(CallAudioState callAudioState) { if (!Objects.equals(mCallAudioState, callAudioState)) { mCallAudioState = callAudioState; fireCallAudioStateChanged(callAudioState); } } final Call internalGetCallByTelecomId(String telecomId) { return mCallByTelecomCallId.get(telecomId); } final void internalBringToForeground(boolean showDialpad) { fireBringToForeground(showDialpad); } final void internalSetCanAddCall(boolean canAddCall) { if (mCanAddCall != canAddCall) { mCanAddCall = canAddCall; fireCanAddCallChanged(canAddCall); } } /** * Called to destroy the phone and cleanup any lingering calls. */ final void destroy() { for (Call call : mCalls) { InCallService.VideoCall videoCall = call.getVideoCall(); if (videoCall != null) { videoCall.destroy(); } if (call.getState() != Call.STATE_DISCONNECTED) { call.internalSetDisconnected(); } } } /** * Adds a listener to this {@code Phone}. * * @param listener A {@code Listener} object. */ public final void addListener(Listener listener) { mListeners.add(listener); } /** * Removes a listener from this {@code Phone}. * * @param listener A {@code Listener} object. */ public final void removeListener(Listener listener) { if (listener != null) { mListeners.remove(listener); } } /** * Obtains the current list of {@code Call}s to be displayed by this in-call experience. * * @return A list of the relevant {@code Call}s. */ public final List<Call> getCalls() { return mUnmodifiableCalls; } /** * Returns if the {@code Phone} can support additional calls. * * @return Whether the phone supports adding more calls. */ public final boolean canAddCall() { return mCanAddCall; } /** * Sets the microphone mute state. When this request is honored, there will be change to * the {@link #getAudioState()}. * * @param state {@code true} if the microphone should be muted; {@code false} otherwise. */ public final void setMuted(boolean state) { mInCallAdapter.mute(state); } /** * Sets the audio route (speaker, bluetooth, etc...). When this request is honored, there will * be change to the {@link #getAudioState()}. * * @param route The audio route to use. */ public final void setAudioRoute(int route) { mInCallAdapter.setAudioRoute(route); } /** * Turns the proximity sensor on. When this request is made, the proximity sensor will * become active, and the touch screen and display will be turned off when the user's face * is detected to be in close proximity to the screen. This operation is a no-op on devices * that do not have a proximity sensor. * * @hide */ public final void setProximitySensorOn() { mInCallAdapter.turnProximitySensorOn(); } /** * Turns the proximity sensor off. When this request is made, the proximity sensor will * become inactive, and no longer affect the touch screen and display. This operation is a * no-op on devices that do not have a proximity sensor. * * @param screenOnImmediately If true, the screen will be turned on immediately if it was * previously off. Otherwise, the screen will only be turned on after the proximity sensor * is no longer triggered. * * @hide */ public final void setProximitySensorOff(boolean screenOnImmediately) { mInCallAdapter.turnProximitySensorOff(screenOnImmediately); } /** * Obtains the current phone call audio state of the {@code Phone}. * * @return An object encapsulating the audio state. * @deprecated Use {@link #getCallAudioState()} instead. */ @Deprecated public final AudioState getAudioState() { return new AudioState(mCallAudioState); } /** * Obtains the current phone call audio state of the {@code Phone}. * * @return An object encapsulating the audio state. */ public final CallAudioState getCallAudioState() { return mCallAudioState; } private void fireCallAdded(Call call) { for (Listener listener : mListeners) { listener.onCallAdded(this, call); } } private void fireCallRemoved(Call call) { for (Listener listener : mListeners) { listener.onCallRemoved(this, call); } } private void fireCallAudioStateChanged(CallAudioState audioState) { for (Listener listener : mListeners) { listener.onCallAudioStateChanged(this, audioState); listener.onAudioStateChanged(this, new AudioState(audioState)); } } private void fireBringToForeground(boolean showDialpad) { for (Listener listener : mListeners) { listener.onBringToForeground(this, showDialpad); } } private void fireCanAddCallChanged(boolean canAddCall) { for (Listener listener : mListeners) { listener.onCanAddCallChanged(this, canAddCall); } } private void checkCallTree(ParcelableCall parcelableCall) { if (parcelableCall.getParentCallId() != null && !mCallByTelecomCallId.containsKey(parcelableCall.getParentCallId())) { Log.wtf(this, "ParcelableCall %s has nonexistent parent %s", parcelableCall.getId(), parcelableCall.getParentCallId()); } if (parcelableCall.getChildCallIds() != null) { for (int i = 0; i < parcelableCall.getChildCallIds().size(); i++) { if (!mCallByTelecomCallId.containsKey(parcelableCall.getChildCallIds().get(i))) { Log.wtf(this, "ParcelableCall %s has nonexistent child %s", parcelableCall.getId(), parcelableCall.getChildCallIds().get(i)); } } } } }