Docs for SoundEvent.CLAP

As added here: bbcmicrobit/micropython@a37074f

Author: microbit-grace

lang/en/typeshed/stdlib/microbit/__init__.pyi

@@ -837,6 +837,9 @@ class SoundEvent:
     QUIET: SoundEvent
     """Represents the transition of sound events, from ``loud`` to ``quiet`` like speaking or background music."""
 
+    CLAP: SoundEvent
+    """Represents a loud event similar to a clap."""
+
 class Sound:
     """The built-in sounds can be called using ``audio.play(Sound.NAME)``."""
 

lang/en/typeshed/stdlib/microbit/microphone.pyi

@@ -10,7 +10,7 @@ def current_event() -> Optional[SoundEvent]:
 
     Example: ``microphone.current_event()``
 
-    :return: The event, ``SoundEvent('loud')`` or ``SoundEvent('quiet')``.
+    :return: The event, ``SoundEvent('loud')``, ``SoundEvent('quiet')`` or ``SoundEvent('clap')``.
     """
     ...
 
@@ -21,7 +21,7 @@ def was_event(event: SoundEvent) -> bool:
 
     This call clears the sound history before returning.
 
-    :param event: The event to check for,  such as ``SoundEvent.LOUD`` or ``SoundEvent.QUIET``
+    :param event: The event to check for, such as ``SoundEvent.LOUD``, ``SoundEvent.QUIET`` or ``SoundEvent.CLAP``.
     :return: ``True`` if sound was heard at least once since the last call, otherwise ``False``.
     """
     ...
@@ -33,7 +33,7 @@ def is_event(event: SoundEvent) -> bool:
 
     This call does not clear the sound event history.
 
-    :param event: The event to check for,  such as ``SoundEvent.LOUD`` or ``SoundEvent.QUIET``
+    :param event: The event to check for, such as ``SoundEvent.LOUD``, ``SoundEvent.QUIET`` or ``SoundEvent.CLAP``.
     :return: ``True`` if sound was the most recent heard, ``False`` otherwise.
     """
     ...
@@ -50,7 +50,7 @@ def get_events() -> Tuple[SoundEvent, ...]:
     ...
 
 def set_threshold(event: SoundEvent, value: int) -> None:
-    """Set the threshold for a sound event.
+    """Set the threshold for the ``LOUD`` or ``QUIET`` sound events.
 
     Example: ``microphone.set_threshold(SoundEvent.LOUD, 250)``
 
@@ -65,7 +65,7 @@ def set_threshold(event: SoundEvent, value: int) -> None:
     threshold, then the ``SoundEvent.LOUD`` threshold will increase by one unit 
     above the ``SoundEvent.QUIET`` threshold.
 
-    :param event: A sound event, such as ``SoundEvent.LOUD`` or ``SoundEvent.QUIET``.
+    :param event: A ``SoundEvent.LOUD`` or ``SoundEvent.QUIET`` event.
     :param value: The threshold level in the range 0-255. Values outside this range will be clamped.
     """
     ...