flet-audio 0.2.0.dev42__py3-none-any.whl → 0.2.0.dev58__py3-none-any.whl

flet_audio/__init__.py

@@ -4,4 +4,14 @@ from .types import (
     AudioPositionChangeEvent,
     AudioState,
     AudioStateChangeEvent,
+    ReleaseMode,
 )
+
+__all__ = [
+    "Audio",
+    "AudioDurationChangeEvent",
+    "AudioPositionChangeEvent",
+    "AudioState",
+    "AudioStateChangeEvent",
+    "ReleaseMode",
+]

flet_audio/audio.py

@@ -20,104 +20,103 @@ class Audio(ft.Service):
         AssertionError: If both [`src`][(c).] and [`src_base64`][(c).] are `None`.
 
     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.
     """
 
     src: Optional[str] = None
     """
-    The audio source. Can be a URL or a local [asset file](https://flet.dev/docs/cookbook/assets).
+    The audio source.
+    Can be a URL or a local [asset file](https://docs.flet.dev/cookbook/assets).
 
     Note:
-        - At least one of `src` or [`src_base64`][..] must be provided, 
-            with `src_base64` having priority if both are provided.
-        - [Here](https://github.com/bluefireteam/audioplayers/blob/main/troubleshooting.md#supported-formats--encodings) 
+        - At least one of `src` or [`src_base64`][flet_audio.Audio.src_base64] must be
+            provided, with `src_base64` having priority if both are provided.
+        - [Here](https://github.com/bluefireteam/audioplayers/blob/main/troubleshooting.md#supported-formats--encodings)
             is a list of supported audio formats.
     """
 
     src_base64: Optional[str] = None
     """
-    Sets the contents of audio file encoded in base-64 format.
-    
+    Defines the contents of audio file encoded in base-64 format.
+
     Note:
-        - At least one of [`src`][..] or `src_base64` must be provided, 
+        - At least one of [`src`][flet_audio.Audio.src] or `src_base64` must be provided,
             with `src_base64` having priority if both are provided.
-        - [Here](https://github.com/bluefireteam/audioplayers/blob/main/troubleshooting.md#supported-formats--encodings) 
+        - [Here](https://github.com/bluefireteam/audioplayers/blob/main/troubleshooting.md#supported-formats--encodings)
             is a list of supported audio formats.
     """
 
     autoplay: bool = False
     """
     Starts playing audio as soon as audio control is added to a page.
-    
+
     Note:
-        Autoplay works in desktop, mobile apps and Safari browser, but doesn't work in Chrome/Edge.
+        Autoplay works in desktop, mobile apps and Safari browser,
+        but doesn't work in Chrome/Edge.
     """
 
     volume: ft.Number = 1.0
     """
     Sets the volume (amplitude).
-    It's value ranges between `0.0` (mute) and `1.0` (maximum volume). 
+    It's value ranges between `0.0` (mute) and `1.0` (maximum volume).
     Intermediate values are linearly interpolated.
     """
 
     balance: ft.Number = 0.0
     """
-    Sets the stereo balance.
-
+    Defines the stereo balance.
 
-    * `-1` - The left channel is at full volume; the right channel is silent. 
-    * `1` - The right channel is at full volume; the left channel is silent. 
+    * `-1` - The left channel is at full volume; the right channel is silent.
+    * `1` - The right channel is at full volume; the left channel is silent.
     * `0` - Both channels are at the same volume.
     """
 
     playback_rate: ft.Number = 1.0
     """
-    Sets the playback rate. 
-    
+    Defines the playback rate.
+
     Should ideally be set when creating the constructor.
-    
-    Note: 
-        - iOS and macOS have limits between `0.5x` and `2x`. 
+
+    Note:
+        - iOS and macOS have limits between `0.5x` and `2x`.
         - Android SDK version should be 23 or higher.
     """
 
     release_mode: ReleaseMode = ReleaseMode.RELEASE
     """
-    Sets the release mode.
+    Defines the release mode.
     """
 
-    on_loaded: ft.OptionalControlEventHandler["Audio"] = None
+    on_loaded: Optional[ft.ControlEventHandler["Audio"]] = None
     """
     Fires when an audio is loaded/buffered.
     """
 
-    on_duration_change: ft.OptionalEventHandler[AudioDurationChangeEvent["Audio"]] = None
+    on_duration_change: Optional[ft.EventHandler[AudioDurationChangeEvent]] = None
     """
-    Fires as soon as audio duration is available (it might take a while to download or buffer it).
-
-    Event handler argument is of type [`AudioDurationChangeEvent`][(p).].
+    Fires as soon as audio duration is available
+    (it might take a while to download or buffer it).
     """
 
-    on_state_change: ft.OptionalEventHandler[AudioStateChangeEvent["Audio"]] = None
+    on_state_change: Optional[ft.EventHandler[AudioStateChangeEvent]] = None
     """
-    Fires when audio player state changes. 
-
-    Event handler argument is of type [`AudioStateChangeEvent`][(p).].
+    Fires when audio player state changes.
     """
 
-    on_position_change: ft.OptionalEventHandler[AudioPositionChangeEvent["Audio"]] = None
+    on_position_change: Optional[ft.EventHandler[AudioPositionChangeEvent]] = None
     """
-    Fires when audio position is changed. 
-    Will continuously update the position of the playback every 1 second if the status is playing. 
-    
-    Can be used for a progress bar.
+    Fires when audio position is changed.
+    Will continuously update the position of the playback
+    every 1 second if the status is playing.
 
-    Event handler argument is of type [`AudioPositionChangeEvent`][(p).].
+    Can be used for a progress bar.
     """
 
-    on_seek_complete: ft.OptionalControlEventHandler["Audio"] = None
+    on_seek_complete: Optional[ft.ControlEventHandler["Audio"]] = None
     """
-    Fires on seek completions. 
+    Fires on seek completions.
     An event is going to be sent as soon as the audio seek is finished.
     """
 
@@ -125,25 +124,35 @@ class Audio(ft.Service):
         super().before_update()
         assert self.src or self.src_base64, "either src or src_base64 must be provided"
 
-    async def play_async(self, position: ft.DurationValue = ft.Duration(), timeout: Optional[float] = 10):
+    async def play_async(
+        self, position: ft.DurationValue = ft.Duration(), timeout: Optional[float] = 10
+    ):
         """
         Starts playing audio from the specified `position`.
 
         Args:
             position: The position to start playback from.
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
-        await self._invoke_method_async("play", {"position": position}, timeout=timeout)
-
-    def play(self, position: ft.DurationValue = ft.Duration(), timeout: Optional[float] = 10):
+        await self._invoke_method_async(
+            method_name="play",
+            arguments={"position": position},
+            timeout=timeout,
+        )
+
+    def play(
+        self, position: ft.DurationValue = ft.Duration(), timeout: Optional[float] = 10
+    ):
         """
         Starts playing audio from the specified `position`.
 
         Args:
             position: The position to start playback from.
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -153,7 +162,8 @@ class Audio(ft.Service):
         """
         Pauses the audio that is currently playing.
 
-        If you call [`resume()`][.resume] or [`resume_async()`][.resume_async] later,
+        If you call [`resume()`][flet_audio.Audio.resume] or
+        [`resume_async()`][flet_audio.Audio.resume_async] later,
         the audio will resume from the point that it has been paused.
         """
         await self._invoke_method_async("pause", timeout=timeout)
@@ -162,11 +172,13 @@ class Audio(ft.Service):
         """
         Pauses the audio that is currently playing.
 
-        If you call [`resume()`][.resume] or [`resume_async()`][.resume_async] later,
+        If you call [`resume()`][flet_audio.Audio.resume] or
+        [`resume_async()`][flet_audio.Audio.resume_async] later,
         the audio will resume from the point that it has been paused.
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -178,6 +190,7 @@ class Audio(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -189,6 +202,7 @@ class Audio(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -198,10 +212,12 @@ class Audio(ft.Service):
         """
         Releases the resources associated with this media player.
         These are going to be fetched or buffered again as soon as
-        you change the source or call [`resume()`][.resume] or [`resume_async()`][.resume_async].
+        you change the source or call [`resume()`][flet_audio.Audio.resume] or
+        [`resume_async()`][flet_audio.Audio.resume_async].
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -211,26 +227,35 @@ class Audio(ft.Service):
         """
         Releases the resources associated with this media player.
         These are going to be fetched or buffered again as soon as
-        you change the source or call [`resume()`][.resume] or [`resume_async()`][.resume_async].
+        you change the source or call [`resume()`][flet_audio.Audio.resume] or
+        [`resume_async()`][flet_audio.Audio.resume_async].
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
         asyncio.create_task(self.release_async(timeout=timeout))
 
-    async def seek_async(self, position: ft.DurationValue, timeout: Optional[float] = 10):
+    async def seek_async(
+        self, position: ft.DurationValue, timeout: Optional[float] = 10
+    ):
         """
         Moves the cursor to the desired position.
 
         Args:
             position: The position to seek/move to.
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
-        await self._invoke_method_async("seek", {"position": position}, timeout=timeout)
+        await self._invoke_method_async(
+            method_name="seek",
+            arguments={"position": position},
+            timeout=timeout,
+        )
 
     def seek(self, position: ft.DurationValue, timeout: Optional[float] = 10):
         """
@@ -239,12 +264,15 @@ class Audio(ft.Service):
         Args:
             position: The position to seek/move to.
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
         asyncio.create_task(self.seek_async(position, timeout=timeout))
 
-    async def get_duration_async(self, timeout: Optional[float] = 10) -> Optional[ft.Duration]:
+    async def get_duration_async(
+        self, timeout: Optional[float] = 10
+    ) -> Optional[ft.Duration]:
         """
         Get audio duration of the audio playback.
 
@@ -253,20 +281,31 @@ class Audio(ft.Service):
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             The duration of audio playback.
+
         Raises:
             TimeoutError: If the request times out.
         """
-        return await self._invoke_method_async("get_duration", timeout=timeout)
-
-    async def get_current_position_async(self, timeout: Optional[float] = 10) -> Optional[ft.Duration]:
+        return await self._invoke_method_async(
+            method_name="get_duration",
+            timeout=timeout,
+        )
+
+    async def get_current_position_async(
+        self, timeout: Optional[float] = 10
+    ) -> Optional[ft.Duration]:
         """
         Get the current position of the audio playback.
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Returns:
             The current position of the audio playback.
         """
-        return await self._invoke_method_async("get_current_position", timeout=timeout)
+        return await self._invoke_method_async(
+            method_name="get_current_position",
+            timeout=timeout,
+        )

flet_audio/types.py

@@ -1,12 +1,17 @@
+from dataclasses import dataclass
 from enum import Enum
+from typing import TYPE_CHECKING
 
 import flet as ft
 
+if TYPE_CHECKING:
+    from .audio import Audio  # noqa
+
 __all__ = [
+    "AudioDurationChangeEvent",
+    "AudioPositionChangeEvent",
     "AudioState",
     "AudioStateChangeEvent",
-    "AudioPositionChangeEvent",
-    "AudioDurationChangeEvent",
     "ReleaseMode",
 ]
 
@@ -19,10 +24,11 @@ class ReleaseMode(Enum):
     Releases all resources, just like calling release method.
 
     Info:
-        - In Android, the media player is quite resource-intensive, and this will
-        let it go. Data will be buffered again when needed (if it's a remote file,
-        it will be downloaded again).
-        - In iOS and macOS, works just like [`Audio.stop()`][(p).Audio.stop] method.
+        - On Android, the media player is quite resource-intensive, and this will
+            let it go. Data will be buffered again when needed (if it's a remote file,
+            it will be downloaded again).
+        - On iOS and macOS, works just like [`Audio.release()`][flet_audio.Audio.release]
+            method.
     """
 
     LOOP = "loop"
@@ -41,6 +47,7 @@ class ReleaseMode(Enum):
 
 class AudioState(Enum):
     """The state of the audio player."""
+
     STOPPED = "stopped"
     """The audio player is stopped."""
 
@@ -57,13 +64,31 @@ class AudioState(Enum):
     """The audio player has been disposed of and should not be used anymore."""
 
 
-class AudioStateChangeEvent(ft.Event[ft.EventControlType]):
+@dataclass
+class AudioStateChangeEvent(ft.Event["Audio"]):
+    """
+    Event triggered when the audio playback state changes.
+    """
+
     state: AudioState
+    """The current state of the audio player."""
+
 
+@dataclass
+class AudioPositionChangeEvent(ft.Event["Audio"]):
+    """
+    Event triggered when the audio playback position changes.
+    """
 
-class AudioPositionChangeEvent(ft.Event[ft.EventControlType]):
     position: int
+    """The current playback position in milliseconds."""
 
 
-class AudioDurationChangeEvent(ft.Event[ft.EventControlType]):
-    duration: int
+@dataclass
+class AudioDurationChangeEvent(ft.Event["Audio"]):
+    """
+    Event triggered when the audio duration changes.
+    """
+
+    duration: ft.Duration
+    """The duration of the audio."""

{flet_audio-0.2.0.dev42.dist-info → flet_audio-0.2.0.dev58.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet-audio
-Version: 0.2.0.dev42
+Version: 0.2.0.dev58
 Summary: Eases audio integration and playback in Flet apps.
 Author-email: Flet contributors <hello@flet.dev>
 License-Expression: Apache-2.0

flet_audio-0.2.0.dev58.dist-info/RECORD

@@ -0,0 +1,18 @@
+flet_audio/__init__.py,sha256=6uWGMdSCJYudjp3naJzcbM89EcupsJ2De2J9rmDV0ME,326
+flet_audio/audio.py,sha256=a_APLvecPmJMtAsiMIcfX8Ctoo8r3A1OPVZjZ8KpB0A,9885
+flet_audio/types.py,sha256=ZxjM1LSKQospbvv9qrcwnpmka0tFtva_4M38prn9GdI,2330
+flet_audio-0.2.0.dev58.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+flutter/flet_audio/CHANGELOG.md,sha256=66sWepPaeTc9_lzcYIGU55AlxSU5Z1XVtknXpzd_-p8,40
+flutter/flet_audio/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
+flutter/flet_audio/README.md,sha256=BEITqZ4okarTGCquI4ii6tdffGm2qyxMkMZbsedCwLQ,60
+flutter/flet_audio/analysis_options.yaml,sha256=32kjGAc-zF87inWaH5M46yGZWQDTwrwfvNLHeAocfG4,154
+flutter/flet_audio/pubspec.lock,sha256=BxIAyK5slzN4RTADs8Byq6oa5UkSTu6Bijzse0WRh08,25471
+flutter/flet_audio/pubspec.yaml,sha256=AzhTbc7Ccloq9APOXFIgTgkPSivh_g1ONnzKpv-zf3M,510
+flutter/flet_audio/lib/flet_audio.dart,sha256=JsHEW9Gic_011jhKpnn278pi1kiWjp9gUjfNF5rWmXs,65
+flutter/flet_audio/lib/src/audio.dart,sha256=ExGoAU9pIlR5z6ptVDXRMhD5NktkBljN9OgRy5InfIw,5108
+flutter/flet_audio/lib/src/extension.dart,sha256=okI-bxwSUB9FwgJ7TmiiHcE5yi5z66Yp1ri--V1wVnw,299
+flutter/flet_audio/lib/src/utils/audio.dart,sha256=Rpbf7xJkNB3xtwrfmXru1t2k3_TgPEnh3Ws6i_2J0EQ,346
+flet_audio-0.2.0.dev58.dist-info/METADATA,sha256=4K69ubpkH1-Us0OT6aKbstliBPfFl2K3-hZQUalyCsU,1935
+flet_audio-0.2.0.dev58.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+flet_audio-0.2.0.dev58.dist-info/top_level.txt,sha256=hZbGOXppSiKRUWJf1ZRlBKMyfijq6Y-8DffGOh10Wq4,19
+flet_audio-0.2.0.dev58.dist-info/RECORD,,

flutter/flet_audio/lib/src/audio.dart

@@ -33,12 +33,12 @@ class AudioService extends FletService {
 
     _onDurationChangedSubscription =
         player.onDurationChanged.listen((duration) {
-      control.triggerEvent(
-          "duration_change", {"duration": duration.inMilliseconds});
+      control.triggerEvent("duration_change", {"duration": duration});
       _duration = duration;
     });
 
-    _onStateChangedSubscription = player.onPlayerStateChanged.listen((PlayerState state) {
+    _onStateChangedSubscription =
+        player.onPlayerStateChanged.listen((PlayerState state) {
       control.triggerEvent("state_change", {"state": state.name});
     });
 
@@ -116,10 +116,7 @@ class AudioService extends FletService {
         await player.setPlaybackRate(playbackRate);
       }
 
-      if (!kIsWeb &&
-          balance != _balance &&
-          balance >= -1 &&
-          balance <= 1) {
+      if (!kIsWeb && balance != _balance && balance >= -1 && balance <= 1) {
         _balance = balance;
         await player.setBalance(balance);
       }

flutter/flet_audio/pubspec.lock

@@ -190,7 +190,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"
@@ -211,10 +211,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
@@ -322,10 +322,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:

flutter/flet_audio/pubspec.yaml

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

flet_audio-0.2.0.dev42.dist-info/RECORD

@@ -1,18 +0,0 @@
-flet_audio/__init__.py,sha256=aLfmcJXT-xQPy6DAn-jQCh0fXRk5ji96Fg15PL5lo0E,151
-flet_audio/audio.py,sha256=QFkZHVEV_TtxnHUh2AIg6ayY2xxfjgEiYlmy2wTYGo4,9572
-flet_audio/types.py,sha256=WvpNbUxjtoGW9YUW3VM1DhhQ8UQbnfvr39MBwJeFNK4,1800
-flet_audio-0.2.0.dev42.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-flutter/flet_audio/CHANGELOG.md,sha256=66sWepPaeTc9_lzcYIGU55AlxSU5Z1XVtknXpzd_-p8,40
-flutter/flet_audio/LICENSE,sha256=QwcOLU5TJoTeUhuIXzhdCEEDDvorGiC6-3YTOl4TecE,11356
-flutter/flet_audio/README.md,sha256=BEITqZ4okarTGCquI4ii6tdffGm2qyxMkMZbsedCwLQ,60
-flutter/flet_audio/analysis_options.yaml,sha256=32kjGAc-zF87inWaH5M46yGZWQDTwrwfvNLHeAocfG4,154
-flutter/flet_audio/pubspec.lock,sha256=Rje88uBW7vkOXea40g_LPnX_P5pFO1r-3gE_5X3Mris,25471
-flutter/flet_audio/pubspec.yaml,sha256=_lJ8tH_SgiuDKkYdpHOlzPYqNguX5mMlaEfZJbz_KFg,510
-flutter/flet_audio/lib/flet_audio.dart,sha256=JsHEW9Gic_011jhKpnn278pi1kiWjp9gUjfNF5rWmXs,65
-flutter/flet_audio/lib/src/audio.dart,sha256=4rHAZCcXeA6ZbFpSENlyc210y5GpVO_zmcfOkcYh-ic,5156
-flutter/flet_audio/lib/src/extension.dart,sha256=okI-bxwSUB9FwgJ7TmiiHcE5yi5z66Yp1ri--V1wVnw,299
-flutter/flet_audio/lib/src/utils/audio.dart,sha256=Rpbf7xJkNB3xtwrfmXru1t2k3_TgPEnh3Ws6i_2J0EQ,346
-flet_audio-0.2.0.dev42.dist-info/METADATA,sha256=LLnFbuVGF75wyivQgiygO2t4dJN3A6gebBCEvrZnrwM,1935
-flet_audio-0.2.0.dev42.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-flet_audio-0.2.0.dev42.dist-info/top_level.txt,sha256=hZbGOXppSiKRUWJf1ZRlBKMyfijq6Y-8DffGOh10Wq4,19
-flet_audio-0.2.0.dev42.dist-info/RECORD,,