UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption

Note: As of July 10, 2024, watch faces must use the Watch Face Format in order to be installed on new watches that launch with Wear OS 5 pre-installed. Learn more about the user-facing changes in this Help Center article.

Additionally, starting in early 2025 (specific date to be announced during Q4 2024), all new watch faces published on Google Play must use the Watch Face Format.

public final class UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption extends UserStyleSetting.Option

java.lang.Object
   ↳ androidx.wear.watchface.style.UserStyleSetting.Option
     ↳ androidx.wear.watchface.style.UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption

An application specific custom value. NB the CustomValueOption.customValue is the same as the CustomValueOption.id.

Summary

Constants
static final int
MAX_SIZE = 125000

The maximum size of customValue in bytes.

Public constructors
CustomValueOption(@NonNull byte[] customValue)

Constructs a CustomValueOption.

Public methods
final @NonNull byte[]

The ByteArray value for this option which is the same as the id.

Inherited methods
From androidx.wear.watchface.style.UserStyleSetting.Option
boolean
equals(Object other)
final @NonNull Collection<@NonNull UserStyleSetting>

The list of child UserStyleSettings, if any, forming a hierarchy of UserStyleSettings.
final @NonNull UserStyleSetting.Option.Id

Machine readable Id for the style setting.
int
@NonNull String

Constants

MAX_SIZE

public static final int MAX_SIZE = 125000

The maximum size of customValue in bytes. This is based on the following assumptions: 2mbps bluetooth bandwidth and a 50 millisecond transfer time (above 50ms delays become quite noticeable).

Public constructors

CustomValueOption

Added in 1.2.0
public CustomValueOption(@NonNull byte[] customValue)

Constructs a CustomValueOption.

Parameters
@NonNull byte[] customValue

The ByteArray and value of this CustomValueOption. This may not exceed Option.Id.MAX_LENGTH.

Public methods

getCustomValue

Added in 1.2.0
public final @NonNull byte[] getCustomValue()

The ByteArray value for this option which is the same as the id. Note the maximum size in bytes is MAX_SIZE.