| | 1 | ///////////////////////////////////////////////////////////////////////////// |
| | 2 | // Name: sound.h |
| | 3 | // Purpose: interface of wxSound |
| | 4 | // Author: wxWidgets team |
| | 5 | // RCS-ID: $Id$ |
| | 6 | // Licence: wxWindows license |
| | 7 | ///////////////////////////////////////////////////////////////////////////// |
| | 8 | |
| | 9 | /** |
| | 10 | @class wxSound |
| | 11 | |
| | 12 | This class represents a short sound (loaded from Windows WAV file), that |
| | 13 | can be stored in memory and played. |
| | 14 | |
| | 15 | Currently this class is implemented on Windows and Unix (and uses either |
| | 16 | Open Sound System or Simple DirectMedia Layer). |
| | 17 | |
| | 18 | @library{wxadv} |
| | 19 | @category{media} |
| | 20 | */ |
| | 21 | class wxSound : public wxObject |
| | 22 | { |
| | 23 | public: |
| | 24 | /** |
| | 25 | Default ctor. |
| | 26 | */ |
| | 27 | wxSound(); |
| | 28 | |
| | 29 | /** |
| | 30 | Constructs a wave object from a file or, under Windows, from a Windows |
| | 31 | resource. Call IsOk() to determine whether this succeeded. |
| | 32 | |
| | 33 | @param fileName |
| | 34 | The filename or Windows resource. |
| | 35 | @param isResource |
| | 36 | @true if fileName is a resource, @false if it is a filename. |
| | 37 | */ |
| | 38 | wxSound(const wxString& fileName, bool isResource = false); |
| | 39 | |
| | 40 | /** |
| | 41 | Destroys the wxSound object. |
| | 42 | */ |
| | 43 | virtual ~wxSound(); |
| | 44 | |
| | 45 | /** |
| | 46 | Constructs a wave object from a file or resource. |
| | 47 | |
| | 48 | @param fileName |
| | 49 | The filename or Windows resource. |
| | 50 | @param isResource |
| | 51 | @true if fileName is a resource, @false if it is a filename. |
| | 52 | |
| | 53 | @return @true if the call was successful, @false otherwise. |
| | 54 | */ |
| | 55 | bool Create(const wxString& fileName, bool isResource = false); |
| | 56 | |
| | 57 | /** |
| | 58 | Returns @true if the object contains a successfully loaded file or resource, |
| | 59 | @false otherwise. |
| | 60 | */ |
| | 61 | bool IsOk() const; |
| | 62 | |
| | 63 | /** |
| | 64 | Returns @true if a sound is played at the moment. |
| | 65 | This method is currently not implemented under Windows. |
| | 66 | */ |
| | 67 | static bool IsPlaying(); |
| | 68 | |
| | 69 | //@{ |
| | 70 | /** |
| | 71 | Plays the sound file. If another sound is playing, it will be interrupted. |
| | 72 | |
| | 73 | Returns @true on success, @false otherwise. Note that in general it is |
| | 74 | possible to delete the object which is being asynchronously played any time |
| | 75 | after calling this function and the sound would continue playing, however this |
| | 76 | currently doesn't work under Windows for sound objects loaded from memory data. |
| | 77 | |
| | 78 | The possible values for @a flags are: |
| | 79 | - wxSOUND_SYNC: @c Play will block and wait until the sound is replayed. |
| | 80 | - wxSOUND_ASYNC: Sound is played asynchronously, @c Play returns immediately. |
| | 81 | - wxSOUND_ASYNC|wxSOUND_LOOP: Sound is played asynchronously and loops |
| | 82 | until another sound is played, Stop() is |
| | 83 | called or the program terminates. |
| | 84 | |
| | 85 | The static form is shorthand for this code: |
| | 86 | @code |
| | 87 | wxSound(filename).Play(flags); |
| | 88 | @endcode |
| | 89 | */ |
| | 90 | bool Play(unsigned flags = wxSOUND_ASYNC) const; |
| | 91 | static bool Play(const wxString& filename, |
| | 92 | unsigned flags = wxSOUND_ASYNC); |
| | 93 | //@} |
| | 94 | |
| | 95 | /** |
| | 96 | If a sound is played, this function stops it. |
| | 97 | */ |
| | 98 | static void Stop(); |
| | 99 | }; |
| | 100 | |
projects / wxWidgets.git / blame_incremental