Struct html_tags::Video

pub struct Video<'life> {

    pub accesskey: Option<&'life str>,
    pub autocapitalize: Option<&'life str>,
    pub autofocus: Option<bool>,
    pub autopictureinpicture: Option<&'life str>,
    pub autoplay: Option<&'life str>,
    pub class: Option<&'life str>,
    pub contenteditable: Option<&'life str>,
    pub contextmenu: Option<&'life str>,
    pub controls: Option<&'life str>,
    pub controlslist: Option<&'life str>,
    pub crossorigin: Option<&'life str>,
    pub data: Option<BTreeMap<&'life str, &'life str>>,
    pub dir: Option<&'life str>,
    pub disablepictureinpicture: Option<&'life str>,
    pub disableremoteplayback: Option<&'life str>,
    pub draggable: Option<&'life str>,
    pub enterkeyhint: Option<&'life str>,
    pub exportparts: Option<&'life str>,
    pub height: Option<&'life str>,
    pub hidden: Option<bool>,
    pub id: Option<&'life str>,
    pub inert: Option<&'life str>,
    pub inputmode: Option<&'life str>,
    pub is: Option<&'life str>,
    pub loop_: Option<&'life str>,
    pub muted: Option<&'life str>,
    pub playsinline: Option<&'life str>,
    pub poster: Option<&'life str>,
    pub preload: Option<&'life str>,
    pub src: Option<&'life str>,
    pub width: Option<&'life str>,
    pub extra: BTreeMap<&'life str, &'life str>,
}

The <video> HTML element embeds a media player which supports video playback into the document. You can use <video> for audio content as well, but the <audio> element may provide a more appropriate user experience.

More information: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video

Fields

accesskey: Option<&'life str>

Provides a hint for generating a keyboard shortcut for the current element. This attribute consists of a space-separated list of characters. The browser should use the first one that exists on the computer keyboard layout.

autocapitalize: Option<&'life str>

Controls whether and how text input is automatically capitalized as it is entered/edited by the user. It can have the following values:

• off or none, no autocapitalization is applied (all letters default to lowercase)
• on or sentences, the first letter of each sentence defaults to a capital letter; all other letters default to lowercase
• words, the first letter of each word defaults to a capital letter; all other letters default to lowercase
• characters, all letters should default to uppercase

autofocus: Option<bool>

Indicates that an element is to be focused on page load, or as soon as the <dialog> it is part of is displayed. This attribute is a boolean, initially false.

autopictureinpicture: Option<&'life str>

A Boolean attribute which if true indicates that the element should automatically toggle picture-in-picture mode when the user switches back and forth between this document and another document or application.

autoplay: Option<&'life str>

A Boolean attribute; if specified, the video automatically begins to play back as soon as it can do so without stopping to finish loading the data.

Note: Sites that automatically play audio (or videos with an audio track) can be an unpleasant experience for users, so should be avoided when possible. If you must offer autoplay functionality, you should make it opt-in (requiring a user to specifically enable it). However, this can be useful when creating media elements whose source will be set at a later time, under user control. See our autoplay guide for additional information about how to properly use autoplay.

To disable video autoplay, autoplay="false" will not work; the video will autoplay if the attribute is there in the <video> tag at all. To remove autoplay, the attribute needs to be removed altogether.

In some browsers (e.g. Chrome 70.0) autoplay doesn't work if no muted attribute is present.

class: Option<&'life str>

A space-separated list of the classes of the element. Classes allow CSS and JavaScript to select and access specific elements via the class selectors or functions like the method Document.getElementsByClassName().

contenteditable: Option<&'life str>

An enumerated attribute indicating if the element should be editable by the user. If so, the browser modifies its widget to allow editing. The attribute must take one of the following values:

• true or the empty string, which indicates that the element must be editable;
• false, which indicates that the element must not be editable.

contextmenu: Option<&'life str>

The id of a <menu> to use as the contextual menu for this element.

controls: Option<&'life str>

If this attribute is present, the browser will offer controls to allow the user to control video playback, including volume, seeking, and pause/resume playback.

controlslist: Option<&'life str>

The controlslist attribute, when specified, helps the browser select what controls to show for the video element whenever the browser shows its own set of controls (that is, when the controls attribute is specified).

The allowed values are nodownload, nofullscreen and noremoteplayback.

Use the disablepictureinpicture attribute if you want to disable the Picture-In-Picture mode (and the control).

crossorigin: Option<&'life str>

This enumerated attribute indicates whether to use CORS to fetch the related video. CORS-enabled resources can be reused in the <canvas> element without being tainted. The allowed values are:

anonymous

Sends a cross-origin request without a credential. In other words, it sends the Origin: HTTP header without a cookie, X.509 certificate, or performing HTTP Basic authentication. If the server does not give credentials to the origin site (by not setting the Access-Control-Allow-Origin: HTTP header), the resource will be tainted, and its usage restricted.

use-credentials

Sends a cross-origin request with a credential. In other words, it sends the Origin: HTTP header with a cookie, a certificate, or performing HTTP Basic authentication. If the server does not give credentials to the origin site (through Access-Control-Allow-Credentials: HTTP header), the resource will be tainted and its usage restricted.

