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
221
222
223
224
225
226
227
228
229
230
|
/**
* Copyright (c) 2008, 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.app;
import android.graphics.Rect;
import android.graphics.RectF;
import android.os.Bundle;
import android.os.ParcelFileDescriptor;
import android.app.IWallpaperManagerCallback;
import android.app.ILocalWallpaperColorConsumer;
import android.app.WallpaperInfo;
import android.content.ComponentName;
import android.app.WallpaperColors;
/** @hide */
interface IWallpaperManager {
/**
* Set the wallpaper for the current user.
*
* If 'extras' is non-null, on successful return it will contain:
* EXTRA_SET_WALLPAPER_ID : integer ID that the new wallpaper will have
*
* 'which' is some combination of:
* FLAG_SET_SYSTEM
* FLAG_SET_LOCK
*
* A 'null' cropHint rectangle is explicitly permitted as a sentinel for "whatever
* the source image's bounding rect is."
*
* The completion callback's "onWallpaperChanged()" method is invoked when the
* new wallpaper content is ready to display.
*/
ParcelFileDescriptor setWallpaper(String name, in String callingPackage,
in Rect cropHint, boolean allowBackup, out Bundle extras, int which,
IWallpaperManagerCallback completion, int userId);
/**
* Set the live wallpaper. This only affects the system wallpaper.
*/
void setWallpaperComponentChecked(in ComponentName name, in String callingPackage, int userId);
/**
* Set the live wallpaper. This only affects the system wallpaper.
*/
@UnsupportedAppUsage
void setWallpaperComponent(in ComponentName name);
/**
* @deprecated Use {@link #getWallpaperWithFeature(String, IWallpaperManagerCallback, int,
* Bundle, int)}
*/
@UnsupportedAppUsage
ParcelFileDescriptor getWallpaper(String callingPkg, IWallpaperManagerCallback cb, int which,
out Bundle outParams, int userId);
/**
* Get the wallpaper for a given user.
*/
ParcelFileDescriptor getWallpaperWithFeature(String callingPkg, String callingFeatureId,
IWallpaperManagerCallback cb, int which, out Bundle outParams, int userId);
/**
* Retrieve the given user's current wallpaper ID of the given kind.
*/
int getWallpaperIdForUser(int which, int userId);
/**
* If the current system wallpaper is a live wallpaper component, return the
* information about that wallpaper. Otherwise, if it is a static image,
* simply return null.
*/
@UnsupportedAppUsage(maxTargetSdk = 30, trackingBug = 170729553)
WallpaperInfo getWallpaperInfo(int userId);
/**
* Clear the system wallpaper.
*/
void clearWallpaper(in String callingPackage, int which, int userId);
/**
* Return whether the current system wallpaper has the given name.
*/
@UnsupportedAppUsage
boolean hasNamedWallpaper(String name);
/**
* Sets the dimension hint for the wallpaper. These hints indicate the desired
* minimum width and height for the wallpaper in a particular display.
*/
void setDimensionHints(in int width, in int height, in String callingPackage, int displayId);
/**
* Returns the desired minimum width for the wallpaper in a particular display.
*/
@UnsupportedAppUsage
int getWidthHint(int displayId);
/**
* Returns the desired minimum height for the wallpaper in a particular display.
*/
@UnsupportedAppUsage
int getHeightHint(int displayId);
/**
* Sets extra padding that we would like the wallpaper to have outside of the display.
*/
void setDisplayPadding(in Rect padding, in String callingPackage, int displayId);
/**
* Returns the name of the wallpaper. Private API.
*/
String getName();
/**
* Informs the service that wallpaper settings have been restored. Private API.
*/
void settingsRestored();
/**
* Check whether wallpapers are supported for the calling user.
*/
boolean isWallpaperSupported(in String callingPackage);
/**
* Check whether setting of wallpapers are allowed for the calling user.
*/
boolean isSetWallpaperAllowed(in String callingPackage);
/*
* Backup: is the current system wallpaper image eligible for off-device backup?
*/
boolean isWallpaperBackupEligible(int which, int userId);
/*
* Keyguard: register a callback for being notified that lock-state relevant
* wallpaper content has changed.
*/
boolean setLockWallpaperCallback(IWallpaperManagerCallback cb);
/**
* Returns the colors used by the lock screen or system wallpaper.
*
* @param which either {@link WallpaperManager#FLAG_LOCK}
* or {@link WallpaperManager#FLAG_SYSTEM}
* @param displayId Which display is interested
* @return colors of chosen wallpaper
*/
WallpaperColors getWallpaperColors(int which, int userId, int displayId);
/**
* @hide
*/
void removeOnLocalColorsChangedListener(
in ILocalWallpaperColorConsumer callback, in List<RectF> area,
int which, int userId, int displayId);
/**
* @hide
*/
void addOnLocalColorsChangedListener(in ILocalWallpaperColorConsumer callback,
in List<RectF> regions, int which, int userId, int displayId);
/**
* Register a callback to receive color updates from a display
*/
void registerWallpaperColorsCallback(IWallpaperManagerCallback cb, int userId, int displayId);
/**
* Unregister a callback that was receiving color updates from a display
*/
void unregisterWallpaperColorsCallback(IWallpaperManagerCallback cb, int userId, int displayId);
/**
* Called from SystemUI when it shows the AoD UI.
*/
oneway void setInAmbientMode(boolean inAmbientMode, long animationDuration);
/**
* Called from SystemUI when the device is waking up.
*
* @hide
*/
oneway void notifyWakingUp(int x, int y, in Bundle extras);
/**
* Called from SystemUI when the device is going to sleep.
*
* @hide
*/
void notifyGoingToSleep(int x, int y, in Bundle extras);
/**
* Sets the wallpaper dim amount between [0f, 1f] which would be blended with the system default
* dimming. 0f doesn't add any additional dimming and 1f makes the wallpaper fully black.
*
* @hide
*/
oneway void setWallpaperDimAmount(float dimAmount);
/**
* Gets the current additional dim amount set on the wallpaper. 0f means no application has
* added any dimming on top of the system default dim amount.
*
* @hide
*/
float getWallpaperDimAmount();
/**
* Whether the lock screen wallpaper is different from the system wallpaper.
*
* @hide
*/
boolean lockScreenWallpaperExists();
}
|
