Next: , Previous: , Up: Emacspeak Commands And Options   [Contents][Index]


12.7 dtk-speak

Defines the TTS interface.

12.7.1 dtk-speak Commands

12.7.1.1 dtk-add-cleanup-pattern

Command: dtk-add-cleanup-pattern (&optional delete)
C-e d a
<fn> d a
        Add this pattern to the list of repeating patterns that
are cleaned up.  Optional interactive prefix arg deletes
this pattern if previously added.  Cleaning up repeated
patterns results in emacspeak speaking the pattern followed
by a repeat count instead of speaking all the characters
making up the pattern.  Thus, by adding the repeating
pattern ‘.’ (this is already added by default) emacspeak
will say ‘‘aw fifteen dot’’ when speaking the string
‘‘...............’’ instead of ‘‘period period period period
’’

(fn &optional DELETE)

12.7.1.2 dtk-cloud

Command: dtk-cloud
C-e d C-c
<fn> d C-c
Select preferred Cloud TTS server.

12.7.1.3 dtk-local-server

Command: dtk-local-server (program &optional prompt-port)
C-e d L
<fn> d L
        Select and start an local speech server interactively. Local server
lets Emacspeak on a remote host connect back via SSH port forwarding
for instance. Argument PROGRAM specifies the speech server
program. Port defaults to dtk-local-server-port

(fn PROGRAM &optional PROMPT-PORT)

12.7.1.4 dtk-notify-initialize

Command: dtk-notify-initialize
C-e d C-n
<fn> d C-n
Initialize notification TTS stream.

12.7.1.5 dtk-notify-shutdown

Command: dtk-notify-shutdown
C-e d C-s
<fn> d C-s
Shutdown notification TTS stream.

12.7.1.6 dtk-notify-stop

Command: dtk-notify-stop
C-e .
<fn> .
Stop  speech on notification stream.

12.7.1.7 dtk-reset-state

Command: dtk-reset-state
C-e d R
<fn> d R
Restore sanity to the Dectalk.
Typically used after the Dectalk has been power   cycled.

12.7.1.8 dtk-select-server

Command: dtk-select-server (program &optional device)
C-e d d
<fn> d d
Select a speech server interactively.
When called interactively, restarts speech server.
Argument PROGRAM specifies the speech server program.
 Optional arg device sets up environment variable
ALSA_DEFAULT to specified device before starting the server.

(fn PROGRAM &optional DEVICE)

12.7.1.9 dtk-set-character-scale

Command: dtk-set-character-scale (factor &optional prefix)
C-e d f
<fn> d f
Set scale FACTOR for   speech rate.
Speech rate is scaled by this factor
when speaking characters.
Interactive PREFIX arg means set   the global default value, and then set the
current local  value to the result.

(fn FACTOR &optional PREFIX)

12.7.1.10 dtk-set-chunk-separator-syntax

Command: dtk-set-chunk-separator-syntax (s)
C-e d RET
<fn> d RET
        Interactively set how text is split in chunks.
See the Emacs documentation on syntax tables for details on how characters are
classified into various syntactic classes.
Argument S specifies the syntax class.

(fn S)

12.7.1.11 dtk-set-language

Command: dtk-set-language (lang)
C-e d S
<fn> d S
        Set language according to the argument lang.

(fn LANG)

12.7.1.12 dtk-set-next-language

Command: dtk-set-next-language
C-e d N
<fn> d N
Switch to the next available language

12.7.1.13 dtk-set-predefined-speech-rate

Command: dtk-set-predefined-speech-rate (&optional prefix)
C-e d 9
C-e d 8
C-e d 7
C-e d 6
C-e d 5
C-e d 4
C-e d 3
C-e d 2
C-e d 1
C-e d 0
<fn> d 9
<fn> d 8
<fn> d 7
<fn> d 6
<fn> d 5
<fn> d 4
<fn> d 3
<fn> d 2
<fn> d 1
<fn> d 0
        Set speech rate to one of nine predefined levels.
Interactive PREFIX arg says to set the rate globally.
Formula used is:
rate = dtk-speech-rate-base + dtk-speech-rate-step * level.

(fn &optional PREFIX)

12.7.1.14 dtk-set-preferred-language

Command: dtk-set-preferred-language (alias lang)
        Set the alias of the preferred language:
For example if alias="en" lang="en_GB",
then the following call:
 dtk-set-language("en")
will set "en_GB".

(fn ALIAS LANG)

12.7.1.15 dtk-set-previous-language

Command: dtk-set-previous-language
C-e d P
<fn> d P
        Switch to the previous available language

12.7.1.16 dtk-set-punctuations

Command: dtk-set-punctuations (mode &optional prefix)
C-e d p
<fn> d p
Set punctuation mode to MODE.
Possible values are ‘some’, ‘all’, or ‘none’.
Interactive PREFIX arg means set   the global default value, and then set the
current local  value to the result.

(fn MODE &optional PREFIX)

12.7.1.17 dtk-set-punctuations-to-all

Command: dtk-set-punctuations-to-all (&optional prefix)
Set punctuation  mode to all.
Interactive PREFIX arg sets punctuation mode globally.

(fn &optional PREFIX)

12.7.1.18 dtk-set-punctuations-to-some

Command: dtk-set-punctuations-to-some (&optional prefix)
Set punctuation  mode to some.
Interactive PREFIX arg sets punctuation mode globally.

(fn &optional PREFIX)

12.7.1.19 dtk-set-rate

