e588dd6b1a
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@22481 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
69 lines
1.7 KiB
TeX
69 lines
1.7 KiB
TeX
\section{\class{wxWave}}\label{wxwave}
|
|
|
|
This class represents a short wave file, in Windows WAV format, that
|
|
can be stored in memory and played. Currently this class is implemented
|
|
on Windows and Linux only.
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxObject}{wxobject}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/wave.h>
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{wxWave::wxWave}\label{wxwaveconstr}
|
|
|
|
\func{}{wxWave}{\void}
|
|
|
|
Default constructor.
|
|
|
|
\func{}{wxWave}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = false}}
|
|
|
|
Constructs a wave object from a file or resource. Call \helpref{wxWave::IsOk}{wxwaveisok} to
|
|
determine whether this succeeded.
|
|
|
|
\wxheading{Parameters}
|
|
|
|
\docparam{fileName}{The filename or Windows resource.}
|
|
|
|
\docparam{isResource}{true if {\it fileName} is a resource, false if it is a filename.}
|
|
|
|
\membersection{wxWave::\destruct{wxWave}}
|
|
|
|
\func{}{\destruct{wxWave}}{\void}
|
|
|
|
Destroys the wxWave object.
|
|
|
|
\membersection{wxWave::Create}\label{wxwavecreate}
|
|
|
|
\func{bool}{Create}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = false}}
|
|
|
|
Constructs a wave object from a file or resource.
|
|
|
|
\wxheading{Parameters}
|
|
|
|
\docparam{fileName}{The filename or Windows resource.}
|
|
|
|
\docparam{isResource}{true if {\it fileName} is a resource, false if it is a filename.}
|
|
|
|
\wxheading{Return value}
|
|
|
|
true if the call was successful, false otherwise.
|
|
|
|
\membersection{wxWave::IsOk}\label{wxwaveisok}
|
|
|
|
\constfunc{bool}{IsOk}{\void}
|
|
|
|
Returns true if the object contains a successfully loaded file or resource, false otherwise.
|
|
|
|
\membersection{wxWave::Play}\label{wxwaveplay}
|
|
|
|
\constfunc{bool}{Play}{\param{bool}{ async = true}, \param{bool}{ looped = false}}
|
|
|
|
Plays the wave file synchronously or asynchronously, looped or single-shot.
|
|
|
|
|