korlibs-audio/korlibs.audio.sound/SoundAudioStream

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

Constructors

SoundAudioStream

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

Types

Companion

object Companion

Properties

closeStream

val closeStream: Boolean

creationCoroutineContext

val creationCoroutineContext: CoroutineContext

defaultCoroutineContext

var defaultCoroutineContext: CoroutineContext

extra

open override var extra: ExtraType

length

open override val length: Duration

name

open override val name: String

nativeSound

val nativeSound: SoundAudioStream

nchannels

open override val nchannels: Int

onComplete

val onComplete: suspend () -> Unit?

panning

open override var panning: Double

pitch

open override var pitch: Double

position

open override var position: Vector3

soundProvider

var soundProvider: NativeSoundProvider

stream

val stream: AudioStream

volume

open override var volume: Double

Functions

applyPropsTo

fun SoundProps.applyPropsTo(samples: AudioSamples)

fun SoundProps.applyPropsTo(samples: AudioSamplesInterleaved)

copySoundPropsFrom

fun SoundProps.copySoundPropsFrom(other: ReadonlySoundProps)

copySoundPropsFromCombined

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

decode

open suspend override fun decode(maxSamples: Int = DEFAULT_MAX_SAMPLES): AudioData

fadeIn

suspend fun SoundProps.fadeIn(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)

fadeTo

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

play

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

playAndWait

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 -> })

playForever

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

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

playNoCancel

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

playNoCancelForever

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

toAudioData

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

toStream

open suspend override fun toStream(): AudioStream

toString

open override fun toString(): String

volumeForChannel

fun SoundProps.volumeForChannel(channel: Int): Float

withEcho

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

withProcessor

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