HTMLVideoElement

Overview

HTMLVideoElement is a class in Aspose.Html FOSS for Python. Inherits from: HTMLMediaElement.

HTML <video> element.

This class provides 84 methods for working with HTMLVideoElement objects in Python programs. Available methods include: __init__, add_event_listener, add_text_track, after, append, append_child, attach_shadow, before, blur, can_play_type, check_visibility, click, and 72 additional methods. All public members are accessible to any Python application after installing the Aspose.Html FOSS for Python package. Properties: access_key, access_key_label, assigned_slot, attributes, audio_tracks, auto_play, and 101 more.

Properties

Name	Type	Access	Description
`width`	`int`	Read/Write	The `width` attribute as integer (default `0`).
`height`	`int`	Read/Write	The `height` attribute as integer (default `0`).
`video_width`	`int`	Read	Intrinsic video width (stub, always `0`).
`video_height`	`int`	Read	Intrinsic video height (stub, always `0`).
`poster`	`str`	Read/Write	The `poster` attribute value, or `''` when absent.
`plays_inline`	`bool`	Read/Write	Whether the `playsinline` boolean attribute is present.
`disable_picture_in_picture`	`bool`	Read/Write	Boolean attribute reflection for `disablepictureinpicture`.
`webkit_decoded_frame_count`	`int`	Read	Number of decoded video frames (stub, always `0`).
`webkit_dropped_frame_count`	`int`	Read	Number of dropped video frames (headless stub — always `0`).
`src`	`str`	Read	The `src` attribute value, or `''` when absent.
`current_src`	`str`	Read	Current selected source URL (stub, always `''`).
`auto_play`	`bool`	Read	Boolean reflection of the `autoplay` attribute.
`controls`	`bool`	Read	Boolean reflection of the `controls` attribute.
`loop`	`bool`	Read	Boolean reflection of the `loop` attribute.
`muted`	`bool`	Read	Boolean reflection of the `muted` attribute.
`preload`	`str`	Read	The `preload` attribute value, or `''` when absent.
`cross_origin`	`str \| None`	Read	The `crossorigin` attribute value, or `None` when absent.
`paused`	`bool`	Read	Playback paused state (stub, always `True`).
`ended`	`bool`	Read	Playback ended state (stub, always `False`).
`duration`	`float`	Read	Media duration in seconds (stub, always NaN).
`current_time`	`float`	Read/Write	Current playback position in seconds (stub, always `0.0`).
`volume`	`float`	Read/Write	Audio volume level (stub, always `1.0`).
`default_muted`	`bool`	Read	Default muted state reflected from `muted` attribute.
`ready_state`	`int`	Read	Readiness state (stub, always `0` = HAVE_NOTHING).
`network_state`	`int`	Read	Network state (stub, always `0` = NETWORK_EMPTY).
`buffered`	`"_TimeRanges"`	Read	Buffered time ranges (stub, always empty).
`played`	`"_TimeRanges"`	Read	Played time ranges (stub, always empty).
`seekable`	`"_TimeRanges"`	Read	Seekable time ranges (stub, always empty).
`seeking`	`bool`	Read	Whether the element is currently seeking (stub, always `False`).
`default_playback_rate`	`float`	Read/Write	Default playback rate (headless default `1.0`).
`playback_rate`	`float`	Read/Write	Current playback rate (headless default `1.0`).
`media_keys`	`None`	Read	Associated MediaKeys object (stub, always `None`).
`src_object`	`None`	Read	Associated MediaStream/Blob (stub, always `None`).
`error`	`None`	Read	Last media error (stub, always `None`).
`text_tracks`	`"_EmptyTrackList"`	Read	Text track list (stub, always empty).
`audio_tracks`	`"_EmptyTrackList"`	Read	Audio track list (stub, always empty).
`video_tracks`	`"_EmptyTrackList"`	Read	Video track list (stub, always empty).
`hidden`	`bool`	Read/Write	Whether the element is hidden (reflects the `hidden` boolean attribute).
`title`	`str`	Read/Write	The tooltip title of this element (reflects the `title` attribute).
`lang`	`str`	Read/Write	The language of the element’s content (reflects the `lang` attribute).
`tab_index`	`int`	Read/Write	The tab order index of this element (reflects the `tabindex` attribute).
`access_key`	`str`	Read/Write	The keyboard shortcut key for this element (reflects the `accesskey`

    attribute). |

