Summary: Ctors | Methods | Inherited Methods

WatchFaceService.Engine

public abstract class WatchFaceService.Engine
extends WallpaperService.Engine

java.lang.Object
↳	android.service.wallpaper.WallpaperService.Engine
	↳	android.support.wearable.watchface.WatchFaceService.Engine

Known direct subclasses

CanvasWatchFaceService.Engine, Gles2WatchFaceService.Engine

CanvasWatchFaceService.Engine	This class is deprecated. Use Watch Face Format APIs instead.
Gles2WatchFaceService.Engine	This class is deprecated. Use Watch Face Format APIs instead.

This class is deprecated.
Use Watch Face Format APIs instead.

The actual implementation of a watch face. You must implement WatchFaceService.onCreateEngine() to return your concrete Engine implementation.

Summary

Public constructors
`Engine()`

Public methods
`final int`	`getInterruptionFilter()` Returns interruption filter selected by the user.
`final int`	`getNotificationCount()` Returns the total number of notification cards in the stream.
`final Rect`	`getPeekCardPosition()` This method is deprecated. Wear 2.0 doesn't have peeking cards
`final int`	`getUnreadCount()` Returns the number of unread notification cards in the stream.
`final boolean`	`isInAmbientMode()` Returns whether the watch face is in ambient mode.
`void`	`onAmbientModeChanged(boolean inAmbientMode)` Called when the device enters or exits ambient mode.
`Bundle`	`onCommand(String action, int x, int y, int z, Bundle extras, boolean resultRequested)`
`void`	`onComplicationDataUpdate(int watchFaceComplicationId, ComplicationData data)` Called when new complication data is received.
`void`	`onCreate(SurfaceHolder holder)`
`void`	`onDestroy()`
`void`	`onInterruptionFilterChanged(int interruptionFilter)` Called when the user changes interruption filter.
`void`	`onNotificationCountChanged(int count)` Called when the total number of notification cards in the stream has changed.
`void`	`onPeekCardPositionUpdate(Rect rect)` This method is deprecated. Wear 2.0 doesn't have peeking cards
`void`	`onPropertiesChanged(Bundle properties)` Called when the properties of the device are determined.
`void`	`onTapCommand(int tapType, int x, int y, long eventTime)` Called when a tap or touch related event occurs.
`void`	`onTimeTick()` Called periodically to update the time shown by the watch face.
`void`	`onTouchEvent(MotionEvent event)` This method is deprecated. Do not use this to receive touch events on a watch face.
`void`	`onUnreadCountChanged(int count)` Called when the number of unread notification cards in the stream has changed.
`void`	`onVisibilityChanged(boolean visible)` Called to inform you of the watch face becoming visible or hidden.
`void`	`setActiveComplications(int... watchFaceComplicationIds)` Sets the complications which are active in the watchface.
`void`	`setDefaultComplicationProvider(int watchFaceComplicationId, ComponentName provider, int type)` Sets a custom provider as the default provider for the specified watch face complication id.
`void`	`setDefaultSystemComplicationProvider(int watchFaceComplicationId, int systemProvider, int type)` Sets a system provider as the default provider for the specified watch face complication id.
`void`	`setTouchEventsEnabled(boolean enabled)` This method is deprecated. Do not use this to receive touch events on a watch face.
`void`	`setWatchFaceStyle(WatchFaceStyle watchFaceStyle)` Sets the watch face style.

Inherited methods

From class


        
          android.service.wallpaper.WallpaperService.Engine

`void`	`dump(String arg0, FileDescriptor arg1, PrintWriter arg2, String[] arg3)`
`int`	`getDesiredMinimumHeight()`
`int`	`getDesiredMinimumWidth()`
`Context`	`getDisplayContext()`
`SurfaceHolder`	`getSurfaceHolder()`
`boolean`	`isPreview()`
`boolean`	`isVisible()`
`void`	`notifyColorsChanged()`
`void`	`onApplyWindowInsets(WindowInsets arg0)`
`Bundle`	`onCommand(String arg0, int arg1, int arg2, int arg3, Bundle arg4, boolean arg5)`
`WallpaperColors`	`onComputeColors()`
`void`	`onCreate(SurfaceHolder arg0)`
`void`	`onDesiredSizeChanged(int arg0, int arg1)`
`void`	`onDestroy()`
`void`	`onOffsetsChanged(float arg0, float arg1, float arg2, float arg3, int arg4, int arg5)`
`void`	`onSurfaceChanged(SurfaceHolder arg0, int arg1, int arg2, int arg3)`
`void`	`onSurfaceCreated(SurfaceHolder arg0)`
`void`	`onSurfaceDestroyed(SurfaceHolder arg0)`
`void`	`onSurfaceRedrawNeeded(SurfaceHolder arg0)`
`void`	`onTouchEvent(MotionEvent arg0)`
`void`	`onVisibilityChanged(boolean arg0)`
`void`	`onZoomChanged(float arg0)`
`void`	`setOffsetNotificationsEnabled(boolean arg0)`
`void`	`setTouchEventsEnabled(boolean arg0)`

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

