WearableButtonsProvider

interface WearableButtonsProvider

Known direct subclasses
DeviceWearableButtonsProvider

Default implementation of WearableButtonsProvider, that reads the button locations from the platform.

TestWearableButtonsProvider

A WearableButtonsProvider suitable for use in tests.


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 Array<@NonNull int>

Get the keycodes of available hardware buttons on device.

abstract @NonNull Bundle
getButtonInfo(@NonNull Context context, @NonNull int keycode)

Returns a bundle containing the metadata of a specific button.

Public methods

getAvailableButtonKeyCodes

@Nullable
@NonNull
public abstract Array<@NonNull 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.

Parameters
@NonNull Context context

The context of the current activity

Returns
Array<@NonNull int>

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

getButtonInfo

@NonNull
public abstract Bundle getButtonInfo(@NonNull Context context, @NonNull 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.

Parameters
@NonNull Context context

The context of the current activity

@NonNull int keycode

The keycode associated with the hardware button of interest

Returns
Bundle

A Bundle containing the metadata for the given keycode