X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/328f5751e8a06727b137189fe04891a9f43bfc8b..0f660b35d96f39c6b43be7ede9c30a7f4fc96451:/interface/sound.h diff --git a/interface/sound.h b/interface/sound.h index 2fff9caf3a..34d910ee97 100644 --- a/interface/sound.h +++ b/interface/sound.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: sound.h -// Purpose: documentation for wxSound class +// Purpose: interface of wxSound // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -27,7 +27,7 @@ public: Constructs a wave object from a file or, under Windows, from a Windows resource. Call IsOk() to determine whether this succeeded. - + @param fileName The filename or Windows resource. @param isResource @@ -44,12 +44,12 @@ public: /** Constructs a wave object from a file or resource. - + @param fileName The filename or Windows resource. @param isResource @true if fileName is a resource, @false if it is a filename. - + @returns @true if the call was successful, @false otherwise. */ bool Create(const wxString& fileName, bool isResource = false); @@ -75,23 +75,23 @@ public: calling this function and the sound would continue playing, however this currently doesn't work under Windows for sound objects loaded from memory data. The possible values for @a flags are: - + wxSOUND_SYNC - + @c Play will block and wait until the sound is replayed. - + wxSOUND_ASYNC - + Sound is played asynchronously, @c Play returns immediately - + wxSOUND_ASYNC | wxSOUND_LOOP - + Sound is played asynchronously and loops until another sound is played, Stop() is called or the program terminates. - + The static form is shorthand for this code: */ bool Play(unsigned flags = wxSOUND_ASYNC); @@ -104,3 +104,4 @@ public: */ static void Stop(); }; +