korlibs-audio/korlibs.audio.sound/Sound

Sound

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

Inheritors

SoundAudioStream

Constructors

constructor(creationCoroutineContext: CoroutineContext)

Properties

creationCoroutineContext

val creationCoroutineContext: CoroutineContext

defaultCoroutineContext

var defaultCoroutineContext: CoroutineContext

open override var extra: ExtraType

open val length: Duration

open val name: String

open val nchannels: Int

open override var panning: Double

open override var pitch: Double

open override var position: Vector3

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 SoundProps.fadeIn(time: Duration = DEFAULT_FADE_TIME, easing: Easing = DEFAULT_FADE_EASING)

suspend fun SoundProps.fadeOut(time: Duration = DEFAULT_FADE_TIME, easing: Easing = DEFAULT_FADE_EASING)

suspend fun SoundProps.fadeTo(volume: Double, time: Duration = DEFAULT_FADE_TIME, easing: Easing = DEFAULT_FADE_EASING)

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

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

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

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

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

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

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

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

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

playNoCancelForever

fun playNoCancelForever(startTime: Duration = 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): Float

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

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