blob: 7c71c441ca0aad29e87b8094d7afeeea54e2efb7 [file] [log] [blame]
Jack Jansene4be9be1995-02-28 15:46:09 +00001\section{Built-in module \sectcode{macspeech}}
2\bimodindex{macspeech}
3
4This module provides an interface to the Macintosh Speech Manager,
5allowing you to let the macintosh utter phrases. You need a version of
6the speech manager extension (version 1 and 2 have been tested) in
7your \code{Extensions} folder for this to work. The module does not
8provide full access to all features of the Speech Manager yet.
9
10\begin{funcdesc}{Available}{}
11Test availability of the Speech Manager extension (and, on the
12PowerPC, the Speech Manager shared library). Returns 0 or 1.
13\end{funcdesc}
14
15\begin{funcdesc}{Version}{}
16Return the (integer) version of the Speech Manager.
17\end{funcdesc}
18
19\begin{funcdesc}{SpeakString}{str}
20Utter the string \var{str} using the default voice,
21asynchronously. This aborts any speech that may still be active from
22prior \code{SpeakString} invocations.
23\end{funcdesc}
24
25\begin{funcdesc}{Busy}{}
26Return the number of speech channels busy, system-wide.
27\end{funcdesc}
28
29\begin{funcdesc}{CountVoices}{}
30Return the number of different voices available.
31\end{funcdesc}
32
33\begin{funcdesc}{GetIndVoice}{num}
34Return a voice object for voice number \var{num}.
35\end{funcdesc}
36
37\subsection{voice objects}
38Voice objects contain the description of a voice. It is currently not
39yet possible to access the parameters of a voice.
40
41\renewcommand{\indexsubitem}{(voice object method)}
42
43\begin{funcdesc}{GetGender}{}
44Return the gender of the voice: 0 for male, 1 for female and -1 for neuter.
45\end{funcdesc}
46
47\begin{funcdesc}{NewChannel}{}
48Return a new speech channel object using this voice.
49\end{funcdesc}
50
51\subsection{speech channel objects}
52A speech channel object allows you to speak strings with slightly more
53control than \code{SpeakString()}, and allows you to use multiple
54speakers at the same time. Please note that channel pitch and rate are
55interrelated in some way, so that to make your macintosh sing you will
56have to adjust both.
57
58\renewcommand{\indexsubitem}{(speech channel object method)}
59\begin{funcdesc}{SpeakText}{str}
60Start uttering the given string.
61\end{funcdesc}
62
63\begin{funcdesc}{Stop}{}
64Stop babbling.
65\end{funcdesc}
66
67\begin{funcdesc}{GetPitch}{}
68Returns the current pitch of the channel, as a floating-point number.
69\end{funcdesc}
70
71\begin{funcdesc}{SetPitch}{pitch}
72Set the pitch of the channel.
73\end{funcdesc}
74
75\begin{funcdesc}{GetRate}{}
76Get the speech rate (utterances per minute) of the channel as a
77floating point number.
78\end{funcdesc}
79
80\begin{funcdesc}{SetRate}{rate}
81Set the speech rate of the channel.
82\end{funcdesc}
83