pages/SDL-Mixer.html-inc

   1 <div class="pod">
   2 <!-- INDEX START -->
   3 <h3 id="TOP">Index</h3>
   4
   5 <ul><li><a href="#NAME">NAME</a></li>
   6 <li><a href="#CATEGORY">CATEGORY</a></li>
   7 <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
   8 <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
   9 <li><a href="#METHODS">METHODS</a>
  10 <ul><li><a href="#new">new()</a></li>
  11 <li><a href="#query_spec">query_spec()</a></li>
  12 <li><a href="#reserve_channels">reserve_channels</a></li>
  13 <li><a href="#allocate_channels">allocate_channels()</a></li>
  14 <li><a href="#group_channel_channel_group">group_channel(channel,group)</a></li>
  15 <li><a href="#group_channels_from_to_group">group_channels(from,to,group)</a></li>
  16 <li><a href="#group_available_group">group_available(group)</a></li>
  17 <li><a href="#group_count_group">group_count(group)</a></li>
  18 <li><a href="#group_oldest">group_oldest()</a></li>
  19 <li><a href="#group_newer">group_newer()</a></li>
  20 <li><a href="#play_channel">play_channel()</a></li>
  21 <li><a href="#play_music">play_music()</a></li>
  22 <li><a href="#fade_in_channel_channel_chunk_loops_">fade_in_channel(channel,chunk,loops,ms,ticks)</a></li>
  23 <li><a href="#fade_in_music_music_loops_ms">fade_in_music(music,loops,ms)</a></li>
  24 <li><a href="#channel_volume_channel_volume">channel_volume(channel,volume)</a></li>
  25 <li><a href="#mucis_volume_volume">mucis_volume(volume)</a></li>
  26 <li><a href="#halt_channel_channel">halt_channel(channel)</a></li>
  27 <li><a href="#halt_group_group">halt_group(group)</a></li>
  28 <li><a href="#halt_music">halt_music()</a></li>
  29 <li><a href="#channel_expire_channel_ticks">channel_expire(channel,ticks)</a></li>
  30 <li><a href="#fade_out_channel_channel_ms">fade_out_channel(channel,ms)</a></li>
  31 <li><a href="#fade_out_group_group_ms">fade_out_group(group,ms)</a></li>
  32 <li><a href="#fade_out_music_ms">fade_out_music(ms)</a></li>
  33 <li><a href="#fading_music">fading_music()</a></li>
  34 <li><a href="#fading_channel">fading_channel()</a></li>
  35 <li><a href="#pause_channel">pause( channel )</a></li>
  36 <li><a href="#resume_channel">resume(channel)</a></li>
  37 <li><a href="#paused">paused()</a></li>
  38 <li><a href="#pause_music">pause_music()</a></li>
  39 <li><a href="#resume_music">resume_music()</a></li>
  40 <li><a href="#rewind_music">rewind_music()</a></li>
  41 <li><a href="#music_paused">music_paused()</a></li>
  42 <li><a href="#playing">playing()</a></li>
  43 <li><a href="#playing_music">playing_music ()</a></li>
  44 </ul>
  45 </li>
  46 <li><a href="#set_panning_channel_left_right">set_panning($channel, $left, $right)</a></li>
  47 <li><a href="#AUTHORS">AUTHORS </a></li>
  48 <li><a href="#SEE_ALSO">SEE ALSO</a>
  49 </li>
  50 </ul><hr />
  51 <!-- INDEX END -->
  52
  53 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
  54 <div id="NAME_CONTENT">
  55 <p>SDL::Mixer - a SDL perl extension</p>
  56
  57 </div>
  58 <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
  59 <div id="CATEGORY_CONTENT">
  60 <p>Mixer</p>
  61
  62 </div>
  63 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
  64 <div id="SYNOPSIS_CONTENT">
  65 <pre>  $mixer = new SDL::Mixer  -frequency =&gt; MIX_DEFAULT_FREQUENCY,
  66                                 -format =&gt; MIX_DEFAULT_FORMAT,
  67                                 -channels =&gt; MIX_DEFAULT_CHANNELS,
  68                                 -size =&gt; 4096;
  69
  70 </pre>
  71
  72 </div>
  73 <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
  74 <div id="DESCRIPTION_CONTENT">
  75 <p>SDL::Mixer allows you access to the SDL mixer library, enablig sound and
  76 music volume setting, playing, pausing and resuming, as well as fading
  77 the sound and music in and out.</p>
  78
  79 </div>
  80 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
  81 <div id="METHODS_CONTENT">
  82
  83 </div>
  84 <h2 id="new">new()</h2>
  85 <div id="new_CONTENT">
  86 <pre>   $mixer = SDL::Mixer-&gt;new(    -frequency =&gt; MIX_DEFAULT_FREQUENCY,
  87                                         -format    =&gt; MIX_DEFAULT_FORMAT,
  88                                         -channels  =&gt; MIX_DEFAULT_CHANNELS,
  89                                         -size      =&gt; 4096);
  90
  91 </pre>
  92 <p>Creates a new SDL::Mixer object. <code>$size</code> is the buffer size in bytes.</p>
  93
  94 </div>
  95 <h2 id="query_spec">query_spec()</h2>
  96 <div id="query_spec_CONTENT">
  97 <pre>   my $specs = SDL::Mixer::query_spec();
  98
  99 </pre>
 100 <p>Returns a hash reference, containing the following keys and their respective
 101 values:</p>
 102 <pre>   -status
 103         -frequency
 104         -channels
 105         -format
 106
 107 </pre>
 108
 109 </div>
 110 <h2 id="reserve_channels">reserve_channels</h2>
 111 <div id="reserve_channels_CONTENT">
 112 <pre>   $mixer-&gt;reserve_channels(4);
 113
 114 </pre>
 115 <p>Reserve so many channels.</p>
 116
 117 </div>
 118 <h2 id="allocate_channels">allocate_channels()</h2>
 119 <div id="allocate_channels_CONTENT">
 120 <pre>   $mixer-&gt;reserve_channels(2);
 121
 122 </pre>
 123 <p>Allocate so many channels.</p>
 124
 125 </div>
 126 <h2 id="group_channel_channel_group">group_channel(channel,group)</h2>
 127 <div id="group_channel_channel_group_CONTENT">
 128 <p>Group the channel number <code>$channel</code> into group <code>$group</code>.</p>
 129
 130 </div>
 131 <h2 id="group_channels_from_to_group">group_channels(from,to,group)</h2>
 132 <div id="group_channels_from_to_group_CONTENT">
 133 <p>Groups a range of channels</p>
 134
 135 </div>
 136 <h2 id="group_available_group">group_available(group)</h2>
 137 <div id="group_available_group_CONTENT">
 138 <p>Return true when the group is available.</p>
 139
 140 </div>
 141 <h2 id="group_count_group">group_count(group)</h2>
 142 <div id="group_count_group_CONTENT">
 143 <p>Returns the number of channels in the group</p>
 144
 145 </div>
 146 <h2 id="group_oldest">group_oldest()</h2>
 147 <div id="group_oldest_CONTENT">
 148
 149
 150
 151
 152
 153 </div>
 154 <h2 id="group_newer">group_newer()</h2>
 155 <div id="group_newer_CONTENT">
 156
 157
 158
 159
 160
 161 </div>
 162 <h2 id="play_channel">play_channel()</h2>
 163 <div id="play_channel_CONTENT">
 164
 165
 166
 167
 168
 169 </div>
 170 <h2 id="play_music">play_music()</h2>
 171 <div id="play_music_CONTENT">
 172 <p>Play <code>$music</code> <code>$loop</code> times.</p>
 173
 174 </div>
 175 <h2 id="fade_in_channel_channel_chunk_loops_">fade_in_channel(channel,chunk,loops,ms,ticks)</h2>
 176 <div id="fade_in_channel_channel_chunk_loops_-2">
 177 <p>Fades a channel in</p>
 178
 179 </div>
 180 <h2 id="fade_in_music_music_loops_ms">fade_in_music(music,loops,ms)</h2>
 181 <div id="fade_in_music_music_loops_ms_CONTENT">
 182 <p>Fades the music in over a number of ms, looping as it does</p>
 183
 184 </div>
 185 <h2 id="channel_volume_channel_volume">channel_volume(channel,volume)</h2>
 186 <div id="channel_volume_channel_volume_CONTEN">
 187 <p>Sets the volume for a single channel</p>
 188
 189 </div>
 190 <h2 id="mucis_volume_volume">mucis_volume(volume)</h2>
 191 <div id="mucis_volume_volume_CONTENT">
 192 <p>Set the volume for the music.</p>
 193
 194 </div>
 195 <h2 id="halt_channel_channel">halt_channel(channel)</h2>
 196 <div id="halt_channel_channel_CONTENT">
 197 <p>Stops a specific channel</p>
 198
 199 </div>
 200 <h2 id="halt_group_group">halt_group(group)</h2>
 201 <div id="halt_group_group_CONTENT">
 202 <p>Stops a group of channels</p>
 203
 204 </div>
 205 <h2 id="halt_music">halt_music()</h2>
 206 <div id="halt_music_CONTENT">
 207 <p>Stops the music</p>
 208
 209 </div>
 210 <h2 id="channel_expire_channel_ticks">channel_expire(channel,ticks)</h2>
 211 <div id="channel_expire_channel_ticks_CONTENT">
 212 <p>Ignores the channel after <code>ticks</code> has expired</p>
 213
 214 </div>
 215 <h2 id="fade_out_channel_channel_ms">fade_out_channel(channel,ms)</h2>
 216 <div id="fade_out_channel_channel_ms_CONTENT">
 217 <p>Fade the channel number <code>$channel</code> in <code>$ms</code> ms out.</p>
 218
 219 </div>
 220 <h2 id="fade_out_group_group_ms">fade_out_group(group,ms)</h2>
 221 <div id="fade_out_group_group_ms_CONTENT">
 222 <p>Fade the channel group <code>$group</code> in <code>$ms</code> ms out.</p>
 223
 224 </div>
 225 <h2 id="fade_out_music_ms">fade_out_music(ms)</h2>
 226 <div id="fade_out_music_ms_CONTENT">
 227 <p>Fade the music in <code>$ms</code> ms out.</p>
 228
 229 </div>
 230 <h2 id="fading_music">fading_music()</h2>
 231 <div id="fading_music_CONTENT">
 232 <p>Return true when the music is currently fading in or out.</p>
 233
 234 </div>
 235 <h2 id="fading_channel">fading_channel()</h2>
 236 <div id="fading_channel_CONTENT">
 237 <p>Return true when the channel number <code>$channel</code> is currently fading in or out.</p>
 238
 239 </div>
 240 <h2 id="pause_channel">pause( channel )</h2>
 241 <div id="pause_channel_CONTENT">
 242 <p>Pause the channel <code>$channel</code>.</p>
 243
 244 </div>
 245 <h2 id="resume_channel">resume(channel)</h2>
 246 <div id="resume_channel_CONTENT">
 247 <p>Resume the channel <code>$channel</code>.</p>
 248
 249 </div>
 250 <h2 id="paused">paused()</h2>
 251 <div id="paused_CONTENT">
 252 <p>Return true when the channel is currently paused.</p>
 253
 254 </div>
 255 <h2 id="pause_music">pause_music()</h2>
 256 <div id="pause_music_CONTENT">
 257 <p>Pause the music play.</p>
 258
 259 </div>
 260 <h2 id="resume_music">resume_music()</h2>
 261 <div id="resume_music_CONTENT">
 262 <p>Resume the music play.</p>
 263
 264 </div>
 265 <h2 id="rewind_music">rewind_music()</h2>
 266 <div id="rewind_music_CONTENT">
 267 <p>Resets the music file to the beginning</p>
 268
 269 </div>
 270 <h2 id="music_paused">music_paused()</h2>
 271 <div id="music_paused_CONTENT">
 272 <p>Return true when the music is currently paused.</p>
 273
 274 </div>
 275 <h2 id="playing">playing()</h2>
 276 <div id="playing_CONTENT">
 277 <p>Return true when the channel is currently playing.</p>
 278
 279 </div>
 280 <h2 id="playing_music">playing_music ()</h2>
 281 <div id="playing_music_CONTENT">
 282 <p>Return true when the music is currently playing.</p>
 283
 284 </div>
 285 <h1 id="set_panning_channel_left_right">set_panning($channel, $left, $right)</h1><p><a href="#TOP" class="toplink">Top</a></p>
 286 <div id="set_panning_channel_left_right_CONTE">
 287 <p>Sets the volume for the left or right channels. To do true panning:</p>
 288
 289 </div>
 290 <h1 id="AUTHORS">AUTHORS </h1><p><a href="#TOP" class="toplink">Top</a></p>
 291 <div id="AUTHORS_CONTENT">
 292 <p>David J. Goehrig, basic doc added by Tels &lt;http://bloodgate.com&gt;.</p>
 293
 294 </div>
 295 <h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
 296 <div id="SEE_ALSO_CONTENT">
 297 <p><cite>perl</cite>, <cite>SDL::Music</cite> and <cite>SDL::Sound</cite>.</p>
 298
 299 </div>
 300 </div>