Command: dtk-set-rate (rate &optional prefix)
C-e d r
<fn> d r
Set speaking RATE for the tts.
Interactive PREFIX arg means set   the global default value, and then set the
current local  value to the result.

(fn RATE &optional PREFIX)

12.7.1.20 dtk-stop

Command: dtk-stop (&optional all)
C-e s
C-e <fn>
<fn> s
<fn> <fn>
Stop speech now.
Optional arg ‘all’ or interactive call   silences notification stream as well.

(fn &optional ALL)

12.7.1.21 dtk-toggle-allcaps-beep

Command: dtk-toggle-allcaps-beep (&optional prefix)
C-e d C
<fn> d C
Toggle allcaps-beep.
when set, allcaps words  are  indicated by a
short beep.  Interactive PREFIX arg means toggle the global default
value, and then set the current local value to the result.
Note that allcaps-beep is a very useful thing when programming.
However it is irritating to have it on when reading documents.

12.7.1.22 dtk-toggle-capitalization

Command: dtk-toggle-capitalization (&optional prefix)
C-e d c
<fn> d c
Toggle capitalization.
when set, capitalization is indicated by a
short beep.  Interactive PREFIX arg means toggle the global default
value, and then set the current local value to the result.

12.7.1.23 dtk-toggle-punctuation-mode

Command: dtk-toggle-punctuation-mode (&optional prefix)
C-e d ,
<fn> d ,
        Toggle punctuation mode between "some" and "all".
Interactive PREFIX arg makes the new setting global.

(fn &optional PREFIX)

12.7.1.24 dtk-toggle-quiet

Command: dtk-toggle-quiet (&optional prefix)
Toggles state of  dtk-quiet.
Turning on this switch silences speech.
Optional interactive prefix arg causes this setting to become global.

12.7.1.25 dtk-toggle-speak-nonprinting-chars

Command: dtk-toggle-speak-nonprinting-chars (&optional prefix)
C-e d n
<fn> d n
Toggle speak-nonprinting-chars.
Switches behavior of how characters with the high bit set are handled.
Interactive PREFIX arg means toggle the global default
value, and then set the current local value to the result.

12.7.1.26 dtk-toggle-split-caps

Command: dtk-toggle-split-caps (&optional prefix)
C-e d s
<fn> d s
Toggle split caps mode.
Split caps mode is useful when reading
Hungarian notation in program source code.  Interactive PREFIX arg
means toggle the global default value, and then set the current local
value to the result.

12.7.1.27 dtk-toggle-splitting-on-white-space

Command: dtk-toggle-splitting-on-white-space
C-e d SPC
<fn> d SPC
        Toggle splitting of speech on white space.
This affects the internal state of emacspeak that decides if we split
text purely by clause boundaries, or also include
whitespace.  By default, emacspeak sends a clause at a time
to the speech device.  This produces fluent speech for
normal use.  However in modes such as ‘shell-mode’ and some
programming language modes, clause markers appear
infrequently, and this can result in large amounts of text
being sent to the speech device at once, making the system
unresponsive when asked to stop talking.  Splitting on white
space makes emacspeak’s stop command responsive.  However,
when splitting on white space, the speech sounds choppy
since the synthesizer is getting a word at a time.

12.7.1.28 dtk-toggle-strip-octals

Command: dtk-toggle-strip-octals (&optional prefix)
C-e d o
<fn> d o
Toggle stripping of octals.
Interactive prefix arg means
 toggle the global default value, and then set the current local
value to the result.

12.7.1.29 tts-cycle-device

Command: tts-cycle-device (&optional restart)
Cycle through available ALSA devices.
Optional interactive prefix arg restarts current TTS server.

(fn &optional RESTART)

12.7.1.30 tts-restart

Command: tts-restart
C-e C-s
<fn> C-s
        Use this to nuke the currently running TTS server and restart it.

12.7.1.31 tts-speak-version

Command: tts-speak-version
Speak version.

12.7.2 dtk-speak Options

Variable: User Option dtk-cleanup-repeats

List of repeating patterns to clean up. You can use command ‘dtk-add-cleanup-pattern’ bound to C-e d a to add more patterns. Specify patterns that people use to decorate their ASCII files, and cause untold pain to the speech synthesizer.

If more than 3 consecutive occurrences of a specified pattern is found, the TTS engine replaces it with a repeat count.

Variable: User Option dtk-cloud-server

Set this to your preferred cloud TTS server.

Variable: User Option dtk-local-engine

Engine we use for our local TTS server.

Variable: User Option dtk-speak-nonprinting-chars

*Option that specifies handling of non-printing chars. Non nil value means non printing characters should be spoken as their octal value. Set this to t to avoid a dectalk bug that makes the speech box die if it seems some accented characters in certain contexts.

Variable: User Option dtk-speech-rate-base

*Value of lowest tolerable speech rate.

Variable: User Option dtk-speech-rate-step

*Value of speech rate increment. This determines step size used when setting speech rate via command ‘dtk-set-predefined-speech-rate’. Formula used is dtk-speech-rate-base + dtk-speech-rate-step*level.

Variable: User Option dtk-use-tones

Allow tones to be turned off.

Variable: User Option tts-device-list

List of ALSA sound devices we can use.

Variable: User Option tts-strip-octals

Set to T to strip all octal chars before speaking. Particularly useful for web browsing.


Next: , Previous: , Up: Emacspeak Commands And Options   [Contents][Index]