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