CanvasWatchFaceService.Engine
public
class
CanvasWatchFaceService.Engine
extends WatchFaceService.Engine
This class is deprecated.
Use androidx.wear.watchface.WatchFaceService
, androidx.wear.watchface.Renderer.CanvasRenderer
and androidx.wear.watchface.complications.rendering.CanvasComplicationDrawable
from the Jetpack Wear Watch Face
libraries instead.
The actual implementation of a watch face that draws on a Canvas
. You must implement
CanvasWatchFaceService.onCreateEngine()
to return your concrete Engine implementation.
Summary
Public constructors |
Engine()
|
Engine(boolean useHardwareCanvas)
|
Inherited methods |
From class
android.support.wearable.watchface.WatchFaceService.Engine
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. Instead, use WatchFaceStyle.Builder.setAcceptsTapEvents(boolean) and then override onTapCommand(int, int, int, long) . This method will cease to function in a future
release.
|
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. Instead, use WatchFaceStyle.Builder.setAcceptsTapEvents(boolean) and then override onTapCommand(int, int, int, long) . This method will cease to function in a future
release.
|
void
|
setWatchFaceStyle(WatchFaceStyle watchFaceStyle)
Sets the watch face style.
|
|
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 (boolean useHardwareCanvas)
Parameters |
useHardwareCanvas |
boolean |
Public methods
invalidate
public void invalidate ()
Schedules a call to onDraw(Canvas, Rect)
to draw the next frame. Must be called on the main
thread.
onDestroy
public void onDestroy ()
onDraw
public void onDraw (Canvas canvas,
Rect bounds)
Draws the watch face.
Parameters |
canvas |
Canvas : the canvas to draw into. Canvas.isHardwareAccelerated() can be used to
confirm if it is hardware accelerated. |
bounds |
Rect : the bounds in which the watch face should be drawn
|
onSurfaceChanged
public void onSurfaceChanged (SurfaceHolder holder,
int format,
int width,
int height)
Parameters |
holder |
SurfaceHolder |
format |
int |
width |
int |
height |
int |
onSurfaceCreated
public void onSurfaceCreated (SurfaceHolder holder)
Parameters |
holder |
SurfaceHolder |
onSurfaceRedrawNeeded
public void onSurfaceRedrawNeeded (SurfaceHolder holder)
Parameters |
holder |
SurfaceHolder |
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 |
postInvalidate
public void postInvalidate ()
Posts a message to schedule a call to onDraw(Canvas, Rect)
to draw the next frame. Unlike invalidate()
, this method is thread-safe and may be called on any thread.