diff audioio/AudioGenerator.h @ 13:89bb89894ad6

* As previous commit
author Chris Cannam
date Fri, 17 Feb 2006 18:11:08 +0000
parents 8dc0ae8fccdd
children c606d3ffa397
line wrap: on
line diff
--- a/audioio/AudioGenerator.h	Fri Feb 17 18:04:26 2006 +0000
+++ b/audioio/AudioGenerator.h	Fri Feb 17 18:11:08 2006 +0000
@@ -29,10 +29,19 @@
     virtual ~AudioGenerator();
 
     /**
-     * Add a data model to be played from and initialise any
-     * necessary audio generation code.
-     * Returns true if the model is of a type that we know how to play.
-     * (The model will be added regardless.)
+     * Return true if the given model is of a type that we generally
+     * know how to play.  This doesn't guarantee that a specific
+     * AudioGenerator will actually produce sounds for it (for
+     * example, it may turn out that a vital plugin is missing).
+     */
+    static bool canPlay(const Model *model);
+
+    /**
+     * Add a data model to be played from and initialise any necessary
+     * audio generation code.  Returns true if the model will be
+     * played.  (The return value test here is stricter than that for
+     * canPlay, above.)  The model will be added regardless of the
+     * return value.
      */
     virtual bool addModel(Model *model);