UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption

Artifact: androidx.wear.watchface:watchface-style

View Source

Added in 1.2.0

---

Kotlin |Java

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.

class UserStyleSetting.LargeCustomValueUserStyleSetting.CustomValueOption : UserStyleSetting.Option

kotlin.Any
↳	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
const Int	MAX_SIZE = 125000 The maximum size of customValue in bytes.

Public constructors
CustomValueOption(customValue: ByteArray) Constructs a CustomValueOption.

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

Inherited functions
From androidx.wear.watchface.style.UserStyleSetting.Option open operator Boolean equals(other: Any?) open Int hashCode() open String toString()

Inherited properties
From androidx.wear.watchface.style.UserStyleSetting.Option Collection<UserStyleSetting> childSettings The list of child UserStyleSettings, if any, forming a hierarchy of UserStyleSettings. UserStyleSetting.Option.Id id Machine readable Id for the style setting.

Constants

MAX_SIZE

const val MAX_SIZE = 125000: Int

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

CustomValueOption(customValue: ByteArray)

Constructs a CustomValueOption.

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

Public properties

customValue

Added in 1.2.0

val customValue: ByteArray

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