korlibs-audio/korlibs.audio.sound

Package-level declarations

Types

AudioConversionQuality

enum AudioConversionQuality : Enum<AudioConversionQuality>

AudioDataStream

class AudioDataStream(val data: AudioData) : AudioStream

AudioSamplesDeque

class AudioSamplesDeque(val channels: Int)

AudioSamplesProcessor

class ~~AudioSamplesProcessor~~(val channels: Int, val totalSamples: Int, val data: Array<FloatArray> = Array(channels) { FloatArray(totalSamples) })

abstract class AudioStream(val rate: Int, val channels: Int, val name: String? = null) : AudioStreamable, AutoCloseable

AudioStreamable

interface ~~AudioStreamable~~

object ~~AudioTone~~

DummySoundChannel

class DummySoundChannel(sound: Sound, val data: AudioData? = null) : SoundChannel

LogNativeSoundProvider

open class LogNativeSoundProvider(val onGen: (AudioData) -> Unit = { }) : NativeSoundProvider

PlaybackParameters

data class PlaybackParameters(val times: PlaybackTimes = 1.playbackTimes, val startTime: Duration = 0.seconds, val bufferTime: Duration = 0.25.seconds, val volume: Double = 1.0, val pitch: Double = 1.0, val panning: Double = 0.0, val position: Vector3 = Vector3.ZERO, val onCancel: () -> Unit? = null, val onFinish: () -> Unit? = null) : ReadonlySoundProps

inline class PlaybackTimes(val count: Int)

abstract class Sound(val creationCoroutineContext: CoroutineContext) : SoundProps, SoundPlay, AudioStreamable, Extra

class SoundAudioData(coroutineContext: CoroutineContext, val audioData: AudioData, var soundProvider: NativeSoundProvider, val name: String = audioData.name ?: "Unknown") : Sound

SoundAudioStream

class SoundAudioStream(coroutineContext: CoroutineContext, val stream: AudioStream, var soundProvider: NativeSoundProvider, val closeStream: Boolean = false, val name: String = stream.name ?: "Unknown", val onComplete: suspend () -> Unit? = null) : Sound

abstract class SoundChannel(val sound: Sound) : SoundChannelBase, Extra

SoundChannelBase

interface SoundChannelBase : SoundProps, Extra

SoundChannelGroup

class SoundChannelGroup(volume: Double = 1.0, pitch: Double = 1.0, panning: Double = 0.0) : SoundChannelBase, SoundChannelPlay, Extra

SoundChannelPlay

interface SoundChannelPlay

SoundChannelState

enum SoundChannelState : Enum<SoundChannelState>

interface SoundPlay

Properties

val NativeSoundProvider.audioFormats: AudioFormats

DEFAULT_MAX_SAMPLES

val DEFAULT_MAX_SAMPLES: Int

infinitePlaybackTimes

val infinitePlaybackTimes: PlaybackTimes

val SoundChannelBase.paused: Boolean

val Int.playbackTimes: PlaybackTimes

val SoundChannelBase.playing: Boolean

playingOrPaused

val SoundChannelBase.playingOrPaused: Boolean

samplesInterleaved

val AudioData.samplesInterleaved: AudioSamplesInterleaved

Functions

fun AudioSamplesInterleaved.applyProps(speed: Double, panning: Double, volume: Double): AudioSamplesInterleaved

fun SoundProps.applyPropsTo(samples: AudioSamples)

fun SoundProps.applyPropsTo(samples: AudioSamplesInterleaved)

fun <T : SoundChannelBase> T.~~attachTo~~(group: SoundChannelGroup): T

suspend fun SoundChannelBase.await()

suspend fun SoundChannel.await(progress: SoundChannel.(current: Duration, total: Duration) -> Unit = { current, total -> })

fun AudioSamplesDeque.consumeToData(rate: Int): AudioData

copySoundPropsFrom

fun SoundProps.copySoundPropsFrom(other: ReadonlySoundProps)

copySoundPropsFromCombined

fun SoundProps.copySoundPropsFromCombined(l: ReadonlySoundProps, r: ReadonlySoundProps)

createNonStreamingSound

suspend fun NativeSoundProvider.createNonStreamingSound(data: AudioData, name: String = "Unknown"): Sound

suspend fun NativeSoundProvider.createSound(file: FinalVfsFile, streaming: Boolean = false, props: AudioDecodingProps = AudioDecodingProps.DEFAULT): Sound

suspend fun NativeSoundProvider.createSound(file: VfsFile, streaming: Boolean = false, props: AudioDecodingProps = AudioDecodingProps.DEFAULT): Sound

suspend fun NativeSoundProvider.createSound(data: AudioData, formats: AudioFormats = defaultAudioFormats, streaming: Boolean = false, name: String = "Unknown"): Sound

