compose/space.kodio.compose/RecorderState

RecorderState

class RecorderState

State holder for audio recording in Compose.

Provides a simplified, reactive API for recording audio that integrates with Compose's state management.

Example Usage

@Composable
fun VoiceRecorder() {
    val recorderState = rememberRecorderState()

    Column {
        // Show recording status
        Text(
            when {
                recorderState.isRecording -> "Recording..."
                recorderState.isProcessing -> "Processing..."
                else -> "Ready"
            }
        )

        // Record button
        Button(
            onClick = { recorderState.toggle() },
            enabled = !recorderState.isProcessing
        ) {
            Text(if (recorderState.isRecording) "Stop" else "Record")
        }

        // Show waveform while recording
        if (recorderState.isRecording) {
            AudioWaveform(amplitudes = recorderState.liveAmplitudes)
        }

        // Access the recording when done
        recorderState.recording?.let { recording ->
            Button(onClick = { recording.play() }) {
                Text("Play Recording")
            }
        }
    }
}

Properties

val error: AudioError?

The most recent error, if any.

val hasError: Boolean

Whether there is an error.

val hasRecording: Boolean

Whether a recording is available.

val isBusy: Boolean

Whether the recorder is busy (recording, paused, or processing).

val isPaused: Boolean

Whether the recorder is paused (recording can be resumed via resume).

val isProcessing: Boolean

Whether the recorder is processing (e.g., collecting recorded data after stop).

val isReady: Boolean

Whether the recorder has been initialized successfully.

val isRecording: Boolean

Whether the recorder is currently recording.

val liveAmplitudes: List<Float>

Live amplitude values for displaying a waveform. Updates in real-time while recording.

needsPermission

val needsPermission: Boolean

Whether permission is required before recording.

permissionState

val permissionState: AudioPermissionManager.State

The current microphone permission state.

val recording: AudioRecording?

The completed recording, if available. This becomes non-null after stop is called and processing completes.

Functions

fun clearError()

Clears the current error.

fun pause()

Pauses recording. The captured audio so far is preserved; call resume to continue appending to the same recording, or stop to finalize it.

suspend fun pauseAsync()

Suspend variant of pause.

requestPermission

fun requestPermission()

Requests microphone permission.

requestPermissionAsync

suspend fun requestPermissionAsync()

Requests microphone permission (suspend version).

fun reset()

Resets the state, discarding any recording.

suspend fun resetAsync()

Resets the state, discarding any recording (suspend version).

fun resume()

Resumes a paused recording.

suspend fun resumeAsync()

Suspend variant of resume.

fun start()

Starts recording audio.

suspend fun startAsync()

Starts recording audio (suspend version).

fun stop()

Stops recording and makes the recording available. The recording will be available in recording once isProcessing becomes false.

suspend fun stopAsync(): AudioRecording?

Stops recording and waits for the recording to be ready (suspend version).

fun toggle()

Toggles recording on/off.

suspend fun toggleAsync(): Boolean

Toggles recording on/off (suspend version).