pygame: docs/ref/Channel.html annotate

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

trunc fix

author	pygame
date	Mon, 12 May 2003 14:54:13 +0000
parents	f3ef1ecb814a
children	4c398dd9d49b

rev	line source
16 790be231ba1a documentation boost pygame parents: diff changeset	1 <html>
790be231ba1a documentation boost pygame parents: diff changeset	2 <title>Channel</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   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 \|\|
178 efa429ee9486 updated url pygame parents: 164 diff changeset	14 <a href=http://www.pygame.org>Home</a>  \|\|
16 790be231ba1a documentation boost pygame parents: diff changeset	15 <a href=../index.html>Help Contents</a>  \|\|
790be231ba1a documentation boost pygame parents: diff changeset	16 <br> <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: 367 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  <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  <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>Channel</h2>
790be231ba1a documentation boost pygame parents: diff changeset	52 Channel objects represent a single channel of sound. Each channel
790be231ba1a documentation boost pygame parents: diff changeset	53 can only playback one Sound object at a time. If your application
790be231ba1a documentation boost pygame parents: diff changeset	54 only requires simply sound playback, you will usually not need to
790be231ba1a documentation boost pygame parents: diff changeset	55 bother with the Channel objects, they exist for finer playback
790be231ba1a documentation boost pygame parents: diff changeset	56 control.
151 638c600d92c7 documentation enhancements pygame parents: 148 diff changeset	57 <br> <br>
16 790be231ba1a documentation boost pygame parents: diff changeset	58 Sound objects can be retrieved from the pygame.mixer module with
88 ae6672503952 docs fixed pygame parents: 85 diff changeset	59 functions like <a href=pygame_mixer.html#Channel>pygame.mixer.Channel()</a> and
151 638c600d92c7 documentation enhancements pygame parents: 148 diff changeset	60 <a href=pygame_mixer.html#find_channel>pygame.mixer.find_channel()</a>. Also, each time you call
638c600d92c7 documentation enhancements pygame parents: 148 diff changeset	61 <a href=Sound.html#play>Sound.play()</a> a Channel object will be returned, representing the
16 790be231ba1a documentation boost pygame parents: diff changeset	62 channel that sound is playing on.
790be231ba1a documentation boost pygame parents: diff changeset	63
790be231ba1a documentation boost pygame parents: diff changeset	64 <hr>
790be231ba1a documentation boost pygame parents: diff changeset	65
790be231ba1a documentation boost pygame parents: diff changeset	66 <table>
790be231ba1a documentation boost pygame parents: diff changeset	67 <tr><td><a href=#fadeout>fadeout</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	68 fade out the channel</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	69
790be231ba1a documentation boost pygame parents: diff changeset	70
790be231ba1a documentation boost pygame parents: diff changeset	71 <tr><td><a href=#get_busy>get_busy</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	72 query state of the channel</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	73
790be231ba1a documentation boost pygame parents: diff changeset	74
428 463003fa6890 queue music and sounds pygame parents: 384 diff changeset	75 <tr><td><a href=#get_endevent>get_endevent</a></td><td> -
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	76 get the endevent for a channel</td></tr>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	77
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	78
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	79 <tr><td><a href=#get_queue>get_queue</a></td><td> -
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	80 get the currently queued sound object</td></tr>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	81
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	82
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	83 <tr><td><a href=#get_sound>get_sound</a></td><td> -
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	84 get the currently playing sound object</td></tr>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	85
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	86
16 790be231ba1a documentation boost pygame parents: diff changeset	87 <tr><td><a href=#get_volume>get_volume</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	88 query the volume for the</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	89
790be231ba1a documentation boost pygame parents: diff changeset	90
790be231ba1a documentation boost pygame parents: diff changeset	91 <tr><td><a href=#pause>pause</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	92 temporarily stop the channel</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	93
790be231ba1a documentation boost pygame parents: diff changeset	94
790be231ba1a documentation boost pygame parents: diff changeset	95 <tr><td><a href=#play>play</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	96 play a sound on this channel</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	97
790be231ba1a documentation boost pygame parents: diff changeset	98
428 463003fa6890 queue music and sounds pygame parents: 384 diff changeset	99 <tr><td><a href=#queue>queue</a></td><td> -
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	100 queue a sound on this channel</td></tr>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	101
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	102
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	103 <tr><td><a href=#set_endevent>set_endevent</a></td><td> -
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	104 set an endevent for a channel</td></tr>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	105
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	106
16 790be231ba1a documentation boost pygame parents: diff changeset	107 <tr><td><a href=#set_volume>set_volume</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	108 set volume for channel</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	109
790be231ba1a documentation boost pygame parents: diff changeset	110
790be231ba1a documentation boost pygame parents: diff changeset	111 <tr><td><a href=#stop>stop</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	112 stop playing on the channel</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	113
790be231ba1a documentation boost pygame parents: diff changeset	114
790be231ba1a documentation boost pygame parents: diff changeset	115 <tr><td><a href=#unpause>unpause</a></td><td> -
790be231ba1a documentation boost pygame parents: diff changeset	116 restart a paused channel</td></tr>
790be231ba1a documentation boost pygame parents: diff changeset	117
790be231ba1a documentation boost pygame parents: diff changeset	118
790be231ba1a documentation boost pygame parents: diff changeset	119 </table>
790be231ba1a documentation boost pygame parents: diff changeset	120
790be231ba1a documentation boost pygame parents: diff changeset	121 <hr>
790be231ba1a documentation boost pygame parents: diff changeset	122
790be231ba1a documentation boost pygame parents: diff changeset	123 <a name=fadeout><font size=+2><b>fadeout
790be231ba1a documentation boost pygame parents: diff changeset	124 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	125 Channel.fadeout(millisec) -> None
790be231ba1a documentation boost pygame parents: diff changeset	126 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	127 Fade out the playing sound and stops it over the
255 25b933a57715 key_repeat checks errors pygame parents: 250 diff changeset	128 given milliseconds.
16 790be231ba1a documentation boost pygame parents: diff changeset	129 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	130
790be231ba1a documentation boost pygame parents: diff changeset	131 <a name=get_busy><font size=+2><b>get_busy
790be231ba1a documentation boost pygame parents: diff changeset	132 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	133 Channel.get_busy() -> bool
790be231ba1a documentation boost pygame parents: diff changeset	134 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	135 Returns true when there is a sound actively playing on this
790be231ba1a documentation boost pygame parents: diff changeset	136 channel.
790be231ba1a documentation boost pygame parents: diff changeset	137 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	138
428 463003fa6890 queue music and sounds pygame parents: 384 diff changeset	139 <a name=get_endevent><font size=+2><b>get_endevent
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	140 </b></font><br><font size=+1><tt>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	141 Channel.get_endevent() -> event_type
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	142 </tt></font><ul>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	143 Returns the end event type for this Channel. If the
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	144 return value is NOEVENT, then no events will be sent
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	145 when playback ends.
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	146 </ul><br> <br>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	147
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	148 <a name=get_queue><font size=+2><b>get_queue
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	149 </b></font><br><font size=+1><tt>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	150 Channel.get_queue() -> Sound
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	151 </tt></font><ul>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	152 Return the currently queued Sound object on this channel.
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	153 This will return None if there is nothing queued.
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	154 </ul><br> <br>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	155
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	156 <a name=get_sound><font size=+2><b>get_sound
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	157 </b></font><br><font size=+1><tt>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	158 Channel.get_sound() -> Sound
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	159 </tt></font><ul>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	160 Return the currently playing Sound object on this channel.
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	161 This will return None if there is nothing playing.
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	162 </ul><br> <br>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	163
16 790be231ba1a documentation boost pygame parents: diff changeset	164 <a name=get_volume><font size=+2><b>get_volume
790be231ba1a documentation boost pygame parents: diff changeset	165 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	166 Channel.get_volume() -> val
790be231ba1a documentation boost pygame parents: diff changeset	167 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	168 Returns the current volume for this sound object. The value is
790be231ba1a documentation boost pygame parents: diff changeset	169 between 0.0 and 1.0.
790be231ba1a documentation boost pygame parents: diff changeset	170 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	171
790be231ba1a documentation boost pygame parents: diff changeset	172 <a name=pause><font size=+2><b>pause
790be231ba1a documentation boost pygame parents: diff changeset	173 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	174 Channel.pause() -> None
790be231ba1a documentation boost pygame parents: diff changeset	175 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	176 Stops the sound that is playing on this channel,
164 0b7607cf25ae mouse docs cleared up pygame parents: 157 diff changeset	177 but it can be resumed with a call to <a href=#unpause>unpause()</a>
16 790be231ba1a documentation boost pygame parents: diff changeset	178 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	179
790be231ba1a documentation boost pygame parents: diff changeset	180 <a name=play><font size=+2><b>play
790be231ba1a documentation boost pygame parents: diff changeset	181 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	182 Channel.play(Sound, [loops, [maxtime]]) -> None
790be231ba1a documentation boost pygame parents: diff changeset	183 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	184 Starts playing a given sound on this channel. If the channels is
790be231ba1a documentation boost pygame parents: diff changeset	185 currently playing a different sound, it will be
790be231ba1a documentation boost pygame parents: diff changeset	186 replaced/restarted with the given sound. Loops controls how many
790be231ba1a documentation boost pygame parents: diff changeset	187 extra times the sound will play, a negative loop will play
790be231ba1a documentation boost pygame parents: diff changeset	188 indefinitely, it defaults to 0. Maxtime is the number of
790be231ba1a documentation boost pygame parents: diff changeset	189 totalmilliseconds that the sound will play. It defaults to
790be231ba1a documentation boost pygame parents: diff changeset	190 forever (-1).
790be231ba1a documentation boost pygame parents: diff changeset	191 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	192
428 463003fa6890 queue music and sounds pygame parents: 384 diff changeset	193 <a name=queue><font size=+2><b>queue
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	194 </b></font><br><font size=+1><tt>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	195 Channel.queue(Sound) -> None
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	196 </tt></font><ul>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	197 When you queue a sound on a channel, it will begin playing
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	198 immediately when the current playing sound finishes. Each
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	199 channel can only have a single Sound object queued. The
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	200 queued sound will only play when the current Sound finishes
435 f3ef1ecb814a experimental tilerow drawer pygame parents: 428 diff changeset	201 naturally, not from another call to <a href=Sound.html#stop>stop()</a> or <a href=Sound.html#play>play()</a>.
428 463003fa6890 queue music and sounds pygame parents: 384 diff changeset	202 <br> <br>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	203 If there is no currently playing sound on this Channel
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	204 it will begin playback immediately.
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	205 <br> <br>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	206 This will only work with SDL_mixer greater than version 1.2.3
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	207 </ul><br> <br>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	208
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	209 <a name=set_endevent><font size=+2><b>set_endevent
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	210 </b></font><br><font size=+1><tt>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	211 Channel.set_endevent([event_type]) -> None
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	212 </tt></font><ul>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	213 When you set an endevent for a channel, that event type
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	214 will be put on the pygame event queue everytime a sound stops
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	215 playing on that channel. This is slightly different than the
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	216 music object end event, because this will trigger an event
435 f3ef1ecb814a experimental tilerow drawer pygame parents: 428 diff changeset	217 anytime the music stops. If you call <a href=Sound.html#stop>stop()</a> or <a href=Sound.html#play>play()</a> on the
428 463003fa6890 queue music and sounds pygame parents: 384 diff changeset	218 channel, it will fire an event. An event will also be fired when
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	219 playback switches to a queued Sound.
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	220 <br> <br>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	221 Pass no argument to stop this channel from firing events
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	222 </ul><br> <br>
463003fa6890 queue music and sounds pygame parents: 384 diff changeset	223
16 790be231ba1a documentation boost pygame parents: diff changeset	224 <a name=set_volume><font size=+2><b>set_volume
790be231ba1a documentation boost pygame parents: diff changeset	225 </b></font><br><font size=+1><tt>
367 b1fa4546ec8d mixer enhancements pygame parents: 359 diff changeset	226 Channel.set_volume(val, [stereoval]) -> None
16 790be231ba1a documentation boost pygame parents: diff changeset	227 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	228 Sets the volume for the channel. The channel's volume level is
790be231ba1a documentation boost pygame parents: diff changeset	229 mixed with the volume for the active sound object. The value is
790be231ba1a documentation boost pygame parents: diff changeset	230 between 0.0 and 1.0.
367 b1fa4546ec8d mixer enhancements pygame parents: 359 diff changeset	231 <br> <br>
b1fa4546ec8d mixer enhancements pygame parents: 359 diff changeset	232 If mixer is using stereo, you can set the panning for audio
b1fa4546ec8d mixer enhancements pygame parents: 359 diff changeset	233 by supplying a volume for the left and right channels. If
b1fa4546ec8d mixer enhancements pygame parents: 359 diff changeset	234 SDL_mixer cannot set the panning, it will average the two
b1fa4546ec8d mixer enhancements pygame parents: 359 diff changeset	235 volumes. Panning requires SDL_mixer-1.2.1.
16 790be231ba1a documentation boost pygame parents: diff changeset	236 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	237
790be231ba1a documentation boost pygame parents: diff changeset	238 <a name=stop><font size=+2><b>stop
790be231ba1a documentation boost pygame parents: diff changeset	239 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	240 Channel.stop() -> None
790be231ba1a documentation boost pygame parents: diff changeset	241 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	242 Stops the sound that is playing on this channel.
790be231ba1a documentation boost pygame parents: diff changeset	243 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	244
790be231ba1a documentation boost pygame parents: diff changeset	245 <a name=unpause><font size=+2><b>unpause
790be231ba1a documentation boost pygame parents: diff changeset	246 </b></font><br><font size=+1><tt>
790be231ba1a documentation boost pygame parents: diff changeset	247 Channel.unpause() -> None
790be231ba1a documentation boost pygame parents: diff changeset	248 </tt></font><ul>
790be231ba1a documentation boost pygame parents: diff changeset	249 Restarts a paused channel where it was paused.
790be231ba1a documentation boost pygame parents: diff changeset	250 </ul><br> <br>
790be231ba1a documentation boost pygame parents: diff changeset	251
790be231ba1a documentation boost pygame parents: diff changeset	252
790be231ba1a documentation boost pygame parents: diff changeset	253 <hr>
790be231ba1a documentation boost pygame parents: diff changeset	254 </body></html>

Mercurial > pygame

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