Audio

Ktvn supports audio to allow rich visual novels to be created. Audio is roughly broken in to two categories - background music and sound effects.

Background Music

In Ktvn background music is specified as part of the Scene. This is documented on the Customising Scenes page.

Sound Effects

Sounds effects can be played during any Step. All sound effects require a SoundEffectPlayer to play.

SoundEffectPlayer

The SoundEffectPlayer is a class that invokes sound effects in Ktvn. It depends on an AudioAdapter. The DynamicGameConfiguration provides an instance of AudioAdapter that is suitable for nearly all use cases.

val configuration = DynamicGameConfiguration()
val audio = SoundEffectPlayer(configuration.gameAdapter.audioAdapter)

The SoundEffectPlayer can then be used to play sound effects with the sfx function. Here a next step is used to play sfxWoosh.

next { audio sfx sfxWoosh }

In this case sfxWoosh is a ResourceSoundEffect, but a FileSoundEffect could also be used.

val sfxWoosh = soundEffectFromResource("shuttleLaunch/audio/woosh.wav")