flet-audio-recorder 0.2.0.dev64__tar.gz → 0.70.0.dev6551__tar.gz

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

@@ -1,24 +1,24 @@
 Metadata-Version: 2.4
 Name: flet-audio-recorder
-Version: 0.2.0.dev64
+Version: 0.70.0.dev6551
 Summary: Adds audio recording support to Flet apps.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0
 Project-URL: Homepage, https://flet.dev
-Project-URL: Documentation, https://flet-dev.github.io/flet-audio-recorder
-Project-URL: Repository, https://github.com/flet-dev/flet-audio-recorder
-Project-URL: Issues, https://github.com/flet-dev/flet-audio-recorder/issues
+Project-URL: Documentation, https://docs.flet.dev/audio-recorder
+Project-URL: Repository, https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-audio-recorder
+Project-URL: Issues, https://github.com/flet-dev/flet/issues
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: flet>=0.70.0.dev0
+Requires-Dist: flet==0.70.0.dev6551
 Dynamic: license-file
 
 # flet-audio-recorder
 
 [![pypi](https://img.shields.io/pypi/v/flet-audio-recorder.svg)](https://pypi.python.org/pypi/flet-audio-recorder)
 [![downloads](https://static.pepy.tech/badge/flet-audio-recorder/month)](https://pepy.tech/project/flet-audio-recorder)
-[![license](https://img.shields.io/github/license/flet-dev/flet-audio-recorder.svg)](https://github.com/flet-dev/flet-audio-recorder/blob/main/LICENSE)
+[![license](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-audio-recorder/LICENSE)
 
 Adds audio recording support to [Flet](https://flet.dev) apps.
 
@@ -26,22 +26,17 @@ It is based on the [record](https://pub.dev/packages/record) Flutter package.
 
 ## Documentation
 
-Detailed documentation to this package can be found [here](https://flet-dev.github.io/flet-audio-recorder/).
+Detailed documentation to this package can be found [here](https://docs.flet.dev/audio-recorder/).
 
 ## Platform Support
 
-This package supports the following platforms:
+| Platform | Windows | macOS | Linux | iOS | Android | Web |
+|----------|---------|-------|-------|-----|---------|-----|
+| Supported|    ✅    |   ✅   |   ✅   |  ✅  |    ✅    |  ✅  |
 
-| Platform | Supported |
-|----------|:---------:|
-| Windows  |     ✅     |
-| macOS    |     ✅     |
-| Linux    |     ✅     |
-| iOS      |     ✅     |
-| Android  |     ✅     |
-| Web      |     ✅     |
+## Usage
 
-## Installation
+### Installation
 
 To install the `flet-audio-recorder` package and add it to your project dependencies:
 
@@ -56,14 +51,10 @@ To install the `flet-audio-recorder` package and add it to your project dependen
     ```
     After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
 
-- Using `poetry`:
-    ```bash
-    poetry add flet-audio-recorder
-    ```
 
 > [!NOTE]
 > On Linux, encoding is provided by [fmedia](https://stsaz.github.io/fmedia/) which must be installed separately.
 
-## Examples
+### Examples
 
-For examples, see [this](./examples)
+For examples, see [these](https://github.com/flet-dev/flet/tree/main/sdk/python/examples/controls/audio_recorder).

{flet_audio_recorder-0.2.0.dev64 → flet_audio_recorder-0.70.0.dev6551}/README.md

@@ -2,7 +2,7 @@
 
 [![pypi](https://img.shields.io/pypi/v/flet-audio-recorder.svg)](https://pypi.python.org/pypi/flet-audio-recorder)
 [![downloads](https://static.pepy.tech/badge/flet-audio-recorder/month)](https://pepy.tech/project/flet-audio-recorder)
-[![license](https://img.shields.io/github/license/flet-dev/flet-audio-recorder.svg)](https://github.com/flet-dev/flet-audio-recorder/blob/main/LICENSE)
+[![license](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-audio-recorder/LICENSE)
 
 Adds audio recording support to [Flet](https://flet.dev) apps.
 
@@ -10,22 +10,17 @@ It is based on the [record](https://pub.dev/packages/record) Flutter package.
 
 ## Documentation
 
-Detailed documentation to this package can be found [here](https://flet-dev.github.io/flet-audio-recorder/).
+Detailed documentation to this package can be found [here](https://docs.flet.dev/audio-recorder/).
 
 ## Platform Support
 
-This package supports the following platforms:
+| Platform | Windows | macOS | Linux | iOS | Android | Web |
+|----------|---------|-------|-------|-----|---------|-----|
+| Supported|    ✅    |   ✅   |   ✅   |  ✅  |    ✅    |  ✅  |
 
-| Platform | Supported |
-|----------|:---------:|
-| Windows  |     ✅     |
-| macOS    |     ✅     |
-| Linux    |     ✅     |
-| iOS      |     ✅     |
-| Android  |     ✅     |
-| Web      |     ✅     |
+## Usage
 
-## Installation
+### Installation
 
 To install the `flet-audio-recorder` package and add it to your project dependencies:
 
@@ -40,14 +35,10 @@ To install the `flet-audio-recorder` package and add it to your project dependen
     ```
     After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
 
-- Using `poetry`:
-    ```bash
-    poetry add flet-audio-recorder
-    ```
 
 > [!NOTE]
 > On Linux, encoding is provided by [fmedia](https://stsaz.github.io/fmedia/) which must be installed separately.
 
-## Examples
+### Examples
 
-For examples, see [this](./examples)
+For examples, see [these](https://github.com/flet-dev/flet/tree/main/sdk/python/examples/controls/audio_recorder).

flet_audio_recorder-0.70.0.dev6551/pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "flet-audio-recorder"
+version = "0.70.0.dev6551"
+description = "Adds audio recording support to Flet apps."
+readme = "README.md"
+authors = [{ name = "Flet contributors", email = "hello@flet.dev" }]
+license = "Apache-2.0"
+requires-python = ">=3.10"
+dependencies = [
+    "flet==0.70.0.dev6551",
+]
+
+[project.urls]
+Homepage = "https://flet.dev"
+Documentation = "https://docs.flet.dev/audio-recorder"
+Repository = "https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-audio-recorder"
+Issues = "https://github.com/flet-dev/flet/issues"
+
+[tool.setuptools.package-data]
+"flutter.flet_audio_recorder" = ["**/*"]
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

flet_audio_recorder-0.70.0.dev6551/src/flet_audio_recorder/audio_recorder.py

@@ -0,0 +1,149 @@
+from dataclasses import field
+from typing import Optional
+
+import flet as ft
+
+from .types import (
+    AudioEncoder,
+    AudioRecorderConfiguration,
+    AudioRecorderStateChangeEvent,
+    InputDevice,
+)
+
+__all__ = ["AudioRecorder"]
+
+
+@ft.control("AudioRecorder")
+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.
+    """
+
+    configuration: AudioRecorderConfiguration = field(
+        default_factory=lambda: AudioRecorderConfiguration()
+    )
+    """
+    The default configuration of the audio recorder.
+    """
+
+    on_state_change: Optional[ft.EventHandler[AudioRecorderStateChangeEvent]] = None
+    """
+    Event handler that is called when the state of the audio recorder changes.
+    """
+
+    async def start_recording(
+        self,
+        output_path: Optional[str] = None,
+        configuration: Optional[AudioRecorderConfiguration] = None,
+    ) -> 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.
+            configuration: The configuration for the audio recorder.
+                If `None`, the `AudioRecorder.configuration` will be used.
+
+        Returns:
+            `True` if recording was successfully started, `False` otherwise.
+
+        Raises:
+            ValueError: If `output_path` is not provided on platforms other than web.
+        """
+        if not (self.page.web or output_path):
+            raise ValueError("output_path must be provided on platforms other than web")
+        return await self._invoke_method(
+            method_name="start_recording",
+            arguments={
+                "output_path": output_path,
+                "configuration": configuration
+                if configuration is not None
+                else self.configuration,
+            },
+        )
+
+    async def is_recording(self) -> bool:
+        """
+        Checks whether the audio recorder is currently recording.
+
+        Returns:
+            `True` if the recorder is currently recording, `False` otherwise.
+        """
+        return await self._invoke_method("is_recording")
+
+    async def stop_recording(self) -> Optional[str]:
+        """
+        Stops the audio recording and optionally returns the path to the saved file.
+
+        Returns:
+            The file path where the audio was saved or `None` if not applicable.
+        """
+        return await self._invoke_method("stop_recording")
+
+    async def cancel_recording(self):
+        """
+        Cancels the current audio recording.
+        """
+        await self._invoke_method("cancel_recording")
+
+    async def resume_recording(self):
+        """
+        Resumes a paused audio recording.
+        """
+        await self._invoke_method("resume_recording")
+
+    async def pause_recording(self):
+        """
+        Pauses the ongoing audio recording.
+        """
+        await self._invoke_method("pause_recording")
+
+    async def is_paused(self) -> bool:
+        """
+        Checks whether the audio recorder is currently paused.
+
+        Returns:
+            `True` if the recorder is paused, `False` otherwise.
+        """
+        return await self._invoke_method("is_paused")
+
+    async def is_supported_encoder(self, encoder: AudioEncoder) -> bool:
+        """
+        Checks if the given audio encoder is supported by the recorder.
+
+        Args:
+            encoder: The audio encoder to check.
+
+        Returns:
+            `True` if the encoder is supported, `False` otherwise.
+        """
+        return await self._invoke_method("is_supported_encoder", {"encoder": encoder})
+
+    async def get_input_devices(self) -> list[InputDevice]:
+        """
+        Retrieves the available input devices for recording.
+
+        Returns:
+            A list of available input devices.
+        """
+        r = await self._invoke_method("get_input_devices")
+        return [
+            InputDevice(id=device_id, label=label) for device_id, label in r.items()
+        ]
+
+    async def has_permission(self) -> bool:
+        """
+        Checks if the app has permission to record audio.
+
+        Returns:
+            `True` if the app has permission, `False` otherwise.
+        """
+        return await self._invoke_method("has_permission")

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

@@ -1,24 +1,24 @@
 Metadata-Version: 2.4
 Name: flet-audio-recorder
-Version: 0.2.0.dev64
+Version: 0.70.0.dev6551
 Summary: Adds audio recording support to Flet apps.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0
 Project-URL: Homepage, https://flet.dev
-Project-URL: Documentation, https://flet-dev.github.io/flet-audio-recorder
-Project-URL: Repository, https://github.com/flet-dev/flet-audio-recorder
-Project-URL: Issues, https://github.com/flet-dev/flet-audio-recorder/issues
+Project-URL: Documentation, https://docs.flet.dev/audio-recorder
+Project-URL: Repository, https://github.com/flet-dev/flet/tree/main/sdk/python/packages/flet-audio-recorder
+Project-URL: Issues, https://github.com/flet-dev/flet/issues
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: flet>=0.70.0.dev0
+Requires-Dist: flet==0.70.0.dev6551
 Dynamic: license-file
 
 # flet-audio-recorder
 
 [![pypi](https://img.shields.io/pypi/v/flet-audio-recorder.svg)](https://pypi.python.org/pypi/flet-audio-recorder)
 [![downloads](https://static.pepy.tech/badge/flet-audio-recorder/month)](https://pepy.tech/project/flet-audio-recorder)
-[![license](https://img.shields.io/github/license/flet-dev/flet-audio-recorder.svg)](https://github.com/flet-dev/flet-audio-recorder/blob/main/LICENSE)
+[![license](https://img.shields.io/badge/License-Apache_2.0-green.svg)](https://github.com/flet-dev/flet/blob/main/sdk/python/packages/flet-audio-recorder/LICENSE)
 
 Adds audio recording support to [Flet](https://flet.dev) apps.
 
@@ -26,22 +26,17 @@ It is based on the [record](https://pub.dev/packages/record) Flutter package.
 
 ## Documentation
 
-Detailed documentation to this package can be found [here](https://flet-dev.github.io/flet-audio-recorder/).
+Detailed documentation to this package can be found [here](https://docs.flet.dev/audio-recorder/).
 
 ## Platform Support
 
-This package supports the following platforms:
+| Platform | Windows | macOS | Linux | iOS | Android | Web |
+|----------|---------|-------|-------|-----|---------|-----|
+| Supported|    ✅    |   ✅   |   ✅   |  ✅  |    ✅    |  ✅  |
 
-| Platform | Supported |
-|----------|:---------:|
-| Windows  |     ✅     |
-| macOS    |     ✅     |
-| Linux    |     ✅     |
-| iOS      |     ✅     |
-| Android  |     ✅     |
-| Web      |     ✅     |
+## Usage
 
-## Installation
+### Installation
 
 To install the `flet-audio-recorder` package and add it to your project dependencies:
 
@@ -56,14 +51,10 @@ To install the `flet-audio-recorder` package and add it to your project dependen
     ```
     After this, you will have to manually add this package to your `requirements.txt` or `pyproject.toml`.
 
-- Using `poetry`:
-    ```bash
-    poetry add flet-audio-recorder
-    ```
 
 > [!NOTE]
 > On Linux, encoding is provided by [fmedia](https://stsaz.github.io/fmedia/) which must be installed separately.
 
-## Examples
+### Examples
 
-For examples, see [this](./examples)
+For examples, see [these](https://github.com/flet-dev/flet/tree/main/sdk/python/examples/controls/audio_recorder).

flet_audio_recorder-0.70.0.dev6551/src/flet_audio_recorder.egg-info/requires.txt

@@ -0,0 +1 @@
+flet==0.70.0.dev6551

flet_audio_recorder-0.70.0.dev6551/src/flutter/flet_audio_recorder/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+Initial release of the package.

{flet_audio_recorder-0.2.0.dev64 → flet_audio_recorder-0.70.0.dev6551}/src/flutter/flet_audio_recorder/LICENSE

@@ -198,4 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.

flet_audio_recorder-0.70.0.dev6551/src/flutter/flet_audio_recorder/README.md

@@ -0,0 +1,3 @@
+# Flet `AudioRecorder` control
+
+`AudioRecorder` control to use in Flet apps.