Mercurial > emacs
changeset 27315:e17a1c6d3d69
(Fplay_sound): Improve doc string.
| author | Gerd Moellmann <gerd@gnu.org> |
|---|---|
| date | Thu, 13 Jan 2000 12:06:44 +0000 |
| parents | 556645e6675e |
| children | 6e868e0bc324 |
| files | src/sound.c |
| diffstat | 1 files changed, 17 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/src/sound.c Thu Jan 13 11:48:47 2000 +0000 +++ b/src/sound.c Thu Jan 13 12:06:44 2000 +0000 @@ -355,7 +355,23 @@ DEFUN ("play-sound", Fplay_sound, Splay_sound, 1, 1, 0, - "Play sound SOUND.") + "Play sound SOUND.\n\ +SOUND is a list of the form `(sound KEYWORD VALUE...)'.\n\ +The following keywords are recognized:\n\ +\n\ + :file FILE.- read sound data from FILE. If FILE Isn't an\n\ +absolute file name, it is searched in `data-directory'.\n\ +\n\ + :data DATA - read sound data from string DATA.\n\ +\n\ +Exactly one of :file or :data must be present.\n\ +\n\ + :volume VOL - set volume to VOL. VOL must an integer in the\n\ +range 0..100 or a float in the range 0..1.0. If not specified,\n\ +don't change the volume setting of the sound device.\n\ +\n\ + :device DEVICE - play sound on DEVICE. If not specified,\n\ +a system-dependent default device name is used.") (sound) Lisp_Object sound; {