kodio-core/space.kodio.core/AudioRecording

AudioRecording

Represents a recorded audio clip with its format metadata.

This is a higher-level abstraction over AudioFlow that provides convenient methods for common operations like saving to file and playback.

AudioRecording is immutable and thread-safe. All factory methods create defensive copies of input data to prevent external mutation.

Example Usage

val recording = Kodio.record(duration = 5.seconds)

// Save to file
recording.saveAs(Path("voice_note.wav"))

// Play it back
recording.play()

// Access raw data
val bytes = recording.toByteArray()

Types

Companion

object Companion

Properties

calculatedDuration

val calculatedDuration: Duration

The calculated duration based on frame count and sample rate. Falls back to the provided duration if available.

duration

val duration: Duration?

The duration of the recording, if known

format

val format: AudioFormat

The audio format of this recording

frameCount

val frameCount: Long

The number of audio frames in this recording. A frame contains one sample per channel.

hasData

val hasData: Boolean

Whether this recording has audio data.

isEmpty

val isEmpty: Boolean

Whether this recording is empty (no audio data).

sizeInBytes

val sizeInBytes: Long

The total size of the audio data in bytes.

Functions

asAudioFlow

fun asAudioFlow(): AudioFlow

Returns the audio data as an AudioFlow for compatibility with existing APIs.

asFlow

fun asFlow(defensiveCopy: Boolean = true): Flow<ByteArray>

Returns the audio data as a Flow of byte array chunks.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

play

suspend fun play()

Plays back this recording using the default audio output device. This is a convenience method that creates a playback session internally.

saveAs

suspend fun saveAs(path: Path, fileFormat: AudioFileFormat = AudioFileFormat.Wav)

Saves the recording to a file in the specified format.

toByteArray

fun toByteArray(): ByteArray

Collects all chunks into a single byte array. Note: This loads all audio data into memory. Returns a new array (not a reference to internal data).

toString

open override fun toString(): String