An abstract base class for AudioRecordingSession that handles the logic for providing a live "hot" flow during recording, and a replayable "cold" flow after the recording is finished.

Channels

enum Channels : Enum<Channels>

Channels: number + layout if you need it later.

Endianness

enum Endianness : Enum<Endianness>

FloatPrecision

enum FloatPrecision : Enum<FloatPrecision>

IntBitDepth

enum IntBitDepth : Enum<IntBitDepth>

IosAudioPermissionManager

object IosAudioPermissionManager : AudioPermissionManager

IMPORTANT: You must add the NSMicrophoneUsageDescription key to your Info.plist.

IosAudioPlaybackSession

class IosAudioPlaybackSession : AVAudioPlaybackSession

IOS implementation for AVAudioPlaybackSession.

IosAudioRecordingSession

class IosAudioRecordingSession(requestedDevice: AudioDevice.Input?, format: AudioFormat = DefaultAppleRecordingAudioFormat) : AVAudioRecordingSession

IOS implementation for AVAudioRecordingSession.

JvmAudioException

sealed class JvmAudioException : Exception

JvmAudioPermissionManager

object JvmAudioPermissionManager : AudioPermissionManager

JvmAudioPlaybackSession

class JvmAudioPlaybackSession(device: AudioDevice.Output) : BaseAudioPlaybackSession

JVM implementation for AudioPlaybackSession.

JvmAudioRecordingSession

class JvmAudioRecordingSession(device: AudioDevice.Input, format: AudioFormat = DefaultJvmRecordingAudioFormat, warmupMillis: Int = JvmRecordingWarmupMillis) : BaseAudioRecordingSession

JVM implementation for AudioRecordingSession.

Kodio

object Kodio

Main entry point for the Kodio audio library.

MacosAudioObject

sealed class MacosAudioObject

MacosAudioPermissionManager

object MacosAudioPermissionManager : AudioPermissionManager

IMPORTANT: Add NSMicrophoneUsageDescription to your Info.plist (macOS).

MacosAudioPlaybackSession

class MacosAudioPlaybackSession(requestedDevice: AudioDevice.Output? = null, bufferDurationSec: Double = 0.05, bufferCount: Int = 5) : BaseAudioPlaybackSession

Mac OS implementation for AudioPlaybackSession using Core Audio AudioQueue (output).

MacosAudioQueue

sealed class MacosAudioQueue<S : Any>

MacosAudioQueueProperty

sealed class MacosAudioQueueProperty<V : CVariable, T>

MacosAudioRecordingSession

class MacosAudioRecordingSession(requestedDevice: AudioDevice.Input?, requestedFormat: AudioFormat? = requestedDevice?.formatSupport?.defaultFormat, bufferDurationSec: Double = 0.05, bufferCount: Int = 5) : BaseAudioRecordingSession

macOS implementation for AVAudioRecordingSession using AudioQueue input.

Player

class Player

High-level wrapper around AudioPlaybackSession providing a simplified API.

PlayerConfig

class PlayerConfig

Configuration for creating a Player.

Recorder

class Recorder

High-level wrapper around AudioRecordingSession providing a simplified API.

RecorderConfig

class RecorderConfig

Configuration for creating a Recorder.

SampleEncoding

sealed interface SampleEncoding

Audio sample encoding. No “signed/unsigned” for floats anymore.

SampleLayout

enum SampleLayout : Enum<SampleLayout>

How samples are laid out in memory.

SystemAudioSystemImpl

abstract class SystemAudioSystemImpl : AudioSystem

WebAudioPermissionManager

open class WebAudioPermissionManager : AudioPermissionManager

WebAudioPlaybackSession

class WebAudioPlaybackSession : BaseAudioPlaybackSession

Web playback session. Output device selection via AudioContext.setSinkId is deferred: the API is Chrome/Edge-only as of 2026 (unsupported in Firefox and Safari). Adding it would require feature-detected progressive enhancement and a device-passing API on the web playback path, which does not exist yet. AudioError.DeviceSelectionUnsupported remains the fallback behavior.

WebAudioRecordingSession

class WebAudioRecordingSession(device: AudioDevice.Input?, format: AudioFormat = DefaultWebRecordingAudioFormat) : BaseAudioRecordingSession

WebAudioSystem

open class WebAudioSystem : SystemAudioSystemImpl

Properties

canStart

val AudioSessionState.canStart: Boolean

Check if a state allows starting a new operation.

DefaultAndroidRecordingAudioFormat

val DefaultAndroidRecordingAudioFormat: AudioFormat

Platform default recording format on Android: 48 kHz, mono, signed 16-bit little-endian interleaved PCM (same as DefaultRecordingInt16).

DefaultAppleRecordingAudioFormat

val DefaultAppleRecordingAudioFormat: AudioFormat

Platform default recording format on Apple platforms: 48 kHz, mono, signed 16-bit little-endian interleaved PCM (same as DefaultRecordingInt16).

