From 714fd26a2fba2049a5c10104b71772d15a933607 Mon Sep 17 00:00:00 2001 From: Fred Drake Date: Fri, 22 Oct 1999 21:08:56 +0000 Subject: [PATCH] Documented Beep() function. --- Doc/lib/libwinsound.tex | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/Doc/lib/libwinsound.tex b/Doc/lib/libwinsound.tex index eacab3be342..153088dd707 100644 --- a/Doc/lib/libwinsound.tex +++ b/Doc/lib/libwinsound.tex @@ -10,10 +10,20 @@ \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 Platform API. The \var{sound} parameter may be a filename, audio