You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
40 lines
1.6 KiB
40 lines
1.6 KiB
import warnings |
|
from pathlib import Path |
|
from typing import Union |
|
|
|
from .. import globals # pylint: disable=redefined-builtin |
|
from ..element import Element |
|
|
|
|
|
class Audio(Element, component='audio.js'): |
|
|
|
def __init__(self, src: Union[str, Path], *, |
|
controls: bool = True, |
|
autoplay: bool = False, |
|
muted: bool = False, |
|
loop: bool = False, |
|
type: str = '', # DEPRECATED, pylint: disable=redefined-builtin |
|
) -> None: |
|
"""Audio |
|
|
|
:param src: URL or local file path of the audio source |
|
:param controls: whether to show the audio controls, like play, pause, and volume (default: `True`) |
|
:param autoplay: whether to start playing the audio automatically (default: `False`) |
|
:param muted: whether the audio should be initially muted (default: `False`) |
|
:param loop: whether the audio should loop (default: `False`) |
|
|
|
See `here <https://developer.mozilla.org/en-US/docs/Web/HTML/Element/audio#events>`_ |
|
for a list of events you can subscribe to using the generic event subscription `on()`. |
|
""" |
|
super().__init__() |
|
if Path(src).is_file(): |
|
src = globals.app.add_media_file(local_file=src) |
|
self._props['src'] = src |
|
self._props['controls'] = controls |
|
self._props['autoplay'] = autoplay |
|
self._props['muted'] = muted |
|
self._props['loop'] = loop |
|
|
|
if type: |
|
url = 'https://github.com/zauberzeug/nicegui/pull/624' |
|
warnings.warn(DeprecationWarning(f'The type parameter for ui.audio is deprecated and ineffective ({url}).'))
|
|
|