WallpaperService.Engine Class
Definition
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
- Attributes
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
| Name | Description |
|---|---|
| WallpaperService.Engine(IntPtr, JniHandleOwnership) |
A constructor used when creating managed representations of JNI objects; called by the runtime. |
| WallpaperService.Engine(WallpaperService) |
Initializes an engine associated with the specified wallpaper service. |
Properties
| Name | Description |
|---|---|
| Class |
Returns the runtime class of this |
| DesiredMinimumHeight |
Convenience for |
| DesiredMinimumWidth |
Convenience for |
| DisplayContext |
The |
| 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
|
| JniIdentityHashCode |
Gets the identity hash code assigned to this Java peer by the interop runtime. (Inherited from Object) |
| JniManagedPeerState | (Inherited from JavaObject) |
| JniPeerMembers |
This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. |
| PeerReference |
Gets the JNI object reference for this Java peer. (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
| Name | Description |
|---|---|
| Clone() |
Creates and returns a copy of this object. (Inherited from Object) |
| Construct(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| Dispose() |
Releases the resources held by this Java peer. (Inherited from Object) |
| Dispose(Boolean) |
Releases the resources held by this Java peer. (Inherited from Object) |
| DisposeUnlessReferenced() | (Inherited from JavaObject) |
| Dump(String, FileDescriptor, PrintWriter, String[]) |
Prints this engine's state to the specified output. |
| Equals(Object) | (Inherited from JavaObject) |
| 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. |
| OnApplyWallpaper(Int32) |
Called when the wallpaper preview rendered by this engine is about to be persisted as a selected wallpaper. |
| 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
|
| 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 |
| OnSurfaceChanged(ISurfaceHolder, Format, Int32, Int32) |
Convenience for |
| OnSurfaceCreated(ISurfaceHolder) |
Convenience for |
| OnSurfaceDestroyed(ISurfaceHolder) |
Convenience for |
| OnSurfaceRedrawNeeded(ISurfaceHolder) |
Convenience for |
| 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. |
| SetPeerReference(JniObjectReference, JniObjectReferenceOptions) | (Inherited from JavaObject) |
| 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>() |
Creates a managed array from this Java array wrapper. (Inherited from Object) |
| ToString() |
Returns a string representation of the object. (Inherited from Object) |
| UnregisterFromRuntime() |
Unregisters this Java peer from the interop runtime. (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
| Name | Description |
|---|---|
| IJavaPeerable.Disposed() | (Inherited from JavaObject) |
| IJavaPeerable.Finalized() | (Inherited from JavaObject) |
| IJavaPeerable.JniObjectReferenceControlBlock | (Inherited from JavaObject) |
| IJavaPeerable.SetJniIdentityHashCode(Int32) | (Inherited from JavaObject) |
| IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates) | (Inherited from JavaObject) |
| IJavaPeerable.SetPeerReference(JniObjectReference) | (Inherited from JavaObject) |
Extension Methods
| Name | Description |
|---|---|
| GetJniTypeName(IJavaPeerable) |
Gets the JNI name of the type of the instance |
| JavaAs<TResult>(IJavaPeerable) |
Try to coerce |
| JavaCast<TResult>(IJavaObject) |
Performs an Android runtime-checked type conversion. |
| JavaCast<TResult>(IJavaObject) | |
| TryJavaCast<TResult>(IJavaPeerable, TResult) |
Try to coerce |