Klarinet/com.vectencia.klarinet/PerformanceMode

PerformanceMode

enum PerformanceMode : Enum<PerformanceMode>

Hint to the platform about the desired trade-off between audio latency and power consumption.

This is a hint -- the platform may not honor the request if the hardware or current system state does not support it. The actual latency achieved can be queried via AudioStream.latencyInfo after the stream is started.

Choosing a Mode

Mode	Use case
LOW_LATENCY	Live audio, instruments, real-time effects
POWER_SAVING	Background music, long-running playback
NONE	No preference; let the platform decide

Entries

NONE

No specific performance mode requested.

LOW_LATENCY

Minimize audio latency at the expense of increased power consumption.

POWER_SAVING

Minimize power consumption at the expense of increased audio latency.

Properties

entries

val entries: EnumEntries<PerformanceMode>

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): PerformanceMode

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<PerformanceMode>

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

PerformanceMode

Choosing a Mode

See also

Entries

Properties

Functions