Audio Streaming

LittleKt supports two ways of playing audio. The first way is loading an AudioClip into memory and playing it. The other is using an AudioStream to stream and play an audio file.

AudioStream

An AudioStream is meant for playing longer audio files such as music. This allows the audio to be streamed and played instantly versus having to try to decode the entire audio and load it into memory all in one go.

Load and play an audio stream:

val stream: AudioStream = resourcesVfs["music.mp3"].readAudioStream()
stream.play(volume = 1f, loop = false)

Setting the volume or loop parameter on the play method will set the stream to the current volume and loop. We can also play a stream just by calling play() with out and parameters and it will default to the current volume and looping state.

We can adjust the volume and looping as well:

val stream: AudioStream = resourcesVfs["music.mp3"].readAudioStream()
stream.volume = 0.5f // must be between 0 and 1. 1 being the max
stream.looping = true

Pausing/resuming and stopping a stream:

val stream: AudioStream = resourcesVfs["music.mp3"].readAudioStream()
stream.pause()
stream.resume() // resumes from last position
stream.stop() // resets to beginning of the stream