updated docs
[sdlgit/SDL-Site.git] / pages / SDL-Mixer-MixChunk.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="#alen">alen</a></li>
11 <li><a href="#volume">volume</a></li>
12 </ul>
13 </li>
14 <li><a href="#AUTHORS">AUTHORS</a>
15 </li>
16 </ul><hr />
17 <!-- INDEX END -->
18
19 <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
20 <div id="NAME_CONTENT">
21 <p>SDL::Mixer::MixChunk -- SDL Bindings for structure SDL_MixChunk</p>
22
23 </div>
24 <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p>
25 <div id="CATEGORY_CONTENT">
26 <p>Mixer, Structure</p>
27
28 </div>
29 <h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
30 <div id="SYNOPSIS_CONTENT">
31 <pre> use SDL;
32  use SDL::Mixer::MixChunk;
33
34  my $mix_chunk = SDL::Mixer::Music::load_WAV('sample.wav');
35
36  printf(&quot;length of audio data is %d bytes\n&quot;, $mix_chunk-&gt;alen);
37  printf(&quot;volume is %d\n&quot;,                     $mix_chunk-&gt;volume);
38
39 </pre>
40
41 </div>
42 <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
43 <div id="DESCRIPTION_CONTENT">
44 <p>Stores audio data in memory.</p>
45 <p><strong>Note:</strong> It's a bad idea to free a chunk that is still being played...</p>
46
47 </div>
48 <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p>
49 <div id="METHODS_CONTENT">
50
51 </div>
52 <h2 id="alen">alen</h2>
53 <div id="alen_CONTENT">
54 <p>length of audio data in bytes</p>
55
56 </div>
57 <h2 id="volume">volume</h2>
58 <div id="volume_CONTENT">
59 <p>Per-sample volume, 0-128 (normally <code>MIX_MAX_VOLUME</code> after loading)</p>
60
61 </div>
62 <h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
63 <div id="AUTHORS_CONTENT">
64 <p>See <b>AUTHORS</b> in <cite>SDL</cite>.</p>
65
66 </div>
67 </div>