flet-audio-recorder 0.2.0.dev55__tar.gz → 0.2.0.dev64__tar.gz

{flet_audio_recorder-0.2.0.dev55/src/flet_audio_recorder.egg-info → flet_audio_recorder-0.2.0.dev64}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet-audio-recorder
-Version: 0.2.0.dev55
+Version: 0.2.0.dev64
 Summary: Adds audio recording support to Flet apps.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0

{flet_audio_recorder-0.2.0.dev55 → flet_audio_recorder-0.2.0.dev64}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flet-audio-recorder"
-version = "0.2.0.dev55"
+version = "0.2.0.dev64"
 description = "Adds audio recording support to Flet apps."
 readme = "README.md"
 authors = [{ name = "Flet contributors", email = "hello@flet.dev" }]
@@ -20,22 +20,43 @@ Issues = "https://github.com/flet-dev/flet-audio-recorder/issues"
 "flutter.flet_audio_recorder" = ["**/*"]
 
 [dependency-groups]
+test = [
+    "pytest >=7.2.0",
+]
+lint = [
+    "ruff >=0.11.7",
+]
 dev = [
-    "pre-commit>=4.2.0",
-    "ruff>=0.11.7",
+    "pre-commit >=4.2.0",
+    { include-group = 'lint' },
+    { include-group = 'test' },
+]
+docs-coverage = [
+    "docstr-coverage >=2.3.2",
 ]
 docs = [
-    "mkdocs",
-    "mkdocs-material",
-    "mkdocstrings[python]",
-    "mkdocstrings-python-xref",
-    "mike",
-    "markdown>=3.6",
-    "pymdown-extensions",
-    "mkdocs-glightbox",
-    "mkdocs-section-index",
-    "griffe-modernized-annotations",
-    "pygments>=2.16",
+    "mkdocs >=1.6.1",
+    "mkdocs-material >=9.6.15",
+    "mkdocstrings-python >=1.16.12",
+    "mkdocstrings-python-xref >=1.16.3",
+    "mike >=2.1.3",
+    "markdown >=3.6",
+    "pymdown-extensions >=10.16",
+    "mkdocs-exclude >=1.0.2",
+    "mkdocs-glightbox >=0.4.0",
+    "mkdocs-open-in-new-tab >=1.0.8",
+    "mkdocs-section-index >=0.3.10",
+    "griffe-modernized-annotations >=1.0.8",
+    "griffe-warnings-deprecated >=1.1.0",
+    "pygments >=2.16",
+    "markdown-exec[ansi] >=1.11.0",
+    "pydocstyle >=6.3.0",
+    "linkcheckmd >=1.4.0",
+    { include-group = 'docs-coverage' },
+]
+all = [
+    { include-group = 'dev' },
+    { include-group = 'docs' },
 ]
 
 [build-system]
@@ -64,6 +85,7 @@ select = [
     "I"
 ]
 preview = true
+pydocstyle = { convention = 'google' }
 
 [tool.ruff.format]
 quote-style = "double"

{flet_audio_recorder-0.2.0.dev55 → flet_audio_recorder-0.2.0.dev64}/src/flet_audio_recorder/__init__.py

@@ -10,3 +10,16 @@ from .types import (
     IosAudioCategoryOption,
     IosRecorderConfiguration,
 )
+
+__all__ = [
+    "AndroidAudioSource",
+    "AndroidRecorderConfiguration",
+    "AudioEncoder",
+    "AudioRecorder",
+    "AudioRecorderConfiguration",
+    "AudioRecorderState",
+    "AudioRecorderStateChangeEvent",
+    "InputDevice",
+    "IosAudioCategoryOption",
+    "IosRecorderConfiguration",
+]

{flet_audio_recorder-0.2.0.dev55 → flet_audio_recorder-0.2.0.dev64}/src/flet_audio_recorder/audio_recorder.py

@@ -1,6 +1,6 @@
 import asyncio
 from dataclasses import field
