refine docs on play-sound

This commit is contained in:
Matthew Flatt 2015-12-28 09:42:07 -06:00
parent ca24d94cdc
commit bf442a8c99

View File

@ -324,24 +324,24 @@ Plays a sound file. If @racket[async?] is false, the function does not
On Windows, only @filepath{.wav} files are supported.
On Unix, the function invokes an external sound-playing program;
looking for a few known programs (@exec{aplay}, @exec{play},
@exec{esdplay}, @exec{sndfile-play}, @exec{audioplay}). In addition, a
On Mac OS X, Quicktime is used to play sounds; most sound
formats (@filepath{.wav}, @filepath{.aiff}, @filepath{.mp3}) are supported in recent versions of
Quicktime. To play @filepath{.wav} files, Quicktime 3.0 (compatible
with OS 7.5 and up) is required.
On Unix, the function invokes an external sound-playing program---looking
by default for a few known programs (@exec{aplay}, @exec{play},
@exec{esdplay}, @exec{sndfile-play}, @exec{audioplay}). A
play command can be defined through the @ResourceFirst{playcmd}
preference (see @|mrprefsdiscuss|). The preference can hold a
program name, or a format string containing a single @litchar{~a}
where the filename should be substituted---and used as a shell
command. (Don't use @litchar{~s}, since the string that is used
with the format string will be properly quoted and wrapped in double
quotes.) A plain command name is usually better since execution is
quotes.) A plain command name is usually better, since execution is
faster. The command's output is discarded, unless it returns an
error code---in this case the last part of the error output is
shown.
On Mac OS X, Quicktime is used to play sounds; most sound
formats (.wav, .aiff, .mp3) are supported in recent versions of
Quicktime. In order to play .wav files, Quicktime 3.0 (compatible
with OS 7.5 and up) is required.}
error code, in which case the last part of the error output is
shown.}
@defproc[(position-integer? [v any/c]) boolean?]{