Metadata-Version: 2.1
Name: pibooth-sound-effects
Version: 0.0.2
Summary: Pibooth plugin for sound effects
Home-page: https://github.com/pibooth/pibooth-sound-effects
Author: Vincent Verdeil, Antoine Rousseaux
License: GPLv3
Download-URL: https://github.com/pibooth/pibooth-sound-effects/archive/0.0.2.tar.gz
Keywords: Raspberry Pi,camera,photobooth,pygame
Platform: unix
Platform: linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Natural Language :: English
Classifier: Topic :: Multimedia :: Graphics :: Capture :: Digital Camera
Description-Content-Type: text/x-rst
Requires-Dist: pibooth (>=2.0.0)


=====================
pibooth-sound-effects
=====================

|PythonVersions| |PypiPackage| |Downloads|

``pibooth-sound-effects`` is a plugin for the `pibooth <https://github.com/pibooth/pibooth>`_
application.

It adds sound effects to the application:

- When pressing on the first menu --> click
- When selecting a layout --> click
- During the countdown --> countdown
- When entering the "thank you" menu --> applause

Sounds can be customized (see below).

Install
-------

::

    $ pip3 install pibooth-sound-effects

Configuration
-------------

This is the extra configuration options that can be added in the ``pibooth``
configuration:

.. code-block:: ini

    [SOUNDS]

    # PATH TO THE SOUNDS FOLDER
    sounds_path = ~/.config/pibooth/sounds

.. note:: Edit the configuration by running the command ``pibooth --config``.

Sounds file shall be .wav and have the name of the state in which it shall be played.
Each sound is played once, when entering the corresponding state except:

- the ``wait`` state were the sound is played in loop
- the ``preview`` state were the sound is played once for each number in the countdown

.. |PythonVersions| image:: https://img.shields.io/badge/python-2.7+ / 3.6+-red.svg
   :target: https://www.python.org/downloads
   :alt: Python 2.7+/3.6+

.. |PypiPackage| image:: https://badge.fury.io/py/pibooth-sound-effects.svg
   :target: https://pypi.org/project/pibooth-sound-effects
   :alt: PyPi package

.. |Downloads| image:: https://img.shields.io/pypi/dm/pibooth-sound-effects?color=purple
   :target: https://pypi.org/project/pibooth-sound-effects
   :alt: PyPi downloads


