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

12.222 soundscape

Soundscapes define an acoustic environment. Boodler at is a Python-based SoundScape generator. To use this module, first install boodler. Then install the soundscape packages (*.boop) files available at Make sure boodler works and produces audio in your environment. finally install the Boodler packages from emacspeak/scapes from the Emacspeak GitHub repository by running cd emacspeak/scapes; make

When boodler is set up and all packages installed, copy file emacspeak/scapes/soundscapes to ~/.boodler/Collection. The above file lists all installed SoundScapes. Directory emacspeak/scapes also contains additional Boodler Agents and SoundScapes that I have created for use with Emacspeak.

Module soundscape.el defines Emacs conveniences for running Soundscapes. Main Entry Points:

When automatic Soundscapes are enabled, SoundScapes are started and stopped based on the current major mode. Active Soundscape are displayed as part of the minor-mode-alist. Command emacspeak-speak-minor-mode-line can be used to have this spoken.

Thus, SoundScapes can be thought of as reflecting the mood of the current mode. This package defines a single soundscape-default-theme that is loaded using (soundscape-load soundscape-default-theme). Emacs modes that provide similar functionality e.g., communication == email, IM, ... map to the same mood.

12.222.1 soundscape Commands soundscape

Command: soundscape (scape)
C-' s
C-x @ s s
Play soundscape.

(fn SCAPE) soundscape-kill

Command: soundscape-kill
Stop all running soundscapes. soundscape-listener

Command: soundscape-listener (&optional restart)
Start  a Soundscape listener.
Listener is loaded with all Soundscapes defined in ‘soundscape-default-theme’ .
Optional interactive prefix arg restarts the listener if already running.

(fn &optional RESTART) soundscape-listener-shutdown

Command: soundscape-listener-shutdown
Shutdown listener. soundscape-remote

Command: soundscape-remote (names)
Activate scapes named names.

(fn NAMES) soundscape-restart

Command: soundscape-restart (&optional device)
C-' r
C-x @ s r
Restart Soundscape  environment.
With prefix arg ‘device’, prompt for a alsa/ladspa device.
Caches most recently used device, which then becomes the default for future invocations.

(fn &optional DEVICE) soundscape-stop

Command: soundscape-stop (scape)
C-' S
C-x @ s S
Stop running Soundscape.

(fn SCAPE) soundscape-theme

Command: soundscape-theme
Shows default theme in a special buffer. soundscape-toggle

Command: soundscape-toggle
C-' t
C-x @ s t
Toggle automatic SoundScapes.
When turned on, Soundscapes are automatically run based on current major mode.
Run command M-x soundscape-theme to see the default mode->mood mapping. soundscape-update-mood

Command: soundscape-update-mood (&optional prompt-mode)
C-' u
C-x @ s u
Update mood/scape mapping for current  mode.
The  updated mapping is not persisted.
Optional interactive prefix arg ‘prompt-mode’ prompts for the mode.

(fn &optional PROMPT-MODE)

12.222.2 soundscape Options

Variable: User Option soundscape-data

Soundscape data directory.

Variable: User Option soundscape-idle-delay

Number of seconds of idle time before soundscapes are synchronized with current mode.

Variable: User Option soundscape-manager-options

User customizable options list passed to boodler. Defaults specify alsa as the output and set master volume to 0.5

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