feedback/com.siddharth.kmp.feedback/SoundKey

SoundKey

The short SFX vocabulary a caller draws on for UX feedback.

Each key is synthesised (jvm/ios tone synth) or sampled (android SoundPool) into a sub-second sound. Keys are intentionally coarse — one per feel, not per event — so an app ships a handful of audibly distinct cues and maps its own moments onto them.

Entries

Confirm

Firm press/slam — a committing action (confirm, claim, submit).

Reward

Bright clink — a positive/rewarding action (income, credit, reward).

Thud

Heavy thud — a weighty negative action (loss, removal, penalty).

Success

Triumphant sting — a success fanfare (win, completion, milestone).

Properties

entries

val entries: EnumEntries<SoundKey>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): SoundKey

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<SoundKey>

Returns an array containing the constants of this enum type, in the order they're declared.