Google is committed to advancing racial equity for Black communities. See how.

TestWearableButtonsProvider

public class TestWearableButtonsProvider
extends Object implements WearableButtonsProvider

java.lang.Object
   ↳ androidx.wear.input.testing.TestWearableButtonsProvider


A WearableButtonsProvider suitable for use in tests.

This allows for explicitly specifying which buttons are available for testing, and their coordinates. It is intended to be used by passing in a map, mapping between the button keycode (typically in the set KeyEvent.KEYCODE_STEM_PRIMARY, KeyEvent.KEYCODE_STEM_1, KeyEvent.KEYCODE_STEM_2, or KeyEvent.KEYCODE_STEM_3) and the location of the button. Take the following example:

     Map buttons = new HashMap<>();
     buttons.put(KEYCODE_STEM_1, new TestWearableButtonLocation(100, 100);

     TestWearableButtonsProvider provider = new TestWearableButtonsProvider(buttons);

     WearableButtons.setWearableButtonsProvider(provider);
 

Summary

Nested classes

class TestWearableButtonsProvider.TestWearableButtonLocation

Class describing the location of a button on a wearable device. 

Public constructors

TestWearableButtonsProvider(Map<Integer, TestWearableButtonsProvider.TestWearableButtonLocation> buttons)

Build a button provider, which will respond with the provided set of buttons.

Public methods

int[] getAvailableButtonKeyCodes(Context context)

Get the keycodes of available hardware buttons on device.

Bundle getButtonInfo(Context context, int keycode)

Returns a bundle containing the metadata of a specific button.

Inherited methods

Public constructors

TestWearableButtonsProvider

public TestWearableButtonsProvider (Map<Integer, TestWearableButtonsProvider.TestWearableButtonLocation> buttons)

Build a button provider, which will respond with the provided set of buttons.

Parameters
buttons Map: The buttons returned by this provider.

Public methods

getAvailableButtonKeyCodes

public int[] getAvailableButtonKeyCodes (Context context)

Get the keycodes of available hardware buttons on device. This function based on key's locations from system property. This count includes the primary stem key as well as any secondary stem keys available.

Parameters
context Context: The context of the current activity

Returns
int[] An int array of available button keycodes, or null if no keycodes could be read.

getButtonInfo

public Bundle getButtonInfo (Context context, 
                int keycode)

Returns a bundle containing the metadata of a specific button. Currently, only location is supported. Use with WearableInputDevice.X_KEY and WearableInputDevice.Y_KEY. The key will not be present if the information is not available for the requested keycode.

The location returned is a Cartesian coordinate where the bottom left corner of the screen is the origin. The unit of measurement is in pixels. The coordinates do not take rotation into account and assume that the device is in the standard upright position.

Parameters
context Context: The context of the current activity

keycode int: The keycode associated with the hardware button of interest

Returns
Bundle A Bundle containing the metadata for the given keycode