suspend fun NativeSoundProvider.createSound(vfs: Vfs, path: String, streaming: Boolean = false, props: AudioDecodingProps = AudioDecodingProps.DEFAULT): Sound

suspend fun NativeSoundProvider.createSound(data: ByteArray, streaming: Boolean = false, props: AudioDecodingProps = AudioDecodingProps.DEFAULT, name: String = "Unknown"): Sound

createStreamingSound

suspend fun NativeSoundProvider.createStreamingSound(stream: AudioStream, closeStream: Boolean = false, name: String = "Unknown", onComplete: suspend () -> Unit? = null): Sound

encodeToByteArray

suspend fun AudioData.encodeToByteArray(format: AudioFormat = WAV, props: AudioEncodingProps = AudioEncodingProps.DEFAULT): ByteArray

suspend fun AudioData.encodeToFile(file: VfsFile, format: AudioFormats = defaultAudioFormats, props: AudioEncodingProps = AudioEncodingProps.DEFAULT)

suspend fun AudioData.encodeToStream(out: AsyncOutputStream, format: AudioFormat = WAV, props: AudioEncodingProps = AudioEncodingProps.DEFAULT)

ensureTwoChannels

fun AudioSamplesInterleaved.ensureTwoChannels(): AudioSamplesInterleaved

fun AudioSamples.interleaved(out: AudioSamplesInterleaved = AudioSamplesInterleaved(channels, totalSamples)): AudioSamplesInterleaved

suspend fun AudioStream.playAndWait(params: PlaybackParameters = PlaybackParameters.DEFAULT)

suspend fun NativeSoundProvider.playAndWait(stream: AudioStream, params: PlaybackParameters = PlaybackParameters.DEFAULT)

suspend fun AudioStream.playAndWait(times: PlaybackTimes = 1.playbackTimes, startTime: Duration = 0.seconds, bufferTime: Duration = 0.1.seconds)

suspend fun VfsFile.readAudioData(formats: AudioFormat = defaultAudioFormats, props: AudioDecodingProps = AudioDecodingProps.DEFAULT): AudioData

readAudioStream

suspend fun VfsFile.readAudioStream(formats: AudioFormat = defaultAudioFormats + nativeSoundProvider.audioFormats, props: AudioDecodingProps = AudioDecodingProps.DEFAULT): AudioStream

readAudioStreamOrNull

suspend fun VfsFile.readAudioStreamOrNull(formats: AudioFormat = defaultAudioFormats + nativeSoundProvider.audioFormats, props: AudioDecodingProps = AudioDecodingProps.DEFAULT): AudioStream?

suspend fun VfsFile.readMusic(props: AudioDecodingProps = AudioDecodingProps.DEFAULT): Sound

suspend fun ByteArray.readMusic(props: AudioDecodingProps = AudioDecodingProps.DEFAULT): Sound

suspend fun VfsFile.readSound(props: AudioDecodingProps = AudioDecodingProps.DEFAULT, streaming: Boolean = false): Sound

suspend fun ByteArray.readSound(props: AudioDecodingProps = AudioDecodingProps.DEFAULT, streaming: Boolean = false): Sound

fun AudioSamples.resample(srcFreq: Int, dstFreq: Int): AudioSamples

resampleIfRequired

fun AudioSamples.resampleIfRequired(srcFreq: Int, dstFreq: Int): AudioSamples

fun AudioSamplesInterleaved.separated(out: AudioSamples = AudioSamples(channels, totalSamples)): AudioSamples

fun AudioSamplesDeque.toData(rate: Int): AudioData

suspend fun AudioStream.toData(maxSamples: Int = DEFAULT_MAX_SAMPLES): AudioData

suspend fun AudioData.toSound(soundProvider: NativeSoundProvider = nativeSoundProvider): Sound

suspend fun AudioStream.toSound(closeStream: Boolean = false, name: String = "Unknown"): Sound

suspend fun AudioStream.toSound(closeStream: Boolean = false, name: String = "Unknown", onComplete: suspend () -> Unit? = null): Sound

fun AudioData.toStream(): AudioStream

volumeForChannel

fun SoundProps.volumeForChannel(channel: Int): Float

fun AudioStream.~~withProcessor~~(block: suspend (inp: AudioStream, outp: AudioSamplesDeque) -> Unit): AudioStream

suspend fun AudioStreamable.~~withProcessor~~(block: suspend (inp: AudioStream, outp: AudioSamplesDeque) -> Unit): Sound

fun AudioData.withRate(rate: Int): AudioData

Change the rate, changing the pitch and the duration of the sound.

suspend fun VfsFile.writeAudio(data: AudioData, formats: AudioFormat = defaultAudioFormats + nativeSoundProvider.audioFormats, props: AudioEncodingProps = AudioEncodingProps.DEFAULT)