mirror of
https://github.com/python/cpython.git
synced 2024-12-04 23:34:42 +08:00
29052482d1
in the docs to indicate the next version before we decided on 1.6. Adjusted winsound.Beep() description slightly as well.
84 lines
2.8 KiB
TeX
84 lines
2.8 KiB
TeX
\section{\module{winsound} ---
|
|
Sound-playing interface for Windows}
|
|
|
|
\declaremodule{builtin}{winsound}
|
|
\platform{Windows}
|
|
\modulesynopsis{Access to the sound-playing machinery for Windows.}
|
|
\moduleauthor{Toby Dickenson}{htrd90@zepler.org}
|
|
\sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org}
|
|
|
|
\versionadded{1.5.2}
|
|
|
|
The \module{winsound} module provides access to the basic
|
|
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.
|
|
\strong{Note:} Under Windows 95 and 98, the arguments are ignored;
|
|
if the system has a sound card, the system default sound is played
|
|
(typically \file{ding.wav}, or whatever is registered as the default
|
|
sound via Control Panel -> Sounds); else (no sound card) the
|
|
standard system beep.
|
|
\versionadded{1.6}
|
|
\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
|
|
data as a string, or \code{None}. Its interpretation depends on the
|
|
value of \var{flags}, which can be a bit-wise ORed combination of
|
|
the constants described below. If the system indicates an error,
|
|
\exception{RuntimeError} is raised.
|
|
\end{funcdesc}
|
|
|
|
|
|
\begin{datadesc}{SND_FILENAME}
|
|
The \var{sound} parameter is the name of a WAV file.
|
|
\end{datadesc}
|
|
|
|
\begin{datadesc}{SND_ALIAS}
|
|
The \var{sound} parameter should be interpreted as a control panel
|
|
sound association name.
|
|
\end{datadesc}
|
|
|
|
\begin{datadesc}{SND_LOOP}
|
|
Play the sound repeatedly. The \constant{SND_ASYNC} flag must also
|
|
be used to avoid blocking.
|
|
\end{datadesc}
|
|
|
|
\begin{datadesc}{SND_MEMORY}
|
|
The \var{sound} parameter to \function{PlaySound()} is a memory
|
|
image of a WAV file.
|
|
|
|
\strong{Note:} This module does not support playing from a memory
|
|
image asynchronously, so a combination of this flag and
|
|
\constant{SND_ASYNC} will raise a \exception{RuntimeError}.
|
|
\end{datadesc}
|
|
|
|
\begin{datadesc}{SND_PURGE}
|
|
Stop playing all instances of the specified sound.
|
|
\end{datadesc}
|
|
|
|
\begin{datadesc}{SND_ASYNC}
|
|
Return immediately, allowing sounds to play asynchronously.
|
|
\end{datadesc}
|
|
|
|
\begin{datadesc}{SND_NODEFAULT}
|
|
If the specified sound cannot be found, do not play a default beep.
|
|
\end{datadesc}
|
|
|
|
\begin{datadesc}{SND_NOSTOP}
|
|
Do not interrupt sounds currently playing.
|
|
\end{datadesc}
|
|
|
|
\begin{datadesc}{SND_NOWAIT}
|
|
Return immediately if the sound driver is busy.
|
|
\end{datadesc}
|