Klarinet/com.vectencia.klarinet/StreamState

StreamState

Lifecycle state of an AudioStream.

A stream progresses through these states as the application calls control methods on it. The typical happy-path lifecycle is:

UNINITIALIZED -> OPEN -> STARTING -> STARTED
                                   -> PAUSING -> PAUSED -> STARTING -> STARTED
                                   -> STOPPING -> STOPPED -> CLOSING -> CLOSED

Transitional states (STARTING, PAUSING, STOPPING, CLOSING) are short-lived and indicate that the platform is processing the requested state change. You can observe transitions via AudioStreamCallback.onStreamStateChanged.

Entries

UNINITIALIZED

The stream has not been initialized yet.

OPEN

The stream has been created and configured but is not yet processing audio.

STARTING

The stream is transitioning to the STARTED state.

STARTED

The stream is actively processing audio.

PAUSING

The stream is transitioning from STARTED to PAUSED.

PAUSED

Audio processing is temporarily suspended.

STOPPING

The stream is transitioning from STARTED or PAUSED to STOPPED.

STOPPED

Audio processing has ended.

CLOSING

The stream is transitioning to the CLOSED state.

CLOSED

The stream has been closed and all resources have been released.

Properties

entries

val entries: EnumEntries<StreamState>

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

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

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

StreamState

See also

Entries

Properties

Functions