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