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