korge-core/korlibs.audio.sound/SoundAudioStream

SoundAudioStream

class SoundAudioStream(coroutineContext: CoroutineContext, val stream: AudioStream, var soundProvider: NativeSoundProvider, val closeStream: Boolean = false, val name: String = "Unknown", val onComplete: suspend () -> Unit? = null) : Sound

Constructors

SoundAudioStream

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

Types

Companion

object Companion

Properties

closeStream

val closeStream: Boolean = false

creationCoroutineContext

val creationCoroutineContext: CoroutineContext

defaultCoroutineContext

var defaultCoroutineContext: CoroutineContext

length

open override val length: TimeSpan

name

open override val name: String

nativeSound

val nativeSound: SoundAudioStream

nchannels

open override val nchannels: Int

onComplete

val onComplete: suspend () -> Unit? = null

panning

open override var panning: Double

pitch

open override var pitch: Double

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): AudioData

play

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

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

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

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

playAndWait

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

playForever

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

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

playNoCancel

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

playNoCancelForever

fun playNoCancelForever(startTime: TimeSpan = 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): Double

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