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


12.174 emacspeak-sounds

This module provides the interface for generating auditory icons in emacspeak. Design goal: 1) Auditory icons should be used to provide additional feedback, not as a gimmick. 2) The interface should be usable at all times without the icons: e.g. when on a machine without a sound card. 3) General principle for when to use an icon: Convey information about events taking place in parallel. For instance, if making a selection automatically moves the current focus to the next choice, We speak the next choice, while indicating the fact that something was selected with a sound cue. This interface will assume the availability of a shell command "play" that can take one or more sound files and play them. This module will also provide a mapping between names in the elisp world and actual sound files. Modules that wish to use auditory icons should use these names, instead of actual file names. As of Emacspeak 13.0, this module defines a themes architecture for auditory icons. Sound files corresponding to a given theme are found in appropriate subdirectories of emacspeak-sounds-directory

12.174.1 emacspeak-sounds Commands

12.174.1.1 emacspeak-audio-setup

Command: emacspeak-audio-setup (&optional prefix)
C-e (
<fn> (
        Call appropriate audio environment set command.

(fn &optional PREFIX)

12.174.1.2 emacspeak-set-auditory-icon-player

Command: emacspeak-set-auditory-icon-player (player)
C-e M-a
<fn> M-a
        Select  player used for producing auditory icons.
Recommended choices:

emacspeak-serve-auditory-icon for  the wave device.
emacspeak-queue-auditory-icon when using software TTS.

(fn PLAYER)

12.174.1.3 emacspeak-sounds-reset-local-player

Command: emacspeak-sounds-reset-local-player
        Ask Emacspeak to use a local audio player.
This lets me have Emacspeak switch to using audioplay on
solaris after I’ve used it for a while from a remote session
where it would use the more primitive speech-server based
audio player.

12.174.1.4 emacspeak-sounds-reset-sound

Command: emacspeak-sounds-reset-sound
Reload sound drivers.

12.174.1.5 emacspeak-sounds-select-theme

Command: emacspeak-sounds-select-theme (theme)
C-e )
<fn> )
Select theme for auditory icons.

(fn THEME)

12.174.1.6 emacspeak-toggle-auditory-icons

Command: emacspeak-toggle-auditory-icons (&optional prefix)
C-e C-a
<fn> C-a
Toggle use of auditory icons.
Optional interactive PREFIX arg toggles global value.

(fn &optional PREFIX)

12.174.2 emacspeak-sounds Options

Variable: User Option emacspeak-auditory-icon-function

*Function that plays auditory icons. play : Launches play-program to play. Serve: Send a command to the speech-server to play. Queue : Add auditory icon to speech queue. soxplay: Use sox to apply effect earwax for headphones. Native : Use Emacs’ builtin sound support. Use Serve when working with remote speech servers.

Variable: User Option emacspeak-play-args

Set this to nil if using paplay from pulseaudio.

Variable: User Option emacspeak-play-program

Name of executable that plays sound files.

Variable: User Option emacspeak-sounds-default-theme

Default theme for auditory icons.

Variable: User Option emacspeak-sounds-reset-snd-module-command

Command to reset sound module.

Variable: User Option emacspeak-soxplay-command

Name of play executable from SoX


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