Struct moxie_dom::elements::media::AudioBuilder

pub struct AudioBuilder { /* fields omitted */ }

The HTML <audio> 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.

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

Implementations

impl AudioBuilder

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

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.

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

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.

pub fn crossorigin(self, to_set: impl ToString) -> Self

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.

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.

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.

pub fn current_time(self, to_set: impl ToString) -> Self

Reading currentTime returns a double-precision floating-point value indicating the current playback position, in seconds, of the audio. If the audio’s metadata isn’t available yet—thereby preventing you from knowing the media’s start time or duration—currentTime instead indicates, and can be used to change, the time at which playback will begin. Otherwise, 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 audio 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 audio may have a media timeline that doesn’t start at 0 seconds, so setting currentTime to a time before that would fail. For example, if the audio’s media timeline starts at 12 hours, setting currentTime to 3600 would be an attempt to set the current playback position well before the beginning of the media, and would fail. The getStartDate() method can be used to determine the beginning point of the media timeline’s reference frame.

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

If specified, the audio player will automatically seek back to the start upon reaching the end of the audio.

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

Indicates whether the audio will be initially silenced. Its default value is false.

pub fn preload(self, to_set: impl ToString) -> Self

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.

Usage notes:

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.

pub fn src(self, to_set: impl ToString) -> Self

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.

Trait Implementations

impl ElementBuilder for AudioBuilder