Engine

public Engine ()

Public methods

getInterruptionFilter

public final int getInterruptionFilter ()

Returns interruption filter selected by the user.

Returns
`int`	`WatchFaceService.INTERRUPTION_FILTER_NONE`, `WatchFaceService.INTERRUPTION_FILTER_PRIORITY`, `WatchFaceService.INTERRUPTION_FILTER_ALL`, `WatchFaceService.INTERRUPTION_FILTER_ALARMS`, or `WatchFaceService.INTERRUPTION_FILTER_UNKNOWN`.

getNotificationCount

public final int getNotificationCount ()

Returns the total number of notification cards in the stream.

Returns
`int`

getPeekCardPosition

public final Rect getPeekCardPosition ()

This method is deprecated.
Wear 2.0 doesn't have peeking cards

Returns the location of the first peeking card. This doesn't provide information about all movements of the card, only about its location when it's peeking at the bottom and allowing the watch face to be exposed.

Returns
`Rect`

getUnreadCount

public final int getUnreadCount ()

Returns the number of unread notification cards in the stream.

Returns
`int`

isInAmbientMode

public final boolean isInAmbientMode ()

Returns whether the watch face is in ambient mode. When true, the watch face should display in white on black.

Returns
`boolean`

onAmbientModeChanged

public void onAmbientModeChanged (boolean inAmbientMode)

Called when the device enters or exits ambient mode. The watch face should switch to a black and white display in ambient mode. If the watch face displays seconds, it should hide them in ambient mode.

Parameters
`inAmbientMode`	`boolean`

onCommand

public Bundle onCommand (String action, 
                int x, 
                int y, 
                int z, 
                Bundle extras, 
                boolean resultRequested)

Parameters
`action`	`String`
`x`	`int`
`y`	`int`
`z`	`int`
`extras`	`Bundle`
`resultRequested`	`boolean`

Returns
`Bundle`

onComplicationDataUpdate

public void onComplicationDataUpdate (int watchFaceComplicationId, 
                ComplicationData data)

Called when new complication data is received.

Parameters
`watchFaceComplicationId`	`int`: The id of the complication that the data relates to. This will be an id that was previously sent in a call to `setActiveComplications(int...)`.
`data`	`ComplicationData`: The data that should be displayed in the complication.

onCreate

public void onCreate (SurfaceHolder holder)

Parameters
`holder`	`SurfaceHolder`

onDestroy

public void onDestroy ()

onInterruptionFilterChanged

public void onInterruptionFilterChanged (int interruptionFilter)

Called when the user changes interruption filter. The watch face should adjust the amount of information it displays. For example, if it displays the number of pending emails, it should hide it if interruptionFilter is equal to WatchFaceService.INTERRUPTION_FILTER_NONE. interruptionFilter can be WatchFaceService.INTERRUPTION_FILTER_NONE, WatchFaceService.INTERRUPTION_FILTER_PRIORITY, WatchFaceService.INTERRUPTION_FILTER_ALL, WatchFaceService.INTERRUPTION_FILTER_ALARMS, or WatchFaceService.INTERRUPTION_FILTER_UNKNOWN.

Parameters
`interruptionFilter`	`int`

onNotificationCountChanged

public void onNotificationCountChanged (int count)

Called when the total number of notification cards in the stream has changed.

Parameters
`count`	`int`: total number of the notification cards in the stream

onPeekCardPositionUpdate

public void onPeekCardPositionUpdate (Rect rect)

This method is deprecated.
Wear 2.0 doesn't have peeking cards

Called when the first, peeking card positions itself on the screen. This is where the watch face can change its appearance depending on where the card is on the screen. This doesn't provide information about all movements of the card, only about its location when it's peeking at the bottom and allowing the watch face to be exposed.

Parameters
`rect`	`Rect`

onPropertiesChanged

public void onPropertiesChanged (Bundle properties)

Called when the properties of the device are determined. These include WatchFaceService.PROPERTY_BURN_IN_PROTECTION and WatchFaceService.PROPERTY_LOW_BIT_AMBIENT.

Parameters
`properties`	`Bundle`: a bundle containing the hardware properties

onTapCommand

public void onTapCommand (int tapType, 
                int x, 
                int y, 
                long eventTime)

Called when a tap or touch related event occurs.

