git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	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	\wxheading{Include files}
	12
	13	<wx/wave.h>
	14
	15	\latexignore{\rtfignore{\wxheading{Members}}}
	16
	17	\membersection{wxWave::wxWave}\label{wxwaveconstr}
	18
	19	\func{}{wxWave}{\void}
	20
	21	Default constructor.
	22
	23	\func{}{wxWave}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = FALSE}}
	24
	25	Constructs a wave object from a file or resource. Call \helpref{wxWave::IsOk}{wxwaveisok} to
	26	determine whether this succeeded.
	27
	28	\wxheading{Parameters}
	29
	30	\docparam{fileName}{The filename or Windows resource.}
	31
	32	\docparam{isResource}{TRUE if {\it fileName} is a resource, FALSE if it is a filename.}
	33
	34	\membersection{wxWave::\destruct{wxWave}}
	35
	36	\func{}{\destruct{wxWave}}{\void}
	37
	38	Destroys the wxWave object.
	39
	40	\membersection{wxWave::Create}\label{wxwavecreate}
	41
	42	\func{bool}{Create}{\param{const wxString\&}{ fileName}, \param{bool}{ isResource = FALSE}}
	43
	44	Constructs a wave object from a file or resource.
	45
	46	\wxheading{Parameters}
	47
	48	\docparam{fileName}{The filename or Windows resource.}
	49
	50	\docparam{isResource}{TRUE if {\it fileName} is a resource, FALSE if it is a filename.}
	51
	52	\wxheading{Return value}
	53
	54	TRUE if the call was successful, FALSE otherwise.
	55
	56	\membersection{wxWave::IsOk}\label{wxwaveisok}
	57
	58	\constfunc{bool}{IsOk}{\void}
	59
	60	Returns TRUE if the object contains a successfully loaded file or resource, FALSE otherwise.
	61
	62	\membersection{wxWave::Play}\label{wxwaveplay}
	63
	64	\constfunc{bool}{Play}{\param{bool}{ async = TRUE}, \param{bool}{ looped = FALSE}}
	65
	66	Plays the wave file synchronously or asynchronously, looped or single-shot.
	67
	68