DefaultJvmRecordingWarmupMillis

const val DefaultJvmRecordingWarmupMillis: Int = 200

Default warmup window applied to JavaSound captures so the silent priming frames a TargetDataLine produces on the first read are dropped before we start emitting audio downstream.

DefaultRecordingFloat32

val DefaultRecordingFloat32: AudioFormat

Default float recording format: 48 kHz, mono, 32-bit float interleaved PCM.

DefaultRecordingInt16

val DefaultRecordingInt16: AudioFormat

Default recording format: 48 kHz, mono, signed 16-bit little-endian interleaved PCM.

isActive

val AudioSessionState.isActive: Boolean

Check if a state represents an active session.

isTerminal

val AudioSessionState.isTerminal: Boolean

Check if a state represents a terminal state (Complete or Failed).

JvmRecordingWarmupMillis

val JvmRecordingWarmupMillis: Int

Tunable warmup applied by JvmAudioRecordingSession.

microphonePermissionDescriptor

actual val microphonePermissionDescriptor: PermissionDescriptor

expect val microphonePermissionDescriptor: PermissionDescriptor

SystemAudioSystem

actual val SystemAudioSystem: AudioSystem

Android implementation for AudioSystem. IMPORTANT: You must add the RECORD_AUDIO permission to your AndroidManifest.xml and handle the runtime permission request in your application.

expect val SystemAudioSystem: AudioSystem

actual val SystemAudioSystem: AudioSystem

JS implementation of the AudioSystem using the Web Audio API. This requires a secure context (HTTPS) to function in a browser.

actual val SystemAudioSystem: AudioSystem

JVM implementation for AudioSystem.

actual val SystemAudioSystem: AudioSystem

JS implementation of the AudioSystem using the Web Audio API. This requires a secure context (HTTPS) to function in a browser.

Functions

allocASBD

fun NativePlacement.allocASBD(format: AudioFormat): AudioStreamBasicDescription

createAudioContextOptions

actual fun createAudioContextOptions(latencyHint: AudioContextLatencyCategory, sampleRate: Int): AudioContextOptions

expect fun createAudioContextOptions(latencyHint: AudioContextLatencyCategory, sampleRate: Int): AudioContextOptions

createAudioWorkletNode

actual fun createAudioWorkletNode(context: BaseAudioContext, name: String): AudioWorkletNode

expect fun createAudioWorkletNode(context: BaseAudioContext, name: String): AudioWorkletNode

createCodeBlobUrl

actual fun createCodeBlobUrl(code: String): String

expect fun createCodeBlobUrl(code: String): String

createMediaStreamConstraints

actual fun createMediaStreamConstraints(audio: MediaTrackConstraints): MediaStreamConstraints

expect fun createMediaStreamConstraints(audio: MediaTrackConstraints): MediaStreamConstraints

createMediaTrackConstraints

actual fun createMediaTrackConstraints(deviceId: String?, sampleRate: Int, sampleSize: Int, channelCount: Int): MediaTrackConstraints

expect fun createMediaTrackConstraints(deviceId: String?, sampleRate: Int, sampleSize: Int, channelCount: Int): MediaTrackConstraints

encodeAs16BitPcmByteArray

actual fun <B : ArrayBufferLike> Float32Array<B>.encodeAs16BitPcmByteArray(): ByteArray

expect fun <B : ArrayBufferLike> Float32Array<B>.encodeAs16BitPcmByteArray(): ByteArray

initialize

fun Kodio.initialize(activity: Activity)

Initialize Kodio with an Activity.

fun Kodio.initialize(application: Application)

Initialize Kodio with an Application instance.

fun Kodio.initialize(context: Context)

Android-specific Kodio initialization.

onRequestPermissionsResult

fun Kodio.onRequestPermissionsResult(requestCode: Int, grantResults: IntArray)

Forward the permission callback to Kodio.

toAVAudioFormat

fun AudioFormat.toAVAudioFormat(): AVAudioFormat

Converts this common AudioFormat to an AVAudioFormat instance.

toCommonAudioFormat

fun AVAudioFormat.toCommonAudioFormat(): AudioFormat

Converts this AVAudioFormat to a common AudioFormat instance.

toList

fun <T : JsAny?> JsArray<T>.toList(): List<T>

toSessionState

fun AudioPlaybackSession.State.toSessionState(): AudioSessionState

Extension to convert legacy playback session states to the unified state.

fun AudioRecordingSession.State.toSessionState(): AudioSessionState

Extension to convert legacy recording session states to the unified state.

use

inline fun <T> Player.use(block: (Player) -> T): T

Extension for using Player with Kotlin's use pattern. Ensures proper cleanup even if an exception occurs.

inline fun <T> Recorder.use(block: (Recorder) -> T): T

Extension for using Recorder with Kotlin's use pattern. Ensures proper cleanup even if an exception occurs.