Parameters
`tapType`	`int`: Value representing the event sent to the wallpaper.
`x`	`int`: X coordinate of the event.
`y`	`int`: Y coordinate of the event.
`eventTime`	`long`: The time the tap occurred, in the `SystemClock.uptimeMillis()` time base

onTimeTick

public void onTimeTick ()

Called periodically to update the time shown by the watch face. This method is called:

at least once per minute in both ambient and interactive modes
when date or time has changed
when timezone has changed

onTouchEvent

public void onTouchEvent (MotionEvent event)

This method is deprecated.
Do not use this to receive touch events on a watch face.

Parameters
`event`	`MotionEvent`

onUnreadCountChanged

public void onUnreadCountChanged (int count)

Called when the number of unread notification cards in the stream has changed.

Parameters
`count`	`int`: number of the notification cards in the stream that haven't yet been seen by the user

onVisibilityChanged

public void onVisibilityChanged (boolean visible)

Called to inform you of the watch face becoming visible or hidden. If you decide to override this method, you must call super.onVisibilityChanged(visible) as the first statement in your override.

Parameters
`visible`	`boolean`

setActiveComplications

public void setActiveComplications (int... watchFaceComplicationIds)

Sets the complications which are active in the watchface. Complication data will be received for these ids.

Any ids not in the provided ids will be considered inactive.

If providers and complication data types have been configured, the data received will match the type chosen by the user. If no provider has been configured, data of type ComplicationData.TYPE_NOT_CONFIGURED will be received.

Ids here are chosen by the watch face to represent each complication and can be any integer.

Parameters
`watchFaceComplicationIds`	`int`

setDefaultComplicationProvider

public void setDefaultComplicationProvider (int watchFaceComplicationId, 
                ComponentName provider, 
                int type)

Sets a custom provider as the default provider for the specified watch face complication id. This may be used to set a non-system provider as a default, if the component name of the provider is known. To set a system provider as a default, use setDefaultSystemComplicationProvider(int, int, int) instead.

This will do nothing if the provider is not installed, or if the specified type is not supported by the provider, or if the user has already selected a provider for the complication.

Note that if the watch face has not yet been granted the RECEIVE_COMPLICATION_DATA permission, it will not be able to receive data from the provider unless the provider is from the same app package as the watch face, or the provider lists the watch face as a safe watch face. For system providers that may be used before your watch face has the permission, use setDefaultSystemComplicationProvider(int, int, int) with a safe provider instead.

A provider not satisfying the above conditions may still be set as a default using this method, but the watch face will receive dummy data of type ComplicationData.TYPE_NO_PERMISSION until the permission has been granted.

To set an 'empty' default, this method may be used with provider equal to null, and type equal to TYPE_EMPTY. It is not required to do this for all complications - any complications with no default set and no user-selected provider will receive data of TYPE_NOT_CONFIGURED.

Parameters
`watchFaceComplicationId`	`int`
`provider`	`ComponentName`
`type`	`int`

setDefaultSystemComplicationProvider

public void setDefaultSystemComplicationProvider (int watchFaceComplicationId, 
                int systemProvider, 
                int type)

Sets a system provider as the default provider for the specified watch face complication id.

The chosen provider must be one listed in the SystemProviders class.

This will do nothing if the provider is not installed, or if the specified type is not supported by the provider, or if the user has already selected a provider for the complication.

Note that if the watch face has not yet been granted the RECEIVE_COMPLICATION_DATA permission, it will not be able to receive data from the provider unless it is a safe provider (see the provider descriptions in the SystemProviders class).

A non-safe provider may still be set as a default using this method, but the watch face will receive dummy data of type ComplicationData.TYPE_NO_PERMISSION until the permission has been granted.

It is not required to do this for all complications - any complications with no default set and no user-selected provider will receive data of TYPE_NOT_CONFIGURED.

To set a non-system provider as a default, or to clear a default, use setDefaultComplicationProvider(int, ComponentName, int).

Parameters
`watchFaceComplicationId`	`int`
`systemProvider`	`int`
`type`	`int`

setTouchEventsEnabled

public void setTouchEventsEnabled (boolean enabled)

This method is deprecated.
Do not use this to receive touch events on a watch face.

Parameters
`enabled`	`boolean`

setWatchFaceStyle

public void setWatchFaceStyle (WatchFaceStyle watchFaceStyle)

Sets the watch face style. This affects how UI elements such as the battery indicator are drawn on top of the watch face. Typically called in onCreate(SurfaceHolder) but may be called at any time, e.g. in response to the user changing the watch face configuration. Must be called from the wallpaper thread.

Parameters
`watchFaceStyle`	`WatchFaceStyle`