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


12.235 voice-setup

A voice is to audio as a font is to a visual display. A personality is to audio as a face is to a visual display.

Voice-lock-mode is a minor mode that causes your comments to be spoken in one personality, strings in another, reserved words in another, documentation strings in another, and so on.

Comments will be spoken in ‘voice-comment-personality’. Strings will be spoken in ‘voice-string-personality’. Function and variable names (in their defining forms) will be spoken in ‘voice-function-name-personality’. Reserved words will be spoken in ‘voice-keyword-personality’.

To make the text you type be voiceified, use M-x voice-lock-mode. When this minor mode is on, the voices of the current line are updated with every insertion or deletion.

How faces map to voices: TTS engine specific modules e.g., dectalk-voices.el and outloud-voices.el define a standard set of voice names. This module maps standard "personality" names to these pre-defined voices. It does this via special form def-voice-font which takes a personality name, a voice name and a face name to set up the mapping between face and personality, and personality and voice. Newer Emacspeak modules should use voice-setup-add-map when defining face->personality mappings. Older code calls def-voice-font directly, but over time those calls will be changed to the more succinct form provided by voice-setup-add-map. For use from other modules, also see function voice-setup-map-face which is useful when mapping a single face. Both voice-setup-add-map and voice-setup-map-face call special form def-voice-font.

Special form def-voice-font sets up the personality name to be available via custom. new voices can be defined using CSS style specifications see special form defvoice Voices defined via defvoice can be customized via custom see the documentation for defvoice.

12.235.1 voice-setup Commands

12.235.1.1 voice-lock-mode

Command: voice-lock-mode (&optional arg)
Toggle voice lock mode.

If called interactively, enable Voice-Lock mode if ARG is positive, and
disable it if ARG is zero or negative.  If called from Lisp,
also enable the mode if ARG is omitted or nil, and toggle it
if ARG is ‘toggle’; disable the mode otherwise.

(fn &optional ARG)

12.235.1.2 voice-lock-toggle

Command: voice-lock-toggle
C-e d v
<fn> d v
Interactively toggle voice lock.

12.235.1.3 voice-setup-describe-personality

Command: voice-setup-describe-personality (personality)
C-h C-v
<f1> C-v
<help> C-v
        Describe specified voice — analogous to C-h /.
When called interactively, ‘personality’ defaults to first personality at point.
If there are multiple personalities at point,
these are available via minibuffer history.

(fn PERSONALITY)

12.235.1.4 voice-setup-list-voices

Command: voice-setup-list-voices (pattern)
C-h "
<f1> "
<help> "
        Show all defined voice-face mappings  in a help buffer.
Sample text to use comes from variable
  ‘voice-setup-sample-text’. 

(fn PATTERN)

12.235.1.5 voice-setup-toggle-silence-personality

Command: voice-setup-toggle-silence-personality
C-e M-q
<fn> M-q
        Toggle audibility of personality under point  .
If personality at point is currently audible, its
face->personality map is cached in a buffer local variable, and
its face->personality map is replaced by face->inaudible.  If
personality at point is inaudible, and there is a cached value,
then the original face->personality mapping is restored.  In
either case, the buffer is refontified to have the new mapping
take effect.

12.235.2 voice-setup Options

Variable: User Option voice-animate-extra-settings

Adds extra animation to current voice.

Variable: User Option voice-animate-medium-settings

Adds medium animation current voice.

Variable: User Option voice-animate-settings

Animates current voice.

Variable: User Option voice-annotate-settings

Indicate annotation.

Variable: User Option voice-bolden-and-animate-settings

Bolden and animate current voice.

Variable: User Option voice-bolden-extra-settings

Extra bolden current voice.

Variable: User Option voice-bolden-medium-settings

Add medium bolden current voice.

Variable: User Option voice-bolden-settings

Bolden current voice.

Variable: User Option voice-brighten-extra-settings

Extra brighten current voice.

Variable: User Option voice-brighten-medium-settings

Brighten (medium) current voice.

Variable: User Option voice-brighten-settings

Brighten current voice.

Variable: User Option voice-indent-settings

Indicate indentation .

Variable: User Option voice-lighten-extra-settings

Add extra lightness to current voice.

Variable: User Option voice-lighten-medium-settings

Add medium lightness to current voice.

Variable: User Option voice-lighten-settings

Lighten current voice.

Variable: User Option voice-lock-global-modes

Modes for which Voice Lock mode is automagically turned on. Global Voice Lock mode is controlled by the command ‘global-voice-lock-mode’. If nil, means no modes have Voice Lock mode automatically turned on. If t, all modes that support Voice Lock mode have it automatically turned on. If a list, it should be a list of ‘major-mode’ symbol names for which Voice Lock mode should be automatically turned on. The sense of the list is negated if it begins with ‘not’. For example: (c-mode c++-mode) means that Voice Lock mode is turned on for buffers in C and C++ modes only.

Variable: User Option voice-lock-overlay-0-settings

Overlay voice that sets dimension 0 of ACSS structure to 8.

Variable: User Option voice-lock-overlay-1-settings

Overlay voice that sets dimension 1 of ACSS structure to 8.

Variable: User Option voice-lock-overlay-2-settings

Overlay voice that sets dimension 2 of ACSS structure to 8.

Variable: User Option voice-lock-overlay-3-settings

Overlay voice that sets dimension 3 of ACSS structure to 8.

Variable: User Option voice-monotone-light-settings

Turns current voice into a light monotone.

Variable: User Option voice-monotone-medium-settings

Turns current voice into a medium monotone.

Variable: User Option voice-monotone-settings

Turns current voice into a monotone and speaks all punctuations.

Variable: User Option voice-punctuations-all-settings

Turns current voice into one that speaks all punctuations.

Variable: User Option voice-punctuations-none-settings

Turns current voice into one that speaks no punctuations.

Variable: User Option voice-punctuations-some-settings

Turns current voice into one that speaks some punctuations.

Variable: User Option voice-setup-sample-text

Sample text used when displaying available voices.

Variable: User Option voice-smoothen-extra-settings

Extra smoothen current voice.

Variable: User Option voice-smoothen-medium-settings

Add medium smoothen current voice.

Variable: User Option voice-smoothen-settings

Smoothen current voice.

Variable: User Option voice-womanize-1-settings

Apply first female voice.


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