soundscape (Emacspeak User’s Manual

12.229 soundscape

Soundscapes https://en.wikipedia.org/wiki/Soundscape define an acoustic environment. Boodler at http://boodler.org is a Python-based SoundScape generator. To use this module, first install boodler. Then install the soundscape packages (*.boop) files available at http://boodler.org/lib. 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:

M-x soundscape-toggle – Enables or disables automatic SoundScapes.
M-x soundscape – runs a named SoundScape
M-x soundscape-stop – Stops a specified running Soundscape.
M-x soundscape-kill – Kills all running Soundscapes.

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.

Soundscape Commands
soundscape Options

12.229.1.1 soundscape

Command: soundscape (scape) ¶

C-. s ¶
C-x @ s s ¶

Play soundscape.

(fn SCAPE)

12.229.1.2 soundscape-kill

Command: soundscape-kill ¶

Stop all running soundscapes.

12.229.1.3 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.

(fn &optional RESTART)

12.229.1.4 soundscape-listener-shutdown

Command: soundscape-listener-shutdown ¶

Shutdown listener.

12.229.1.5 soundscape-remote

Command: soundscape-remote (names) ¶

Activate scapes named ‘names’ — a list of strings.

(fn NAMES)

12.229.1.6 soundscape-restart

Command: soundscape-restart (&optional prompt) ¶

C-. r ¶
C-x @ s r ¶

Restart Soundscape  environment.
With prefix arg ‘prompt’, prompt for a alsa/ladspa device and volume.
The  is then saved to soundscape-device for future use.

(fn &optional PROMPT)

12.229.1.7 soundscape-stop

Command: soundscape-stop (scape) ¶

Stop running Soundscape.

(fn SCAPE)

12.229.1.8 soundscape-theme

Command: soundscape-theme ¶

Shows default theme in a special buffer.

12.229.1.9 soundscape-toggle

Command: soundscape-toggle ¶

C-. t ¶
C-x @ s t ¶

Toggle automatic SoundScapes.
Run command M-x soundscape-theme to see the default mode->mood mapping.

12.229.1.10 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.229.2 soundscape Options

Variable: User Option soundscape-data ¶

Soundscape data directory.

Default Value: /home/raman/.boodler/Collection

Variable: User Option soundscape-device ¶

Alsa sound device to use for soundscapes.

Default Value: default

Variable: User Option soundscape-manager-options ¶

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

Default Value: (-m 0.3)