.. module:: pygame_menu.sound
A sound engine can be created using the :py:class:`Sound` class. The sound engine can be customized by setting a sound file to several sounds defined by a type.
Example:
import pygame_menu
from pygame_menu import sound
engine = sound.Sound()
engine.set_sound(sound.SOUND_TYPE_CLICK_MOUSE, '/home/me/click.ogg')
engine.set_sound(sound.SOUND_TYPE_OPEN_MENU, '/home/me/open.ogg')
menu = pygame_menu.Menu(...)
menu.set_sound(engine, recursive=True) # Apply on menu and all sub-menus
Sound types are the following:
Type | Description |
---|---|
:py:data:`pygame_menu.sound.SOUND_TYPE_CLICK_MOUSE` | Mouse click |
:py:data:`pygame_menu.sound.SOUND_TYPE_CLOSE_MENU` | A menu is closed |
:py:data:`pygame_menu.sound.SOUND_TYPE_ERROR` | Generic error |
:py:data:`pygame_menu.sound.SOUND_TYPE_EVENT` | Generic event |
:py:data:`pygame_menu.sound.SOUND_TYPE_EVENT_ERROR` | Error generated by user |
:py:data:`pygame_menu.sound.SOUND_TYPE_KEY_ADDITION` | User type a key |
:py:data:`pygame_menu.sound.SOUND_TYPE_KEY_DELETION` | User deletes with a key |
:py:data:`pygame_menu.sound.SOUND_TYPE_OPEN_MENU` | A menu is opened |
:py:data:`pygame_menu.sound.SOUND_TYPE_WIDGET_SELECTION` | A widget is selected |
.. autoclass:: Sound :members: