diff options
Diffstat (limited to 'manuals/guile-sdl2/Sound.html')
| -rw-r--r-- | manuals/guile-sdl2/Sound.html | 303 |
1 files changed, 0 insertions, 303 deletions
diff --git a/manuals/guile-sdl2/Sound.html b/manuals/guile-sdl2/Sound.html deleted file mode 100644 index 6dab26a..0000000 --- a/manuals/guile-sdl2/Sound.html +++ /dev/null @@ -1,303 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Copyright (C) 2016, 2017, 2018, 2019 David Thompson davet@gnu.org - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 -or any later version published by the Free Software Foundation; -with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. -A copy of the license is included in the section entitled "GNU -Free Documentation License". - -A copy of the license is also available from the Free Software -Foundation Web site at http://www.gnu.org/licenses/fdl.html. - - -* Guile-SDL2: (guile-sdl2). SDL2 bindings for Guile. - -The document was typeset with -http://www.texinfo.org/ (GNU Texinfo). - --> -<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<title>Sound (Guile-SDL2)</title> - -<meta name="description" content="Sound (Guile-SDL2)"> -<meta name="keywords" content="Sound (Guile-SDL2)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<link href="index.html" rel="start" title="Top"> -<link href="Index.html" rel="index" title="Index"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="API-Reference.html" rel="up" title="API Reference"> -<link href="Fonts.html" rel="next" title="Fonts"> -<link href="Images.html" rel="prev" title="Images"> -<style type="text/css"> -<!-- -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -div.lisp {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -ul.no-bullet {list-style: none} -@media (min-width: 1140px) { - body { - margin-left: 14rem; - margin-right: 4rem; - max-width: 52rem; - } -} - -@media (min-width: 800px) and (max-width: 1140px) { - body { - margin-left: 6rem; - margin-right: 4rem; - max-width: 52rem; - } -} - -@media (max-width: 800px) { - body { - margin: 1rem; - } -} - ---> -</style> -<link rel="stylesheet" type="text/css" href="https://dthompson.us/css/dthompson.css"> - - -</head> - -<body lang="en"> -<span id="Sound"></span><div class="header"> -<p> -Next: <a href="Fonts.html" accesskey="n" rel="next">Fonts</a>, Previous: <a href="Images.html" accesskey="p" rel="prev">Images</a>, Up: <a href="API-Reference.html" accesskey="u" rel="up">API Reference</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p> -</div> -<hr> -<span id="Sound-1"></span><h3 class="section">3.10 Sound</h3> - -<div class="example"> -<pre class="example">(use-modules (sdl2 mixer)) -</pre></div> - -<dl> -<dt id="index-_0025default_002dfrequency">Scheme Variable: <strong>%default-frequency</strong></dt> -</dl> - -<dl> -<dt id="index-_0025default_002dformat">Scheme Variable: <strong>%default-format</strong></dt> -</dl> - -<dl> -<dt id="index-_0025default_002dchunk_002dsize">Scheme Variable: <strong>%default-chunk-size</strong></dt> -</dl> - -<dl> -<dt id="index-mixer_002dinit">Procedure: <strong>mixer-init</strong> <em>[#:optional formats='(flac mod modplug mp3 ogg fluidsynth)]</em></dt> -<dd><p>Initialize mixer library with support for <var>formats</var>, a list of -symbols representing audio file formats. Possible formats are: -</p> -<ul> -<li> flac -</li><li> mod -</li><li> modplug -</li><li> mp3 -</li><li> ogg -</li><li> fluidsynth -</li></ul> -</dd></dl> - -<dl> -<dt id="index-mixer_002dquit">Procedure: <strong>mixer-quit</strong></dt> -<dd><p>Shutdown mixer library. -</p></dd></dl> - -<dl> -<dt id="index-open_002daudio">Procedure: <strong>open-audio</strong> <em>[#:frequency=%default-frequency] [#:format=%default-format] [#:stereo?=#t] [#:chunk-size=%default-chunk-size]</em></dt> -<dd><p>Initialize the mixer API. <var>frequency</var> specificies the sample rate in -hertz. When <var>stereo?</var> is <code>#t</code>, two output channels are used, otherwise -mono output is used instead. <var>chunk-size</var> specifies the number of bytes -used per output sample. <var>format</var> is a symbol that specifies the output -sample format. Possible values are: -</p> -<ul> -<li> u8 -</li><li> s8 -</li><li> u16lsb -</li><li> s16lsb -</li><li> u16msb -</li><li> s16msb -</li><li> u16 -</li><li> s16 -</li><li> s32lsb -</li><li> s32msb -</li><li> s32 -</li><li> f32lsb -</li><li> f32msb -</li><li> f32 -</li></ul> -</dd></dl> - -<dl> -<dt id="index-close_002daudio">Procedure: <strong>close-audio</strong></dt> -<dd><p>Shut down the mixer API. -</p></dd></dl> - -<dl> -<dt id="index-chunk_003f">Procedure: <strong>chunk?</strong> <em>c</em></dt> -<dd><p>Return <code>#t</code> if <var>c</var> is a chunk. -</p></dd></dl> - -<dl> -<dt id="index-load_002dchunk">Procedure: <strong>load-chunk</strong> <em>file</em></dt> -<dd><p>Load the audio data in <var>file</var> and return an audio chunk. -</p></dd></dl> - -<dl> -<dt id="index-delete_002dchunk_0021">Procedure: <strong>delete-chunk!</strong> <em>chunk</em></dt> -<dd><p>Free the memory used for <var>chunk</var>. -</p></dd></dl> - -<dl> -<dt id="index-set_002dchunk_002dvolume_0021">Procedure: <strong>set-chunk-volume!</strong> <em>chunk volume</em></dt> -<dd><p>Set the loudness of <var>chunk</var> to <var>volume</var>, an integer in the range -[0,128]. Return the previous chunk volume setting. -</p></dd></dl> - -<dl> -<dt id="index-play_002dchunk_0021">Procedure: <strong>play-chunk!</strong> <em>chunk [#:loops=0] [#:channel]</em></dt> -<dd><p>Play <var>chunk</var> on <var>channel</var>, an integer channel identifier or <code>#f</code> -to use the first unreserved audio channel. <var>chunk</var> will play <var>loops</var> + -1 times. Return the channel identifier that <var>chunk</var> is played on. -</p></dd></dl> - -<dl> -<dt id="index-set_002dchannel_002dvolume_0021">Procedure: <strong>set-channel-volume!</strong> <em>channel volume</em></dt> -<dd><p>Set the loudness of <var>channel</var>, an integer channel identifier or <code>#f</code> -for all channels, to <var>volume</var>, an integer in the range [0,128]. Return -the previous volume of <var>channel</var>, or the average of all channels if -<var>channel</var> is <code>#f</code>. -</p></dd></dl> - -<dl> -<dt id="index-pause_002dchannel_0021">Procedure: <strong>pause-channel!</strong> <em>channel</em></dt> -<dd><p>Pause playback on <var>channel</var>, an integer channel identifier, or <code>#f</code> to -pause all channels. -</p></dd></dl> - -<dl> -<dt id="index-resume_002dchannel_0021">Procedure: <strong>resume-channel!</strong> <em>channel</em></dt> -<dd><p>Resume playback on <var>channel</var>, an integer channel identifier, or <code>#f</code> to -resume all channels. -</p></dd></dl> - -<dl> -<dt id="index-stop_002dchannel_0021">Procedure: <strong>stop-channel!</strong> <em>channel</em></dt> -<dd><p>Halt playback on <var>channel</var>, an integer channel identifier, or <code>#f</code> to -halt all channels. -</p></dd></dl> - -<dl> -<dt id="index-channel_002dplaying_003f">Procedure: <strong>channel-playing?</strong> <em>channel</em></dt> -<dd><p>Return <code>#t</code> if <var>channel</var> is playing. -</p></dd></dl> - -<dl> -<dt id="index-playing_002dchannels_002dcount">Procedure: <strong>playing-channels-count</strong></dt> -<dd><p>Return the number of channels currently playing. -</p></dd></dl> - -<dl> -<dt id="index-channel_002dpaused_003f">Procedure: <strong>channel-paused?</strong> <em>channel</em></dt> -<dd><p>Return <code>#t</code> if <var>channel</var> is paused. -</p></dd></dl> - -<dl> -<dt id="index-paused_002dchannels_002dcount">Procedure: <strong>paused-channels-count</strong></dt> -<dd><p>Return the number of channels that are paused. -</p></dd></dl> - -<dl> -<dt id="index-music_003f">Procedure: <strong>music?</strong> <em>m</em></dt> -<dd><p>Return <code>#t</code> if <var>m</var> is music. -</p></dd></dl> - -<dl> -<dt id="index-load_002dmusic">Procedure: <strong>load-music</strong> <em>file</em></dt> -<dd><p>Load music from <var>file</var>. -</p></dd></dl> - -<dl> -<dt id="index-delete_002dmusic_0021">Procedure: <strong>delete-music!</strong> <em>music</em></dt> -<dd><p>Delete the memory used for <var>music</var>. -</p></dd></dl> - -<dl> -<dt id="index-play_002dmusic_0021">Procedure: <strong>play-music!</strong> <em>music [#:optional loops=1]</em></dt> -<dd><p>Play <var>music</var>, repeated <var>loops</var> times. <var>loops</var> may be <code>#f</code>, in -which case the music loops indefinitely. -</p></dd></dl> - -<dl> -<dt id="index-set_002dmusic_002dvolume_0021">Procedure: <strong>set-music-volume!</strong> <em>volume</em></dt> -<dd><p>Set music loudness to <var>volume</var>, an integer in the range [0,128]. Return the -previous volume. -</p></dd></dl> - -<dl> -<dt id="index-music_002dvolume">Procedure: <strong>music-volume</strong></dt> -<dd><p>Return the music volume. -</p></dd></dl> - -<dl> -<dt id="index-pause_002dmusic_0021">Procedure: <strong>pause-music!</strong></dt> -<dd><p>Puase the music. -</p></dd></dl> - -<dl> -<dt id="index-resume_002dmusic_0021">Procedure: <strong>resume-music!</strong></dt> -<dd><p>Resume music playback. -</p></dd></dl> - -<dl> -<dt id="index-rewind_002dmusic_0021">Procedure: <strong>rewind-music!</strong></dt> -<dd><p>Start music playback from the beginning. Rewinding is only supported for MOD, -OGG, MP3, and native MIDI music. -</p></dd></dl> - -<dl> -<dt id="index-stop_002dmusic_0021">Procedure: <strong>stop-music!</strong></dt> -<dd><p>Halt music playback. -</p></dd></dl> - -<dl> -<dt id="index-music_002dplaying_003f">Procedure: <strong>music-playing?</strong></dt> -<dd><p>Return <code>#t</code> if music is currently playing. -</p></dd></dl> - -<dl> -<dt id="index-music_002dpaused_003f">Procedure: <strong>music-paused?</strong></dt> -<dd><p>Return <code>#t</code> if music is currently paused. -</p></dd></dl> - -<hr> -<div class="header"> -<p> -Next: <a href="Fonts.html" accesskey="n" rel="next">Fonts</a>, Previous: <a href="Images.html" accesskey="p" rel="prev">Images</a>, Up: <a href="API-Reference.html" accesskey="u" rel="up">API Reference</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p> -</div> - - - -</body> -</html> |