Methods

Signature	Description
`request_picture_in_picture()`	Raise `NotSupportedError` — PiP is unavailable in headless mode.
`play()`	Start playback (stub no-op).
`pause()`	Pause playback (stub no-op).
`load()`	Reload media resource selection (stub no-op).
`can_play_type(type: str)` → `str`	Return `''` — headless mode cannot play any media type.
`add_text_track(kind: str, label: str, language: str)`	Add a text track (stub no-op, returns `None`).
`click()`	Dispatch a synthetic click event on this element.
`focus(options: "dict \| None")`	Dispatch a non-bubbling `'focus'` event on this element.
`blur()`	Dispatch a non-bubbling `'blur'` event on this element.
`show_popover()`	Show this element as a popover (no-op in headless mode).
`hide_popover()`	Hide this element’s popover (no-op in headless mode).
`toggle_popover(force: "bool \| None")` → `bool`	Toggle this element’s popover state (no-op, always returns `False`).
`__init__(local_name: str, namespace_uri: str \| None, prefix: str \| None, owner_document: Document \| None)`	Calls init(local_name, namespace_uri, prefix, owner_document) on this HTMLVideoElement instance.
`get_computed_style()` → `"ComputedStyleDeclaration"`	Return phase-2 cascade-resolved declarations for this element.
`insert_adjacent_html(position: str, html: str)`	Insert parsed HTML markup relative to this element.
`insert_adjacent_text(position: str, text: str)`	Insert a text node relative to this element.
`insert_adjacent_element(position: str, element: "Element \| None")` → `"Element \| None"`	Insert element at position relative to this element.
`get_attribute(name: str)` → `str \| None`	Return the value of attribute name, or `None` if absent.
`set_attribute(name: str, value: str)`	Set attribute name to value, creating it if not present.
`remove_attribute(name: str)`	Remove attribute name.
`has_attribute(name: str)` → `bool`	Return `True` if attribute name exists on this element.
`get_attribute_node(name: str)` → `"Attr \| None"`	Return the `Attr` object for attribute name, or `None` if absent.
`set_attribute_node(attr: "Attr")` → `"Attr \| None"`	Insert or replace attr in this element’s attribute set.
`remove_attribute_node(attr: "Attr")` → `"Attr"`	Remove attr from this element’s attribute set and return it.
`get_attribute_node_ns(namespace_uri: str \| None, local_name: str)` → `"Attr \| None"`	Return the `Attr` node matching namespace_uri and local_name, or `None`.
`set_attribute_node_ns(attr: "Attr")` → `"Attr \| None"`	Insert or replace a namespaced `Attr` node.
`remove_attribute_node_ns(namespace_uri: str \| None, local_name: str)` → `"Attr"`	Remove and return the `Attr` node matching namespace_uri and local_name.
`get_attribute_ns(namespace_uri: str \| None, local_name: str)` → `str \| None`	Return the value of the namespaced attribute, or `None` if absent.
`set_attribute_ns(namespace_uri: str \| None, qualified_name: str, value: str)`	Set a namespaced attribute to value, creating it if not present.
`has_attribute_ns(namespace_uri: str \| None, local_name: str)` → `bool`	Return `True` if a namespaced attribute with the given local name exists.
`remove_attribute_ns(namespace_uri: str \| None, local_name: str)`	Remove the namespaced attribute.
`toggle_attribute(name: str, force: bool \| None)` → `bool`	Toggle attribute name and return its new presence state.
`get_attribute_names()` → `list[str]`	Return the qualified names of all attributes in collection order.
`has_attributes()` → `bool`	Return `True` when this element has one or more attributes.
`scroll_into_view(arg: bool \| dict \| None)`	Scroll this element into view (no-op in server-side context).
`scroll(x_or_options: float \| dict \| None, y: float \| None)`	Scroll this element to coordinates (no-op in server-side context).
`scroll_into_view_if_needed(center_if_needed: bool)`	Scroll this element into view if it is not already visible (no-op in headless mode).
`set_pointer_capture(pointer_id: int)`	Designate this element as the capture target for the given pointer (no-op).
`release_pointer_capture(pointer_id: int)`	Release pointer capture for the given pointer id (no-op).
`has_pointer_capture(pointer_id: int)` → `bool`	Return whether this element has pointer capture for the given id.
`request_pointer_lock()`	Request that the pointer be locked to this element (no-op).
`request_fullscreen(options: "dict \| None")`	Request that this element be displayed in fullscreen mode (no-op).
`check_visibility(options: "dict \| None")` → `bool`	Return whether this element is visible in the current rendering (always `True`).
`query_selector(selector: str)` → `Element \| None`	Return the first element in the subtree matching selector.
`query_selector_all(selector: str)` → `NodeList`	Return a static NodeList of all elements matching selector.
`matches(selector: str)` → `bool`	Return `True` if this element matches the CSS selector.
`webkit_matches_selector(selector: str)` → `bool`	Browser-compat alias for :meth:`matches`.
`closest(selector: str)` → `"Element \| None"`	Return the nearest ancestor (inclusive) matching the CSS selector.
`get_elements_by_tag_name(qualified_name: str)` → `HTMLCollection`	Return all descendant elements whose tag name matches qualified_name.
`get_elements_by_class_name(class_names: str)` → `HTMLCollection`	Return all descendant elements that carry all of the given class tokens.
`filter_fn(el: "Element")` → `bool`	Calls filter_fn(el) on this HTMLVideoElement instance.
`remove()`	Remove this element from its parent node.
`before()`	Insert nodes immediately before this element in its parent.
`after()`	Insert nodes immediately after this element in its parent.
`replace_with()`	Replace this element with nodes in its parent.
`prepend()`	Insert nodes before the first child of this element.
`append()`	Append nodes as the last children of this element.
`replace_children()`	Remove all children, then append nodes as new children.
`get_bounding_client_rect()` → `"DOMRect"`	Return the bounding client rectangle (all-zero stub).
`get_client_rects()` → `"DOMRectList"`	Return the client rectangle list (empty in server-side context).
`get_animations()` → `list[object]`	Return active animations for this element (headless stub: always `[]`).
`attach_shadow(init: "dict \| None")`	Raise `NotSupportedError` — shadow trees are not supported in headless mode.
`get_root_node(composed: bool)` → `"Node"`	Return the root of the node’s tree.
`has_child_nodes()` → `bool`	Return whether this node has at least one direct child node.
`lookup_namespace_uri(prefix: str \| None)` → `str \| None`	Return the effective namespace URI for prefix in this node context.
`lookup_prefix(namespace_uri: str \| None)` → `str \| None`	Return the effective prefix for namespace_uri in this node context.
`is_default_namespace(namespace_uri: str \| None)` → `bool`	Return whether namespace_uri equals this node context default namespace.
`is_supported(feature: str, version: str \| None)` → `bool`	Return legacy feature-probe compatibility status.
`get_feature(feature: str, version: str \| None)` → `object \| None`	Return the legacy feature object for a probe, or `None`.
`set_user_data(key: str, data: object \| None, handler: object \| None)` → `object \| None`	Store or clear node-local user data and return the previous value.
`get_user_data(key: str)` → `object \| None`	Return node-local user data for key or `None` when absent.
`append_child(node: Node)` → `Node`	Append node as the last child of this node.
`insert_before(node: Node, reference: Node \| None)` → `Node`	Insert node before reference in the child list.
`remove_child(node: Node)` → `Node`	Remove node from the child list and return it.
`replace_child(new_child: Node, old_child: Node)` → `Node`	Replace old_child with new_child.
`clone_node(deep: bool)` → `Node`	Return a copy of this node.
`normalize()`	Put this node and its entire subtree into normalized form.
`contains(other: Node \| None)` → `bool`	Return `True` if other is an inclusive descendant of this node.
`compare_document_position(other: "Node")` → `int`	Return a bitmask describing the position of other relative to this node.
`is_equal_node(other: Node \| None)` → `bool`	Return `True` if other has the same structure as this node.
`is_same_node(other_node: Node \| None)` → `bool`	Return `True` when other_node is this node instance.
`add_event_listener(type: str, listener: Callable, capture: bool, once: bool)`	Register listener for events of type.
`remove_event_listener(type: str, listener: Callable, capture: bool)`	Deregister a previously-registered listener.
`dispatch_event(event: "Event")` → `bool`	Dispatch event through the ancestor tree.

HTMLVideoElement

Overview

Properties

Methods

See Also