script/dom/html/
htmlaudioelement.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use dom_struct::dom_struct;
6use html5ever::{LocalName, Prefix, QualName, local_name, ns};
7use js::rust::HandleObject;
8use style::attr::AttrValue;
9
10use crate::dom::bindings::codegen::Bindings::HTMLAudioElementBinding::HTMLAudioElementMethods;
11use crate::dom::bindings::codegen::Bindings::WindowBinding::WindowMethods;
12use crate::dom::bindings::error::Fallible;
13use crate::dom::bindings::root::DomRoot;
14use crate::dom::bindings::str::DOMString;
15use crate::dom::document::Document;
16use crate::dom::element::{CustomElementCreationMode, Element, ElementCreator};
17use crate::dom::html::htmlmediaelement::HTMLMediaElement;
18use crate::dom::node::Node;
19use crate::dom::window::Window;
20use crate::script_runtime::CanGc;
21
22#[dom_struct]
23pub(crate) struct HTMLAudioElement {
24    htmlmediaelement: HTMLMediaElement,
25}
26
27impl HTMLAudioElement {
28    fn new_inherited(
29        local_name: LocalName,
30        prefix: Option<Prefix>,
31        document: &Document,
32    ) -> HTMLAudioElement {
33        HTMLAudioElement {
34            htmlmediaelement: HTMLMediaElement::new_inherited(local_name, prefix, document),
35        }
36    }
37
38    #[cfg_attr(crown, allow(crown::unrooted_must_root))]
39    pub(crate) fn new(
40        local_name: LocalName,
41        prefix: Option<Prefix>,
42        document: &Document,
43        proto: Option<HandleObject>,
44        can_gc: CanGc,
45    ) -> DomRoot<HTMLAudioElement> {
46        Node::reflect_node_with_proto(
47            Box::new(HTMLAudioElement::new_inherited(
48                local_name, prefix, document,
49            )),
50            document,
51            proto,
52            can_gc,
53        )
54    }
55}
56
57impl HTMLAudioElementMethods<crate::DomTypeHolder> for HTMLAudioElement {
58    /// <https://html.spec.whatwg.org/multipage/#dom-audio>
59    fn Audio(
60        window: &Window,
61        proto: Option<HandleObject>,
62        can_gc: CanGc,
63        src: Option<DOMString>,
64    ) -> Fallible<DomRoot<HTMLAudioElement>> {
65        // Step 1. Let document be the current global object's associated Document.
66        let document = window.Document();
67
68        // Step 2. Let audio be the result of creating an element given document, "audio", and the
69        // HTML namespace.
70        let audio = Element::create(
71            QualName::new(None, ns!(html), local_name!("audio")),
72            None,
73            &document,
74            ElementCreator::ScriptCreated,
75            CustomElementCreationMode::Synchronous,
76            proto,
77            can_gc,
78        );
79
80        // Step 3. Set an attribute value for audio using "preload" and "auto".
81        audio.set_attribute(
82            &local_name!("preload"),
83            AttrValue::String("auto".to_owned()),
84            can_gc,
85        );
86
87        // Step 4. If src is given, then set an attribute value for audio using "src" and src. (This
88        // will cause the user agent to invoke the object's resource selection algorithm before
89        // returning).
90        if let Some(s) = src {
91            audio.set_attribute(&local_name!("src"), AttrValue::String(s.into()), can_gc);
92        }
93
94        // Step 5. Return audio.
95        Ok(DomRoot::downcast::<HTMLAudioElement>(audio).unwrap())
96    }
97}