html_compose.attributes.video_attrs

  1from . import BaseAttribute
  2from typing import Literal
  3
  4
  5class VideoAttrs:
  6    """
  7    This module contains functions for attributes in the 'video' element.
  8    Which is inherited by a class so we can generate type hints
  9    """
 10
 11    @staticmethod
 12    def autoplay(value: bool) -> BaseAttribute:
 13        """
 14        "video" attribute: autoplay
 15        Hint that the media resource can be started automatically when the page is loaded
 16
 17        Args:
 18            value:
 19                Boolean attribute
 20
 21        Returns:
 22            An autoplay attribute to be added to your element
 23
 24        """
 25
 26        return BaseAttribute("autoplay", value)
 27
 28    @staticmethod
 29    def controls(value: bool) -> BaseAttribute:
 30        """
 31        "video" attribute: controls
 32        Show user agent controls
 33
 34        Args:
 35            value:
 36                Boolean attribute
 37
 38        Returns:
 39            An controls attribute to be added to your element
 40
 41        """
 42
 43        return BaseAttribute("controls", value)
 44
 45    @staticmethod
 46    def crossorigin(
 47        value: Literal["anonymous", "use-credentials"],
 48    ) -> BaseAttribute:
 49        """
 50        "video" attribute: crossorigin
 51        How the element handles crossorigin requests
 52
 53        Args:
 54            value:
 55                ['anonymous', 'use-credentials']
 56
 57        Returns:
 58            An crossorigin attribute to be added to your element
 59
 60        """
 61
 62        return BaseAttribute("crossorigin", value)
 63
 64    @staticmethod
 65    def height(value: int) -> BaseAttribute:
 66        """
 67        "video" attribute: height
 68        Vertical dimension
 69
 70        Args:
 71            value:
 72                Valid non-negative integer
 73
 74        Returns:
 75            An height attribute to be added to your element
 76
 77        """
 78
 79        return BaseAttribute("height", value)
 80
 81    @staticmethod
 82    def loop(value: bool) -> BaseAttribute:
 83        """
 84        "video" attribute: loop
 85        Whether to loop the media resource
 86
 87        Args:
 88            value:
 89                Boolean attribute
 90
 91        Returns:
 92            An loop attribute to be added to your element
 93
 94        """
 95
 96        return BaseAttribute("loop", value)
 97
 98    @staticmethod
 99    def muted(value: bool) -> BaseAttribute:
100        """
101        "video" attribute: muted
102        Whether to mute the media resource by default
103
104        Args:
105            value:
106                Boolean attribute
107
108        Returns:
109            An muted attribute to be added to your element
110
111        """
112
113        return BaseAttribute("muted", value)
114
115    @staticmethod
116    def playsinline(value: bool) -> BaseAttribute:
117        """
118        "video" attribute: playsinline
119        Encourage the user agent to display video content within the element's playback area
120
121        Args:
122            value:
123                Boolean attribute
124
125        Returns:
126            An playsinline attribute to be added to your element
127
128        """
129
130        return BaseAttribute("playsinline", value)
131
132    @staticmethod
133    def poster(value) -> BaseAttribute:
134        """
135        "video" attribute: poster
136        Poster frame to show prior to video playback
137
138        Args:
139            value:
140                Valid non-empty URL potentially surrounded by spaces
141
142        Returns:
143            An poster attribute to be added to your element
144
145        """
146
147        return BaseAttribute("poster", value)
148
149    @staticmethod
150    def preload(value: Literal["none", "metadata", "auto"]) -> BaseAttribute:
151        """
152        "video" attribute: preload
153        Hints how much buffering the media resource will likely need
154
155        Args:
156            value:
157                ['none', 'metadata', 'auto']
158
159        Returns:
160            An preload attribute to be added to your element
161
162        """
163
164        return BaseAttribute("preload", value)
165
166    @staticmethod
167    def src(value) -> BaseAttribute:
168        """
169        "video" attribute: src
170        Address of the resource
171
172        Args:
173            value:
174                Valid non-empty URL potentially surrounded by spaces
175
176        Returns:
177            An src attribute to be added to your element
178
179        """
180
181        return BaseAttribute("src", value)
182
183    @staticmethod
184    def width(value: int) -> BaseAttribute:
185        """
186        "video" attribute: width
187        Horizontal dimension
188
189        Args:
190            value:
191                Valid non-negative integer
192
193        Returns:
194            An width attribute to be added to your element
195
196        """
197
198        return BaseAttribute("width", value)