Merge pull request #492 from JaskRendix/patch-1

set_sound_volume (Sound)

Author: ppizarror

pygame_menu/sound.py

@@ -407,95 +407,96 @@ def _play_sound(self, sound: Optional[Dict[str, Any]]) -> bool:
         self._last_time = sound_time
         return True
 
+    def play_sound_type(self, sound_type: str) -> 'Sound':
+        """
+        Play a sound based on its type.
+
+        :param sound_type: The type of sound to play.
+        :return: Self reference.
+        """
+        if sound_type in self._sound:
+            self._play_sound(self._sound[sound_type])
+        return self
+
     def play_click_mouse(self) -> 'Sound':
         """
         Play click mouse sound.
 
         :return: Self reference
         """
-        self._play_sound(self._sound[SOUND_TYPE_CLICK_MOUSE])
-        return self
+        return self.play_sound_type(SOUND_TYPE_CLICK_MOUSE)
 
     def play_click_touch(self) -> 'Sound':
         """
         Play click touch sound.
 
         :return: Self reference
         """
-        self._play_sound(self._sound[SOUND_TYPE_CLICK_TOUCH])
-        return self
+        return self.play_sound_type(SOUND_TYPE_CLICK_TOUCH)
 
     def play_error(self) -> 'Sound':
         """
         Play error sound.
 
         :return: Self reference
         """
-        self._play_sound(self._sound[SOUND_TYPE_ERROR])
-        return self
+        return self.play_sound_type(SOUND_TYPE_ERROR)
 
     def play_event(self) -> 'Sound':
         """
         Play event sound.
 
         :return: Self reference
         """
-        self._play_sound(self._sound[SOUND_TYPE_EVENT])
-        return self
+        return self.play_sound_type(SOUND_TYPE_EVENT)
 
     def play_event_error(self) -> 'Sound':
         """
         Play event error sound.
 
         :return: Self reference
         """
-        self._play_sound(self._sound[SOUND_TYPE_EVENT_ERROR])
-        return self
+        return self.play_sound_type(SOUND_TYPE_EVENT_ERROR)
 
     def play_key_add(self) -> 'Sound':
         """
         Play key addition sound.
 
         :return: Self reference
         """
-        self._play_sound(self._sound[SOUND_TYPE_KEY_ADDITION])
-        return self
+        return self.play_sound_type(SOUND_TYPE_KEY_ADDITION)
 
     def play_key_del(self) -> 'Sound':
         """
         Play key deletion sound.
 
         :return: Self reference
         """
-        self._play_sound(self._sound[SOUND_TYPE_KEY_DELETION])
-        return self
+        return self.play_sound_type(SOUND_TYPE_KEY_DELETION)
 
     def play_open_menu(self) -> 'Sound':
         """
         Play open Menu sound.
 
         :return: Self reference
         """
-        self._play_sound(self._sound[SOUND_TYPE_OPEN_MENU])
-        return self
+        return self.play_sound_type(SOUND_TYPE_OPEN_MENU)
 
     def play_close_menu(self) -> 'Sound':
         """
         Play close Menu sound.
 
         :return: Self reference
         """
-        self._play_sound(self._sound[SOUND_TYPE_CLOSE_MENU])
-        return self
+        return self.play_sound_type(SOUND_TYPE_CLOSE_MENU)
 
     def play_widget_selection(self) -> 'Sound':
         """
         Play widget selection sound.
 
         :return: Self reference
         """
-        self._play_sound(self._sound[SOUND_TYPE_WIDGET_SELECTION])
-        return self
+        return self.play_sound_type(SOUND_TYPE_WIDGET_SELECTION)
 
     def stop(self) -> 'Sound':
         """
@@ -558,3 +559,20 @@ def get_channel_info(self) -> Dict[str, Any]:
         data['sound'] = channel.get_sound()
         data['volume'] = channel.get_volume()
         return data
+
+    def set_sound_volume(self, sound_type: str, volume: float) -> bool:
+        """
+        Set the volume of a specific sound type.
+    
+        :param sound_type: Sound type
+        :param volume: Volume of the sound, from ``0.0`` to ``1.0``
+        :return: ``True`` if the volume was set, ``False`` otherwise
+        """
+        if sound_type not in SOUND_TYPES:
+            return False
+        sound_data = self._sound.get(sound_type)
+        if sound_data:
+            sound_data['file'].set_volume(volume)
+            sound_data['volume'] = volume
+            return True
+        return False

test/test_sound.py

@@ -104,3 +104,13 @@ def test_sound_menu(self) -> None:
         menu.set_sound(None, True)
         self.assertNotEqual(button.get_sound(), self.sound)
         self.assertEqual(menu.get_sound(), menu._sound)
+
+    def test_set_sound_volume(self) -> None:
+        self.sound.load_example_sounds()
+        self.assertTrue(self.sound.set_sound_volume(pygame_menu.sound.SOUND_TYPE_CLICK_MOUSE, 0.5))
+        self.assertEqual(self.sound._sound[pygame_menu.sound.SOUND_TYPE_CLICK_MOUSE]['volume'], 0.5)
+        self.assertFalse(self.sound.set_sound_volume('bad_sound', 0.5))
+        self.assertTrue(self.sound.set_sound_volume(pygame_menu.sound.SOUND_TYPE_CLICK_MOUSE, 1.0))
+        self.assertEqual(self.sound._sound[pygame_menu.sound.SOUND_TYPE_CLICK_MOUSE]['volume'], 1.0)
+        self.assertTrue(self.sound.set_sound_volume(pygame_menu.sound.SOUND_TYPE_CLICK_MOUSE, 0.0))
+        self.assertEqual(self.sound._sound[pygame_menu.sound.SOUND_TYPE_CLICK_MOUSE]['volume'], 0.0)