flet-audio 0.1.0__tar.gz

flet_audio-0.1.0/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.2
+Name: flet-audio
+Version: 0.1.0
+Summary: Audio control for Flet
+Author-email: Flet contributors <hello@flet.dev>
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://flet.dev/docs/controls/audio
+Project-URL: Repository, https://github.com/flet-dev/flet-audio
+Project-URL: Issues, https://github.com/flet-dev/flet-audio/issues
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: flet>=0.25.1
+
+# Flet Audio control
+
+`Audio` control for Flet.
+
+## Usage
+
+Add `flet-audio` as dependency (`pyproject.toml` or `requirements.txt`) to your Flet project.
+
+## Example
+
+```py
+
+import flet as ft
+
+import flet_audio as fta
+
+
+def main(page: ft.Page):
+    audio1 = fta.Audio(
+        src="https://luan.xyz/files/audio/ambient_c_motion.mp3", autoplay=True
+    )
+    page.overlay.append(audio1)
+    page.add(
+        ft.Text("This is an app with background audio."),
+        ft.ElevatedButton("Stop playing", on_click=lambda _: audio1.pause()),
+    )
+
+ft.app(main)
+```

flet_audio-0.1.0/README.md

@@ -0,0 +1,29 @@
+# Flet Audio control
+
+`Audio` control for Flet.
+
+## Usage
+
+Add `flet-audio` as dependency (`pyproject.toml` or `requirements.txt`) to your Flet project.
+
+## Example
+
+```py
+
+import flet as ft
+
+import flet_audio as fta
+
+
+def main(page: ft.Page):
+    audio1 = fta.Audio(
+        src="https://luan.xyz/files/audio/ambient_c_motion.mp3", autoplay=True
+    )
+    page.overlay.append(audio1)
+    page.add(
+        ft.Text("This is an app with background audio."),
+        ft.ElevatedButton("Stop playing", on_click=lambda _: audio1.pause()),
+    )
+
+ft.app(main)
+```

flet_audio-0.1.0/pyproject.toml

@@ -0,0 +1,36 @@
+[project]
+name = "flet-audio"
+version = "0.1.0"
+description = "Audio control for Flet"
+readme = "README.md"
+authors = [
+    { name = "Flet contributors", email = "hello@flet.dev" }
+]
+classifiers = [
+  "License :: OSI Approved :: Apache Software License",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "flet>=0.25.1",
+]
+
+[project.urls]
+Homepage = "https://flet.dev"
+Documentation = "https://flet.dev/docs/controls/audio"
+Repository = "https://github.com/flet-dev/flet-audio"
+Issues = "https://github.com/flet-dev/flet-audio/issues"
+
+[tool.setuptools.package-data]
+"flutter.flet_audio" = ["**/*"]
+
+[tool.uv]
+dev-dependencies = [
+    "flet[all]>=0.25.1",
+]
+
+[tool.setuptools]
+license-files = []
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

flet_audio-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

flet_audio-0.1.0/src/flet_audio/__init__.py

@@ -0,0 +1,7 @@
+from flet_audio.audio import (
+    Audio,
+    AudioDurationChangeEvent,
+    AudioPositionChangeEvent,
+    AudioState,
+    AudioStateChangeEvent,
+)

flet_audio-0.1.0/src/flet_audio/audio.py

