<html><head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Sdl" rel="Chapter" href="Sdl.html">
<link title="Sdlcdrom" rel="Chapter" href="Sdlcdrom.html">
<link title="Sdltimer" rel="Chapter" href="Sdltimer.html">
<link title="Sdljoystick" rel="Chapter" href="Sdljoystick.html">
<link title="Sdlkey" rel="Chapter" href="Sdlkey.html">
<link title="Sdlmouse" rel="Chapter" href="Sdlmouse.html">
<link title="Sdlevent" rel="Chapter" href="Sdlevent.html">
<link title="Sdlvideo" rel="Chapter" href="Sdlvideo.html">
<link title="Sdlwm" rel="Chapter" href="Sdlwm.html">
<link title="Sdlttf" rel="Chapter" href="Sdlttf.html">
<link title="Sdlloader" rel="Chapter" href="Sdlloader.html">
<link title="Sdlmixer" rel="Chapter" href="Sdlmixer.html">
<link title="Sdlgfx" rel="Chapter" href="Sdlgfx.html"><title>OCamlSDL 0.9.1 : Sdlmixer</title>
</head>
<body>
<code class="code"><span class="keyword">sig</span><br>
<span class="keyword">exception</span> <span class="constructor">SDLmixer_exception</span> <span class="keyword">of</span> string<br>
<span class="keyword">val</span> version : unit <span class="keywordsign">-></span> <span class="constructor">Sdl</span>.version<br>
<span class="keyword">type</span> format =<br>
<span class="constructor">AUDIO_FORMAT_U8</span><br>
<span class="keywordsign">|</span> <span class="constructor">AUDIO_FORMAT_S8</span><br>
<span class="keywordsign">|</span> <span class="constructor">AUDIO_FORMAT_U16LSB</span><br>
<span class="keywordsign">|</span> <span class="constructor">AUDIO_FORMAT_S16LSB</span><br>
<span class="keywordsign">|</span> <span class="constructor">AUDIO_FORMAT_U16MSB</span><br>
<span class="keywordsign">|</span> <span class="constructor">AUDIO_FORMAT_S16MSB</span><br>
<span class="keywordsign">|</span> <span class="constructor">AUDIO_FORMAT_U16SYS</span><br>
<span class="keywordsign">|</span> <span class="constructor">AUDIO_FORMAT_S16SYS</span><br>
<span class="keyword">type</span> channels = <span class="constructor">MONO</span> <span class="keywordsign">|</span> <span class="constructor">STEREO</span><br>
<span class="keyword">val</span> open_audio :<br>
?freq:int <span class="keywordsign">-></span><br>
?format:<span class="constructor">Sdlmixer</span>.format <span class="keywordsign">-></span><br>
?chunksize:int <span class="keywordsign">-></span> ?channels:<span class="constructor">Sdlmixer</span>.channels <span class="keywordsign">-></span> unit <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> close_audio : unit <span class="keywordsign">-></span> unit<br>
<span class="keyword">type</span> specs = {<br>
frequency : int;<br>
format : <span class="constructor">Sdlmixer</span>.format;<br>
channels : <span class="constructor">Sdlmixer</span>.channels;<br>
}<br>
<span class="keyword">val</span> query_specs : unit <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.specs<br>
<span class="keyword">type</span> chunk<br>
<span class="keyword">val</span> loadWAV : string <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.chunk<br>
<span class="keyword">val</span> loadWAV_from_mem : string <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.chunk<br>
<span class="keyword">val</span> load_string : string <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.chunk<br>
<span class="keyword">val</span> load_string_raw : string <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.chunk<br>
<span class="keyword">val</span> volume_chunk : <span class="constructor">Sdlmixer</span>.chunk <span class="keywordsign">-></span> float<br>
<span class="keyword">val</span> setvolume_chunk : <span class="constructor">Sdlmixer</span>.chunk <span class="keywordsign">-></span> float <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> free_chunk : <span class="constructor">Sdlmixer</span>.chunk <span class="keywordsign">-></span> unit<br>
<span class="keyword">type</span> channel = int<br>
<span class="keyword">val</span> all_channels : <span class="constructor">Sdlmixer</span>.channel<br>
<span class="keyword">val</span> num_channels : unit <span class="keywordsign">-></span> int<br>
<span class="keyword">val</span> allocate_channels : int <span class="keywordsign">-></span> int<br>
<span class="keyword">val</span> play_channel :<br>
?channel:<span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span><br>
?loops:int <span class="keywordsign">-></span> ?ticks:float <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.chunk <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> play_sound : <span class="constructor">Sdlmixer</span>.chunk <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> fadein_channel :<br>
?channel:<span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span><br>
?loops:int <span class="keywordsign">-></span> ?ticks:float <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.chunk <span class="keywordsign">-></span> float <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> volume_channel : <span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span> float<br>
<span class="keyword">val</span> setvolume_channel : <span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span> float <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> pause_channel : <span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> resume_channel : <span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> halt_channel : <span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> expire_channel : <span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span> float option <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> fadeout_channel : <span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span> float <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> playing_channel : <span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span> bool<br>
<span class="keyword">val</span> num_playing_channel : unit <span class="keywordsign">-></span> int<br>
<span class="keyword">val</span> paused_channel : <span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span> bool<br>
<span class="keyword">val</span> num_paused_channel : unit <span class="keywordsign">-></span> int<br>
<span class="keyword">type</span> fade_status = <span class="constructor">NO_FADING</span> <span class="keywordsign">|</span> <span class="constructor">FADING_OUT</span> <span class="keywordsign">|</span> <span class="constructor">FADING_IN</span><br>
<span class="keyword">val</span> fading_channel : <span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.fade_status<br>
<span class="keyword">type</span> group = int<br>
<span class="keyword">val</span> default_group : <span class="constructor">Sdlmixer</span>.group<br>
<span class="keyword">val</span> reserve_channels : int <span class="keywordsign">-></span> int<br>
<span class="keyword">val</span> group_channel : <span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.group <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> group_channels :<br>
from_c:<span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span><br>
to_c:<span class="constructor">Sdlmixer</span>.channel <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.group <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> group_count : <span class="constructor">Sdlmixer</span>.group <span class="keywordsign">-></span> int<br>
<span class="keyword">val</span> group_available : <span class="constructor">Sdlmixer</span>.group <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.channel<br>
<span class="keyword">val</span> group_oldest : <span class="constructor">Sdlmixer</span>.group <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.channel<br>
<span class="keyword">val</span> group_newer : <span class="constructor">Sdlmixer</span>.group <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.channel<br>
<span class="keyword">val</span> fadeout_group : <span class="constructor">Sdlmixer</span>.group <span class="keywordsign">-></span> float <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> halt_group : <span class="constructor">Sdlmixer</span>.group <span class="keywordsign">-></span> unit<br>
<span class="keyword">type</span> music<br>
<span class="keyword">type</span> music_kind = <span class="constructor">NONE</span> <span class="keywordsign">|</span> <span class="constructor">CMD</span> <span class="keywordsign">|</span> <span class="constructor">WAV</span> <span class="keywordsign">|</span> <span class="constructor">MOD</span> <span class="keywordsign">|</span> <span class="constructor">MID</span> <span class="keywordsign">|</span> <span class="constructor">OGG</span> <span class="keywordsign">|</span> <span class="constructor">MP3</span><br>
<span class="keyword">val</span> load_music : string <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.music<br>
<span class="keyword">val</span> free_music : <span class="constructor">Sdlmixer</span>.music <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> play_music : ?loops:int <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.music <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> fadein_music : ?loops:int <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.music <span class="keywordsign">-></span> float <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> volume_music : unit <span class="keywordsign">-></span> float<br>
<span class="keyword">val</span> setvolume_music : float <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> pause_music : unit <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> resume_music : unit <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> rewind_music : unit <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> set_music_cmd : string <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> unset_music_cmd : unit <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> halt_music : unit <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> fadeout_music : float <span class="keywordsign">-></span> unit<br>
<span class="keyword">val</span> music_type : <span class="constructor">Sdlmixer</span>.music option <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.music_kind<br>
<span class="keyword">val</span> playing_music : unit <span class="keywordsign">-></span> bool<br>
<span class="keyword">val</span> paused_music : unit <span class="keywordsign">-></span> bool<br>
<span class="keyword">val</span> fading_music : unit <span class="keywordsign">-></span> <span class="constructor">Sdlmixer</span>.fade_status<br>
<span class="keyword">end</span></code></body></html>
