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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
|
<html>
<title>mixer - Pygame Documentation</title>
<body bgcolor=#aaeebb text=#000000 link=#331111 vlink=#331111>
<table cellpadding=0 cellspacing=0 border=0 style='border: 3px solid black;' width='100%'>
<tr>
<td bgcolor='#c2fc20' style='padding: 6px;' align=center valign=center><a href='http://www.pygame.org/'><img src='../pygame_tiny.gif' border=0 width=200 height=60></a><br><b>pygame documentation</b></td>
<td bgcolor='#6aee28' style='border-left: 3px solid black; padding: 6px;' align=center valign=center>
||
<a href=http://www.pygame.org>Pygame Home</a> ||
<a href=../index.html>Help Contents</a> ||
<a href=index.html>Reference Index</a> ||
<br> <br>
<a href="camera.html">Camera</a> ||
<a href="cdrom.html">Cdrom</a> ||
<a href="color.html">Color</a> ||
<a href="cursors.html">Cursors</a> ||
<a href="display.html">Display</a> ||
<a href="draw.html">Draw</a> ||
<a href="event.html">Event</a> ||
<a href="examples.html">Examples</a> ||
<a href="font.html">Font</a> ||
<a href="gfxdraw.html">Gfxdraw</a> ||
<a href="image.html">Image</a> ||
<a href="joystick.html">Joystick</a> ||
<a href="key.html">Key</a> ||
<a href="locals.html">Locals</a> ||
<a href="mask.html">Mask</a> ||
<a href="midi.html">Midi</a> ||
<a href="mixer.html">Mixer</a> ||
<a href="mouse.html">Mouse</a> ||
<a href="movie.html">Movie</a> ||
<a href="music.html">Music</a> ||
<a href="overlay.html">Overlay</a> ||
<a href="pixelarray.html">Pixelarray</a> ||
<a href="pygame.html">Pygame</a> ||
<a href="rect.html">Rect</a> ||
<a href="scrap.html">Scrap</a> ||
<a href="sndarray.html">Sndarray</a> ||
<a href="sprite.html">Sprite</a> ||
<a href="surface.html">Surface</a> ||
<a href="surfarray.html">Surfarray</a> ||
<a href="tests.html">Tests</a> ||
<a href="time.html">Time</a> ||
<a href="transform.html">Transform</a>
</td></tr></table>
<br>
<a name="pygame.mixer">
<big><b>pygame.mixer</big></b><br><ul>
<i>pygame module for loading and playing sounds</i><br>
<ul><small><table>
<tr><td><a href="mixer.html#pygame.mixer.init">pygame.mixer.init</a> - <font size=-1>initialize the mixer module</font></td><td>initialize the mixer module</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.pre_init">pygame.mixer.pre_init</a> - <font size=-1>preset the mixer init arguments</font></td><td>preset the mixer init arguments</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.quit">pygame.mixer.quit</a> - <font size=-1>uninitialize the mixer</font></td><td>uninitialize the mixer</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.get_init">pygame.mixer.get_init</a> - <font size=-1>test if the mixer is initialized</font></td><td>test if the mixer is initialized</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.stop">pygame.mixer.stop</a> - <font size=-1>stop playback of all sound channels</font></td><td>stop playback of all sound channels</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.pause">pygame.mixer.pause</a> - <font size=-1>temporarily stop playback of all sound channels</font></td><td>temporarily stop playback of all sound channels</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.unpause">pygame.mixer.unpause</a> - <font size=-1>resume paused playback of sound channels</font></td><td>resume paused playback of sound channels</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.fadeout">pygame.mixer.fadeout</a> - <font size=-1>fade out the volume on all sounds before stopping</font></td><td>fade out the volume on all sounds before stopping</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.set_num_channels">pygame.mixer.set_num_channels</a> - <font size=-1>set the total number of playback channels</font></td><td>set the total number of playback channels</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.get_num_channels">pygame.mixer.get_num_channels</a> - <font size=-1>get the total number of playback channels</font></td><td>get the total number of playback channels</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.set_reserved">pygame.mixer.set_reserved</a> - <font size=-1>reserve channels from being automatically used</font></td><td>reserve channels from being automatically used</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.find_channel">pygame.mixer.find_channel</a> - <font size=-1>find an unused channel</font></td><td>find an unused channel</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.get_busy">pygame.mixer.get_busy</a> - <font size=-1>test if any sound is being mixed</font></td><td>test if any sound is being mixed</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.Sound">pygame.mixer.Sound</a> - <font size=-1>Create a new Sound object from a file</font></td><td>Create a new Sound object from a file</td></tr>
<tr><td><a href="mixer.html#pygame.mixer.Channel">pygame.mixer.Channel</a> - <font size=-1>Create a Channel object for controlling playback</font></td><td>Create a Channel object for controlling playback</td></tr>
</table></small></ul>
<p>This module contains classes for loading Sound objects and controlling playback. The mixer module is optional and depends on SDL_mixer. Your program should test that <tt>pygame.mixer</tt> is available and intialized before using it. </p>
<p>The mixer module has a limited number of channels for playback of sounds. Usually programs tell pygame to start playing audio and it selects an available channel automatically. The default is 8 simultaneous channels, but complex programs can get more precise control over the number of channels and their use. </p>
<p>All sound playback is mixed in background threads. When you begin to play a Sound object, it will return immediately while the sound continues to play. <tt>A</tt> single Sound object can also be actively played back multiple times. </p>
<p>The mixer also has a special streaming channel. This is for music playback and is accessed through the <tt>pygame.mixer.music</tt> module. </p>
<p>The mixer module must be initialized like other pygame modules, but it has some extra conditions. The <tt><a href="mixer.html#pygame.mixer.init">pygame.mixer.init</a> - <font size=-1>initialize the mixer module</font></tt> function takes several optional arguments to control the playback rate and sample size. Pygame will default to reasonable values, but pygame cannot perform Sound resampling, so the mixer should be initialized to match the values of your audio resources. </p>
<p><tt>NOTE:</tt> Not to get less laggy sound, use a smaller buffer size. The default is set to reduce the chance of scratchy sounds on some computers. You can change the default buffer by calling <tt>pygame.mixer.pre_init</tt> before <tt>pygame.mixer.init</tt> or <tt>pygame.init</tt> is called. For example: <tt>pygame.mixer.pre_init(44100,-16,2</tt>, 1024) The default size was changed from 1024 to 3072 in pygame <tt>1.8</tt>. </p>
<!--COMMENTS:pygame.mixer--> <br>
<a name="pygame.mixer.init">
<big><b>pygame.mixer.init</big></b><br><ul>
<i>initialize the mixer module</i><br>
<tt>pygame.mixer.init(frequency=22050, size=-16, channels=2, buffer=4096): return None</tt><br>
<p>Initialize the mixer module for Sound loading and playback. The default arguments can be overridden to provide specific audio mixing. Keyword arguments are accepted. For backward compatibility where an argument is set zero the default value is used (possible changed by a pre_init call). </p>
<p>The size argument represents how many bits are used for each audio sample. If the value is negative then signed sample values will be used. Positive values mean unsigned audio samples will be used. An invalid value raises an exception. </p>
<p>The channels argument is used to specify whether to use mono or stereo. 1 for mono and 2 for stereo. No other values are supported (negative values are treated as 1, values greater than 2 as 2). </p>
<p>The buffer argument controls the number of internal samples used in the sound mixer. The default value should work for most cases. It can be lowered to reduce latency, but sound dropout may occur. It can be raised to larger values to ensure playback never skips, but it will impose latency on sound playback. The buffer size must be a power of two (if not it is rounded up to the next nearest power of 2). </p>
<p>Some platforms require the <tt>pygame.mixer</tt> module to be initialized after the display modules have initialized. The top level <tt><a href="pygame.html#pygame.init">pygame.init</a> - <font size=-1>initialize all imported pygame modules</font></tt> takes care of this automatically, but cannot pass any arguments to the mixer init. To solve this, mixer has a function <tt><a href="mixer.html#pygame.mixer.pre_init">pygame.mixer.pre_init</a> - <font size=-1>preset the mixer init arguments</font></tt> to set the proper defaults before the toplevel init is used. </p>
<p>It is safe to call this more than once, but after the mixer is initialized you cannot change the playback arguments without first calling <tt><a href="mixer.html#pygame.mixer.quit">pygame.mixer.quit</a> - <font size=-1>uninitialize the mixer</font></tt>. </p>
<!--COMMENTS:pygame.mixer.init--> <br>
<br></ul>
<a name="pygame.mixer.pre_init">
<big><b>pygame.mixer.pre_init</big></b><br><ul>
<i>preset the mixer init arguments</i><br>
<tt>pygame.mixer.pre_init(frequency=22050, size=-16, channels=2, buffersize=4096): return None</tt><br>
<p>Call pre_init to change the defaults used when the real <tt><a href="mixer.html#pygame.mixer.init">pygame.mixer.init</a> - <font size=-1>initialize the mixer module</font></tt> is called. Keyword arguments are accepted. The best way to set custom mixer playback values is to call <tt><a href="mixer.html#pygame.mixer.pre_init">pygame.mixer.pre_init</a> - <font size=-1>preset the mixer init arguments</font></tt> before calling the top level <tt><a href="pygame.html#pygame.init">pygame.init</a> - <font size=-1>initialize all imported pygame modules</font></tt>. For backward compatibility argument values of zero is replaced with the startup defaults. </p>
<!--COMMENTS:pygame.mixer.pre_init--> <br>
<br></ul>
<a name="pygame.mixer.quit">
<big><b>pygame.mixer.quit</big></b><br><ul>
<i>uninitialize the mixer</i><br>
<tt>pygame.mixer.quit(): return None</tt><br>
<p>This will uninitialize <tt>pygame.mixer</tt>. All playback will stop and any loaded Sound objects may not be compatible with the mixer if it is reinitialized later. </p>
<!--COMMENTS:pygame.mixer.quit--> <br>
<br></ul>
<a name="pygame.mixer.get_init">
<big><b>pygame.mixer.get_init</big></b><br><ul>
<i>test if the mixer is initialized</i><br>
<tt>pygame.mixer.get_init(): return (frequency, format, channels)</tt><br>
<p>If the mixer is initialized, this returns the playback arguments it is using. If the mixer has not been initialized this returns None </p>
<!--COMMENTS:pygame.mixer.get_init--> <br>
<br></ul>
<a name="pygame.mixer.stop">
<big><b>pygame.mixer.stop</big></b><br><ul>
<i>stop playback of all sound channels</i><br>
<tt>pygame.mixer.stop(): return None</tt><br>
<p>This will stop all playback of all active mixer channels. </p>
<!--COMMENTS:pygame.mixer.stop--> <br>
<br></ul>
<a name="pygame.mixer.pause">
<big><b>pygame.mixer.pause</big></b><br><ul>
<i>temporarily stop playback of all sound channels</i><br>
<tt>pygame.mixer.pause(): return None</tt><br>
<p>This will temporarily stop all playback on the active mixer channels. The playback can later be resumed with <tt><a href="mixer.html#pygame.mixer.unpause">pygame.mixer.unpause</a> - <font size=-1>resume paused playback of sound channels</font></tt> </p>
<!--COMMENTS:pygame.mixer.pause--> <br>
<br></ul>
<a name="pygame.mixer.unpause">
<big><b>pygame.mixer.unpause</big></b><br><ul>
<i>resume paused playback of sound channels</i><br>
<tt>pygame.mixer.unpause(): return None</tt><br>
<p>This will resume all active sound channels after they have been paused. </p>
<!--COMMENTS:pygame.mixer.unpause--> <br>
<br></ul>
<a name="pygame.mixer.fadeout">
<big><b>pygame.mixer.fadeout</big></b><br><ul>
<i>fade out the volume on all sounds before stopping</i><br>
<tt>pygame.mixer.fadeout(time): return None</tt><br>
<p>This will fade out the volume on all active channels over the time argument in milliseconds. After the sound is muted the playback will stop. </p>
<!--COMMENTS:pygame.mixer.fadeout--> <br>
<br></ul>
<a name="pygame.mixer.set_num_channels">
<big><b>pygame.mixer.set_num_channels</big></b><br><ul>
<i>set the total number of playback channels</i><br>
<tt>pygame.mixer.set_num_channels(count): return None</tt><br>
<p>Sets the number of available channels for the mixer. The default value is 8. The value can be increased or decreased. If the value is decreased, sounds playing on the truncated channels are stopped. </p>
<!--COMMENTS:pygame.mixer.set_num_channels--> <br>
<br></ul>
<a name="pygame.mixer.get_num_channels">
<big><b>pygame.mixer.get_num_channels</big></b><br><ul>
<i>get the total number of playback channels</i><br>
<p>Returns the number of currently active playback channels. </p>
<!--COMMENTS:pygame.mixer.get_num_channels--> <br>
<br></ul>
<a name="pygame.mixer.set_reserved">
<big><b>pygame.mixer.set_reserved</big></b><br><ul>
<i>reserve channels from being automatically used</i><br>
<tt>pygame.mixer.set_reserved(count): return None</tt><br>
<p>The mixer can reserve any number of channels that will not be automatically selected for playback by Sounds. If sounds are currently playing on the reserved channels they will not be stopped. </p>
<p>This allows the application to reserve a specific number of channels for important sounds that must not be dropped or have a guaranteed channel to play on. </p>
<!--COMMENTS:pygame.mixer.set_reserved--> <br>
<br></ul>
<a name="pygame.mixer.find_channel">
<big><b>pygame.mixer.find_channel</big></b><br><ul>
<i>find an unused channel</i><br>
<tt>pygame.mixer.find_channel(force=False): return Channel</tt><br>
<p>This will find and return an inactive Channel object. If there are no inactive Channels this function will return None. If there are no inactive channels and the force argument is True, this will find the Channel with the longest running Sound and return it. </p>
<p>If the mixer has reserved channels from <tt><a href="mixer.html#pygame.mixer.set_reserved">pygame.mixer.set_reserved</a> - <font size=-1>reserve channels from being automatically used</font></tt> then those channels will not be returned here. </p>
<!--COMMENTS:pygame.mixer.find_channel--> <br>
<br></ul>
<a name="pygame.mixer.get_busy">
<big><b>pygame.mixer.get_busy</big></b><br><ul>
<i>test if any sound is being mixed</i><br>
<tt>pygame.mixer.get_busy(): return bool</tt><br>
<p>Returns True if the mixer is busy mixing any channels. If the mixer is idle then this return False. </p>
<!--COMMENTS:pygame.mixer.get_busy--> <br>
<br></ul>
<a name="pygame.mixer.Sound">
<big><b>pygame.mixer.Sound</big></b><br><ul>
<i>Create a new Sound object from a file</i><br>
<tt>pygame.mixer.Sound(filename): return Sound</tt><br>
<tt>pygame.mixer.Sound(buffer): return Sound</tt><br>
<tt>pygame.mixer.Sound(object): return Sound</tt><br>
<ul><small><table>
<tr><td><a href="mixer.html#Sound.play">Sound.play</a> - <font size=-1>begin sound playback</font></td><td>begin sound playback</td></tr>
<tr><td><a href="mixer.html#Sound.stop">Sound.stop</a> - <font size=-1>stop sound playback</font></td><td>stop sound playback</td></tr>
<tr><td><a href="mixer.html#Sound.fadeout">Sound.fadeout</a> - <font size=-1>stop sound playback after fading out</font></td><td>stop sound playback after fading out</td></tr>
<tr><td><a href="mixer.html#Sound.set_volume">Sound.set_volume</a> - <font size=-1>set the playback volume for this Sound</font></td><td>set the playback volume for this Sound</td></tr>
<tr><td><a href="mixer.html#Sound.get_volume">Sound.get_volume</a> - <font size=-1>get the playback volume</font></td><td>get the playback volume</td></tr>
<tr><td><a href="mixer.html#Sound.get_num_channels">Sound.get_num_channels</a> - <font size=-1>count how many times this Sound is playing</font></td><td>count how many times this Sound is playing</td></tr>
<tr><td><a href="mixer.html#Sound.get_length">Sound.get_length</a> - <font size=-1>get the length of the Sound</font></td><td>get the length of the Sound</td></tr>
<tr><td><a href="mixer.html#Sound.get_buffer">Sound.get_buffer</a> - <font size=-1>acquires a buffer object for the sameples of the Sound.</font></td><td>acquires a buffer object for the sameples of the Sound.</td></tr>
</table></small></ul>
<p>Load a new sound buffer from a filename, a python file object or a readable buffer object. Limited resampling will be performed to help the sample match the initialize arguments for the mixer. </p>
<p>The Sound object represents actual sound sample data. Methods that change the state of the Sound object will the all instances of the Sound playback. </p>
<p>The Sound can be loaded from an <tt>OGG</tt> audio file or from an uncompressed <tt>WAV</tt>. </p>
<p>Note: The buffer will be copied internally, no data will be shared between it and the Sound object. </p>
<p><tt>pygame.mixer.Sound(buffer)</tt> is new in pygame <tt>1.8</tt> </p>
<!--COMMENTS:pygame.mixer.Sound--> <br>
<a name="Sound.play">
<big><b>Sound.play</big></b><br><ul>
<i>begin sound playback</i><br>
<tt>Sound.play(loops=0, maxtime=0, fade_ms=0): return Channel</tt><br>
<p>Begin playback of the Sound <tt>(i.e.</tt>, on the computer's speakers) on an available Channel. This will forcibly select a Channel, so playback may cut off a currently playing sound if necessary. </p>
<p>The loops argument controls how many times the sample will be repeated after being played the first time. <tt>A</tt> value of 5 means that the sound will be played once, then repeated five times, and so is played a total of six times. The default value (zero) means the Sound is not repeated, and so is only played once. If loops is set to -1 the Sound will loop indefinitely (though you can still call stop() to stop it). </p>
<p>The maxtime argument can be used to stop playback after a given number of milliseconds. </p>
<p>The fade_ms argument will make the sound start playing at 0 volume and fade up to full volume over the time given. The sample may end before the fade-in is complete. </p>
<p>This returns the Channel object for the channel that was selected. </p>
<!--COMMENTS:Sound.play--> <br>
<br></ul>
<a name="Sound.stop">
<big><b>Sound.stop</big></b><br><ul>
<i>stop sound playback</i><br>
<tt>Sound.stop(): return None</tt><br>
<p>This will stop the playback of this Sound on any active Channels. </p>
<!--COMMENTS:Sound.stop--> <br>
<br></ul>
<a name="Sound.fadeout">
<big><b>Sound.fadeout</big></b><br><ul>
<i>stop sound playback after fading out</i><br>
<tt>Sound.fadeout(time): return None</tt><br>
<p>This will stop playback of the sound after fading it out over the time argument in milliseconds. The Sound will fade and stop on all actively playing channels. </p>
<!--COMMENTS:Sound.fadeout--> <br>
<br></ul>
<a name="Sound.set_volume">
<big><b>Sound.set_volume</big></b><br><ul>
<i>set the playback volume for this Sound</i><br>
<tt>Sound.set_volume(value): return None</tt><br>
<p>This will set the playback volume (loudness) for this Sound. This will immediately affect the Sound if it is playing. It will also affect any future playback of this Sound. The argument is a value from <tt>0.0</tt> to <tt>1.0</tt>. </p>
<!--COMMENTS:Sound.set_volume--> <br>
<br></ul>
<a name="Sound.get_volume">
<big><b>Sound.get_volume</big></b><br><ul>
<i>get the playback volume</i><br>
<tt>Sound.get_volume(): return value</tt><br>
<p>Return a value from <tt>0.0</tt> to <tt>1.0</tt> representing the volume for this Sound. </p>
<!--COMMENTS:Sound.get_volume--> <br>
<br></ul>
<a name="Sound.get_num_channels">
<big><b>Sound.get_num_channels</big></b><br><ul>
<i>count how many times this Sound is playing</i><br>
<tt>Sound.get_num_channels(): return count</tt><br>
<p>Return the number of active channels this sound is playing on. </p>
<!--COMMENTS:Sound.get_num_channels--> <br>
<br></ul>
<a name="Sound.get_length">
<big><b>Sound.get_length</big></b><br><ul>
<i>get the length of the Sound</i><br>
<tt>Sound.get_length(): return seconds</tt><br>
<p>Return the length of this Sound in seconds. </p>
<!--COMMENTS:Sound.get_length--> <br>
<br></ul>
<a name="Sound.get_buffer">
<big><b>Sound.get_buffer</big></b><br><ul>
<i>acquires a buffer object for the sameples of the Sound.</i><br>
<tt>Sound.get_buffer(): return BufferProxy</tt><br>
<p>Return a buffer object for the Sound samples. The buffer can be used for direct access and manipulation. </p>
<p>New in pygame <tt>1.8</tt>. </p>
<!--COMMENTS:Sound.get_buffer--> <br>
<br></ul>
<br></ul>
<a name="pygame.mixer.Channel">
<big><b>pygame.mixer.Channel</big></b><br><ul>
<i>Create a Channel object for controlling playback</i><br>
<tt>pygame.mixer.Channel(id): return Channel</tt><br>
<ul><small><table>
<tr><td><a href="mixer.html#Channel.play">Channel.play</a> - <font size=-1>play a Sound on a specific Channel</font></td><td>play a Sound on a specific Channel</td></tr>
<tr><td><a href="mixer.html#Channel.stop">Channel.stop</a> - <font size=-1>stop playback on a Channel</font></td><td>stop playback on a Channel</td></tr>
<tr><td><a href="mixer.html#Channel.pause">Channel.pause</a> - <font size=-1>temporarily stop playback of a channel</font></td><td>temporarily stop playback of a channel</td></tr>
<tr><td><a href="mixer.html#Channel.unpause">Channel.unpause</a> - <font size=-1>resume pause playback of a channel</font></td><td>resume pause playback of a channel</td></tr>
<tr><td><a href="mixer.html#Channel.fadeout">Channel.fadeout</a> - <font size=-1>stop playback after fading channel out</font></td><td>stop playback after fading channel out</td></tr>
<tr><td><a href="mixer.html#Channel.set_volume">Channel.set_volume</a> - <font size=-1>set the volume of a playing channel</font></td><td>set the volume of a playing channel</td></tr>
<tr><td><a href="mixer.html#Channel.get_volume">Channel.get_volume</a> - <font size=-1>get the volume of the playing channel</font></td><td>get the volume of the playing channel</td></tr>
<tr><td><a href="mixer.html#Channel.get_busy">Channel.get_busy</a> - <font size=-1>check if the channel is active</font></td><td>check if the channel is active</td></tr>
<tr><td><a href="mixer.html#Channel.get_sound">Channel.get_sound</a> - <font size=-1>get the currently playing Sound</font></td><td>get the currently playing Sound</td></tr>
<tr><td><a href="mixer.html#Channel.queue">Channel.queue</a> - <font size=-1>queue a Sound object to follow the current</font></td><td>queue a Sound object to follow the current</td></tr>
<tr><td><a href="mixer.html#Channel.get_queue">Channel.get_queue</a> - <font size=-1>return any Sound that is queued</font></td><td>return any Sound that is queued</td></tr>
<tr><td><a href="mixer.html#Channel.set_endevent">Channel.set_endevent</a> - <font size=-1>have the channel send an event when playback stops</font></td><td>have the channel send an event when playback stops</td></tr>
<tr><td><a href="mixer.html#Channel.get_endevent">Channel.get_endevent</a> - <font size=-1>get the event a channel sends when playback stops</font></td><td>get the event a channel sends when playback stops</td></tr>
</table></small></ul>
<p>Return a Channel object for one of the current channels. The id must be a value from 0 to the value of <tt><a href="mixer.html#pygame.mixer.get_num_channels">pygame.mixer.get_num_channels</a> - <font size=-1>get the total number of playback channels</font></tt>. </p>
<p>The Channel object can be used to get fine control over the playback of Sounds. <tt>A</tt> channel can only playback a single Sound at time. Using channels is entirely optional since pygame can manage them by default. </p>
<!--COMMENTS:pygame.mixer.Channel--> <br>
<a name="Channel.play">
<big><b>Channel.play</big></b><br><ul>
<i>play a Sound on a specific Channel</i><br>
<tt>Channel.play(Sound, loops=0, maxtime=0, fade_ms=0): return None</tt><br>
<p>This will begin playback of a Sound on a specific Channel. If the Channel is currently playing any other Sound it will be stopped. </p>
<p>The loops argument has the same meaning as in <tt>Sound.play():</tt> it is the number of times to repeat the sound after the first time. If it is 3, the sound will be played 4 times (the first time, then three more). If loops is -1 then the playback will repeat indefinitely. </p>
<p>As in <tt><a href="mixer.html#Sound.play">Sound.play</a> - <font size=-1>begin sound playback</font></tt>, the maxtime argument can be used to stop playback of the Sound after a given number of milliseconds. </p>
<p>As in <tt><a href="mixer.html#Sound.play">Sound.play</a> - <font size=-1>begin sound playback</font></tt>, the fade_ms argument can be used fade in the sound. </p>
<!--COMMENTS:Channel.play--> <br>
<br></ul>
<a name="Channel.stop">
<big><b>Channel.stop</big></b><br><ul>
<i>stop playback on a Channel</i><br>
<tt>Channel.stop(): return None</tt><br>
<p>Stop sound playback on a channel. After playback is stopped the channel becomes available for new Sounds to play on it. </p>
<!--COMMENTS:Channel.stop--> <br>
<br></ul>
<a name="Channel.pause">
<big><b>Channel.pause</big></b><br><ul>
<i>temporarily stop playback of a channel</i><br>
<tt>Channel.pause(): return None</tt><br>
<p>Temporarily stop the playback of sound on a channel. It can be resumed at a later time with <tt><a href="mixer.html#Channel.unpause">Channel.unpause</a> - <font size=-1>resume pause playback of a channel</font></tt> </p>
<!--COMMENTS:Channel.pause--> <br>
<br></ul>
<a name="Channel.unpause">
<big><b>Channel.unpause</big></b><br><ul>
<i>resume pause playback of a channel</i><br>
<tt>Channel.unpause(): return None</tt><br>
<p>Resume the playback on a paused channel. </p>
<!--COMMENTS:Channel.unpause--> <br>
<br></ul>
<a name="Channel.fadeout">
<big><b>Channel.fadeout</big></b><br><ul>
<i>stop playback after fading channel out</i><br>
<tt>Channel.fadeout(time): return None</tt><br>
<p>Stop playback of a channel after fading out the sound over the given time argument in milliseconds. </p>
<!--COMMENTS:Channel.fadeout--> <br>
<br></ul>
<a name="Channel.set_volume">
<big><b>Channel.set_volume</big></b><br><ul>
<i>set the volume of a playing channel</i><br>
<tt>Channel.set_volume(value): return None</tt><br>
<tt>Channel.set_volume(left, right): return None</tt><br>
<p>Set the volume (loudness) of a playing sound. When a channel starts to play its volume value is reset. This only affects the current sound. The value argument is between <tt>0.0</tt> and <tt>1.0</tt>. </p>
<p>If one argument is passed, it will be the volume of both speakers. If two arguments are passed and the mixer is in stereo mode, the first argument will be the volume of the left speaker and the second will be the volume of the right speaker. (If the second argument is None, the first argument will be the volume of both <tt>speakers.)</tt> </p>
<p>If the channel is playing a Sound on which set_volume() has also been called, both calls are taken into account. For example: </p>
<pre> sound = pygame.mixer.Sound("s.wav")
channel = s.play() # Sound plays at full volume by default
sound.set_volume(0.9) # Now plays at 90% of full volume.
sound.set_volume(0.6) # Now plays at 60% (previous value replaced).
channel.set_volume(0.5) # Now plays at 30% (0.6 * 0.5).
</pre>
<!--COMMENTS:Channel.set_volume--> <br>
<br></ul>
<a name="Channel.get_volume">
<big><b>Channel.get_volume</big></b><br><ul>
<i>get the volume of the playing channel</i><br>
<tt>Channel.get_volume(): return value</tt><br>
<p>Return the volume of the channel for the current playing sound. This does not take into account stereo separation used by <tt>Channel.set_volume</tt>. The Sound object also has its own volume which is mixed with the channel. </p>
<!--COMMENTS:Channel.get_volume--> <br>
<br></ul>
<a name="Channel.get_busy">
<big><b>Channel.get_busy</big></b><br><ul>
<i>check if the channel is active</i><br>
<tt>Channel.get_busy(): return bool</tt><br>
<p>Returns true if the channel is activily mixing sound. If the channel is idle this returns False. </p>
<!--COMMENTS:Channel.get_busy--> <br>
<br></ul>
<a name="Channel.get_sound">
<big><b>Channel.get_sound</big></b><br><ul>
<i>get the currently playing Sound</i><br>
<tt>Channel.get_sound(): return Sound</tt><br>
<p>Return the actual Sound object currently playing on this channel. If the channel is idle None is returned. </p>
<!--COMMENTS:Channel.get_sound--> <br>
<br></ul>
<a name="Channel.queue">
<big><b>Channel.queue</big></b><br><ul>
<i>queue a Sound object to follow the current</i><br>
<tt>Channel.queue(Sound): return None</tt><br>
<p>When a Sound is queued on a Channel, it will begin playing immediately after the current Sound is finished. Each channel can only have a single Sound queued at a time. The queued Sound will only play if the current playback finished automatically. It is cleared on any other call to <tt><a href="mixer.html#Channel.stop">Channel.stop</a> - <font size=-1>stop playback on a Channel</font></tt> or <tt><a href="mixer.html#Channel.play">Channel.play</a> - <font size=-1>play a Sound on a specific Channel</font></tt>. </p>
<p>If there is no sound actively playing on the Channel then the Sound will begin playing immediately. </p>
<!--COMMENTS:Channel.queue--> <br>
<br></ul>
<a name="Channel.get_queue">
<big><b>Channel.get_queue</big></b><br><ul>
<i>return any Sound that is queued</i><br>
<tt>Channel.get_queue(): return Sound</tt><br>
<p>If a Sound is already queued on this channel it will be returned. Once the queued sound begins playback it will no longer be on the queue. </p>
<!--COMMENTS:Channel.get_queue--> <br>
<br></ul>
<a name="Channel.set_endevent">
<big><b>Channel.set_endevent</big></b><br><ul>
<i>have the channel send an event when playback stops</i><br>
<tt>Channel.set_endevent(): return None</tt><br>
<tt>Channel.set_endevent(type): return None</tt><br>
<p>When an endevent is set for a channel, it will send an event to the pygame queue every time a sound finishes playing on that channel (not just the first time). Use <tt><a href="event.html#pygame.event.get">pygame.event.get</a> - <font size=-1>get events from the queue</font></tt> to retrieve the endevent once it's sent. </p>
<p>Note that if you called <tt>Sound.play(n)</tt> or <tt>Channel.play(sound,n)</tt>, the end event is sent only once: after the sound has been played "n+1" times (see the documentation of <tt>Sound.play)</tt>. </p>
<p>If <tt><a href="mixer.html#Channel.stop">Channel.stop</a> - <font size=-1>stop playback on a Channel</font></tt> or <tt><a href="mixer.html#Channel.play">Channel.play</a> - <font size=-1>play a Sound on a specific Channel</font></tt> is called while the sound was still playing, the event will be posted immediately. </p>
<p>The type argument will be the event id sent to the queue. This can be any valid event type, but a good choice would be a value between <tt>pygame.locals.USEREVENT</tt> and <tt>pygame.locals.NUMEVENTS</tt>. If no type argument is given then the Channel will stop sending endevents. </p>
<!--COMMENTS:Channel.set_endevent--> <br>
<br></ul>
<a name="Channel.get_endevent">
<big><b>Channel.get_endevent</big></b><br><ul>
<i>get the event a channel sends when playback stops</i><br>
<tt>Channel.get_endevent(): return type</tt><br>
<p>Returns the event type to be sent every time the Channel finishes playback of a Sound. If there is no endevent the function returns <tt>pygame.NOEVENT</tt>. </p>
<!--COMMENTS:Channel.get_endevent--> <br>
<br></ul>
<br></ul>
<br></ul>
</body></html>
|