@@ -0,0 +1,294 @@
+from enum import Enum
+from typing import Any, Optional
+
+from flet.core.control import Control, OptionalNumber
+from flet.core.control_event import ControlEvent
+from flet.core.event_handler import EventHandler
+from flet.core.ref import Ref
+from flet.core.types import OptionalControlEventCallable, OptionalEventCallable
+from flet.utils import deprecated
+
+
+class ReleaseMode(Enum):
+    RELEASE = "release"
+    LOOP = "loop"
+    STOP = "stop"
+
+
+class AudioState(Enum):
+    STOPPED = "stopped"
+    PLAYING = "playing"
+    PAUSED = "paused"
+    COMPLETED = "completed"
+    DISPOSED = "disposed"
+
+
+class AudioStateChangeEvent(ControlEvent):
+    def __init__(self, e: ControlEvent):
+        super().__init__(e.target, e.name, e.data, e.control, e.page)
+        self.state: AudioState = AudioState(e.data)
+
+
+class AudioPositionChangeEvent(ControlEvent):
+    def __init__(self, e: ControlEvent):
+        super().__init__(e.target, e.name, e.data, e.control, e.page)
+        self.position: int = int(e.data)
+
+
+class AudioDurationChangeEvent(ControlEvent):
+    def __init__(self, e: ControlEvent):
+        super().__init__(e.target, e.name, e.data, e.control, e.page)
+        self.duration: int = int(e.data)
+
+
+class Audio(Control):
+    """
+    A control to simultaneously play multiple audio files. Works on macOS, Linux, Windows, iOS, Android and web. Based on audioplayers Flutter widget (https://pub.dev/packages/audioplayers).
+
+    Audio control is non-visual and should be added to `page.overlay` list.
+
+    Example:
+    ```
+    import flet as ft
+
+    import flet_audio as fta
+
+    def main(page: ft.Page):
+        audio1 = fta.Audio(
+            src="https://luan.xyz/files/audio/ambient_c_motion.mp3", autoplay=True
+        )
+        page.overlay.append(audio1)
+        page.add(
+            ft.Text("This is an app with background audio."),
+            ft.ElevatedButton("Stop playing", on_click=lambda _: audio1.pause()),
+        )
+
+    ft.app(target=main)
+    ```
+
+    -----
+
+    Online docs: https://flet.dev/docs/controls/audio
+    """
+
+    def __init__(
+        self,
+        src: Optional[str] = None,
+        src_base64: Optional[str] = None,
+        autoplay: Optional[bool] = None,
+        volume: OptionalNumber = None,
+        balance: OptionalNumber = None,
+        playback_rate: OptionalNumber = None,
+        release_mode: Optional[ReleaseMode] = None,
+        on_loaded: OptionalControlEventCallable = None,
+        on_duration_changed: OptionalEventCallable[AudioDurationChangeEvent] = None,
+        on_state_changed: OptionalEventCallable[AudioStateChangeEvent] = None,
+        on_position_changed: OptionalEventCallable[AudioPositionChangeEvent] = None,
+        on_seek_complete: OptionalControlEventCallable = None,
+        #
+        # Control
+        #
+        ref: Optional[Ref] = None,
+        data: Any = None,
+    ):
+        Control.__init__(
+            self,
+            ref=ref,
+            data=data,
+        )
+
+        self.__on_state_changed = EventHandler(lambda e: AudioStateChangeEvent(e))
+        self._add_event_handler("state_changed", self.__on_state_changed.get_handler())
+
+        self.__on_position_changed = EventHandler(lambda e: AudioPositionChangeEvent(e))
+        self._add_event_handler(
+            "position_changed", self.__on_position_changed.get_handler()
+        )
+
+        self.__on_duration_changed = EventHandler(lambda e: AudioDurationChangeEvent(e))
+        self._add_event_handler(
+            "duration_changed", self.__on_duration_changed.get_handler()
+        )
+
+        self.src = src
+        self.src_base64 = src_base64
+        self.autoplay = autoplay
+        self.volume = volume
+        self.balance = balance
+        self.playback_rate = playback_rate
+        self.release_mode = release_mode
+        self.on_loaded = on_loaded
+        self.on_duration_changed = on_duration_changed
+        self.on_state_changed = on_state_changed
+        self.on_position_changed = on_position_changed
+        self.on_seek_complete = on_seek_complete
+
+    def _get_control_name(self):
+        return "audio"
+
+    def play(self):
+        self.invoke_method("play")
+
+    def pause(self):
+        self.invoke_method("pause")
+
+    def resume(self):
+        self.invoke_method("resume")
+
+    def release(self):
+        self.invoke_method("release")
+
+    def seek(self, position_milliseconds: int):
+        self.invoke_method("seek", {"position": str(position_milliseconds)})
+
+    def get_duration(self, wait_timeout: Optional[float] = 5) -> Optional[int]:
+        sr = self.invoke_method(
+            "get_duration",
+            wait_for_result=True,
+            wait_timeout=wait_timeout,
+        )
+        return int(sr) if sr else None
+
+    async def get_duration_async(
+        self, wait_timeout: Optional[float] = 5
+    ) -> Optional[int]:
+        sr = await self.invoke_method_async(
+            "get_duration",
+            wait_for_result=True,
+            wait_timeout=wait_timeout,
+        )
+        return int(sr) if sr else None
+
+    def get_current_position(self, wait_timeout: Optional[float] = 5) -> Optional[int]:
+        sr = self.invoke_method(
+            "get_current_position",
+            wait_for_result=True,
+            wait_timeout=wait_timeout,
+        )
+        return int(sr) if sr else None
+
+    async def get_current_position_async(
+        self, wait_timeout: Optional[float] = 5
+    ) -> Optional[int]:
+        sr = await self.invoke_method_async(
+            "get_current_position",
+            wait_for_result=True,
+            wait_timeout=wait_timeout,
+        )
+        return int(sr) if sr else None
+
+    # src
+    @property
+    def src(self):
+        return self._get_attr("src")
+
+    @src.setter
+    def src(self, value):
+        self._set_attr("src", value)
+
+    # src_base64
+    @property
+    def src_base64(self):
+        return self._get_attr("srcBase64")
+
+    @src_base64.setter
+    def src_base64(self, value):
+        self._set_attr("srcBase64", value)
+
+    # autoplay
+    @property
+    def autoplay(self) -> bool:
+        return self._get_attr("autoplay", data_type="bool", def_value=False)
+
+    @autoplay.setter
+    def autoplay(self, value: Optional[bool]):
+        self._set_attr("autoplay", value)
+
+    # volume
+    @property
+    def volume(self) -> OptionalNumber:
+        return self._get_attr("volume")
+
+    @volume.setter
+    def volume(self, value: OptionalNumber):
+        if value is None or (0 <= value <= 1):
+            self._set_attr("volume", value)
+
+    # balance
+    @property
+    def balance(self) -> OptionalNumber:
+        return self._get_attr("balance")
+
+    @balance.setter
+    def balance(self, value: OptionalNumber):
+        if value is None or (-1 <= value <= 1):
+            self._set_attr("balance", value)
+
+    # playback_rate
+    @property
+    def playback_rate(self) -> OptionalNumber:
+        return self._get_attr("playbackRate")
+
+    @playback_rate.setter
+    def playback_rate(self, value: OptionalNumber):
+        if value is None or (0 <= value <= 2):
+            self._set_attr("playbackRate", value)
+
+    # release_mode
+    @property
+    def release_mode(self):
+        return self._get_attr("releaseMode")
+
+    @release_mode.setter
+    def release_mode(self, value: Optional[ReleaseMode]):
+        self._set_enum_attr("releaseMode", value, ReleaseMode)
+
+    # on_loaded
+    @property
+    def on_loaded(self):
+        return self._get_event_handler("loaded")
+
+    @on_loaded.setter
+    def on_loaded(self, handler: OptionalControlEventCallable):
+        self._add_event_handler("loaded", handler)
+
+    # on_duration_changed
+    @property
+    def on_duration_changed(self):
+        return self.__on_duration_changed.handler
+
+    @on_duration_changed.setter
+    def on_duration_changed(
+        self, handler: OptionalEventCallable[AudioDurationChangeEvent]
+    ):
+        self.__on_duration_changed.handler = handler
+
+    # on_state_changed
+    @property
+    def on_state_changed(self):
+        return self.__on_state_changed.handler
+
+    @on_state_changed.setter
+    def on_state_changed(self, handler: OptionalEventCallable[AudioStateChangeEvent]):
+        self.__on_state_changed.handler = handler
+
+    # on_position_changed
+    @property
+    def on_position_changed(self):
+        return self.__on_position_changed.handler
+
+    @on_position_changed.setter
+    def on_position_changed(
+        self, handler: OptionalEventCallable[AudioPositionChangeEvent]
+    ):
+        self.__on_position_changed.handler = handler
+        self._set_attr("onPositionChanged", True if handler is not None else None)
+
+    # on_seek_complete
+    @property
+    def on_seek_complete(self):
+        return self._get_event_handler("seek_complete")
+
+    @on_seek_complete.setter
+    def on_seek_complete(self, handler: OptionalControlEventCallable):
+        self._add_event_handler("seek_complete", handler)

