WearableButtonsProvider
public interface WearableButtonsProvider
DeviceWearableButtonsProvider |
Default implementation of |
TestWearableButtonsProvider |
A |
A provider interface to allow WearableButtons to query for information on the device's buttons from the platform. This exists to allow for the button provider to be switched out for testing, for example, by using androidx.wear.input.testing.TestWearableButtonsProvider.
Summary
Public methods |
|
|---|---|
abstract @Nullable int[] |
getAvailableButtonKeyCodes(@NonNull Context context)Get the keycodes of available hardware buttons on device. |
abstract @NonNull Bundle |
getButtonInfo(@NonNull Context context, int keycode)Returns a bundle containing the metadata of a specific button. |
Public methods
getAvailableButtonKeyCodes
abstract @Nullable int[] getAvailableButtonKeyCodes(@NonNull 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.
| Returns | |
|---|---|
@Nullable int[] |
An int array of available button keycodes, or null if no keycodes could be read. |
getButtonInfo
abstract @NonNull Bundle getButtonInfo(@NonNull Context context, int keycode)
Returns a bundle containing the metadata of a specific button. Currently, only location is supported. Use with X_KEY and 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.