[−][src]Struct moxie_dom::elements::media::AudioBuilder
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
[src]
impl AudioBuilder
[src]
pub fn autoplay(self, to_set: bool) -> Self
[src]
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
[src]
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
[src]
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
[src]
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
[src]
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
[src]
Indicates whether the audio will be initially silenced. Its default value is false.
pub fn preload(self, to_set: impl ToString) -> Self
[src]
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
[src]
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
[src]
pub fn attribute(self, name: &'static str, value: impl AsRef<str>) -> Self
[src]
pub fn class(self, to_set: impl ToString) -> Self
[src]
pub fn id(self, to_set: impl ToString) -> Self
[src]
pub fn style(self, to_set: impl ToString) -> Self
[src]
impl<E> EventTarget<E> for AudioBuilder where
E: GlobalEvent,
[src]
E: GlobalEvent,
impl GlobalEventHandler for AudioBuilder
[src]
pub fn onabort(self, callback: impl FnMut(Abort) + 'static) -> Self
[src]
pub fn onblur(self, callback: impl FnMut(Blur) + 'static) -> Self
[src]
pub fn oncancel(self, callback: impl FnMut(Cancel) + 'static) -> Self
[src]
pub fn oncanplay(self, callback: impl FnMut(CanPlay) + 'static) -> Self
[src]
pub fn oncanplaythrough(
self,
callback: impl FnMut(CanPlayThrough) + 'static
) -> Self
[src]
self,
callback: impl FnMut(CanPlayThrough) + 'static
) -> Self
pub fn onchange(self, callback: impl FnMut(Change) + 'static) -> Self
[src]
pub fn onclick(self, callback: impl FnMut(Click) + 'static) -> Self
[src]
pub fn onclose(self, callback: impl FnMut(CloseWebsocket) + 'static) -> Self
[src]
pub fn oncontextmenu(self, callback: impl FnMut(ContextMenu) + 'static) -> Self
[src]
pub fn oncuechange(self, callback: impl FnMut(CueChange) + 'static) -> Self
[src]
pub fn ondblclick(self, callback: impl FnMut(DoubleClick) + 'static) -> Self
[src]
pub fn ondrag(self, callback: impl FnMut(Drag) + 'static) -> Self
[src]
pub fn ondragend(self, callback: impl FnMut(DragEnd) + 'static) -> Self
[src]
pub fn ondragenter(self, callback: impl FnMut(DragEnter) + 'static) -> Self
[src]
pub fn ondragexit(self, callback: impl FnMut(DragExit) + 'static) -> Self
[src]
pub fn ondragleave(self, callback: impl FnMut(DragLeave) + 'static) -> Self
[src]
pub fn ondragover(self, callback: impl FnMut(DragOver) + 'static) -> Self
[src]
pub fn ondragstart(self, callback: impl FnMut(DragStart) + 'static) -> Self
[src]
pub fn ondrop(self, callback: impl FnMut(Dropped) + 'static) -> Self
[src]
pub fn ondurationchange(
self,
callback: impl FnMut(DurationChange) + 'static
) -> Self
[src]
self,
callback: impl FnMut(DurationChange) + 'static
) -> Self
pub fn onemptied(self, callback: impl FnMut(Emptied) + 'static) -> Self
[src]
pub fn onended(self, callback: impl FnMut(PlaybackEnded) + 'static) -> Self
[src]
pub fn onerror(self, callback: impl FnMut(ErrorEvent) + 'static) -> Self
[src]
pub fn onfocus(self, callback: impl FnMut(Focus) + 'static) -> Self
[src]
pub fn ongotpointercapture(
self,
callback: impl FnMut(GotPointerCapture) + 'static
) -> Self
[src]
self,
callback: impl FnMut(GotPointerCapture) + 'static
) -> Self
pub fn oninput(self, callback: impl FnMut(Input) + 'static) -> Self
[src]
pub fn oninvalid(self, callback: impl FnMut(Invalid) + 'static) -> Self
[src]
pub fn onkeydown(self, callback: impl FnMut(KeyDown) + 'static) -> Self
[src]
pub fn onkeypress(self, callback: impl FnMut(KeyPress) + 'static) -> Self
[src]
pub fn onkeyup(self, callback: impl FnMut(KeyUp) + 'static) -> Self
[src]
pub fn onload(self, callback: impl FnMut(ResourceLoad) + 'static) -> Self
[src]
pub fn onloadeddata(self, callback: impl FnMut(DataLoaded) + 'static) -> Self
[src]
pub fn onloadedmetadata(
self,
callback: impl FnMut(MetadataLoaded) + 'static
) -> Self
[src]
self,
callback: impl FnMut(MetadataLoaded) + 'static
) -> Self
pub fn onloadend(self, callback: impl FnMut(LoadEnd) + 'static) -> Self
[src]
pub fn onloadstart(self, callback: impl FnMut(LoadStart) + 'static) -> Self
[src]
pub fn onlostpointercapture(
self,
callback: impl FnMut(LostPointerCapture) + 'static
) -> Self
[src]
self,
callback: impl FnMut(LostPointerCapture) + 'static
) -> Self
pub fn onmouseenter(self, callback: impl FnMut(MouseEnter) + 'static) -> Self
[src]
pub fn onmouseleave(self, callback: impl FnMut(MouseLeave) + 'static) -> Self
[src]
pub fn onmousemove(self, callback: impl FnMut(MouseMove) + 'static) -> Self
[src]
pub fn onmouseout(self, callback: impl FnMut(MouseOut) + 'static) -> Self
[src]
pub fn onmouseover(self, callback: impl FnMut(MouseOver) + 'static) -> Self
[src]
pub fn onmouseup(self, callback: impl FnMut(MouseUp) + 'static) -> Self
[src]
pub fn onpause(self, callback: impl FnMut(Pause) + 'static) -> Self
[src]
pub fn onplay(self, callback: impl FnMut(Play) + 'static) -> Self
[src]
pub fn onplaying(self, callback: impl FnMut(Playing) + 'static) -> Self
[src]
pub fn onpointercancel(
self,
callback: impl FnMut(PointerCancel) + 'static
) -> Self
[src]
self,
callback: impl FnMut(PointerCancel) + 'static
) -> Self
pub fn onpointerdown(self, callback: impl FnMut(PointerDown) + 'static) -> Self
[src]
pub fn onpointerenter(
self,
callback: impl FnMut(PointerEnter) + 'static
) -> Self
[src]
self,
callback: impl FnMut(PointerEnter) + 'static
) -> Self
pub fn onpointerleave(
self,
callback: impl FnMut(PointerLeave) + 'static
) -> Self
[src]
self,
callback: impl FnMut(PointerLeave) + 'static
) -> Self
pub fn onpointermove(self, callback: impl FnMut(PointerMove) + 'static) -> Self
[src]
pub fn onpointerout(self, callback: impl FnMut(PointerOut) + 'static) -> Self
[src]
pub fn onpointerover(self, callback: impl FnMut(PointerOver) + 'static) -> Self
[src]
pub fn onpointerup(self, callback: impl FnMut(PointerUp) + 'static) -> Self
[src]
pub fn onprogress(self, callback: impl FnMut(Progress) + 'static) -> Self
[src]
pub fn onratechange(
self,
callback: impl FnMut(PlaybackRateChange) + 'static
) -> Self
[src]
self,
callback: impl FnMut(PlaybackRateChange) + 'static
) -> Self
pub fn onreset(self, callback: impl FnMut(FormReset) + 'static) -> Self
[src]
pub fn onresize(self, callback: impl FnMut(ViewResize) + 'static) -> Self
[src]
pub fn onscroll(self, callback: impl FnMut(Scroll) + 'static) -> Self
[src]
pub fn onseeked(self, callback: impl FnMut(Seeked) + 'static) -> Self
[src]
pub fn onseeking(self, callback: impl FnMut(Seeking) + 'static) -> Self
[src]
pub fn onselect(self, callback: impl FnMut(Select) + 'static) -> Self
[src]
pub fn onselectionchange(
self,
callback: impl FnMut(SelectionChange) + 'static
) -> Self
[src]
self,
callback: impl FnMut(SelectionChange) + 'static
) -> Self
pub fn onselectstart(
self,
callback: impl FnMut(SelectionStart) + 'static
) -> Self
[src]
self,
callback: impl FnMut(SelectionStart) + 'static
) -> Self
pub fn onshow(self, callback: impl FnMut(ContextMenuShow) + 'static) -> Self
[src]
pub fn onstalled(self, callback: impl FnMut(Stalled) + 'static) -> Self
[src]
pub fn onsubmit(self, callback: impl FnMut(Submit) + 'static) -> Self
[src]
pub fn onsuspend(self, callback: impl FnMut(Suspend) + 'static) -> Self
[src]
pub fn ontimeupdate(self, callback: impl FnMut(TimeUpdate) + 'static) -> Self
[src]
pub fn onvolumechange(
self,
callback: impl FnMut(VolumeChange) + 'static
) -> Self
[src]
self,
callback: impl FnMut(VolumeChange) + 'static
) -> Self
pub fn onwaiting(self, callback: impl FnMut(Waiting) + 'static) -> Self
[src]
pub fn onwheel(self, callback: impl FnMut(Wheel) + 'static) -> Self
[src]
impl HtmlElementBuilder for AudioBuilder
[src]
pub fn accesskey(self, to_set: impl ToString) -> Self
[src]
pub fn autocapitalize(self, to_set: impl ToString) -> Self
[src]
pub fn contenteditable(self, to_set: bool) -> Self
[src]
pub fn dir(self, to_set: impl ToString) -> Self
[src]
pub fn draggable(self, to_set: bool) -> Self
[src]
pub fn hidden(self, to_set: bool) -> Self
[src]
pub fn inert(self, to_set: bool) -> Self
[src]
pub fn inputmode(self, to_set: impl ToString) -> Self
[src]
pub fn lang(self, to_set: impl ToString) -> Self
[src]
pub fn slot(self, to_set: impl ToString) -> Self
[src]
pub fn spellcheck(self, to_set: impl ToString) -> Self
[src]
pub fn tabindex(self, to_set: impl ToString) -> Self
[src]
pub fn title(self, to_set: impl ToString) -> Self
[src]
impl NodeWrapper for AudioBuilder
[src]
pub fn raw_node_that_has_sharp_edges_please_be_careful(&self) -> &Node
[src]
impl Parent<Source> for AudioBuilder
[src]
impl Parent<Track> for AudioBuilder
[src]
Auto Trait Implementations
impl !RefUnwindSafe for AudioBuilder
[src]
impl !Send for AudioBuilder
[src]
impl !Sync for AudioBuilder
[src]
impl Unpin for AudioBuilder
[src]
impl !UnwindSafe for AudioBuilder
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<N> Child for N where
N: NodeWrapper,
[src]
N: NodeWrapper,
impl<T> Downcast for T where
T: Any,
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn as_any(&self) -> &(dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
impl<T> Erased for T
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,