flet-audio-recorder 0.2.0.dev17__tar.gz → 0.2.0.dev18__tar.gz

flet_audio_recorder-0.2.0.dev18/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.2
+Name: flet-audio-recorder
+Version: 0.2.0.dev18
+Summary: AudioRecorder control for Flet
+Author-email: Flet contributors <hello@flet.dev>
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://flet.dev/docs/controls/audiorecorder
+Project-URL: Repository, https://github.com/flet-dev/flet-audio-recorder
+Project-URL: Issues, https://github.com/flet-dev/flet-audio-recorder/issues
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: flet>=0.25.2
+
+# AudioRecorder
+
+Audio recorder from microphone to a given file path. Works on macOS, Linux, Windows, iOS, Android and web.
+Based on the [record](https://pub.dev/packages/record) Dart/Flutter package.
+
+**NOTE:** On Linux, encoding is provided by [fmedia](https://stsaz.github.io/fmedia/) which must be installed separately.
+
+AudioRecorder control is non-visual and should be added to `page.overlay` list.
+
+## Installation
+
+Add `flet-audio-recorder` as dependency to `pyproject.toml` of your Flet app:
+
+```
+dependencies = [
+  "flet-audio-recorder",
+  "flet>=0.27.4",
+]
+```
+
+## Documentation
+
+https://flet-dev.github.io/flet-audio-recorder/

flet_audio_recorder-0.2.0.dev18/README.md

@@ -0,0 +1,23 @@
+# AudioRecorder
+
+Audio recorder from microphone to a given file path. Works on macOS, Linux, Windows, iOS, Android and web.
+Based on the [record](https://pub.dev/packages/record) Dart/Flutter package.
+
+**NOTE:** On Linux, encoding is provided by [fmedia](https://stsaz.github.io/fmedia/) which must be installed separately.
+
+AudioRecorder control is non-visual and should be added to `page.overlay` list.
+
+## Installation
+
+Add `flet-audio-recorder` as dependency to `pyproject.toml` of your Flet app:
+
+```
+dependencies = [
+  "flet-audio-recorder",
+  "flet>=0.27.4",
+]
+```
+
+## Documentation
+
+https://flet-dev.github.io/flet-audio-recorder/

{flet_audio_recorder-0.2.0.dev17 → flet_audio_recorder-0.2.0.dev18}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flet-audio-recorder"
-version = "0.2.0.dev17"
+version = "0.2.0.dev18"
 description = "AudioRecorder control for Flet"
 readme = "README.md"
 authors = [
@@ -26,8 +26,17 @@ Issues = "https://github.com/flet-dev/flet-audio-recorder/issues"
 [tool.uv]
 dev-dependencies = [
     "flet[all]>=0.25.2",
+    "mkdocs", 
+    "mkdocs-material",
+    "mkdocstrings[python]"
 ]
 
+[tool.poetry.group.dev.dependencies]
+flet = {extras = ["all"], version = "0.27.4"}
+mkdocs = "^1.0"
+mkdocstrings = { extras = ["python"], version = "^0.10" }
+mkdocs-material = "^8.0"
+
 [tool.setuptools]
 license-files = []
 

{flet_audio_recorder-0.2.0.dev17 → flet_audio_recorder-0.2.0.dev18}/src/flet_audio_recorder/audio_recorder.py

@@ -11,6 +11,13 @@ from flet.utils import deprecated
 
 
 class AudioRecorderState(Enum):
+    """
+        The available AudioRecorder states are:
+
+    - `STOPPED`
+    - `RECORDING`
+    - `PAUSED`
+    """
     STOPPED = "stopped"
     RECORDING = "recording"
     PAUSED = "paused"
@@ -18,11 +25,29 @@ class AudioRecorderState(Enum):
 
 class AudioRecorderStateChangeEvent(ControlEvent):
     def __init__(self, e: ControlEvent):
+        """The current state of the audio recorder.
+
+        Value is of type [AudioRecorderState](audiorecorderstate.md)."""
         super().__init__(e.target, e.name, e.data, e.control, e.page)
         self.state: AudioRecorderState = AudioRecorderState(e.data)
 
 
 class AudioEncoder(Enum):
+    """
+    The `AudioEncoder` enum represents the different audio encoders supported by the audio recorder.
+
+    The available encoders are:
+
+    - `AACLC`: Advanced Audio Codec Low Complexity. A commonly used encoder for streaming and general audio recording.
+    - `AACELD`: Advanced Audio Codec Enhanced Low Delay. Suitable for low-latency applications like VoIP.
+    - `AACHE`: Advanced Audio Codec High Efficiency. Optimized for high-quality audio at lower bit rates.
+    - `AMRNB`: Adaptive Multi-Rate Narrow Band. Used for speech audio in mobile communication.
+    - `AMRWB`: Adaptive Multi-Rate Wide Band. Used for higher-quality speech audio.
+    - `OPUS`: A codec designed for both speech and audio applications, known for its versatility.
+    - `FLAC`: Free Lossless Audio Codec. Provides high-quality lossless audio compression.
+    - `WAV`: Standard audio format used for raw, uncompressed audio data.
+    - `PCM16BITS`: Pulse Code Modulation with 16-bit depth, used for high-fidelity audio.
+    """
     AACLC = "aacLc"
     AACELD = "aacEld"
     AACHE = "aacHe"
@@ -34,13 +59,13 @@ class AudioEncoder(Enum):
     PCM16BITS = "pcm16bits"
 
 
+
 class AudioRecorder(Control):
     """
     A control that allows you to record audio from your device.
 
-    -----
-
-    Online docs: https://flet.dev/docs/controls/audiorecorder
+    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.
     """
 
     def __init__(
@@ -84,6 +109,18 @@ class AudioRecorder(Control):
     def start_recording(
         self, output_path: str = None, wait_timeout: Optional[float] = 10
     ) -> bool:
+        """
+        Starts recording audio and saves it to the specified output path.
+
+        If not on the web, the `output_path` parameter must be provided.
+
+        Args:
+            output_path: The file path where the audio will be saved. It must be specified if not on web.
+            wait_timeout: The time in seconds to wait for the recording to start. Default is 10.
+
+        Returns:
+            bool: `True` if recording was successfully started, `False` otherwise.
+        """
         assert (
             self.page.web or output_path
         ), "output_path must be provided when not on web"
@@ -96,6 +133,15 @@ class AudioRecorder(Control):
         return started == "true"
 
     def is_recording(self, wait_timeout: Optional[float] = 5) -> bool:
+        """
+        Checks whether the audio recorder is currently recording.
+
+        Args:
+            wait_timeout: The time in seconds to wait for the result. Default is 5.
+
+        Returns:
+            bool: `True` if the recorder is currently recording, `False` otherwise.
+        """
         recording = self.invoke_method(
             "is_recording",
             wait_for_result=True,
@@ -104,6 +150,15 @@ class AudioRecorder(Control):
         return recording == "true"
 
     async def is_recording_async(self, wait_timeout: Optional[float] = 5) -> bool:
+        """
+        Asynchronously checks whether the audio recorder is currently recording.
+
+        Args:
+            wait_timeout: The time in seconds to wait for the result. Default is 5.
+
+        Returns:
+            bool: `True` if the recorder is currently recording, `False` otherwise.
+        """
         recording = await self.invoke_method_async(
             "is_recording",
             wait_for_result=True,
@@ -112,6 +167,15 @@ class AudioRecorder(Control):
         return recording == "true"
 
     def stop_recording(self, wait_timeout: Optional[float] = 5) -> Optional[str]:
+        """
+        Stops the audio recording and optionally returns the path to the saved file.
+
+        Args:
+            wait_timeout: The time in seconds to wait for the result. Default is 5.
+
+        Returns:
+            Optional[str]: The file path where the audio was saved or `None` if not applicable.
+        """
         return self.invoke_method(
             "stop_recording",
             wait_for_result=True,
@@ -121,6 +185,15 @@ class AudioRecorder(Control):
     async def stop_recording_async(
         self, wait_timeout: Optional[float] = 10
     ) -> Optional[str]:
+        """
+        Asynchronously stops the audio recording and optionally returns the path to the saved file.
+
+        Args:
+            wait_timeout: The time in seconds to wait for the result. Default is 10.
+
+        Returns:
+            Optional[str]: The file path where the audio was saved or `None` if not applicable.
+        """
         return await self.invoke_method_async(
             "stop_recording",
             wait_for_result=True,
@@ -128,6 +201,12 @@ class AudioRecorder(Control):
         )
 
     def cancel_recording(self, wait_timeout: Optional[float] = 5) -> None:
+        """
+        Cancels the current audio recording.
+
+        Args:
+            wait_timeout: The time in seconds to wait for the result. Default is 5.
+        """
         self.invoke_method(
             "cancel_recording",
             wait_for_result=True,
@@ -135,12 +214,27 @@ class AudioRecorder(Control):
         )
 
     def resume_recording(self):
+        """
+        Resumes a paused audio recording.
+        """
         self.invoke_method("resume_recording")
 
     def pause_recording(self):
+        """
+        Pauses the ongoing audio recording.
+        """
         self.invoke_method("pause_recording")
 
     def is_paused(self, wait_timeout: Optional[float] = 5) -> bool:
+        """
+        Checks whether the audio recorder is currently paused.
+
+        Args:
+            wait_timeout: The time in seconds to wait for the result. Default is 5.
+
+        Returns:
+            bool: `True` if the recorder is paused, `False` otherwise.
+        """
         paused = self.invoke_method(
             "is_paused",
             wait_for_result=True,
@@ -149,6 +243,15 @@ class AudioRecorder(Control):
         return paused == "true"
 
     async def is_paused_async(self, wait_timeout: Optional[float] = 5) -> bool:
+        """
+        Asynchronously checks whether the audio recorder is currently paused.
+
+        Args:
+            wait_timeout: The time in seconds to wait for the result. Default is 5.
+
+        Returns:
+            bool: `True` if the recorder is paused, `False` otherwise.
+        """
         supported = await self.invoke_method_async(
             "is_paused",
             wait_for_result=True,
@@ -159,6 +262,16 @@ class AudioRecorder(Control):
     def is_supported_encoder(
         self, encoder: AudioEncoder, wait_timeout: Optional[float] = 5
     ) -> bool:
+        """
+        Checks if the given audio encoder is supported by the recorder.
+
+        Args:
+            encoder: The audio encoder to check.
+            wait_timeout: The time in seconds to wait for the result. Default is 5.
+
+        Returns:
+            bool: `True` if the encoder is supported, `False` otherwise.
+        """
         supported = self.invoke_method(
             "is_supported_encoder",
             {
@@ -174,6 +287,16 @@ class AudioRecorder(Control):
     async def is_supported_encoder_async(
         self, encoder: AudioEncoder, wait_timeout: Optional[float] = 5
     ) -> bool:
+        """
+        Asynchronously checks if the given audio encoder is supported by the recorder.
+
+        Args:
+            encoder: The audio encoder to check.
+            wait_timeout: The time in seconds to wait for the result. Default is 5.
+
+        Returns:
+            bool: `True` if the encoder is supported, `False` otherwise.
+        """
         supported = await self.invoke_method_async(
             "is_supported_encoder",
             {
@@ -187,6 +310,15 @@ class AudioRecorder(Control):
         return supported == "true"
 
     def get_input_devices(self, wait_timeout: Optional[float] = 5) -> dict:
+        """
+        Retrieves the available input devices for recording.
+
+        Args:
+            wait_timeout: The time in seconds to wait for the result. Default is 5.
+
+        Returns:
+            dict: A dictionary of available input devices.
+        """
         devices = self.invoke_method(
             "get_input_devices",
             wait_for_result=True,
@@ -195,6 +327,15 @@ class AudioRecorder(Control):
         return json.loads(devices)
 
     async def get_input_devices_async(self, wait_timeout: Optional[float] = 5) -> dict:
+        """
+        Asynchronously retrieves the available input devices for recording.
+
+        Args:
+            wait_timeout: The time in seconds to wait for the result. Default is 5.
+
+        Returns:
+            dict: A dictionary of available input devices.
+        """
         devices = await self.invoke_method_async(
             "get_input_devices",
             wait_for_result=True,
@@ -203,6 +344,15 @@ class AudioRecorder(Control):
         return json.loads(devices)
 
     def has_permission(self, wait_timeout: Optional[float] = 10) -> bool:
+        """
+        Checks if the app has permission to record audio.
+
+        Args:
+            wait_timeout: The time in seconds to wait for the result. Default is 10.
+
+        Returns:
+            bool: `True` if the app has permission, `False` otherwise.
+        """
         p = self.invoke_method(
             "has_permission",
             wait_for_result=True,
@@ -211,6 +361,15 @@ class AudioRecorder(Control):
         return p == "true"
 
     async def has_permission_async(self, wait_timeout: Optional[float] = 10) -> bool:
+        """
+        Asynchronously checks if the app has permission to record audio.
+
+        Args:
+            wait_timeout: The time in seconds to wait for the result. Default is 10.
+
+        Returns:
+            bool: `True` if the app has permission, `False` otherwise.
+        """
         p = await self.invoke_method_async(
             "has_permission",
             wait_for_result=True,
@@ -221,6 +380,12 @@ class AudioRecorder(Control):
     # audio_encoder
     @property
     def audio_encoder(self):
+        """
+        The audio encoder to be used for recording.
+
+        Value is of type [`AudioEncoder`](audioencoder.md) 
+        and defaults to `AudioEncoder.WAV`.
+        """
         return self._get_attr("audioEncoder")
 
     @audio_encoder.setter
@@ -230,6 +395,13 @@ class AudioRecorder(Control):
     # suppress_noise
     @property
     def suppress_noise(self) -> bool:
+        """
+        Whether to suppress noise during recording.
+
+        Defaults to `False`.
+
+        If `True`, it reduces the background noise while recording.
+        """
         return self._get_attr("suppressNoise", data_type="bool", def_value=False)
 
     @suppress_noise.setter
@@ -239,6 +411,13 @@ class AudioRecorder(Control):
     # cancel_echo
     @property
     def cancel_echo(self) -> bool:
+        """
+        Whether to cancel echo during recording.
+
+        Defaults to `False`.
+
+        If `True`, it reduces or cancels echo during recording.
+        """
         return self._get_attr("cancelEcho", data_type="bool", def_value=False)
 
     @cancel_echo.setter
@@ -248,6 +427,13 @@ class AudioRecorder(Control):
     # auto_gain
     @property
     def auto_gain(self) -> bool:
+        """
+        Whether to automatically adjust the audio gain during recording.
+
+        Defaults to `False`.
+
+        If `True`, the audio gain is automatically adjusted to avoid distortion or clipping.
+        """
         return self._get_attr("autoGain", data_type="bool", def_value=False)
 
     @auto_gain.setter
@@ -257,6 +443,11 @@ class AudioRecorder(Control):
     # bit_rate
     @property
     def bit_rate(self) -> OptionalNumber:
+        """
+        The bit rate of the audio recording.
+
+        This value is specified in kilobits per second (kbps). Defaults to `None`.
+        """
         return self._get_attr("bitRate")
 
     @bit_rate.setter
@@ -266,6 +457,11 @@ class AudioRecorder(Control):
     # sample_rate
     @property
     def sample_rate(self) -> OptionalNumber:
+        """
+        The sample rate for the audio recording.
+
+        This value is specified in Hertz (Hz). Defaults to `None`.
+        """
         return self._get_attr("sampleRate")
 
     @sample_rate.setter
@@ -275,6 +471,11 @@ class AudioRecorder(Control):
     # channels_num
     @property
     def channels_num(self) -> OptionalNumber:
+        """
+        The number of audio channels for the recording.
+
+        Can be `1` (mono) or `2` (stereo). Defaults to `None`.
+        """
         return self._get_attr("channels")
 
     @channels_num.setter
@@ -285,6 +486,11 @@ class AudioRecorder(Control):
     # on_state_changed
     @property
     def on_state_changed(self):
+        """
+        Event handler that is triggered when the recording state changes.
+
+        This handler should accept an instance of [`AudioRecorderStateChangeEvent`](audiorecorderstatechangeevent.md).
+        """
         return self.__on_state_changed.handler
 
     @on_state_changed.setter
@@ -292,3 +498,5 @@ class AudioRecorder(Control):
         self, handler: OptionalEventCallable[AudioRecorderStateChangeEvent]
     ):
         self.__on_state_changed.handler = handler
+
+

flet_audio_recorder-0.2.0.dev18/src/flet_audio_recorder.egg-info/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.2
+Name: flet-audio-recorder
+Version: 0.2.0.dev18
+Summary: AudioRecorder control for Flet
+Author-email: Flet contributors <hello@flet.dev>
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://flet.dev/docs/controls/audiorecorder
+Project-URL: Repository, https://github.com/flet-dev/flet-audio-recorder
+Project-URL: Issues, https://github.com/flet-dev/flet-audio-recorder/issues
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: flet>=0.25.2
+
+# AudioRecorder
+
+Audio recorder from microphone to a given file path. Works on macOS, Linux, Windows, iOS, Android and web.
+Based on the [record](https://pub.dev/packages/record) Dart/Flutter package.
+
+**NOTE:** On Linux, encoding is provided by [fmedia](https://stsaz.github.io/fmedia/) which must be installed separately.
+
+AudioRecorder control is non-visual and should be added to `page.overlay` list.
+
+## Installation
+
+Add `flet-audio-recorder` as dependency to `pyproject.toml` of your Flet app:
+
+```
+dependencies = [
+  "flet-audio-recorder",
+  "flet>=0.27.4",
+]
+```
+
+## Documentation
+
+https://flet-dev.github.io/flet-audio-recorder/

flet_audio_recorder-0.2.0.dev17/PKG-INFO

@@ -1,93 +0,0 @@
-Metadata-Version: 2.2
-Name: flet-audio-recorder
-Version: 0.2.0.dev17
-Summary: AudioRecorder control for Flet
-Author-email: Flet contributors <hello@flet.dev>
-Project-URL: Homepage, https://flet.dev
-Project-URL: Documentation, https://flet.dev/docs/controls/audiorecorder
-Project-URL: Repository, https://github.com/flet-dev/flet-audio-recorder
-Project-URL: Issues, https://github.com/flet-dev/flet-audio-recorder/issues
-Classifier: License :: OSI Approved :: Apache Software License
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: flet>=0.25.2
-
-# AudioRecorder control for Flet
-
-`AudioRecorder` control for Flet.
-
-## Usage
-
-Add `flet-audio-recorder` as dependency (`pyproject.toml` or `requirements.txt`) to your Flet project.
-
-## Example
-
-```py
-
-import flet as ft
-
-import flet_audio_recorder as far
-
-async def main(page: ft.Page):
-    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
-    page.appbar = ft.AppBar(title=ft.Text("Audio Recorder"), center_title=True)
-
-    path = "test-audio-file.wav"
-
-    async def handle_start_recording(e):
-        print(f"StartRecording: {path}")
-        await audio_rec.start_recording_async(path)
-
-    async def handle_stop_recording(e):
-        output_path = await audio_rec.stop_recording_async()
-        print(f"StopRecording: {output_path}")
-        if page.web and output_path is not None:
-            await page.launch_url_async(output_path)
-
-    async def handle_list_devices(e):
-        devices = await audio_rec.get_input_devices_async()
-        print(devices)
-
-    async def handle_has_permission(e):
-        try:
-            print(f"HasPermission: {await audio_rec.has_permission_async()}")
-        except Exception as e:
-            print(e)
-
-    async def handle_pause(e):
-        print(f"isRecording: {await audio_rec.is_recording_async()}")
-        if await audio_rec.is_recording_async():
-            await audio_rec.pause_recording_async()
-
-    async def handle_resume(e):
-        print(f"isPaused: {await audio_rec.is_paused_async()}")
-        if await audio_rec.is_paused_async():
-            await audio_rec.resume_recording_async()
-
-    async def handle_audio_encoding_test(e):
-        for i in list(far.AudioEncoder):
-            print(f"{i}: {await audio_rec.is_supported_encoder_async(i)}")
-
-    async def handle_state_change(e):
-        print(f"State Changed: {e.data}")
-
-    audio_rec = far.AudioRecorder(
-        audio_encoder=far.AudioEncoder.WAV,
-        on_state_changed=handle_state_change,
-    )
-    page.overlay.append(audio_rec)
-    await page.update_async()
-
-    await page.add_async(
-        ft.ElevatedButton("Start Audio Recorder", on_click=handle_start_recording),
-        ft.ElevatedButton("Stop Audio Recorder", on_click=handle_stop_recording),
-        ft.ElevatedButton("List Devices", on_click=handle_list_devices),
-        ft.ElevatedButton("Pause Recording", on_click=handle_pause),
-        ft.ElevatedButton("Resume Recording", on_click=handle_resume),
-        ft.ElevatedButton("Test AudioEncodings", on_click=handle_audio_encoding_test),
-        ft.ElevatedButton("Has Permission", on_click=handle_has_permission),
-    )
-
-
-ft.app(main)
-```

flet_audio_recorder-0.2.0.dev17/README.md

@@ -1,79 +0,0 @@
-# AudioRecorder control for Flet
-
-`AudioRecorder` control for Flet.
-
-## Usage
-
-Add `flet-audio-recorder` as dependency (`pyproject.toml` or `requirements.txt`) to your Flet project.
-
-## Example
-
-```py
-
-import flet as ft
-
-import flet_audio_recorder as far
-
-async def main(page: ft.Page):
-    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
-    page.appbar = ft.AppBar(title=ft.Text("Audio Recorder"), center_title=True)
-
-    path = "test-audio-file.wav"
-
-    async def handle_start_recording(e):
-        print(f"StartRecording: {path}")
-        await audio_rec.start_recording_async(path)
-
-    async def handle_stop_recording(e):
-        output_path = await audio_rec.stop_recording_async()
-        print(f"StopRecording: {output_path}")
-        if page.web and output_path is not None:
-            await page.launch_url_async(output_path)
-
-    async def handle_list_devices(e):
-        devices = await audio_rec.get_input_devices_async()
-        print(devices)
-
-    async def handle_has_permission(e):
-        try:
-            print(f"HasPermission: {await audio_rec.has_permission_async()}")
-        except Exception as e:
-            print(e)
-
-    async def handle_pause(e):
-        print(f"isRecording: {await audio_rec.is_recording_async()}")
-        if await audio_rec.is_recording_async():
-            await audio_rec.pause_recording_async()
-
-    async def handle_resume(e):
-        print(f"isPaused: {await audio_rec.is_paused_async()}")
-        if await audio_rec.is_paused_async():
-            await audio_rec.resume_recording_async()
-
-    async def handle_audio_encoding_test(e):
-        for i in list(far.AudioEncoder):
-            print(f"{i}: {await audio_rec.is_supported_encoder_async(i)}")
-
-    async def handle_state_change(e):
-        print(f"State Changed: {e.data}")
-
-    audio_rec = far.AudioRecorder(
-        audio_encoder=far.AudioEncoder.WAV,
-        on_state_changed=handle_state_change,
-    )
-    page.overlay.append(audio_rec)
-    await page.update_async()
-
-    await page.add_async(
-        ft.ElevatedButton("Start Audio Recorder", on_click=handle_start_recording),
-        ft.ElevatedButton("Stop Audio Recorder", on_click=handle_stop_recording),
-        ft.ElevatedButton("List Devices", on_click=handle_list_devices),
-        ft.ElevatedButton("Pause Recording", on_click=handle_pause),
-        ft.ElevatedButton("Resume Recording", on_click=handle_resume),
-        ft.ElevatedButton("Test AudioEncodings", on_click=handle_audio_encoding_test),
-        ft.ElevatedButton("Has Permission", on_click=handle_has_permission),
-    )
-
-
-ft.app(main)
-```

flet_audio_recorder-0.2.0.dev17/src/flet_audio_recorder.egg-info/PKG-INFO

@@ -1,93 +0,0 @@
-Metadata-Version: 2.2
-Name: flet-audio-recorder
-Version: 0.2.0.dev17
-Summary: AudioRecorder control for Flet
-Author-email: Flet contributors <hello@flet.dev>
-Project-URL: Homepage, https://flet.dev
-Project-URL: Documentation, https://flet.dev/docs/controls/audiorecorder
-Project-URL: Repository, https://github.com/flet-dev/flet-audio-recorder
-Project-URL: Issues, https://github.com/flet-dev/flet-audio-recorder/issues
-Classifier: License :: OSI Approved :: Apache Software License
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: flet>=0.25.2
-
-# AudioRecorder control for Flet
-
-`AudioRecorder` control for Flet.
-
-## Usage
-
-Add `flet-audio-recorder` as dependency (`pyproject.toml` or `requirements.txt`) to your Flet project.
-
-## Example
-
-```py
-
-import flet as ft
-
-import flet_audio_recorder as far
-
-async def main(page: ft.Page):
-    page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
-    page.appbar = ft.AppBar(title=ft.Text("Audio Recorder"), center_title=True)
-
-    path = "test-audio-file.wav"
-
-    async def handle_start_recording(e):
-        print(f"StartRecording: {path}")
-        await audio_rec.start_recording_async(path)
-
-    async def handle_stop_recording(e):
-        output_path = await audio_rec.stop_recording_async()
-        print(f"StopRecording: {output_path}")
-        if page.web and output_path is not None:
-            await page.launch_url_async(output_path)
-
-    async def handle_list_devices(e):
-        devices = await audio_rec.get_input_devices_async()
-        print(devices)
-
-    async def handle_has_permission(e):
-        try:
-            print(f"HasPermission: {await audio_rec.has_permission_async()}")
-        except Exception as e:
-            print(e)
-
-    async def handle_pause(e):
-        print(f"isRecording: {await audio_rec.is_recording_async()}")
-        if await audio_rec.is_recording_async():
-            await audio_rec.pause_recording_async()
-
-    async def handle_resume(e):
-        print(f"isPaused: {await audio_rec.is_paused_async()}")
-        if await audio_rec.is_paused_async():
-            await audio_rec.resume_recording_async()
-
-    async def handle_audio_encoding_test(e):
-        for i in list(far.AudioEncoder):
-            print(f"{i}: {await audio_rec.is_supported_encoder_async(i)}")
-
-    async def handle_state_change(e):
-        print(f"State Changed: {e.data}")
-
-    audio_rec = far.AudioRecorder(
-        audio_encoder=far.AudioEncoder.WAV,
-        on_state_changed=handle_state_change,
-    )
-    page.overlay.append(audio_rec)
-    await page.update_async()
-
-    await page.add_async(
-        ft.ElevatedButton("Start Audio Recorder", on_click=handle_start_recording),
-        ft.ElevatedButton("Stop Audio Recorder", on_click=handle_stop_recording),
-        ft.ElevatedButton("List Devices", on_click=handle_list_devices),
-        ft.ElevatedButton("Pause Recording", on_click=handle_pause),
-        ft.ElevatedButton("Resume Recording", on_click=handle_resume),
-        ft.ElevatedButton("Test AudioEncodings", on_click=handle_audio_encoding_test),
-        ft.ElevatedButton("Has Permission", on_click=handle_has_permission),
-    )
-
-
-ft.app(main)
-```