readme: add information section
[nit.git] / lib / app / audio.nit
index 1b5eff4..42d90ae 100644 (file)
@@ -15,6 +15,8 @@
 # limitations under the License.
 
 # App audio abstraction
+# Default behaviour is loading the audio from the `assets` folder of the project with its name and extension
+# Platforms implementations can modify this comportement
 #
 # Once the application has started (after `App.setup`)
 # use `App.load_sound` to get a sound
 module audio
 
 import app_base
-import standard::error
+import core::error
+
+# Platform variations
+# TODO: move on the platform once qualified names are understand in the condition
+import linux::audio is conditional(linux)
+import android::audio is conditional(android)
 
 # Abstraction of a playable Audio
 abstract class PlayableAudio
@@ -36,7 +43,7 @@ abstract class PlayableAudio
        # Is this already loaded ?
        protected var is_loaded = false is writable
 
-       # load this playable audio
+       # Load this playable audio
        fun load is abstract
 
        # Plays the sound