1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/* Copyright (c) 2015, The Linux Foundation. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
* * Neither the name of The Linux Foundation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
* IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.android.incallui;
import android.content.Context;
import android.hardware.display.DisplayManager;
import android.view.Display;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.List;
import com.google.common.base.Preconditions;
/**
* This class listens to below events and notifes whether InCallUI is visible to the user or not.
* a. InCallActivity's lifecycle events (onStop/onStart)
* b. Display state change events (DISPLAY_ON/DISPLAY_OFF)
*/
public class InCallUiStateNotifier implements DisplayManager.DisplayListener {
private List<InCallUiStateNotifierListener> mInCallUiStateNotifierListeners =
new CopyOnWriteArrayList<>();
private static InCallUiStateNotifier sInCallUiStateNotifier;
private DisplayManager mDisplayManager;
private Context mContext;
/**
* Tracks whether the application is in the background. {@code True} if the application is in
* the background, {@code false} otherwise.
*/
private boolean mIsInBackground;
/**
* Tracks whether display is ON/OFF. {@code True} if display is ON, {@code false} otherwise.
*/
private boolean mIsDisplayOn;
/**
* Handles set up of the {@class InCallUiStateNotifier}. Instantiates the context needed by
* the class and adds a listener to listen to display state changes.
*/
public void setUp(Context context) {
mContext = context;
mDisplayManager = (DisplayManager) mContext.getSystemService(Context.DISPLAY_SERVICE);
mDisplayManager.registerDisplayListener(this, null);
mIsDisplayOn = (mDisplayManager.getDisplay(Display.DEFAULT_DISPLAY).getState()
== Display.STATE_ON);
Log.d(this, "setUp mIsDisplayOn: " + mIsDisplayOn);
}
/**
* Private constructor. Must use getInstance() to get this singleton.
*/
private InCallUiStateNotifier() {
}
/**
* This method returns a singleton instance of {@class InCallUiStateNotifier}
*/
public static synchronized InCallUiStateNotifier getInstance() {
if (sInCallUiStateNotifier == null) {
sInCallUiStateNotifier = new InCallUiStateNotifier();
}
return sInCallUiStateNotifier;
}
/**
* Adds a new {@link InCallUiStateNotifierListener}.
*
* @param listener The listener.
*/
public void addListener(InCallUiStateNotifierListener listener) {
Preconditions.checkNotNull(listener);
mInCallUiStateNotifierListeners.add(listener);
}
/**
* Remove a {@link InCallUiStateNotifierListener}.
*
* @param listener The listener.
*/
public void removeListener(InCallUiStateNotifierListener listener) {
if (listener != null) {
mInCallUiStateNotifierListeners.remove(listener);
} else {
Log.e(this, "Can't remove null listener");
}
}
/**
* Notfies when visibility of InCallUI is changed. For eg.
* when UE moves in/out of the foreground, display either turns ON/OFF
* @param showing true if InCallUI is visible, false otherwise.
*/
private void notifyOnUiShowing(boolean showing) {
Preconditions.checkNotNull(mInCallUiStateNotifierListeners);
for (InCallUiStateNotifierListener listener : mInCallUiStateNotifierListeners) {
listener.onUiShowing(showing);
}
}
/**
* Handles tear down of the {@class InCallUiStateNotifier}. Sets the context to null and
* unregisters it's display listener.
*/
public void tearDown() {
mDisplayManager.unregisterDisplayListener(this);
mDisplayManager = null;
mContext = null;
mInCallUiStateNotifierListeners.clear();
}
/**
* checks to see whether InCallUI experience is visible to the user or not.
* returns true if InCallUI experience is visible to the user else false.
*/
private boolean isUiShowing() {
/* Not in background and display is ON does mean that InCallUI is visible/showing.
Return true in such cases else false */
return !mIsInBackground && mIsDisplayOn;
}
/**
* Called when UE goes in/out of the foreground.
* @param showing true if UE is in the foreground, false otherwise.
*/
public void onUiShowing(boolean showing) {
//Check UI's old state before updating corresponding state variable(s)
final boolean wasShowing = isUiShowing();
mIsInBackground = !showing;
//Check UI's new state after updating corresponding state variable(s)
final boolean isShowing = isUiShowing();
Log.d(this, "onUiShowing wasShowing: " + wasShowing + " isShowing: " + isShowing);
//notify if there is a change in UI state
if (wasShowing != isShowing) {
notifyOnUiShowing(showing);
}
}
/**
* This method overrides onDisplayRemoved method of {@interface DisplayManager.DisplayListener}
* Added for completeness. No implementation yet.
*/
@Override
public void onDisplayRemoved(int displayId) {
}
/**
* This method overrides onDisplayAdded method of {@interface DisplayManager.DisplayListener}
* Added for completeness. No implementation yet.
*/
@Override
public void onDisplayAdded(int displayId) {
}
/**
* This method overrides onDisplayAdded method of {@interface DisplayManager.DisplayListener}
* The method gets invoked whenever the properties of a logical display have changed.
*/
@Override
public void onDisplayChanged(int displayId) {
final int displayState = mDisplayManager.getDisplay(displayId).getState();
Log.d(this, "onDisplayChanged displayState: " + displayState +
" displayId: " + displayId);
/* Ignore display changed indications if they are received for displays
* other than default display
*/
if (displayId != Display.DEFAULT_DISPLAY) {
Log.w(this, "onDisplayChanged Ignoring...");
return;
}
//Check UI's old state before updating corresponding state variable(s)
final boolean wasShowing = isUiShowing();
mIsDisplayOn = (displayState == Display.STATE_ON ||
displayState == Display.STATE_DOZE ||
displayState == Display.STATE_DOZE_SUSPEND);
//Check UI's new state after updating corresponding state variable(s)
final boolean isShowing = isUiShowing();
Log.d(this, "onDisplayChanged wasShowing: " + wasShowing + " isShowing: " + isShowing);
//notify if there is a change in UI state
if (wasShowing != isShowing) {
notifyOnUiShowing(mIsDisplayOn);
}
}
}
|
