korge-core/korlibs.audio.sound/Sound

Sound

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

Inheritors

SoundAudioStream

AudioBufferSound

Constructors

constructor(creationCoroutineContext: CoroutineContext)

Properties

creationCoroutineContext

val creationCoroutineContext: CoroutineContext

defaultCoroutineContext

var defaultCoroutineContext: CoroutineContext

open val length: TimeSpan

open val name: String

open val nchannels: Int

open override var panning: Double

open override var pitch: Double

open override var volume: Double

Functions

fun SoundProps.applyPropsTo(samples: AudioSamples)

fun SoundProps.applyPropsTo(samples: AudioSamplesInterleaved)

copySoundPropsFrom

fun SoundProps.copySoundPropsFrom(other: ReadonlySoundProps)

copySoundPropsFromCombined

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

abstract suspend fun decode(maxSamples: Int = DEFAULT_MAX_SAMPLES): AudioData

suspend fun play(params: PlaybackParameters = PlaybackParameters.DEFAULT): SoundChannel

suspend fun play(times: PlaybackTimes, startTime: TimeSpan = 0.seconds): SoundChannel

open fun play(coroutineContext: CoroutineContext, params: PlaybackParameters = PlaybackParameters.DEFAULT): SoundChannel

fun play(coroutineContext: CoroutineContext, times: PlaybackTimes, startTime: TimeSpan = 0.seconds): SoundChannel

suspend fun playAndWait(params: PlaybackParameters, progress: SoundChannel.(TimeSpan, TimeSpan) -> Unit = { current, total -> })

suspend fun playAndWait(times: PlaybackTimes = 1.playbackTimes, startTime: TimeSpan = 0.seconds, progress: SoundChannel.(TimeSpan, TimeSpan) -> Unit = { current, total -> })

suspend fun playForever(startTime: TimeSpan = 0.seconds): SoundChannel

fun playForever(coroutineContext: CoroutineContext, startTime: TimeSpan = 0.seconds): SoundChannel

fun playNoCancel(times: PlaybackTimes = PlaybackTimes.ONE, startTime: TimeSpan = 0.seconds): SoundChannel

playNoCancelForever

fun playNoCancelForever(startTime: TimeSpan = 0.seconds): SoundChannel

suspend fun toAudioData(maxSamples: Int = DEFAULT_MAX_SAMPLES): AudioData

open suspend override fun toStream(): AudioStream

open override fun toString(): String

volumeForChannel

fun SoundProps.volumeForChannel(channel: Int): Double

suspend fun AudioStreamable.withEcho(bufferLen: Int = 2048, config: AudioStreamEchoConfig = AudioStreamEchoConfig()): Sound

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