X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dcb206ade4c14afe9660d4bfcb9ae136b153ecc5..68d411dc5724b9284455a31ef8a8d6d99c18d224:/docs/latex/wx/sound.tex?ds=sidebyside diff --git a/docs/latex/wx/sound.tex b/docs/latex/wx/sound.tex index 623fae31b9..fd48c22e87 100644 --- a/docs/latex/wx/sound.tex +++ b/docs/latex/wx/sound.tex @@ -2,8 +2,8 @@ This class represents a short sound (loaded from Windows WAV file), that can be stored in memory and played. Currently this class is implemented -on Windows and Unix (and uses either -\urlref{Open Sound System}{http://www.opensound.com/oss.html} or +on Windows and Unix (and uses either +\urlref{Open Sound System}{http://www.opensound.com/oss.html} or \urlref{Simple DirectMedia Layer}{http://www.libsdl.org/}). \wxheading{Derived from} @@ -16,7 +16,7 @@ on Windows and Unix (and uses either \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxSound::wxSound}\label{wxsoundconstr} +\membersection{wxSound::wxSound}\label{wxsoundctor} \func{}{wxSound}{\void} @@ -33,7 +33,7 @@ determine whether this succeeded. \docparam{isResource}{\true if {\it fileName} is a resource, \false if it is a filename.} -\membersection{wxSound::\destruct{wxSound}} +\membersection{wxSound::\destruct{wxSound}}\label{wxsounddtor} \func{}{\destruct{wxSound}}{\void} @@ -79,16 +79,17 @@ Returns \true on success, \false otherwise. The possible values for \arg{flags} are: \begin{twocollist} - \twocolitem{wxSOUND\_SYNC}{{\tt Play} will block and wait until the sound is - replayed.} - \twocolitem{wxSOUND\_ASYNC}{Sound is played asynchronously, - {\tt Play} returns immediately} - \twocolitem{wxSOUND\_ASYNC | wxSOUND\_LOOP}{Sound is played asynchronously - and loops until another sound is played, - \helpref{wxSound::Stop}{wxsoundstop} is called or the program terminates.} +\twocolitem{wxSOUND\_SYNC}{{\tt Play} will block and wait until the sound is +replayed.} +\twocolitem{wxSOUND\_ASYNC}{Sound is played asynchronously, +{\tt Play} returns immediately} +\twocolitem{wxSOUND\_ASYNC | wxSOUND\_LOOP}{Sound is played asynchronously +and loops until another sound is played, +\helpref{wxSound::Stop}{wxsoundstop} is called or the program terminates.} \end{twocollist} The static form is shorthand for this code: + \begin{verbatim} wxSound(filename).Play(flags); \end{verbatim} @@ -98,3 +99,4 @@ wxSound(filename).Play(flags); \func{static void}{Stop}{\void} If a sound is played, this function stops it. +