-from typing import List, Optional
+from typing import Optional
 
 import flet as ft
 
@@ -19,11 +19,14 @@ class AudioRecorder(ft.Service):
     """
     A control that allows you to record audio from your device.
 
-    This control can record audio using different audio encoders and also allows configuration
-    of various audio recording parameters such as noise suppression, echo cancellation, and more.
+    This control can record audio using different
+    audio encoders and also allows configuration
+    of various audio recording parameters such as
+    noise suppression, echo cancellation, and more.
 
     Note:
-        This control is non-visual and should be added to `Page.services` list before it can be used.
+        This control is non-visual and should be added to
+            [`Page.services`][flet.Page.services] list before it can be used.
     """
 
     configuration: AudioRecorderConfiguration = field(
@@ -33,13 +36,9 @@ class AudioRecorder(ft.Service):
     The default configuration of the audio recorder.
     """
 
-    on_state_change: ft.OptionalEventHandler[
-        AudioRecorderStateChangeEvent["AudioRecorder"]
-    ] = None
+    on_state_change: Optional[ft.EventHandler[AudioRecorderStateChangeEvent]] = None
     """
     Event handler that is called when the state of the audio recorder changes.
-    
-    Event handler argument is of type [`AudioRecorderStateChangeEvent`][(p).].
     """
 
     async def start_recording_async(
@@ -59,14 +58,16 @@ class AudioRecorder(ft.Service):
             configuration: The configuration for the audio recorder.
                 If `None`, the `AudioRecorder.configuration` will be used.
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             `True` if recording was successfully started, `False` otherwise.
+
         Raises:
             TimeoutError: If the request times out.
         """
-        assert (
-            self.page.web or output_path
-        ), "output_path must be provided on platforms other than web"
+        assert self.page.web or output_path, (
+            "output_path must be provided on platforms other than web"
+        )
         return await self._invoke_method_async(
             method_name="start_recording",
             arguments={
@@ -84,21 +85,27 @@ class AudioRecorder(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             `True` if the recorder is currently recording, `False` otherwise.
+
         Raises:
             TimeoutError: If the request times out.
         """
         return await self._invoke_method_async("is_recording", timeout=timeout)
 
-    async def stop_recording_async(self, timeout: Optional[float] = 10) -> Optional[str]:
+    async def stop_recording_async(
+        self, timeout: Optional[float] = 10
+    ) -> Optional[str]:
         """
         Stops the audio recording and optionally returns the path to the saved file.
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             The file path where the audio was saved or `None` if not applicable.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -110,6 +117,7 @@ class AudioRecorder(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -121,6 +129,7 @@ class AudioRecorder(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -132,6 +141,7 @@ class AudioRecorder(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -143,6 +153,7 @@ class AudioRecorder(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -154,6 +165,7 @@ class AudioRecorder(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -165,6 +177,7 @@ class AudioRecorder(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -176,22 +189,28 @@ class AudioRecorder(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             `True` if the recorder is paused, `False` otherwise.
+
         Raises:
             TimeoutError: If the request times out.
         """
         return await self._invoke_method_async("is_paused", timeout=timeout)
 
-    async def is_supported_encoder_async(self, encoder: AudioEncoder, timeout: Optional[float] = 10) -> bool:
+    async def is_supported_encoder_async(
+        self, encoder: AudioEncoder, timeout: Optional[float] = 10
+    ) -> bool:
         """
         Checks if the given audio encoder is supported by the recorder.
 
         Args:
             encoder: The audio encoder to check.
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             `True` if the encoder is supported, `False` otherwise.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -199,14 +218,18 @@ class AudioRecorder(ft.Service):
             "is_supported_encoder", {"encoder": encoder}, timeout=timeout
         )
 
-    async def get_input_devices_async(self, timeout: Optional[float] = 10) -> List[InputDevice]:
+    async def get_input_devices_async(
+        self, timeout: Optional[float] = 10
+    ) -> list[InputDevice]:
         """
         Retrieves the available input devices for recording.
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             A list of available input devices.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -221,8 +244,10 @@ class AudioRecorder(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             `True` if the app has permission, `False` otherwise.
+
         Raises:
             TimeoutError: If the request times out.
         """

{flet_audio_recorder-0.2.0.dev55 → flet_audio_recorder-0.2.0.dev64}/src/flet_audio_recorder/types.py

@@ -1,16 +1,19 @@
 from dataclasses import dataclass, field
 from enum import Enum
-from typing import List, Optional
+from typing import TYPE_CHECKING, Optional
 
 import flet as ft
 
+if TYPE_CHECKING:
+    from .audio_recorder import AudioRecorder  # noqa
+
 __all__ = [
-    "AudioRecorderState",
-    "AudioEncoder",
-    "AudioRecorderStateChangeEvent",
-    "AudioRecorderConfiguration",
     "AndroidAudioSource",
     "AndroidRecorderConfiguration",
+    "AudioEncoder",
+    "AudioRecorderConfiguration",
+    "AudioRecorderState",
+    "AudioRecorderStateChangeEvent",
     "InputDevice",
     "IosAudioCategoryOption",
     "IosRecorderConfiguration",
@@ -31,7 +34,7 @@ class AudioRecorderState(Enum):
 
 
 @dataclass
-class AudioRecorderStateChangeEvent(ft.Event[ft.EventControlType]):
+class AudioRecorderStateChangeEvent(ft.Event["AudioRecorder"]):
     state: AudioRecorderState
     """The new state of the audio recorder."""
 
@@ -43,42 +46,43 @@ class AudioEncoder(Enum):
 
     AACLC = "aacLc"
     """
-    Advanced Audio Codec Low Complexity. 
+    Advanced Audio Codec Low Complexity.
     A commonly used encoder for streaming and general audio recording.
     """
 
     AACELD = "aacEld"
     """
-    Advanced Audio Codec Enhanced Low Delay. 
+    Advanced Audio Codec Enhanced Low Delay.
     Suitable for low-latency applications like VoIP.
     """
 
     AACHE = "aacHe"
     """
-    Advanced Audio Codec High Efficiency. 
+    Advanced Audio Codec High Efficiency.
     Optimized for high-quality audio at lower bit rates.
     """
 
     AMRNB = "amrNb"
     """
-    Adaptive Multi-Rate Narrow Band. 
+    Adaptive Multi-Rate Narrow Band.
     Used for speech audio in mobile communication.
     """
 
     AMRWB = "amrWb"
     """
-    Adaptive Multi-Rate Wide Band. 
+    Adaptive Multi-Rate Wide Band.
     Used for higher-quality speech audio.
     """
 
     OPUS = "opus"
     """
-    A codec designed for both speech and audio applications, known for its versatility.
+    A codec designed for both speech and audio applications,
+    known for its versatility.
     """
 
     FLAC = "flac"
     """
-    Free Lossless Audio Codec. 
+    Free Lossless Audio Codec.
     Provides high-quality lossless audio compression.
     """
 
@@ -113,7 +117,7 @@ class AndroidAudioSource(Enum):
 
     CAMCORDER = "camcorder"
     """
-    Microphone audio source tuned for video recording, 
+    Microphone audio source tuned for video recording,
     with the same orientation as the camera, if available.
     """
 
@@ -128,13 +132,13 @@ class AndroidAudioSource(Enum):
 
     UNPROCESSED = "unprocessed"
     """
-    Microphone audio source tuned for unprocessed (raw) sound if available, 
+    Microphone audio source tuned for unprocessed (raw) sound if available,
     behaves like `DEFAULT_SOURCE` otherwise.
     """
 
     VOICE_PERFORMANCE = "voicePerformance"
     """
-    Source for capturing audio meant to be processed in real time 
+    Source for capturing audio meant to be processed in real time
     and played back for live performance (e.g karaoke).
     """
 
@@ -146,15 +150,15 @@ class AndroidRecorderConfiguration:
     use_legacy: bool = False
     """
     Whether to use the Android MediaRecorder.
-    
-    While advanced recorder (the default) unlocks additionnal features, 
+
+    While advanced recorder (the default) unlocks additionnal features,
     the legacy recorder is stability oriented.
     """
 
     mute_audio: bool = False
     """
     Whether to mute all audio streams like alarms, music, ring, etc.
-    
+
     This is useful when you want to record audio without any background noise.
     The streams are restored to their previous state after recording is stopped
     and will stay at current state on pause/resume.
@@ -168,11 +172,14 @@ class AndroidRecorderConfiguration:
     audio_source: AndroidAudioSource = AndroidAudioSource.DEFAULT_SOURCE
     """
     Defines the audio source.
-    
-    An audio source defines both a default physical source of audio signal, and a recording configuration.
+
+    An audio source defines both a default physical source of audio signal,
+    and a recording configuration.
     Some effects are available or not depending on this source.
-    
-    Most of the time, you should use `AndroidAudioSource.DEFAULT_SOURCE` or `AndroidAudioSource.MIC`.
+
+    Most of the time, you should use
+    [`AndroidAudioSource.DEFAULT_SOURCE`][(p).] or
+    [`AndroidAudioSource.MIC`][(p).].
     """
 
 
@@ -185,7 +192,7 @@ class IosAudioCategoryOption(Enum):
 
     MIX_WITH_OTHERS = "mixWithOthers"
     """
-    Whether audio from this session mixes with audio 
+    Whether audio from this session mixes with audio
     from active sessions in other audio apps.
     """
 
@@ -207,30 +214,33 @@ class IosAudioCategoryOption(Enum):
     INTERRUPT_SPOKEN_AUDIO_AND_MIX_WITH_OTHERS = "interruptSpokenAudioAndMixWithOthers"
     """
     Pause spoken audio content from other sessions when your app plays its audio.
-    
+
     Available from iOS 9.0.
     """
 
     ALLOW_BLUETOOTH_A2DP = "allowBluetoothA2DP"
     """
-    Stream audio from this session to Bluetooth devices 
+    Stream audio from this session to Bluetooth devices
     that support the Advanced Audio Distribution Profile (A2DP).
-    
-    Available from iOS 10.0.
+
+    Note:
+        Available from iOS 10.0.
     """
 
     ALLOW_AIRPLAY = "allowAirPlay"
     """
     Stream audio from this session to AirPlay devices.
-    
-    Available from iOS 10.0.
+
+    Note:
+        Available from iOS 10.0.
     """
 
     OVERRIDE_MUTED_MICROPHONE_INTERRUPTION = "overrideMutedMicrophoneInterruption"
     """
     System interrupts the audio session when it mutes the built-in microphone.
-    
-    Available from iOS 14.5.
+
+    Note:
+        Available from iOS 14.5.
     """
 
 
@@ -238,7 +248,7 @@ class IosAudioCategoryOption(Enum):
 class IosRecorderConfiguration:
     """iOS specific configuration for recording."""
 
-    options: List[IosAudioCategoryOption] = field(
+    options: list[IosAudioCategoryOption] = field(
         default_factory=lambda: [
             IosAudioCategoryOption.DEFAULT_TO_SPEAKER,
             IosAudioCategoryOption.ALLOW_BLUETOOTH,
@@ -252,8 +262,9 @@ class IosRecorderConfiguration:
     manage_audio_session: bool = True
     """
     Whether to manage the shared AVAudioSession.
-    
-    Set this to `false` if another plugin is already managing the AVAudioSession.
+
+    Set this to `False` if another plugin is
+    already managing the AVAudioSession.
     """
 
 
@@ -279,21 +290,22 @@ class AudioRecorderConfiguration:
 
     suppress_noise: bool = False
     """
-    The recorder will try to negates the input noise (if available on the device).
-    
+    The recorder will try to negate the input
+    noise (if available on the device).
+
     Recording volume may be lowered by using this.
     """
 
     cancel_echo: bool = False
     """
     The recorder will try to reduce echo (if available on the device).
-    
+
     Recording volume may be lowered by using this.
     """
 
     auto_gain: bool = False
     """
-    The recorder will try to auto adjust recording volume in a 
+    The recorder will try to auto adjust recording volume in a
     limited range (if available on the device).
 
     Recording volume may be lowered by using this.
@@ -301,8 +313,12 @@ class AudioRecorderConfiguration:
 
     channels: int = 2
     """
-    The numbers of channels for the recording: `1` = mono, `2` = stereo
-    Most platforms only accept 2 at most.
+    The numbers of channels for the recording.
+
+    - `1` for mono
+    - `2` for stereo
+
+    Most platforms only accept at most 2 channels.
     """
 
     sample_rate: int = 44100
@@ -317,7 +333,8 @@ class AudioRecorderConfiguration:
 
     device: Optional[InputDevice] = None
     """
-    The device to be used for recording. 
+    The device to be used for recording.
+
     If `None`, default device will be selected.
     """
 

{flet_audio_recorder-0.2.0.dev55 → flet_audio_recorder-0.2.0.dev64/src/flet_audio_recorder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet-audio-recorder
-Version: 0.2.0.dev55
+Version: 0.2.0.dev64
 Summary: Adds audio recording support to Flet apps.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0

{flet_audio_recorder-0.2.0.dev55 → flet_audio_recorder-0.2.0.dev64}/src/flutter/flet_audio_recorder/pubspec.lock

@@ -134,7 +134,7 @@ packages:
     description:
       path: "packages/flet"
       ref: main
-      resolved-ref: b996d06ff462b88f5b31d6cceafac34ea6f57968
+      resolved-ref: cf8823c5d766ea7866480986aa3ee871f4091e78
       url: "https://github.com/flet-dev/flet.git"
     source: git
     version: "0.70.0"
@@ -155,10 +155,10 @@ packages:
     dependency: "direct dev"
     description:
       name: flutter_lints
-      sha256: a25a15ebbdfc33ab1cd26c63a6ee519df92338a9c10f122adda92938253bef04
+      sha256: "9e8c3858111da373efc5aa341de011d9bd23e2c5c5e0c62bccf32438e192d7b1"
       url: "https://pub.dev"
     source: hosted
-    version: "2.0.3"
+    version: "3.0.2"
   flutter_localizations:
     dependency: transitive
     description: flutter
@@ -266,10 +266,10 @@ packages:
     dependency: transitive
     description:
       name: lints
-      sha256: "0a217c6c989d21039f1498c3ed9f3ed71b354e69873f13a8dfc3c9fe76f1b452"
+      sha256: cbf8d4b858bb0134ef3ef87841abdf8d63bfc255c266b7bf6b39daa1085c4290
       url: "https://pub.dev"
     source: hosted
-    version: "2.1.1"
+    version: "3.0.0"
   logging:
     dependency: transitive
     description:
@@ -823,10 +823,10 @@ packages:
     dependency: transitive
     description:
       name: window_manager
-      sha256: "51d50168ab267d344b975b15390426b1243600d436770d3f13de67e55b05ec16"
+      sha256: "7eb6d6c4164ec08e1bf978d6e733f3cebe792e2a23fb07cbca25c2872bfdbdcd"
       url: "https://pub.dev"
     source: hosted
-    version: "0.5.0"
+    version: "0.5.1"
   window_to_front:
     dependency: transitive
     description:

{flet_audio_recorder-0.2.0.dev55 → flet_audio_recorder-0.2.0.dev64}/src/flutter/flet_audio_recorder/pubspec.yaml

@@ -20,4 +20,4 @@ dependencies:
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  flutter_lints: ^2.0.0
+  flutter_lints: ^3.0.0