WallpaperService.Engine Class

Reference

Definition

Namespace:: Android.Service.Wallpaper

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

The actual implementation of a wallpaper.

[Android.Runtime.Register("android/service/wallpaper/WallpaperService$Engine", DoNotGenerateAcw=true)]
public class WallpaperService.Engine : Java.Lang.Object

[<Android.Runtime.Register("android/service/wallpaper/WallpaperService$Engine", DoNotGenerateAcw=true)>]
type WallpaperService.Engine = class
    inherit Object

Inheritance: Object

Object
WallpaperService.Engine

Attributes: RegisterAttribute

Remarks

The actual implementation of a wallpaper. A wallpaper service may have multiple instances running (for example as a real wallpaper and as a preview), each of which is represented by its own Engine instance. You must implement WallpaperService#onCreateEngine() to return your concrete Engine implementation.

Java documentation for android.service.wallpaper.WallpaperService.Engine.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

WallpaperService.Engine(IntPtr, JniHandleOwnership)	A constructor used when creating managed representations of JNI objects; called by the runtime.
WallpaperService.Engine(WallpaperService)

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
DesiredMinimumHeight	Convenience for `WallpaperManager#getDesiredMinimumHeight() WallpaperManager.getDesiredMinimumHeight()`, returning the height that the system would like this wallpaper to run in.
DesiredMinimumWidth	Convenience for `WallpaperManager#getDesiredMinimumWidth() WallpaperManager.getDesiredMinimumWidth()`, returning the width that the system would like this wallpaper to run in.
DisplayContext	The `Context` with resources that match the current display the wallpaper is on.
Handle	The handle to the underlying Android instance. (Inherited from Object)
IsPreview	Returns true if this engine is running in preview mode -- that is, it is being shown to the user before they select it as the actual wallpaper.
IsVisible	Return whether the wallpaper is currently visible to the user, this is the last value supplied to `#onVisibilityChanged(boolean)`.
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
SurfaceHolder	Provides access to the surface in which this wallpaper is drawn.
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code.
WallpaperFlags	Returns the current wallpaper flags indicating which screen this Engine is rendering to.

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Dump(String, FileDescriptor, PrintWriter, String[])
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
NotifyColorsChanged()	Notifies the engine that wallpaper colors changed significantly.
OnApplyWindowInsets(WindowInsets)	Called with the current insets that are in effect for the wallpaper.
OnCommand(String, Int32, Int32, Int32, Bundle, Boolean)	Process a command that was sent to the wallpaper with `WallpaperManager#sendWallpaperCommand`.
OnComputeColors()	Called by the system when it needs to know what colors the wallpaper is using.
OnCreate(ISurfaceHolder)	Called once to initialize the engine.
OnDesiredSizeChanged(Int32, Int32)	Called when an application has changed the desired virtual size of the wallpaper.
OnDestroy()	Called right before the engine is going away.
OnOffsetsChanged(Single, Single, Single, Single, Int32, Int32)	Called to inform you of the wallpaper's offsets changing within its contain, corresponding to the container's call to `WallpaperManager#setWallpaperOffsets(IBinder, float, float) WallpaperManager.setWallpaperOffsets()`.
OnSurfaceChanged(ISurfaceHolder, Format, Int32, Int32)	Convenience for `SurfaceHolder.Callback#surfaceChanged SurfaceHolder.Callback.surfaceChanged()`.
OnSurfaceCreated(ISurfaceHolder)	Convenience for `SurfaceHolder.Callback#surfaceCreated SurfaceHolder.Callback.surfaceCreated()`.
OnSurfaceDestroyed(ISurfaceHolder)	Convenience for `SurfaceHolder.Callback#surfaceDestroyed SurfaceHolder.Callback.surfaceDestroyed()`.
OnSurfaceRedrawNeeded(ISurfaceHolder)	Convenience for `SurfaceHolder.Callback2#surfaceRedrawNeeded SurfaceHolder.Callback.surfaceRedrawNeeded()`.
OnTouchEvent(MotionEvent)	Called as the user performs touch-screen interaction with the window that is currently showing this wallpaper.
OnVisibilityChanged(Boolean)	Called to inform you of the wallpaper becoming visible or hidden.
OnWallpaperFlagsChanged(WallpaperManagerFlags)	Called when the current wallpaper flags change.
OnZoomChanged(Single)	Called when the zoom level of the wallpaper changed.
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
SetOffsetNotificationsEnabled(Boolean)	Control whether this wallpaper will receive notifications when the wallpaper has been scrolled.
SetTouchEventsEnabled(Boolean)	Control whether this wallpaper will receive raw touch events from the window manager as the user interacts with the window that is currently displaying the wallpaper.
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to

Compartilhar via