1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
<HTML>
<head><title>wxWave</title></head>
<BODY BGCOLOR=#FFFFFF>
<A NAME="wxwave"></A><CENTER>
<A HREF="wx.htm"><img align=center src="contents.gif" BORDER=0 ALT="Contents"></A> <A HREF="wx22.htm#classref"><img align=center src="up.gif" BORDER=0 ALT="Up"></A> <A HREF="wx258.htm#wxview"><img align=center src="back.gif" BORDER=0 ALT="Previous"></A> <A HREF="wx260.htm#wxwindow"><img align=center src="forward.gif" BORDER=0 ALT="Next"></A> </CENTER><HR>
<H2>wxWave</H2>
<P>
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.<P>
<B><FONT COLOR="#FF0000">Derived from</FONT></B><P>
<A HREF="wx158.htm#wxobject">wxObject</A><P>
<B><FONT COLOR="#FF0000">Include files</FONT></B><P>
<wx/wave.h><P>
<B><FONT COLOR="#FF0000">Members</FONT></B><P>
<A HREF="#wxwaveconstr">wxWave::wxWave</A><BR>
<A HREF="#topic1026">wxWave::~wxWave</A><BR>
<A HREF="#wxwavecreate">wxWave::Create</A><BR>
<A HREF="#wxwaveisok">wxWave::IsOk</A><BR>
<A HREF="#wxwaveplay">wxWave::Play</A><BR>
<P>
<HR>
<A NAME="wxwaveconstr"></A>
<H3>wxWave::wxWave</H3>
<P>
<B></B> <B>wxWave</B>()<P>
Default constructor.<P>
<B></B> <B>wxWave</B>(<B>const wxString&</B><I> fileName</I>, <B>bool</B><I> isResource = FALSE</I>)<P>
Constructs a wave object from a file or resource. Call <A HREF="wx259.htm#wxwaveisok">wxWave::IsOk</A> to
determine whether this succeeded.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>fileName</I><UL><UL>
The filename or Windows resource.</UL></UL>
<P>
<I>isResource</I><UL><UL>
TRUE if <I>fileName</I> is a resource, FALSE if it is a filename.</UL></UL>
<P>
<HR>
<A NAME="topic1026"></A>
<H3>wxWave::~wxWave</H3>
<P>
<B></B> <B>~wxWave</B>()<P>
Destroys the wxWave object.<P>
<HR>
<A NAME="wxwavecreate"></A>
<H3>wxWave::Create</H3>
<P>
<B>bool</B> <B>Create</B>(<B>const wxString&</B><I> fileName</I>, <B>bool</B><I> isResource = FALSE</I>)<P>
Constructs a wave object from a file or resource.<P>
<B><FONT COLOR="#FF0000">Parameters</FONT></B><P>
<I>fileName</I><UL><UL>
The filename or Windows resource.</UL></UL>
<P>
<I>isResource</I><UL><UL>
TRUE if <I>fileName</I> is a resource, FALSE if it is a filename.</UL></UL>
<P>
<B><FONT COLOR="#FF0000">Return value</FONT></B><P>
TRUE if the call was successful, FALSE otherwise.<P>
<HR>
<A NAME="wxwaveisok"></A>
<H3>wxWave::IsOk</H3>
<P>
<B>bool</B> <B>IsOk</B>() <B>const</B><P>
Returns TRUE if the object contains a successfully loaded file or resource, FALSE otherwise.<P>
<HR>
<A NAME="wxwaveplay"></A>
<H3>wxWave::Play</H3>
<P>
<B>bool</B> <B>Play</B>(<B>bool</B><I> async = TRUE</I>, <B>bool</B><I> looped = FALSE</I>) <B>const</B><P>
Plays the wave file synchronously or asynchronously, looped or single-shot.<P>
</BODY></HTML>
|
