audio.pyi 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. """Stub file for reflex/components/react_player/audio.py"""
  2. # ------------------- DO NOT EDIT ----------------------
  3. # This file was generated by `reflex/utils/pyi_generator.py`!
  4. # ------------------------------------------------------
  5. from typing import Any, Callable, Dict, Optional, Union, overload
  6. from reflex.components.react_player.react_player import ReactPlayer
  7. from reflex.event import EventHandler, EventSpec
  8. from reflex.style import Style
  9. from reflex.vars.base import Var
  10. class Audio(ReactPlayer):
  11. pass
  12. @overload
  13. @classmethod
  14. def create( # type: ignore
  15. cls,
  16. *children,
  17. url: Optional[Union[Var[str], str]] = None,
  18. playing: Optional[Union[Var[bool], bool]] = None,
  19. loop: Optional[Union[Var[bool], bool]] = None,
  20. controls: Optional[Union[Var[bool], bool]] = None,
  21. light: Optional[Union[Var[bool], bool]] = None,
  22. volume: Optional[Union[Var[float], float]] = None,
  23. muted: Optional[Union[Var[bool], bool]] = None,
  24. width: Optional[Union[Var[str], str]] = None,
  25. height: Optional[Union[Var[str], str]] = None,
  26. style: Optional[Style] = None,
  27. key: Optional[Any] = None,
  28. id: Optional[Any] = None,
  29. class_name: Optional[Any] = None,
  30. autofocus: Optional[bool] = None,
  31. custom_attrs: Optional[Dict[str, Union[Var, str]]] = None,
  32. on_blur: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  33. on_buffer: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  34. on_buffer_end: Optional[
  35. Union[EventHandler, EventSpec, list, Callable, Var]
  36. ] = None,
  37. on_click: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  38. on_click_preview: Optional[
  39. Union[EventHandler, EventSpec, list, Callable, Var]
  40. ] = None,
  41. on_context_menu: Optional[
  42. Union[EventHandler, EventSpec, list, Callable, Var]
  43. ] = None,
  44. on_disable_pip: Optional[
  45. Union[EventHandler, EventSpec, list, Callable, Var]
  46. ] = None,
  47. on_double_click: Optional[
  48. Union[EventHandler, EventSpec, list, Callable, Var]
  49. ] = None,
  50. on_duration: Optional[
  51. Union[EventHandler, EventSpec, list, Callable, Var]
  52. ] = None,
  53. on_enable_pip: Optional[
  54. Union[EventHandler, EventSpec, list, Callable, Var]
  55. ] = None,
  56. on_ended: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  57. on_error: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  58. on_focus: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  59. on_mount: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  60. on_mouse_down: Optional[
  61. Union[EventHandler, EventSpec, list, Callable, Var]
  62. ] = None,
  63. on_mouse_enter: Optional[
  64. Union[EventHandler, EventSpec, list, Callable, Var]
  65. ] = None,
  66. on_mouse_leave: Optional[
  67. Union[EventHandler, EventSpec, list, Callable, Var]
  68. ] = None,
  69. on_mouse_move: Optional[
  70. Union[EventHandler, EventSpec, list, Callable, Var]
  71. ] = None,
  72. on_mouse_out: Optional[
  73. Union[EventHandler, EventSpec, list, Callable, Var]
  74. ] = None,
  75. on_mouse_over: Optional[
  76. Union[EventHandler, EventSpec, list, Callable, Var]
  77. ] = None,
  78. on_mouse_up: Optional[
  79. Union[EventHandler, EventSpec, list, Callable, Var]
  80. ] = None,
  81. on_pause: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  82. on_play: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  83. on_playback_quality_change: Optional[
  84. Union[EventHandler, EventSpec, list, Callable, Var]
  85. ] = None,
  86. on_playback_rate_change: Optional[
  87. Union[EventHandler, EventSpec, list, Callable, Var]
  88. ] = None,
  89. on_progress: Optional[
  90. Union[EventHandler, EventSpec, list, Callable, Var]
  91. ] = None,
  92. on_ready: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  93. on_scroll: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  94. on_seek: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  95. on_start: Optional[Union[EventHandler, EventSpec, list, Callable, Var]] = None,
  96. on_unmount: Optional[
  97. Union[EventHandler, EventSpec, list, Callable, Var]
  98. ] = None,
  99. **props,
  100. ) -> "Audio":
  101. """Create the component.
  102. Args:
  103. *children: The children of the component.
  104. url: The url of a video or song to play
  105. playing: Set to true or false to pause or play the media
  106. loop: Set to true or false to loop the media
  107. controls: Set to true or false to display native player controls.
  108. light: Set to true to show just the video thumbnail, which loads the full player on click
  109. volume: Set the volume of the player, between 0 and 1
  110. muted: Mutes the player
  111. width: Set the width of the player: ex:640px
  112. height: Set the height of the player: ex:640px
  113. style: The style of the component.
  114. key: A unique key for the component.
  115. id: The id for the component.
  116. class_name: The class name for the component.
  117. autofocus: Whether the component should take the focus once the page is loaded
  118. custom_attrs: custom attribute
  119. **props: The props of the component.
  120. Returns:
  121. The component.
  122. """
  123. ...