summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1999-10-22 21:08:56 (GMT)
committerFred Drake <fdrake@acm.org>1999-10-22 21:08:56 (GMT)
commit714fd26a2fba2049a5c10104b71772d15a933607 (patch)
treedd3152d14ced2f504b0208434352f6fe33322b31
parentbda10c81d06e36ab9d90f5c5d0d336589347da39 (diff)
downloadcpython-714fd26a2fba2049a5c10104b71772d15a933607.zip
cpython-714fd26a2fba2049a5c10104b71772d15a933607.tar.gz
cpython-714fd26a2fba2049a5c10104b71772d15a933607.tar.bz2
Documented Beep() function.
-rw-r--r--Doc/lib/libwinsound.tex16
1 files changed, 13 insertions, 3 deletions
diff --git a/Doc/lib/libwinsound.tex b/Doc/lib/libwinsound.tex
index eacab3b..153088d 100644
--- a/Doc/lib/libwinsound.tex
+++ b/Doc/lib/libwinsound.tex
@@ -10,9 +10,19 @@
\versionadded{1.5.2}
The \module{winsound} module provides access to the basic
-sound-playing machinery provided by Windows platforms. It includes a
-single function and several constants.
-
+sound-playing machinery provided by Windows platforms. It includes
+two functions and several constants.
+
+
+\begin{funcdesc}{Beep}{frequency, duration}
+ Beep the PC's speaker.
+ The \var{frequency} parameter specifies frequency, in hertz, of the
+ sound, and must be in the range 37 through 32,767 (\code{0x25}
+ through \code{0x7fff}). The \var{duration} parameter specifies the
+ number of milliseconds the sound should last. If the system is not
+ able to beep the speaker, \exception{RuntimeError} is raised.
+ \versionadded{1.5.3} % XXX fix this version number when release is scheduled!
+\end{funcdesc}
\begin{funcdesc}{PlaySound}{sound, flags}
Call the underlying \cfunction{PlaySound()} function from the