Struct html_tags::AudioOwned

pub struct AudioOwned {

    pub accesskey: Option<String>,
    pub autocapitalize: Option<String>,
    pub autofocus: Option<bool>,
    pub autoplay: Option<String>,
    pub class: Option<String>,
    pub contenteditable: Option<String>,
    pub contextmenu: Option<String>,
    pub controls: Option<String>,
    pub controlslist: Option<String>,
    pub crossorigin: Option<String>,
    pub data: Option<BTreeMap<String, String>>,
    pub dir: Option<String>,
    pub disableremoteplayback: Option<String>,
    pub draggable: Option<String>,
    pub enterkeyhint: Option<String>,
    pub exportparts: Option<String>,
    pub extra: Option<BTreeMap<String, String>>,
    pub hidden: Option<bool>,
    pub id: Option<String>,
    pub inert: Option<String>,
    pub inputmode: Option<String>,
    pub is: Option<String>,
    pub loop_: Option<String>,
    pub muted: Option<String>,
    pub preload: Option<String>,
    pub src: Option<String>,
}

The <audio> HTML element is used to embed sound content in documents. It may contain one or more audio sources, represented using the src attribute or the <source> element: the browser will choose the most suitable one. It can also be the destination for streamed media, using a MediaStream.

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

Fields

accesskey: Option<String>

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<String>

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.

autoplay: Option<String>

A Boolean attribute: if specified, the audio will automatically begin playback as soon as it can do so, without waiting for the entire audio file to finish downloading.

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.

class: Option<String>

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<String>

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<String>

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

controls: Option<String>

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

controlslist: Option<String>

The controlslist attribute, when specified, helps the browser select what controls to show for the audio 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.

crossorigin: Option<String>

This enumerated attribute indicates whether to use CORS to fetch the related audio file. 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<String, String>>

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<String>

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.

disableremoteplayback: Option<String>

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.). See this proposed specification for more information.

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

draggable: Option<String>

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<String>

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

exportparts: Option<String>

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

extra: Option<BTreeMap<String, String>>

/// Extra attributes of the element. This is a map of attribute names to their values, and the attribute names are in lowercase.

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<String>

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<String>

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

inputmode: Option<String>

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<String>

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<String>

A Boolean attribute: if specified, the audio player will automatically seek back to the start upon reaching the end of the audio.

muted: Option<String>

A Boolean attribute that indicates whether the audio will be initially silenced. Its default value is false.

preload: Option<String>

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

• none: Indicates that the audio should not be preloaded.
• metadata: Indicates that only audio metadata (e.g. length) is fetched.
• auto: Indicates that the whole audio file can be downloaded, even if the user is not expected to use it.
• empty string: A 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 audio for playback.
• The browser is not forced by the specification to follow the value of this attribute; it is a mere hint.

src: Option<String>

The URL of the audio to embed. This is subject to HTTP access controls. This is optional; you may instead use the <source> element within the audio block to specify the audio to embed.

Implementations

impl AudioOwned

pub fn tag() -> &'static str

Get the tag name of the element. This is the same as the name of the struct, in kebab-case.

Trait Implementations

impl Clone for AudioOwned

fn clone(&self) -> AudioOwned

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AudioOwned

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

Formats the value using the given formatter.

impl Default for AudioOwned

fn default() -> AudioOwned

Returns the “default value” for a type.

impl Ord for AudioOwned

fn cmp(&self, other: &AudioOwned) -> 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 PartialEq<AudioOwned> for AudioOwned

fn eq(&self, other: &AudioOwned) -> 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 PartialOrd<AudioOwned> for AudioOwned

fn partial_cmp(&self, other: &AudioOwned) -> 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 Eq for AudioOwned

impl StructuralEq for AudioOwned

impl StructuralPartialEq for AudioOwned