[wxWidgets.git] / docs / latex / wx / wave.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 for Windows
only.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\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.
Commit	Line	Data
eaaa6a06 JS	1	\section{\class{wxWave}}\label{wxwave}
	2
	3	This class represents a short wave file, in Windows WAV format, that
	4	can be stored in memory and played. Currently this class is for Windows
	5	only.
	6
	7	\wxheading{Derived from}
	8
	9	\helpref{wxObject}{wxobject}
	10
	11	\latexignore{\rtfignore{\wxheading{Members}}}
	12
	13	\membersection{wxWave::wxWave}\label{wxwaveconstr}
	14
	15	\func{}{wxWave}{\void}
	16
	17	Default constructor.
	18
	19	\func{}{wxWave}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = FALSE}}
	20
	21	Constructs a wave object from a file or resource. Call \helpref{wxWave::IsOk}{wxwaveisok} to
	22	determine whether this succeeded.
	23
	24	\wxheading{Parameters}
	25
	26	\docparam{fileName}{The filename or Windows resource.}
	27
	28	\docparam{isResource}{TRUE if {\it fileName} is a resource, FALSE if it is a filename.}
	29
	30	\membersection{wxWave::\destruct{wxWave}}
	31
	32	\func{}{\destruct{wxWave}}{\void}
	33
	34	Destroys the wxWave object.
	35
	36	\membersection{wxWave::Create}\label{wxwavecreate}
	37
c030b70f	38	\func{bool}{Create}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = FALSE}}
eaaa6a06 JS	39
	40	Constructs a wave object from a file or resource.
	41
	42	\wxheading{Parameters}
	43
	44	\docparam{fileName}{The filename or Windows resource.}
	45
	46	\docparam{isResource}{TRUE if {\it fileName} is a resource, FALSE if it is a filename.}
	47
	48	\wxheading{Return value}
	49
	50	TRUE if the call was successful, FALSE otherwise.
	51
	52	\membersection{wxWave::IsOk}\label{wxwaveisok}
	53
	54	\constfunc{bool}{IsOk}{\void}
	55
	56	Returns TRUE if the object contains a successfully loaded file or resource, FALSE otherwise.
	57
	58	\membersection{wxWave::Play}\label{wxwaveplay}
	59
	60	\constfunc{bool}{Play}{\param{bool}{ async = TRUE}, \param{bool}{ looped = FALSE}}
	61
	62	Plays the wave file synchronously or asynchronously, looped or single-shot.
	63
	64