Struct moxie_dom::elements::media::VideoBuilder[−][src]

pub struct VideoBuilder { /* fields omitted */ }
Expand description

The HTML Video element (<video>) embeds a media player which supports video playback into the document.

A type for initializing the element’s attributes before calling build.

Implementations

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.

An attribute you can read to determine the time ranges of the buffered media. This attribute contains a TimeRanges object.

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.

This enumerated attribute indicates whether to use CORS to fetch the related image. 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 image 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 image 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 used in <canvas> elements. If invalid, it is handled as if the enumerated keyword anonymous was used.

Reading currentTime returns a double-precision floating-point value indicating the current playback position of the media specified in seconds. If the media has not started playing yet, the time offset at which it will begin is returned. Setting currentTime sets the current playback position to the given time and seeks the media to that position if the media is currently loaded.

If the media is being streamed, it’s possible that the user agent may not be able to obtain some parts of the resource if that data has expired from the media buffer. Other media may have a media timeline that doesn’t start at 0 seconds, so setting currentTime to a time before that would fail. The getStartDate() method can be used to determine the beginning point of the media timeline’s reference frame.

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

[src]

pub fn loop_(self, to_set: bool) -> Self

If specified, the browser will automatically seek back to the start upon reaching the end of the video.

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.

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.

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.

This enumerated attribute is intended to provide a hint to the browser about what the author thinks will lead to the best user experience with regards to 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.

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.

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

Trait Implementations

Declare an attribute of the element, mutating the actual element’s attribute when the passed value changes. Read more

Updates the element’s class.

Updates the element’s id.

Updates the element’s style. Read more

Declare an event handler on the element. Read more

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Set an event handler.

Keyboard shortcut to activate or add focus to the element.

Sets whether input is automatically capitalized when entered by user. It can have the following values: Read more

A value of “true” means the element is editable and a value of “false” means it isn’t.

The directionality of the element. It can have the following values: Read more

Defines whether the element can be dragged.

Indicates if the element is hidden or not.

Indicates whether the user agent must act as though the given node is absent for the purposes of user interaction events, in-page text searches (“find in page”), and text selection. Read more

Provides a hint as to the type of data that might be entered by the user while editing the element or its contents. The attribute can be used with form controls (such as the value of textarea elements), or in elements in an editing host (e.g., using contenteditable attribute). Read more

The language of an element’s attributes, text, and element contents.

Assigns a slot in a shadow DOM shadow tree to an element.

Indicates whether spell checking is allowed for the element.

Overrides the browser’s default tab order and follows the one specified instead. Read more

The text that appears in a popup box when mouse is over the element.

Initialize the element with all of the attributes so far.

The type of the DOM node

Retrieves access to the raw HTML element underlying the (CachedNode). Read more

Add a child to this node.

Add a child to this node.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the “raw” node for this child to bind to its parent.

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more