Commit | Line | Data |
b82df135 |
1 | <div class="pod"> |
2 | <!-- INDEX START --> |
3 | <h3 id="TOP">Index</h3> |
4 | |
5 | <ul><li><a href="#NAME">NAME</a></li> |
8758037a |
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="#open_audio">open_audio</a></li> |
10 | <li><a href="#PauseAudio">PauseAudio </a></li> |
11 | <li><a href="#GetAudioStatus">GetAudioStatus </a></li> |
12 | <li><a href="#LoadWAV">LoadWAV </a></li> |
13 | <li><a href="#FreeWAV">FreeWAV </a></li> |
14 | <li><a href="#AudioCVT">AudioCVT </a></li> |
15 | <li><a href="#BuildAudioCVT">BuildAudioCVT </a></li> |
16 | <li><a href="#ConvertAudio">ConvertAudio </a></li> |
17 | <li><a href="#MixAudio">MixAudio </a></li> |
18 | <li><a href="#LockAudio">LockAudio</a></li> |
19 | <li><a href="#UnlockAudio">UnlockAudio</a></li> |
20 | <li><a href="#CloseAudio">CloseAudio </a> |
21 | </li> |
22 | </ul> |
b82df135 |
23 | </li> |
24 | </ul><hr /> |
25 | <!-- INDEX END --> |
26 | |
27 | <h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p> |
28 | <div id="NAME_CONTENT"> |
29 | <p>SDL::Audio -- SDL Bindings for Audio</p> |
30 | |
31 | </div> |
32 | <h1 id="CATEGORY">CATEGORY</h1><p><a href="#TOP" class="toplink">Top</a></p> |
33 | <div id="CATEGORY_CONTENT"> |
34 | <p>TODO, Core, Audio</p> |
35 | |
36 | </div> |
8758037a |
37 | <h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p> |
38 | <div id="DESCRIPTION_CONTENT"> |
39 | |
40 | |
41 | |
42 | |
43 | |
44 | </div> |
45 | <h1 id="METHODS">METHODS</h1><p><a href="#TOP" class="toplink">Top</a></p> |
46 | <div id="METHODS_CONTENT"> |
47 | |
48 | </div> |
49 | <h2 id="open_audio">open_audio</h2> |
50 | <div id="open_audio_CONTENT"> |
51 | <p>Opens the audio device with the desired parameters.</p> |
52 | |
53 | </div> |
54 | <h2 id="PauseAudio">PauseAudio </h2> |
55 | <div id="PauseAudio_CONTENT"> |
56 | <p>Pauses and unpauses the audio callback processing</p> |
57 | |
58 | </div> |
59 | <h2 id="GetAudioStatus">GetAudioStatus </h2> |
60 | <div id="GetAudioStatus_CONTENT"> |
61 | <p>Gets the current audio state</p> |
62 | |
63 | </div> |
64 | <h2 id="LoadWAV">LoadWAV </h2> |
65 | <div id="LoadWAV_CONTENT"> |
66 | <p>Loads a WAVE file</p> |
67 | |
68 | </div> |
69 | <h2 id="FreeWAV">FreeWAV </h2> |
70 | <div id="FreeWAV_CONTENT"> |
71 | <p>Frees previously opened WAV data</p> |
72 | |
73 | </div> |
74 | <h2 id="AudioCVT">AudioCVT </h2> |
75 | <div id="AudioCVT_CONTENT"> |
76 | <p>Audio Conversion Structure</p> |
77 | |
78 | </div> |
79 | <h2 id="BuildAudioCVT">BuildAudioCVT </h2> |
80 | <div id="BuildAudioCVT_CONTENT"> |
81 | <p>Initializes a SDL_AudioCVT - structure for conversion</p> |
82 | |
83 | </div> |
84 | <h2 id="ConvertAudio">ConvertAudio </h2> |
85 | <div id="ConvertAudio_CONTENT"> |
86 | <p>Converts audio data to a desired audio format.</p> |
87 | |
88 | </div> |
89 | <h2 id="MixAudio">MixAudio </h2> |
90 | <div id="MixAudio_CONTENT"> |
91 | <p>Mixes audio data</p> |
92 | |
93 | </div> |
94 | <h2 id="LockAudio">LockAudio</h2> |
95 | <div id="LockAudio_CONTENT"> |
96 | <p>Locks out the callback function</p> |
97 | |
98 | </div> |
99 | <h2 id="UnlockAudio">UnlockAudio</h2> |
100 | <div id="UnlockAudio_CONTENT"> |
101 | <p>Unlocks the callback function</p> |
102 | |
103 | </div> |
104 | <h2 id="CloseAudio">CloseAudio </h2> |
105 | <div id="CloseAudio_CONTENT"> |
106 | <p>Shuts down audio processing and closes the audio device. </p> |
107 | |
108 | </div> |
b82df135 |
109 | </div> |