DeviceWearableButtonsProvider

public final class DeviceWearableButtonsProvider implements WearableButtonsProvider


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

Summary

Public methods

@Nullable @Override Array<@NonNull int>

Get the keycodes of available hardware buttons on device.

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

Returns a bundle containing the metadata of a specific button.

Public methods

getAvailableButtonKeyCodes

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

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

getButtonInfo

@NonNull
@Override
public @Override 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
@Override Bundle

A Bundle containing the metadata for the given keycode