korlibs-audio/korlibs.audio.sound/SoundChannelGroup

SoundChannelGroup

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

Constructors

SoundChannelGroup

constructor(volume: Double = 1.0, pitch: Double = 1.0, panning: Double = 0.0)

Properties

extra

open override var extra: ExtraType

panning

open override var panning: Double

paused

val SoundChannelBase.paused: Boolean

pausedOrPausing

val SoundChannelBase.pausedOrPausing: Boolean

pitch

open override var pitch: Double

playing

val SoundChannelBase.playing: Boolean

playingOrPaused

val SoundChannelBase.playingOrPaused: Boolean

position

open override var position: Vector3

state

open override val state: SoundChannelState

volume

open override var volume: Double

Functions

add

fun ~~add~~(channel: SoundChannelBase)

applyPropsTo

fun SoundProps.applyPropsTo(samples: AudioSamples)

fun SoundProps.applyPropsTo(samples: AudioSamplesInterleaved)

await

suspend fun SoundChannelBase.await()

copySoundPropsFrom

fun SoundProps.copySoundPropsFrom(other: ReadonlySoundProps)

copySoundPropsFromCombined

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

fadeIn

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

fadeInResume

suspend fun SoundChannelBase.fadeInResume(time: Duration = DEFAULT_FADE_TIME, easing: Easing = DEFAULT_FADE_EASING)

fadeOut

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

fadeOutPause

suspend fun SoundChannelBase.fadeOutPause(time: Duration = DEFAULT_FADE_TIME, easing: Easing = DEFAULT_FADE_EASING)

fadeTo

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

onCompleted

open fun onCompleted(coroutineContext: CoroutineContext, block: () -> Unit)

pause

open override fun pause()

play

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

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

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

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

playAndWait

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

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

playForever

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

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

fun register(channel: SoundChannelBase, coroutineContext: CoroutineContext)

remove

fun ~~remove~~(channel: SoundChannelBase)

reset

open override fun reset()

resume

open override fun resume()

stop

open override fun stop()

togglePausedFaded

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

volumeForChannel

fun SoundProps.volumeForChannel(channel: Int): Float