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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.adv.Sound:
==========================================================================================================================================
|phoenix_title| **wx.adv.Sound**
==========================================================================================================================================
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 Open Sound System or Simple DirectMedia Layer).
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>Sound</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.adv.Sound_inheritance.png" alt="Inheritance diagram of Sound" usemap="#dummy" class="inheritance"/></center>
</div>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Object.html" title="wx.Object" alt="" coords="19,5,100,35"/> <area shape="rect" id="node2" href="wx.adv.Sound.html" title="wx.adv.Sound" alt="" coords="5,83,115,112"/> </map>
</p>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.adv.Sound.__init__` Default constructor.
:meth:`~wx.adv.Sound.Create` Constructs a wave object from a file or resource.
:meth:`~wx.adv.Sound.CreateFromData` Create a sound object from data in a memory buffer in ``WAV`` format.
:meth:`~wx.adv.Sound.IsOk` Returns ``True`` if the object contains a successfully loaded file or resource, ``False`` otherwise.
:meth:`~wx.adv.Sound.Play` Plays the sound file.
:meth:`~wx.adv.Sound.PlaySound` Plays the sound file.
:meth:`~wx.adv.Sound.Stop` If a sound is played, this function stops it.
:meth:`~wx.adv.Sound.__bool__`
:meth:`~wx.adv.Sound.__nonzero__`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.adv.Sound(Object)
**Possible constructors**::
Sound()
Sound(fileName)
This class represents a short sound (loaded from Windows ``WAV`` file),
that can be stored in memory and played.
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
**~~~**
**__init__** `(self)`
Default constructor.
**~~~**
**__init__** `(self, fileName)`
Constructs a wave object from a file or, under Windows, from a Windows resource.
Call :meth:`IsOk` to determine whether this succeeded.
:param `fileName`: The filename or Windows resource.
:type `fileName`: string
**~~~**
.. method:: Create(self, fileName)
Constructs a wave object from a file or resource.
:param `fileName`: The filename or Windows resource.
:type `fileName`: string
:rtype: `bool`
:returns:
``True`` if the call was successful, ``False`` otherwise.
.. method:: CreateFromData(self, data)
Create a sound object from data in a memory buffer in ``WAV`` format.
:rtype: `bool`
.. method:: IsOk(self)
Returns ``True`` if the object contains a successfully loaded file or resource, ``False`` otherwise.
:rtype: `bool`
.. method:: Play(self, flags=SOUND_ASYNC)
Plays the sound file.
If another sound is playing, it will be interrupted.
Returns ``True`` on success, ``False`` otherwise. Note that in general it is possible to delete the object which is being asynchronously played any time after calling this function and the sound would continue playing, however this currently doesn't work under Windows for sound objects loaded from memory data.
The possible values for `flags` are:
- ``wx.adv.SOUND_SYNC``: ``Play`` will block and wait until the sound is replayed.
- ``wx.adv.SOUND_ASYNC``: Sound is played asynchronously, ``Play`` returns immediately.
- SOUND_ASYNC|wxSOUND_LOOP: Sound is played asynchronously and loops until another sound is played, :meth:`Stop` is called or the program terminates.
The static form is shorthand for this code: ::
wx.adv.Sound(filename).Play(flags)
:param `flags`:
:rtype: `bool`
.. staticmethod:: PlaySound(filename, flags=SOUND_ASYNC)
Plays the sound file.
If another sound is playing, it will be interrupted.
Returns ``True`` on success, ``False`` otherwise. Note that in general it is possible to delete the object which is being asynchronously played any time after calling this function and the sound would continue playing, however this currently doesn't work under Windows for sound objects loaded from memory data.
The possible values for `flags` are:
- ``wx.adv.SOUND_SYNC``: ``Play`` will block and wait until the sound is replayed.
- ``wx.adv.SOUND_ASYNC``: Sound is played asynchronously, ``Play`` returns immediately.
- SOUND_ASYNC|wxSOUND_LOOP: Sound is played asynchronously and loops until another sound is played, :meth:`Stop` is called or the program terminates.
The static form is shorthand for this code: ::
wx.adv.Sound(filename).Play(flags)
:param `filename`:
:type `filename`: string
:param `flags`:
:rtype: `bool`
.. staticmethod:: Stop()
If a sound is played, this function stops it.
.. method:: __bool__(self)
:rtype: `int`
.. method:: __nonzero__(self)
:rtype: `int`
|
