Mercurial > pygame

annotate docs/ref/Sound.html @ 457:c7745825439b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
trunc fix
author pygame
date Mon, 12 May 2003 14:54:13 +0000
parents f4e6726b7d1d
children 4c398dd9d49b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16
790be231ba1a documentation boost
pygame
parents:
diff changeset
1 <html>
790be231ba1a documentation boost
pygame
parents:
diff changeset
2 <title>Sound</title>
235
74eafc13dbab new doc color scheme and logos
pygame
parents: 198
diff changeset
3 <body bgcolor=#aaeebb text=#000000 link=#331111 vlink=#331111>
74eafc13dbab new doc color scheme and logos
pygame
parents: 198
diff changeset
4
16
790be231ba1a documentation boost
pygame
parents:
diff changeset
5
235
74eafc13dbab new doc color scheme and logos
pygame
parents: 198
diff changeset
6 <table cellspacing=3 width=100%><tr><td bgcolor=#00000>
74eafc13dbab new doc color scheme and logos
pygame
parents: 198
diff changeset
7 <table width=100%><tr><td bgcolor=c2fc20 align=center>
74eafc13dbab new doc color scheme and logos
pygame
parents: 198
diff changeset
8 <a href=http://www.pygame.org>
250
d001d5979095 ready for 1.2 release
pygame
parents: 238
diff changeset
9 <img src=../pygame_tiny.gif border=0 width=200 height=60></a><br>
235
74eafc13dbab new doc color scheme and logos
pygame
parents: 198
diff changeset
10 <b>pygame&nbsp;&nbsp;&nbsp;documentation</b>
74eafc13dbab new doc color scheme and logos
pygame
parents: 198
diff changeset
11 </td><td bgcolor=6aee28 align=center valign=top width=100%>
16
790be231ba1a documentation boost
pygame
parents:
diff changeset
12
790be231ba1a documentation boost
pygame
parents:
diff changeset
13 ||&nbsp;
178
efa429ee9486 updated url
pygame
parents: 151
diff changeset
14 <a href=http://www.pygame.org>Home</a> &nbsp;||&nbsp;
16
790be231ba1a documentation boost
pygame
parents:
diff changeset
15 <a href=../index.html>Help Contents</a> &nbsp;||
790be231ba1a documentation boost
pygame
parents:
diff changeset
16 <br>&nbsp;<br>
790be231ba1a documentation boost
pygame
parents:
diff changeset
17
384
f4e6726b7d1d docs updates
pygame
parents: 375
diff changeset
18 || <a href=pygame.html>pygame</a> ||
265
478a437afa69 documentation updates
pygame
parents: 264
diff changeset
19 <a href=pygame_cdrom.html>cdrom</a> ||
478a437afa69 documentation updates
pygame
parents: 264
diff changeset
20 <a href=pygame_constants.html>constants</a> ||
478a437afa69 documentation updates
pygame
parents: 264
diff changeset
21 <a href=pygame_display.html>display</a> ||
384
f4e6726b7d1d docs updates
pygame
parents: 375
diff changeset
22 <a href=pygame_draw.html>draw</a> ||
f4e6726b7d1d docs updates
pygame
parents: 375
diff changeset
23 <a href=pygame_event.html>event</a> ||<br>
f4e6726b7d1d docs updates
pygame
parents: 375
diff changeset
24 || <a href=pygame_font.html>font</a> ||
265
478a437afa69 documentation updates
pygame
parents: 264
diff changeset
25 <a href=pygame_image.html>image</a> ||
478a437afa69 documentation updates
pygame
parents: 264
diff changeset
26 <a href=pygame_joystick.html>joystick</a> ||
478a437afa69 documentation updates
pygame
parents: 264
diff changeset
27 <a href=pygame_key.html>key</a> ||
384
f4e6726b7d1d docs updates
pygame
parents: 375
diff changeset
28 <a href=pygame_mixer.html>mixer</a> ||
f4e6726b7d1d docs updates
pygame
parents: 375
diff changeset
29 <a href=pygame_mixer_music.html>mixer_music</a> ||<br>
f4e6726b7d1d docs updates
pygame
parents: 375
diff changeset
30 || <a href=pygame_mouse.html>mouse</a> ||
265
478a437afa69 documentation updates
pygame
parents: 264
diff changeset
31 <a href=pygame_movie.html>movie</a> ||
370
14d423681804 new gl attributes
pygame
parents: 359
diff changeset
32 <a href=pygame_sndarray.html>sndarray</a> ||
265
478a437afa69 documentation updates
pygame
parents: 264
diff changeset
33 <a href=pygame_surfarray.html>surfarray</a> ||
384
f4e6726b7d1d docs updates
pygame
parents: 375
diff changeset
34 <a href=pygame_time.html>time</a> ||
f4e6726b7d1d docs updates
pygame
parents: 375
diff changeset
35 <a href=pygame_transform.html>transform</a> ||<br>
265
478a437afa69 documentation updates
pygame
parents: 264
diff changeset
36 &nbsp;<br>|| <a href=CD.html>CD</a> ||
16
790be231ba1a documentation boost
pygame
parents:
diff changeset
37 <a href=Channel.html>Channel</a> ||
277
4116bd435131 big updates for pygame.time
pygame
parents: 265
diff changeset
38 <a href=Clock.html>Clock</a> ||
16
790be231ba1a documentation boost
pygame
parents:
diff changeset
39 <a href=Font.html>Font</a> ||
790be231ba1a documentation boost
pygame
parents:
diff changeset
40 <a href=Joystick.html>Joystick</a> ||
277
4116bd435131 big updates for pygame.time
pygame
parents: 265
diff changeset
41 <a href=Movie.html>Movie</a> ||<br>
4116bd435131 big updates for pygame.time
pygame
parents: 265
diff changeset
42 || <a href=Rect.html>Rect</a> ||
4116bd435131 big updates for pygame.time
pygame
parents: 265
diff changeset
43 <a href=Sound.html>Sound</a> ||
265
478a437afa69 documentation updates
pygame
parents: 264
diff changeset
44 <a href=Surface.html>Surface</a> ||<br>
299
954940c4bbaa userrect removal
pygame
parents: 277
diff changeset
45 &nbsp;<br>|| <a href=pygame_cursors.html>cursors</a> ||
375
841ce59c200a music.play start time works
pygame
parents: 372
diff changeset
46 <a href=pygame_sprite.html>sprite</a> ||<br>
16
790be231ba1a documentation boost
pygame
parents:
diff changeset
47
790be231ba1a documentation boost
pygame
parents:
diff changeset
48
235
74eafc13dbab new doc color scheme and logos
pygame
parents: 198
diff changeset
49 </td></tr></table></td></tr></table>
16
790be231ba1a documentation boost
pygame
parents:
diff changeset
50 <br>
790be231ba1a documentation boost
pygame
parents:
diff changeset
51 <h2 align=center>Sound</h2>
790be231ba1a documentation boost
pygame
parents:
diff changeset
52 Sound objects represent actual sound data. Sound objects are
151
638c600d92c7 documentation enhancements
pygame
parents: 148
diff changeset
53 created from the function <a href=pygame_mixer.html#Sound>pygame.mixer.Sound()</a>. Sound objects can
16
790be231ba1a documentation boost
pygame
parents:
diff changeset
54 be playing on multiple channels simultaneously. Calling functions
88
ae6672503952 docs fixed
pygame
parents: 85
diff changeset
55 like <a href=#stop>Sound.stop()</a> from the sound objects will effect all channels
16
790be231ba1a documentation boost
pygame
parents:
diff changeset
56 playing that Sound object.
151
638c600d92c7 documentation enhancements
pygame
parents: 148
diff changeset
57 <br>&nbsp;<br>
16
790be231ba1a documentation boost
pygame
parents:
diff changeset
58 All sound objects have the same frequency and format as the
790be231ba1a documentation boost
pygame
parents:
diff changeset
59 pygame.mixer module's initialization.
790be231ba1a documentation boost
pygame
parents:
diff changeset
60
790be231ba1a documentation boost
pygame
parents:
diff changeset
61 <hr>
790be231ba1a documentation boost
pygame
parents:
diff changeset
62
790be231ba1a documentation boost
pygame
parents:
diff changeset
63 <table>
790be231ba1a documentation boost
pygame
parents:
diff changeset
64 <tr><td><a href=#fadeout>fadeout</a></td><td> -
790be231ba1a documentation boost
pygame
parents:
diff changeset
65 fadeout all channels playing this sound</td></tr>
790be231ba1a documentation boost
pygame
parents:
diff changeset
66
790be231ba1a documentation boost
pygame
parents:
diff changeset
67
790be231ba1a documentation boost
pygame
parents:
diff changeset
68 <tr><td><a href=#get_num_channels>get_num_channels</a></td><td> -
790be231ba1a documentation boost
pygame
parents:
diff changeset
69 number of channels with sound</td></tr>
790be231ba1a documentation boost
pygame
parents:
diff changeset
70
790be231ba1a documentation boost
pygame
parents:
diff changeset
71
790be231ba1a documentation boost
pygame
parents:
diff changeset
72 <tr><td><a href=#get_volume>get_volume</a></td><td> -
790be231ba1a documentation boost
pygame
parents:
diff changeset
73 query volume for sound</td></tr>
790be231ba1a documentation boost
pygame
parents:
diff changeset
74
790be231ba1a documentation boost
pygame
parents:
diff changeset
75
790be231ba1a documentation boost
pygame
parents:
diff changeset
76 <tr><td><a href=#play>play</a></td><td> -
790be231ba1a documentation boost
pygame
parents:
diff changeset
77 play sound</td></tr>
790be231ba1a documentation boost
pygame
parents:
diff changeset
78
790be231ba1a documentation boost
pygame
parents:
diff changeset
79
790be231ba1a documentation boost
pygame
parents:
diff changeset
80 <tr><td><a href=#set_volume>set_volume</a></td><td> -
790be231ba1a documentation boost
pygame
parents:
diff changeset
81 change volume for sound</td></tr>
790be231ba1a documentation boost
pygame
parents:
diff changeset
82
790be231ba1a documentation boost
pygame
parents:
diff changeset
83
790be231ba1a documentation boost
pygame
parents:
diff changeset
84 <tr><td><a href=#stop>stop</a></td><td> -
790be231ba1a documentation boost
pygame
parents:
diff changeset
85 stop all channels playing this sound</td></tr>
790be231ba1a documentation boost
pygame
parents:
diff changeset
86
790be231ba1a documentation boost
pygame
parents:
diff changeset
87
790be231ba1a documentation boost
pygame
parents:
diff changeset
88 </table>
790be231ba1a documentation boost
pygame
parents:
diff changeset
89
790be231ba1a documentation boost
pygame
parents:
diff changeset
90 <hr>
790be231ba1a documentation boost
pygame
parents:
diff changeset
91
790be231ba1a documentation boost
pygame
parents:
diff changeset
92 <a name=fadeout><font size=+2><b>fadeout
790be231ba1a documentation boost
pygame
parents:
diff changeset
93 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost
pygame
parents:
diff changeset
94 Sound.fadeout(millisec) -> None
790be231ba1a documentation boost
pygame
parents:
diff changeset
95 </tt></font><ul>
790be231ba1a documentation boost
pygame
parents:
diff changeset
96 Fade out all the playing channels playing this sound over the.
790be231ba1a documentation boost
pygame
parents:
diff changeset
97 All channels playing this sound will be stopped after the given
790be231ba1a documentation boost
pygame
parents:
diff changeset
98 milliseconds.
790be231ba1a documentation boost
pygame
parents:
diff changeset
99 </ul><br>&nbsp;<br>
790be231ba1a documentation boost
pygame
parents:
diff changeset
100
790be231ba1a documentation boost
pygame
parents:
diff changeset
101 <a name=get_num_channels><font size=+2><b>get_num_channels
790be231ba1a documentation boost
pygame
parents:
diff changeset
102 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost
pygame
parents:
diff changeset
103 Sound.get_num_channels() -> int
790be231ba1a documentation boost
pygame
parents:
diff changeset
104 </tt></font><ul>
790be231ba1a documentation boost
pygame
parents:
diff changeset
105 Returns the number of channels that have been using this sound.
790be231ba1a documentation boost
pygame
parents:
diff changeset
106 The channels may have already finished, but have not started
790be231ba1a documentation boost
pygame
parents:
diff changeset
107 playing any other sounds.
790be231ba1a documentation boost
pygame
parents:
diff changeset
108 </ul><br>&nbsp;<br>
790be231ba1a documentation boost
pygame
parents:
diff changeset
109
790be231ba1a documentation boost
pygame
parents:
diff changeset
110 <a name=get_volume><font size=+2><b>get_volume
790be231ba1a documentation boost
pygame
parents:
diff changeset
111 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost
pygame
parents:
diff changeset
112 Sound.get_volume() -> val
790be231ba1a documentation boost
pygame
parents:
diff changeset
113 </tt></font><ul>
790be231ba1a documentation boost
pygame
parents:
diff changeset
114 Returns the current volume for this sound object. The value is
790be231ba1a documentation boost
pygame
parents:
diff changeset
115 0.0 to 1.0.
790be231ba1a documentation boost
pygame
parents:
diff changeset
116 </ul><br>&nbsp;<br>
790be231ba1a documentation boost
pygame
parents:
diff changeset
117
790be231ba1a documentation boost
pygame
parents:
diff changeset
118 <a name=play><font size=+2><b>play
790be231ba1a documentation boost
pygame
parents:
diff changeset
119 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost
pygame
parents:
diff changeset
120 Sound.play([loops, [maxtime]]) -> Channel
790be231ba1a documentation boost
pygame
parents:
diff changeset
121 </tt></font><ul>
790be231ba1a documentation boost
pygame
parents:
diff changeset
122 Starts playing a song on an available channel. If no channels are
790be231ba1a documentation boost
pygame
parents:
diff changeset
123 available, it will not play and return None. Loops controls how
790be231ba1a documentation boost
pygame
parents:
diff changeset
124 many extra times the sound will play, a negative loop will play
790be231ba1a documentation boost
pygame
parents:
diff changeset
125 indefinitely, it defaults to 0. Maxtime is the number of total
790be231ba1a documentation boost
pygame
parents:
diff changeset
126 milliseconds that the sound will play. It defaults to forever
790be231ba1a documentation boost
pygame
parents:
diff changeset
127 (-1).
151
638c600d92c7 documentation enhancements
pygame
parents: 148
diff changeset
128 <br>&nbsp;<br>
16
790be231ba1a documentation boost
pygame
parents:
diff changeset
129 Returns a channel object for the channel that is selected to play
790be231ba1a documentation boost
pygame
parents:
diff changeset
130 the sound.
790be231ba1a documentation boost
pygame
parents:
diff changeset
131 </ul><br>&nbsp;<br>
790be231ba1a documentation boost
pygame
parents:
diff changeset
132
790be231ba1a documentation boost
pygame
parents:
diff changeset
133 <a name=set_volume><font size=+2><b>set_volume
790be231ba1a documentation boost
pygame
parents:
diff changeset
134 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost
pygame
parents:
diff changeset
135 Sound.set_volume(val) -> None
790be231ba1a documentation boost
pygame
parents:
diff changeset
136 </tt></font><ul>
790be231ba1a documentation boost
pygame
parents:
diff changeset
137 Set the play volume for this sound. This will effect any channels
790be231ba1a documentation boost
pygame
parents:
diff changeset
138 currently playing this sound, along with all subsequent calls to
790be231ba1a documentation boost
pygame
parents:
diff changeset
139 play. The value is 0.0 to 1.0.
790be231ba1a documentation boost
pygame
parents:
diff changeset
140 </ul><br>&nbsp;<br>
790be231ba1a documentation boost
pygame
parents:
diff changeset
141
790be231ba1a documentation boost
pygame
parents:
diff changeset
142 <a name=stop><font size=+2><b>stop
790be231ba1a documentation boost
pygame
parents:
diff changeset
143 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost
pygame
parents:
diff changeset
144 Sound.stop() -> None
790be231ba1a documentation boost
pygame
parents:
diff changeset
145 </tt></font><ul>
790be231ba1a documentation boost
pygame
parents:
diff changeset
146 This will instantly stop all channels playing this sound.
790be231ba1a documentation boost
pygame
parents:
diff changeset
147 </ul><br>&nbsp;<br>
790be231ba1a documentation boost
pygame
parents:
diff changeset
148
790be231ba1a documentation boost
pygame
parents:
diff changeset
149
790be231ba1a documentation boost
pygame
parents:
diff changeset
150 <hr>
790be231ba1a documentation boost
pygame
parents:
diff changeset
151 </body></html>