When not present, the resource is fetched without a CORS request (i.e. without sending the Origin: HTTP header), preventing its non-tainted use in <canvas> elements. If invalid, it is handled as if the enumerated keyword anonymous was used. See CORS settings attributes for additional information.

data: Option<BTreeMap<&'life str, &'life str>>

Forms a class of attributes, called custom data attributes, that allow proprietary information to be exchanged between the HTML and its DOM representation that may be used by scripts. All such custom data are available via the HTMLElement interface of the element the attribute is set on. The HTMLElement.dataset property gives access to them.

dir: Option<&'life str>

An enumerated attribute indicating the directionality of the element's text. It can have the following values:

• ltr, which means left to right and is to be used for languages that are written from the left to the right (like English);
• rtl, which means right to left and is to be used for languages that are written from the right to the left (like Arabic);
• auto, which lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then it applies that directionality to the whole element.

disablepictureinpicture: Option<&'life str>

Prevents the browser from suggesting a Picture-in-Picture context menu or to request Picture-in-Picture automatically in some cases.

disableremoteplayback: Option<&'life str>

A Boolean attribute used to disable the capability of remote playback in devices that are attached using wired (HDMI, DVI, etc.) and wireless technologies (Miracast, Chromecast, DLNA, AirPlay, etc.).

In Safari, you can use x-webkit-airplay="deny" as a fallback.

draggable: Option<&'life str>

An enumerated attribute indicating whether the element can be dragged, using the Drag and Drop API. It can have the following values:

• true, which indicates that the element may be dragged
• false, which indicates that the element may not be dragged.

enterkeyhint: Option<&'life str>

Hints what action label (or icon) to present for the enter key on virtual keyboards.

exportparts: Option<&'life str>

Used to transitively export shadow parts from a nested shadow tree into a containing light tree.

height: Option<&'life str>

The height of the video's display area, in CSS pixels (absolute values only; no percentages).

hidden: Option<bool>

An enumerated attribute indicating that the element is not yet, or is no longer, relevant. For example, it can be used to hide elements of the page that can't be used until the login process has been completed. The browser won't render such elements. This attribute must not be used to hide content that could legitimately be shown.

id: Option<&'life str>

Defines a unique identifier (ID) which must be unique in the whole document. Its purpose is to identify the element when linking (using a fragment identifier), scripting, or styling (with CSS).

inert: Option<&'life str>

A boolean value that makes the browser disregard user input events for the element. Useful when click events are present.

inputmode: Option<&'life str>

Provides a hint to browsers about the type of virtual keyboard configuration to use when editing this element or its contents. Used primarily on <input> elements, but is usable on any element while in contenteditable mode.

is: Option<&'life str>

Allows you to specify that a standard HTML element should behave like a registered custom built-in element (see Using custom elements for more details).

loop_: Option<&'life str>

A Boolean attribute; if specified, the browser will automatically seek back to the start upon reaching the end of the video.

muted: Option<&'life str>

A Boolean attribute that indicates the default setting of the audio contained in the video. If set, the audio will be initially silenced. Its default value is false, meaning that the audio will be played when the video is played.

playsinline: Option<&'life str>

A Boolean attribute indicating that the video is to be played "inline", that is within the element's playback area. Note that the absence of this attribute does not imply that the video will always be played in fullscreen.

poster: Option<&'life str>

A URL for an image to be shown while the video is downloading. If this attribute isn't specified, nothing is displayed until the first frame is available, then the first frame is shown as the poster frame.

preload: Option<&'life str>

This enumerated attribute is intended to provide a hint to the browser about what the author thinks will lead to the best user experience regarding what content is loaded before the video is played. It may have one of the following values:

• none: Indicates that the video should not be preloaded.
• metadata: Indicates that only video metadata (e.g. length) is fetched.
• auto: Indicates that the whole video file can be downloaded, even if the user is not expected to use it.
• empty string: Synonym of the auto value.

The default value is different for each browser. The spec advises it to be set to metadata.

Note:

• The autoplay attribute has precedence over preload. If autoplay is specified, the browser would obviously need to start downloading the video for playback.
• The specification does not force the browser to follow the value of this attribute; it is a mere hint.

src: Option<&'life str>

The URL of the video to embed. This is optional; you may instead use the <source> element within the video block to specify the video to embed.

width: Option<&'life str>

The width of the video's display area, in CSS pixels (absolute values only; no percentages).

extra: BTreeMap<&'life str, &'life str>

The extra attributes of the element. This is a map of attribute names to their values. The attribute names are in lowercase.

Trait Implementations

impl<'life> Clone for Video<'life>

fn clone(&self) -> Video<'life>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'life> Debug for Video<'life>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'life> Default for Video<'life>

fn default() -> Video<'life>

Returns the “default value” for a type.

impl<'life> Ord for Video<'life>

fn cmp(&self, other: &Video<'life>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'life> PartialEq<Video<'life>> for Video<'life>

fn eq(&self, other: &Video<'life>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'life> PartialOrd<Video<'life>> for Video<'life>

fn partial_cmp(&self, other: &Video<'life>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'life> Eq for Video<'life>

impl<'life> StructuralEq for Video<'life>

impl<'life> StructuralPartialEq for Video<'life>