flet_audio-0.1.0/src/flet_audio.egg-info/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.2
+Name: flet-audio
+Version: 0.1.0
+Summary: Audio control for Flet
+Author-email: Flet contributors <hello@flet.dev>
+Project-URL: Homepage, https://flet.dev
+Project-URL: Documentation, https://flet.dev/docs/controls/audio
+Project-URL: Repository, https://github.com/flet-dev/flet-audio
+Project-URL: Issues, https://github.com/flet-dev/flet-audio/issues
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: flet>=0.25.1
+
+# Flet Audio control
+
+`Audio` control for Flet.
+
+## Usage
+
+Add `flet-audio` as dependency (`pyproject.toml` or `requirements.txt`) to your Flet project.
+
+## Example
+
+```py
+
+import flet as ft
+
+import flet_audio as fta
+
+
+def main(page: ft.Page):
+    audio1 = fta.Audio(
+        src="https://luan.xyz/files/audio/ambient_c_motion.mp3", autoplay=True
+    )
+    page.overlay.append(audio1)
+    page.add(
+        ft.Text("This is an app with background audio."),
+        ft.ElevatedButton("Stop playing", on_click=lambda _: audio1.pause()),
+    )
+
+ft.app(main)
+```

flet_audio-0.1.0/src/flet_audio.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+README.md
+pyproject.toml
+src/flet_audio/__init__.py
+src/flet_audio/audio.py
+src/flet_audio.egg-info/PKG-INFO
+src/flet_audio.egg-info/SOURCES.txt
+src/flet_audio.egg-info/dependency_links.txt
+src/flet_audio.egg-info/requires.txt
+src/flet_audio.egg-info/top_level.txt
+src/flutter/flet_audio/CHANGELOG.md
+src/flutter/flet_audio/LICENSE
+src/flutter/flet_audio/README.md
+src/flutter/flet_audio/analysis_options.yaml
+src/flutter/flet_audio/pubspec.lock
+src/flutter/flet_audio/pubspec.yaml
+src/flutter/flet_audio/lib/flet_audio.dart
+src/flutter/flet_audio/lib/src/audio.dart
+src/flutter/flet_audio/lib/src/create_control.dart

flet_audio-0.1.0/src/flet_audio.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

flet_audio-0.1.0/src/flet_audio.egg-info/requires.txt

@@ -0,0 +1 @@
+flet>=0.25.1

flet_audio-0.1.0/src/flet_audio.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+flet_audio
+flutter

flet_audio-0.1.0/src/flutter/flet_audio/CHANGELOG.md

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