Changes between Version 14 and Version 15 of content/Sound

Timestamp:

May 18, 2009, 3:36:59 PM (16 years ago)

Author:

erwin

Comment:

—

content/Sound

@@ -5 +5 @@
 
 == User Guide ==
+
+=== Configuring available sounds ===
 Configuration of soundfiles is done in the XML files. You just have to add the specific attribut to your class tag. The value has to be the filepath relative to the [mediapath]/audio directory.
 
-|| '''Class''' || '''Soundattribute(s)''' ||
-|| Level || ambientsound ||
-|| Engine || sound ||
+Current possible sounds:
+|| '''Class''' || '''Soundattribute(s)''' || '''Looped?''' ||
+|| Level || ambientsound || Yes ||
+|| Engine || sound || Yes||
+
+=== Make more soundattributes available ===
+Here are some instructions:
+ * Look at the implementaion of the above classes. You should be able to copy a most of the things.
+ * Add a new XMLPort macro to the XMLPort function of the class the sound belongs to(most likely XMLPortLoadOnly), name the function loadFooSound or something similar
+ * Implement the load function, for some examples look at the above classes
+ * Add the needed members to the class (at least one SoundBase pointer)
+ * Add the calls to SondBase::play(bool loop) where you want to have the sound being played
+ * Add the class/sound to the above list and that's it
 
 == Development ==
@@ -25 +37 @@
  * manages OpenAL buffer and source
  * has to be attached to a WorldEntity
- * can load a sound sample form a file (via alut all alut supported sound formats, via fallback handler ogg vorbis files)
+ * can load a sound sample form a file (via alut all alut supported sound formats, ~~via fallback handler ogg vorbis files~~)
 
-== PPS-Timetable ==
-
-|| '''Date''' || '''What?''' ||
-|| 2009-03-30 || Initial code commit, defitiv decision of API (done)||
-|| 2009-04-06 || Implementing SoundManager and integration into the build system (done) ||
-|| 2009-04-27 || Implementing SoundBase (done) ||
-|| 2009-05-04 || Adding default sounds, configuration loaders (done for levels) ||
-|| 2009-05-11 || Testing ||
-|| 2009-05-18 || Testing and getting things ready for presentation ||
-|| 2009-05-2? || Presentation ||
-
-=== Future ===
+=== Future projects ===
  * implement sound device configuration
- * implment a fallback ogg loader
- * add streaming abilities for large soundfiles
+ * implement a fallback ogg loader
+ * implement fallback loaders for other file types
+ * implement streaming abilites for large files
+ * implement context handling for multiple Levels/SoundManagers