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

flet_audio/audio.py

@@ -20,7 +20,8 @@ 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
@@ -36,7 +37,7 @@ class Audio(ft.Service):
 
     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, 
@@ -62,7 +63,7 @@ class Audio(ft.Service):
 
     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. 
@@ -72,7 +73,7 @@ class Audio(ft.Service):
 
     playback_rate: ft.Number = 1.0
     """
-    Sets the playback rate. 
+    Defines the playback rate. 
     
     Should ideally be set when creating the constructor.
     
@@ -83,39 +84,33 @@ class Audio(ft.Service):
 
     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["Audio"]]] = 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).].
     """
 
-    on_state_change: ft.OptionalEventHandler[AudioStateChangeEvent["Audio"]] = None
+    on_state_change: Optional[ft.EventHandler[AudioStateChangeEvent["Audio"]]] = 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["Audio"]]] = 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.
-
-    Event handler argument is of type [`AudioPositionChangeEvent`][(p).].
     """
 
-    on_seek_complete: ft.OptionalControlEventHandler["Audio"] = None
+    on_seek_complete: Optional[ft.ControlEventHandler["Audio"]] = None
     """
     Fires on seek completions. 
     An event is going to be sent as soon as the audio seek is finished.
@@ -132,6 +127,7 @@ class Audio(ft.Service):
         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.
         """
@@ -144,6 +140,7 @@ class Audio(ft.Service):
         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 +150,7 @@ 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()`][(c).resume] or [`resume_async()`][(c).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 +159,12 @@ 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()`][(c).resume] or [`resume_async()`][(c).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 +176,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 +188,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 +198,11 @@ 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()`][(c).resume] or [`resume_async()`][(c).resume_async].
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -211,10 +212,11 @@ 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()`][(c).resume] or [`resume_async()`][(c).resume_async].
 
         Args:
             timeout: The maximum amount of time (in seconds) to wait for a response.
+
         Raises:
             TimeoutError: If the request times out.
         """
@@ -227,6 +229,7 @@ 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.
         """
@@ -239,6 +242,7 @@ 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.
         """
@@ -253,8 +257,10 @@ 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.
         """

flet_audio/types.py

@@ -1,3 +1,4 @@
+from dataclasses import dataclass, field
 from enum import Enum
 
 import flet as ft
@@ -19,10 +20,10 @@ class ReleaseMode(Enum):
     Releases all resources, just like calling release method.
 
     Info:
-        - In Android, the media player is quite resource-intensive, and this will
+        - 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).
-        - In iOS and macOS, works just like [`Audio.stop()`][(p).Audio.stop] method.
+        - On iOS and macOS, works just like [`Audio.release()`][(p).Audio.release] method.
     """
 
     LOOP = "loop"
@@ -41,6 +42,7 @@ class ReleaseMode(Enum):
 
 class AudioState(Enum):
     """The state of the audio player."""
+
     STOPPED = "stopped"
     """The audio player is stopped."""
 
@@ -57,13 +59,31 @@ class AudioState(Enum):
     """The audio player has been disposed of and should not be used anymore."""
 
 
+@dataclass
 class AudioStateChangeEvent(ft.Event[ft.EventControlType]):
+    """
+    Event triggered when the audio playback state changes.
+    """
+
     state: AudioState
+    """The current state of the audio player."""
 
 
+@dataclass
 class AudioPositionChangeEvent(ft.Event[ft.EventControlType]):
+    """
+    Event triggered when the audio playback position changes.
+    """
+
     position: int
+    """The current playback position in milliseconds."""
 
 
+@dataclass
 class AudioDurationChangeEvent(ft.Event[ft.EventControlType]):
-    duration: int
+    """
+    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.dev51.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flet-audio
-Version: 0.2.0.dev42
+Version: 0.2.0.dev51
 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.dev42.dist-info → flet_audio-0.2.0.dev51.dist-info}/RECORD

@@ -1,7 +1,7 @@
 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
+flet_audio/audio.py,sha256=IaJ_nIp410ClXFZRTlhwOLvQv9xv2heuQikCjeXeNig,9444
+flet_audio/types.py,sha256=YJ_RYQanID06LZ8q3APHcM7QBielawXNo5ft8Zi0VKw,2257
+flet_audio-0.2.0.dev51.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
@@ -9,10 +9,10 @@ flutter/flet_audio/analysis_options.yaml,sha256=32kjGAc-zF87inWaH5M46yGZWQDTwrwf
 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/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.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,,
+flet_audio-0.2.0.dev51.dist-info/METADATA,sha256=lxqKNt7Aj8VEWIAyF6ub3_0DIkyjcBhHfvwyG05_Zoo,1935
+flet_audio-0.2.0.dev51.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+flet_audio-0.2.0.dev51.dist-info/top_level.txt,sha256=hZbGOXppSiKRUWJf1ZRlBKMyfijq6Y-8DffGOh10Wq4,19
+flet_audio-0.2.0.dev51.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);
       }