Requirements

• pibooth 2.x

• Python 3.10 or later

• A working sound output (if no audio device is found, the plugin is disabled and a warning is logged)

Install

$ pip3 install pibooth-sound-effects

Configuration

Here below the new configuration options available in the pibooth configuration. The keys and their default values are automatically added to your configuration after first pibooth restart.

[SOUNDS]

# Path to the sounds folder
sounds_path = ~/.config/pibooth/sounds

# Delay in seconds before playing the capture sound (to synchronize it with the camera shutter)
capture_delay = 0.0

Customize sounds

Sound files shall be .wav and have the name of the state in which it shall be played (e.g. {state}.wav). If you want to play the sound in loop, just add “_loop” in the name (e.g. {state}_loop.wav).

Available states are: wait, choose, chosen, preview, capture, processing, print and finish.

For example at the print level:

• if it exists, the sound named print.wav will be played once, when entering the state

• if it exists, the sound named print_loop.wav will be played in loop until the state is left.

Looping sounds are stopped as soon as the state is left. For instance, a background music can be played on the start screen with a wait_loop.wav file: it will stop when the user presses the button to take a picture.

Custom sounds can be added by adding or replacing existing sound files of the sounds folder (by default ~/.config/pibooth/sounds) with custom ones. Run pibooth --reset to restore the default sounds.