Audio docs (#20)

* Added docs for existing state

* Renamed audio manager to SoundEffectPlayer.

---------

docs/mkdocs/docs/audio.md

@@ -0,0 +1,32 @@
+# 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](customising-scenes.md) 
+page.
+
+## Sound Effects
+Sounds effects can be played during any **Step**. All sound effects require an **AudioManager** to play.
+
+### Sound Effect Player
+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.
+
+```kotlin
+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*.
+
+```kotlin
+next { audio sfx sfxWoosh }
+```
+
+In this case *sfxWoosh** is a **ResourceSoundEffect**, but a **FileSoundEffect** could also be used.
+
+```kotlin
+val sfxWoosh = soundEffectFromResource("shuttleLaunch/audio/woosh.wav")
+```

docs/mkdocs/mkdocs.yml

@@ -16,6 +16,7 @@ nav:
     - 'Clear': 'dsl/clear.md'
     - 'End': 'dsl/end.md'
   - Customising Scenes: 'customising-scenes.md'
+  - Audio: 'audio.md'
   - Game Engine: 'game-engine.md'
   - Using Resources: 'using-resources.md'
   - Api documentation: 'api-documentation.md'

ktvn-examples/src/main/kotlin/com/github/benpollarduk/ktvn/examples/shuttleLaunch/assets/AssetStore.kt

@@ -1,9 +1,9 @@
 package com.github.benpollarduk.ktvn.examples.shuttleLaunch.assets
 
-import com.github.benpollarduk.ktvn.audio.AudioManager
 import com.github.benpollarduk.ktvn.audio.ResourceSoundEffect.Companion.soundEffectFromResource
 import com.github.benpollarduk.ktvn.audio.ResourceTrack.Companion.trackFromResource
 import com.github.benpollarduk.ktvn.audio.SoundEffect
+import com.github.benpollarduk.ktvn.audio.SoundEffectPlayer
 import com.github.benpollarduk.ktvn.audio.Track
 import com.github.benpollarduk.ktvn.backgrounds.Background
 import com.github.benpollarduk.ktvn.backgrounds.ResourceBackground.Companion.backgroundFromResource
@@ -50,9 +50,9 @@ public object AssetStore {
     public val narrator: Narrator = Narrator(configuration.gameAdapter.narratorAdapter)
 
     /**
-     * The audio manager, responsible for all audio.
+     * The sound effect player, responsible invoking sound effects.
      */
-    public val audio: AudioManager = AudioManager(configuration.gameAdapter.audioAdapter)
+    public val audio: SoundEffectPlayer = SoundEffectPlayer(configuration.gameAdapter.audioAdapter)
 
     /**
      * Toki, a cosmonaut.

ktvn-examples/src/main/kotlin/com/github/benpollarduk/ktvn/examples/theFateOfMorgana/assets/AssetStore.kt

@@ -1,6 +1,6 @@
 package com.github.benpollarduk.ktvn.examples.theFateOfMorgana.assets
 
-import com.github.benpollarduk.ktvn.audio.AudioManager
+import com.github.benpollarduk.ktvn.audio.SoundEffectPlayer
 import com.github.benpollarduk.ktvn.characters.Character
 import com.github.benpollarduk.ktvn.characters.Narrator
 import com.github.benpollarduk.ktvn.characters.animations.Animation
@@ -23,9 +23,9 @@ public object AssetStore {
     public val narrator: Narrator = Narrator(configuration.gameAdapter.narratorAdapter)
 
     /**
-     * The audio manager, responsible for all audio.
+     * The sound effect player, responsible invoking sound effects.
      */
-    public val audio: AudioManager = AudioManager(configuration.gameAdapter.audioAdapter)
+    public val audio: SoundEffectPlayer = SoundEffectPlayer(configuration.gameAdapter.audioAdapter)
 
     /**
      * Morgana, a witch. The antagonist of the story.

ktvn/src/main/kotlin/com/github/benpollarduk/ktvn/audio/AudioManager.kt → ktvn/src/main/kotlin/com/github/benpollarduk/ktvn/audio/SoundEffectPlayer.kt

@@ -4,9 +4,9 @@ import com.github.benpollarduk.ktvn.audio.ResourceSoundEffect.Companion.soundEff
 import com.github.benpollarduk.ktvn.logic.adapters.AudioAdapter
 
 /**
- * Provides a class for managing audio playback and control. An [adapter] must be specified.
+ * Provides a class for playing sound effects. An [adapter] must be specified.
  */
-public class AudioManager(private val adapter: AudioAdapter) {
+public class SoundEffectPlayer(private val adapter: AudioAdapter) {
     /**
      * Play a specified [soundEffect].
      */

ktvn/src/test/kotlin/com/github/benpollarduk/ktvn/audio/AudioManagerTest.kt → ktvn/src/test/kotlin/com/github/benpollarduk/ktvn/audio/SoundEffectPlayerTest.kt

@@ -4,7 +4,7 @@ import com.github.benpollarduk.ktvn.logic.adapters.AudioAdapter
 import org.junit.jupiter.api.Assertions
 import org.junit.jupiter.api.Test
 
-class AudioManagerTest {
+class SoundEffectPlayerTest {
     @Test
     fun `given sfx from object when calling sfx then listener invoked`() {
         // Given
@@ -14,10 +14,10 @@ class AudioManagerTest {
                 called = true
             }
         }
-        val manager = AudioManager(adapter)
+        val player = SoundEffectPlayer(adapter)
 
         // When
-        manager.sfx(ResourceSoundEffect(""))
+        player.sfx(ResourceSoundEffect(""))
 
         // Then
         Assertions.assertTrue(called)
@@ -32,10 +32,10 @@ class AudioManagerTest {
                 called = true
             }
         }
-        val manager = AudioManager(adapter)
+        val player = SoundEffectPlayer(adapter)
 
         // When
-        manager.sfx("")
+        player.sfx("")
 
         // Then
         Assertions.assertTrue(called)