fn attribute(self, name: &'static str, value: impl AsRef<str>) -> Self

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

fn class(self, to_set: impl ToString) -> Self

Updates the element’s class.

fn id(self, to_set: impl ToString) -> Self

Updates the element’s id.

fn style(self, to_set: impl ToString) -> Self

Updates the element’s style.

impl<E> EventTarget<E> for AudioBuilder where
    E: GlobalEvent, 

fn on(self, callback: impl FnMut(Ev) + 'static) -> Self

Declare an event handler on the element.

impl GlobalEventHandler for AudioBuilder

fn onabort(self, callback: impl FnMut(Abort) + 'static) -> Self

Set an event handler.

fn onblur(self, callback: impl FnMut(Blur) + 'static) -> Self

Set an event handler.

fn oncancel(self, callback: impl FnMut(Cancel) + 'static) -> Self

Set an event handler.

fn oncanplay(self, callback: impl FnMut(CanPlay) + 'static) -> Self

Set an event handler.

fn oncanplaythrough(
    self,
    callback: impl FnMut(CanPlayThrough) + 'static
) -> Self

Set an event handler.

fn onchange(self, callback: impl FnMut(Change) + 'static) -> Self

Set an event handler.

fn onclick(self, callback: impl FnMut(Click) + 'static) -> Self

Set an event handler.

fn onclose(self, callback: impl FnMut(CloseWebsocket) + 'static) -> Self

Set an event handler.

fn oncontextmenu(self, callback: impl FnMut(ContextMenu) + 'static) -> Self

Set an event handler.

fn oncuechange(self, callback: impl FnMut(CueChange) + 'static) -> Self

Set an event handler.

fn ondblclick(self, callback: impl FnMut(DoubleClick) + 'static) -> Self

Set an event handler.

fn ondrag(self, callback: impl FnMut(Drag) + 'static) -> Self

Set an event handler.

fn ondragend(self, callback: impl FnMut(DragEnd) + 'static) -> Self

Set an event handler.

fn ondragenter(self, callback: impl FnMut(DragEnter) + 'static) -> Self

Set an event handler.

fn ondragexit(self, callback: impl FnMut(DragExit) + 'static) -> Self

Set an event handler.

fn ondragleave(self, callback: impl FnMut(DragLeave) + 'static) -> Self

Set an event handler.

fn ondragover(self, callback: impl FnMut(DragOver) + 'static) -> Self

Set an event handler.

fn ondragstart(self, callback: impl FnMut(DragStart) + 'static) -> Self

Set an event handler.

fn ondrop(self, callback: impl FnMut(Dropped) + 'static) -> Self

Set an event handler.

fn ondurationchange(
    self,
    callback: impl FnMut(DurationChange) + 'static
) -> Self

Set an event handler.

fn onemptied(self, callback: impl FnMut(Emptied) + 'static) -> Self

Set an event handler.

fn onended(self, callback: impl FnMut(PlaybackEnded) + 'static) -> Self

Set an event handler.

fn onerror(self, callback: impl FnMut(ErrorEvent) + 'static) -> Self

Set an event handler.

fn onfocus(self, callback: impl FnMut(Focus) + 'static) -> Self

Set an event handler.

fn ongotpointercapture(
    self,
    callback: impl FnMut(GotPointerCapture) + 'static
) -> Self

Set an event handler.

fn oninput(self, callback: impl FnMut(Input) + 'static) -> Self

Set an event handler.

fn oninvalid(self, callback: impl FnMut(Invalid) + 'static) -> Self

Set an event handler.

fn onkeydown(self, callback: impl FnMut(KeyDown) + 'static) -> Self

Set an event handler.

fn onkeypress(self, callback: impl FnMut(KeyPress) + 'static) -> Self

Set an event handler.

fn onkeyup(self, callback: impl FnMut(KeyUp) + 'static) -> Self

Set an event handler.

fn onload(self, callback: impl FnMut(ResourceLoad) + 'static) -> Self

Set an event handler.

fn onloadeddata(self, callback: impl FnMut(DataLoaded) + 'static) -> Self

Set an event handler.

fn onloadedmetadata(
    self,
    callback: impl FnMut(MetadataLoaded) + 'static
) -> Self

Set an event handler.

fn onloadend(self, callback: impl FnMut(LoadEnd) + 'static) -> Self

Set an event handler.

fn onloadstart(self, callback: impl FnMut(LoadStart) + 'static) -> Self

Set an event handler.

fn onlostpointercapture(
    self,
    callback: impl FnMut(LostPointerCapture) + 'static
) -> Self

Set an event handler.

fn onmouseenter(self, callback: impl FnMut(MouseEnter) + 'static) -> Self

Set an event handler.

fn onmouseleave(self, callback: impl FnMut(MouseLeave) + 'static) -> Self

Set an event handler.

fn onmousemove(self, callback: impl FnMut(MouseMove) + 'static) -> Self

Set an event handler.

fn onmouseout(self, callback: impl FnMut(MouseOut) + 'static) -> Self

Set an event handler.

fn onmouseover(self, callback: impl FnMut(MouseOver) + 'static) -> Self

Set an event handler.

fn onmouseup(self, callback: impl FnMut(MouseUp) + 'static) -> Self

Set an event handler.

fn onpause(self, callback: impl FnMut(Pause) + 'static) -> Self

Set an event handler.

fn onplay(self, callback: impl FnMut(Play) + 'static) -> Self

Set an event handler.

fn onplaying(self, callback: impl FnMut(Playing) + 'static) -> Self

Set an event handler.

fn onpointercancel(self, callback: impl FnMut(PointerCancel) + 'static) -> Self

Set an event handler.

fn onpointerdown(self, callback: impl FnMut(PointerDown) + 'static) -> Self

Set an event handler.

fn onpointerenter(self, callback: impl FnMut(PointerEnter) + 'static) -> Self

Set an event handler.

fn onpointerleave(self, callback: impl FnMut(PointerLeave) + 'static) -> Self

Set an event handler.

fn onpointermove(self, callback: impl FnMut(PointerMove) + 'static) -> Self

Set an event handler.

fn onpointerout(self, callback: impl FnMut(PointerOut) + 'static) -> Self

Set an event handler.

fn onpointerover(self, callback: impl FnMut(PointerOver) + 'static) -> Self

Set an event handler.

fn onpointerup(self, callback: impl FnMut(PointerUp) + 'static) -> Self

Set an event handler.

fn onprogress(self, callback: impl FnMut(Progress) + 'static) -> Self

Set an event handler.

fn onratechange(
    self,
    callback: impl FnMut(PlaybackRateChange) + 'static
) -> Self

Set an event handler.

fn onreset(self, callback: impl FnMut(FormReset) + 'static) -> Self

Set an event handler.

fn onresize(self, callback: impl FnMut(ViewResize) + 'static) -> Self

Set an event handler.

fn onscroll(self, callback: impl FnMut(Scroll) + 'static) -> Self

Set an event handler.

fn onseeked(self, callback: impl FnMut(Seeked) + 'static) -> Self

Set an event handler.

fn onseeking(self, callback: impl FnMut(Seeking) + 'static) -> Self

Set an event handler.

fn onselect(self, callback: impl FnMut(Select) + 'static) -> Self

Set an event handler.

fn onselectionchange(
    self,
    callback: impl FnMut(SelectionChange) + 'static
) -> Self

Set an event handler.

fn onselectstart(self, callback: impl FnMut(SelectionStart) + 'static) -> Self

Set an event handler.

fn onshow(self, callback: impl FnMut(ContextMenuShow) + 'static) -> Self

Set an event handler.

fn onstalled(self, callback: impl FnMut(Stalled) + 'static) -> Self

Set an event handler.

fn onsubmit(self, callback: impl FnMut(Submit) + 'static) -> Self

Set an event handler.

fn onsuspend(self, callback: impl FnMut(Suspend) + 'static) -> Self

Set an event handler.

fn ontimeupdate(self, callback: impl FnMut(TimeUpdate) + 'static) -> Self

Set an event handler.

fn onvolumechange(self, callback: impl FnMut(VolumeChange) + 'static) -> Self

Set an event handler.

fn onwaiting(self, callback: impl FnMut(Waiting) + 'static) -> Self

Set an event handler.

fn onwheel(self, callback: impl FnMut(Wheel) + 'static) -> Self

Set an event handler.

impl HtmlElementBuilder for AudioBuilder

fn accesskey(self, to_set: impl ToString) -> Self

Keyboard shortcut to activate or add focus to the element.

fn autocapitalize(self, to_set: impl ToString) -> Self

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

fn contenteditable(self, to_set: bool) -> Self

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

fn dir(self, to_set: impl ToString) -> Self

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

fn draggable(self, to_set: bool) -> Self

Defines whether the element can be dragged.

fn hidden(self, to_set: bool) -> Self

Indicates if the element is hidden or not.

fn inert(self, to_set: bool) -> Self

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.

fn inputmode(self, to_set: impl ToString) -> Self

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).

fn lang(self, to_set: impl ToString) -> Self

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

fn slot(self, to_set: impl ToString) -> Self

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

fn spellcheck(self, to_set: impl ToString) -> Self

Indicates whether spell checking is allowed for the element.

fn tabindex(self, to_set: impl ToString) -> Self

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

fn title(self, to_set: impl ToString) -> Self

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

impl NodeBuilder for AudioBuilder

fn build(self) -> Audio

Initialize the element with all of the attributes so far.

type Output = Audio

The type of the DOM node

impl NodeWrapper for AudioBuilder

fn raw_node_that_has_sharp_edges_please_be_careful(&self) -> &Node

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

impl Parent<Source> for AudioBuilder

fn child<T: NodeBuilder<Output = C>>(self, child: T) -> Self

Add a child to this node.

impl Parent<Track> for AudioBuilder

fn child<T: NodeBuilder<Output = C>>(self, child: T) -> Self

Add a child to this node.