korge-core/korlibs.audio.sound/SoundChannel

SoundChannel

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

Inheritors

DummySoundChannel

Constructors

SoundChannel

constructor(sound: Sound)

Properties

current

open var current: TimeSpan

extra

open override var extra: ExtraType

panning

open override var panning: Double

paused

val SoundChannelBase.paused: Boolean

pausedOrPausing

val SoundChannel.pausedOrPausing: Boolean

pitch

open override var pitch: Double

playing

val SoundChannelBase.playing: Boolean

playingOrPaused

val SoundChannelBase.playingOrPaused: Boolean

sound

val sound: Sound

state

open override val state: SoundChannelState

total

open val total: TimeSpan

volume

open override var volume: Double

Functions

applyPropsTo

fun SoundProps.applyPropsTo(samples: AudioSamples)

fun SoundProps.applyPropsTo(samples: AudioSamplesInterleaved)

await

suspend fun SoundChannelBase.await()

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

copySoundPropsFrom

fun SoundProps.copySoundPropsFrom(other: ReadonlySoundProps)

copySoundPropsFromCombined

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

fadeIn

suspend fun SoundChannel.fadeIn(time: TimeSpan = DEFAULT_FADE_TIME, easing: Easing = DEFAULT_FADE_EASING)

fadeInResume

suspend fun SoundChannel.fadeInResume(time: TimeSpan = DEFAULT_FADE_TIME, easing: Easing = DEFAULT_FADE_EASING)

fadeOut

suspend fun SoundChannel.fadeOut(time: TimeSpan = DEFAULT_FADE_TIME, easing: Easing = DEFAULT_FADE_EASING)

fadeOutPause

suspend fun SoundChannel.fadeOutPause(time: TimeSpan = DEFAULT_FADE_TIME, easing: Easing = DEFAULT_FADE_EASING)

fadeTo

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

open fun pause()

override fun reset()

open fun resume()

abstract override fun stop()

togglePaused

fun togglePaused()

togglePausedFaded

suspend fun SoundChannel.togglePausedFaded(enable: Boolean? = null, time: TimeSpan = DEFAULT_FADE_TIME, easing: Easing = DEFAULT_FADE_EASING)

volumeForChannel

fun SoundProps.volumeForChannel(channel: Int): Double