public abstract class

WallpaperService

extends Service

java.lang.Object
↳	android.content.Context
	↳	android.content.ContextWrapper
		↳	android.app.Service
			↳	android.service.wallpaper.WallpaperService

Class Overview

A wallpaper service is responsible for showing a live wallpaper behind applications that would like to sit on top of it. This service object itself does very little -- its only purpose is to generate instances of WallpaperService.Engine as needed. Implementing a wallpaper thus involves subclassing from this, subclassing an Engine implementation, and implementing onCreateEngine() to return a new instance of your engine.

Summary

Nested Classes
class	WallpaperService.Engine	The actual implementation of a wallpaper.

Constants
String	SERVICE_INTERFACE	The `Intent` that must be declared as handled by the service.
String	SERVICE_META_DATA	Name under which a WallpaperService component publishes information about itself.

[Expand]

Inherited Constants

From class android.app.Service

From class android.content.Context

Public Constructors
	WallpaperService()

Public Methods
final IBinder	onBind(Intent intent) Implement to return the implementation of the internal accessibility service interface.
void	onCreate() Called by the system when the service is first created.
abstract WallpaperService.Engine	onCreateEngine() Must be implemented to return a new instance of the wallpaper's engine.
void	onDestroy() Called by the system to notify a Service that it is no longer used and is being removed.

[Expand]

Inherited Methods

From class android.app.Service

void	dump(FileDescriptor fd, PrintWriter writer, String[] args) Print the Service's state into the given stream.
void	finalize() Called before the object's memory is reclaimed by the VM.
final Application	getApplication() Return the application that owns this service.
abstract IBinder	onBind(Intent intent) Return the communication channel to the service.
void	onConfigurationChanged(Configuration newConfig) Called by the system when the device configuration changes while your component is running.
void	onCreate() Called by the system when the service is first created.
void	onDestroy() Called by the system to notify a Service that it is no longer used and is being removed.
void	onLowMemory() This is called when the overall system is running low on memory, and would like actively running process to try to tighten their belt.
void	onRebind(Intent intent) Called when new clients have connected to the service, after it had previously been notified that all had disconnected in its `onUnbind(Intent)`.
void	onStart(Intent intent, int startId) This method is deprecated. Implement `onStartCommand(Intent, int, int)` instead.
int	onStartCommand(Intent intent, int flags, int startId) Called by the system every time a client explicitly starts the service by calling `startService(Intent)`, providing the arguments it supplied and a unique integer token representing the start request.
boolean	onUnbind(Intent intent) Called when all clients have disconnected from a particular interface published by the service.
final void	setForeground(boolean isForeground) This method is deprecated. This is a now a no-op, use `startForeground(int, Notification)` instead. This method has been turned into a no-op rather than simply being deprecated because analysis of numerous poorly behaving devices has shown that increasingly often the trouble is being caused in part by applications that are abusing it. Thus, given a choice between introducing problems in existing applications using this API (by allowing them to be killed when they would like to avoid it), vs allowing the performance of the entire system to be decreased, this method was deemed less important.
final void	startForeground(int id, Notification notification) Make this service run in the foreground, supplying the ongoing notification to be shown to the user while in this state.
final void	stopForeground(boolean removeNotification) Remove this service from foreground state, allowing it to be killed if more memory is needed.
final void	stopSelf() Stop the service, if it was previously started.
final void	stopSelf(int startId) Old version of `stopSelfResult(int)` that doesn't return a result.
final boolean	stopSelfResult(int startId) Stop the service if the most recent time it was started was `startId`.

From class android.content.ContextWrapper

From class android.content.Context

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Called before the object's memory is reclaimed by the VM.
final Class<? extends Object>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.content.ComponentCallbacks

Constants

public static final String SERVICE_INTERFACE

Since: API Level 7

The Intent that must be declared as handled by the service. To be supported, the service must also require the BIND_WALLPAPER permission so that other applications can not abuse it.

Constant Value: "android.service.wallpaper.WallpaperService"

public static final String SERVICE_META_DATA

Since: API Level 7

Name under which a WallpaperService component publishes information about itself. This meta-data must reference an XML resource containing a <wallpaper> tag.

Constant Value: "android.service.wallpaper"

Public Constructors

public WallpaperService ()

Since: API Level 7

Public Methods

public final IBinder onBind (Intent intent)

Since: API Level 7

Implement to return the implementation of the internal accessibility service interface. Subclasses should not override.

Parameters

intent	The Intent that was used to bind to this service, as given to `Context.bindService`. Note that any extras that were included with the Intent at that point will not be seen here.

Returns

Return an IBinder through which clients can call on to the service.

public void onCreate ()

Since: API Level 7

Called by the system when the service is first created. Do not call this method directly.

public abstract WallpaperService.Engine onCreateEngine ()

Since: API Level 7

Must be implemented to return a new instance of the wallpaper's engine. Note that multiple instances may be active at the same time, such as when the wallpaper is currently set as the active wallpaper and the user is in the wallpaper picker viewing a preview of it as well.

public void onDestroy ()

Since: API Level 7

Called by the system to notify a Service that it is no longer used and is being removed. The service should clean up an resources it holds (threads, registered receivers, etc) at this point. Upon return, there will be no more calls in to this Service object and it is effectively dead. Do not call this method directly.

Classes

WallpaperService

Class Overview

Summary

Constants

public static final String SERVICE_INTERFACE

public static final String SERVICE_META_DATA

Public Constructors

public WallpaperService ()

Public Methods

public final IBinder onBind (Intent intent)

Parameters

Returns

public void onCreate ()

public abstract WallpaperService.Engine onCreateEngine ()

public void onDestroy ()