Class

pl.metastack.metaweb.tag

Audio

Related Doc: package tag

Permalink

class Audio extends state.Tag with HTMLTag

The HTML <audio> element is used to embed sound content in documents. It may contain several audio sources, represented using the src attribute or the <source> element; the browser will choose the most suitable one. Fallback content for browser not supporting the <audio> element can be added too. You can use the Web Audio API to directly generate and manipulate audio streams from JavaScript code. See Web Audio API for details.

Linear Supertypes
HTMLTag, state.Tag, Children, state.Node, Tag, Container, Node, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Audio
  2. HTMLTag
  3. Tag
  4. Children
  5. Node
  6. Tag
  7. Container
  8. Node
  9. AnyRef
  10. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Audio()

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ++=(nodes: Seq[Node]): Unit

    Permalink
    Definition Classes
    Tag
  4. def +=(node: Node): Unit

    Permalink
    Definition Classes
    Tag
  5. def -=(node: Node): Unit

    Permalink
    Definition Classes
    Tag
  6. def :=(node: Node): Unit

    Permalink
    Definition Classes
    Tag
  7. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. val _attributes: Dict[String, Var[Any]]

    Permalink
    Attributes
    protected
    Definition Classes
    Tag
  9. def accesskey: StateChannel[String]

    Permalink

    Provides a hint for generating a keyboard shortcut for the current element.

    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.

    Definition Classes
    HTMLTag
  10. def append(node: Node): Unit

    Permalink
    Definition Classes
    Tag
  11. def appendAll(nodes: Seq[Node]): Unit

    Permalink
    Definition Classes
    Tag
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def attribute(attribute: String): Var[Any]

    Permalink
    Definition Classes
    Tag
  14. def attributes: scala.Predef.Map[String, Any]

    Permalink
    Definition Classes
    TagTag
  15. def autobuffer: StateChannel[String]

    Permalink

    A Boolean attribute; if specified, the audio will automatically begin being downloaded, even if not set to automatically play.

    A Boolean attribute; if specified, the audio will automatically begin being downloaded, even if not set to automatically play. This continues until the media cache is full, or the entire audio file has been downloaded, whichever comes first. This should only be used when it is expected that the user will choose to play the audio; for example, if the user has navigated to a page using a "Play this audio" link. This attribute was removed in Gecko 2.0 (Firefox 4 / Thunderbird 3.3 / SeaMonkey 2.1) in favor of the preload attribute.

  16. def autoplay: StateChannel[String]

    Permalink

    A Boolean attribute; if specified (even if the value is "false"!), the audio will automatically begin to play back as soon as it can do so without stopping to finish loading the data.

  17. def buffered: StateChannel[String]

    Permalink

    An attribute you can read to determine which time ranges of the media have been buffered.

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

  18. def byId[T <: Tag](id: String): T

    Permalink
    Definition Classes
    Tag
  19. def byIdOpt[T <: Tag](id: String): scala.Option[T]

    Permalink
    Definition Classes
    Tag
  20. def byTag[T <: Tag](tagName: String): T

    Permalink
    Definition Classes
    Tag
  21. def byTagOpt[T <: Tag](tag: String): scala.Option[T]

    Permalink
    Definition Classes
    Tag
  22. def children: Seq[Node]

    Permalink
    Definition Classes
    TagTagContainer
  23. def class: StateChannel[String]

    Permalink

    Is a space-separated list of the classes of the element.

    Is a space-separated list of the classes of the element. Classes allows CSS and JavaScript to select and access specific elements via the class selectors or functions like the method Document.getElementsByClassName().

    Definition Classes
    HTMLTag
  24. def clearChildren(): Unit

    Permalink
    Definition Classes
    Tag
  25. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def contenteditable: StateChannel[String]

    Permalink

    Is an enumerated attribute indicating if the element should be editable by the user.

    Is 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.
    Definition Classes
    HTMLTag
  27. def contextmenu: StateChannel[String]

    Permalink

    Is the id of an <menu> to use as the contextual menu for this element.

    Is the id of an <menu> to use as the contextual menu for this element.

    Definition Classes
    HTMLTag
  28. def controls: StateChannel[String]

    Permalink

    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.

  29. def dir: StateChannel[String]

    Permalink

    Is an enumerated attribute indicating the directionality of the element's text.

    Is 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 let the user agent decides. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then apply that directionality to the whole element.
    Definition Classes
    HTMLTag
  30. def domNode: scala.Option[Any]

    Permalink
    Definition Classes
    Tag
  31. def draggable: StateChannel[String]

    Permalink

    Is an enumerated attribute indicating whether the element can be dragged, using the Drag and Drop API.

    Is 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.
    Definition Classes
    HTMLTag
  32. def dropzone: StateChannel[String]

    Permalink

    Is an enumerated attribute indicating what types of content can be dropped on an element, using the Drag and Drop API.

    Is an enumerated attribute indicating what types of content can be dropped on an element, using the Drag and Drop API. It can have the following values:

    • copy, which indicates that dropping will create a copy of the element that was dragged
    • move, which indicates that the element that was dragged will be moved to this new location.
    • link, will create a link to the dragged data.
    Definition Classes
    HTMLTag
  33. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  34. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  35. val eventProvider: Provider[(String, Seq[Any]), Unit]

    Permalink
    Definition Classes
    Tag
  36. def events: scala.Predef.Map[String, (Any) ⇒ Unit]

    Permalink
    Definition Classes
    TagTag
  37. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  38. def find(f: (Node) ⇒ Boolean): scala.Option[Node]

    Permalink
    Definition Classes
    Container
  39. def getAttribute(attr: String): scala.Option[Any]

    Permalink
    Definition Classes
    TagTag
  40. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  41. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  42. def hidden: StateChannel[String]

    Permalink

    Is a Boolean attribute indicates that the element is not yet, or is no longer, relevant.

    Is a Boolean attribute indicates 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.

    Definition Classes
    HTMLTag
  43. def id: StateChannel[String]

    Permalink

    Defines a unique identifier (ID) which must be unique in the whole document.

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

    Definition Classes
    HTMLTag
  44. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  45. def itemid: StateChannel[String]

    Permalink

    Definition Classes
    HTMLTag
  46. def itemprop: StateChannel[String]

    Permalink

    Definition Classes
    HTMLTag
  47. def itemref: StateChannel[String]

    Permalink

    Definition Classes
    HTMLTag
  48. def itemscope: StateChannel[String]

    Permalink

    Definition Classes
    HTMLTag
  49. def itemtype: StateChannel[String]

    Permalink

    These attributes are related to the WHATWG HTML Microdata feature.

    These attributes are related to the WHATWG HTML Microdata feature.

    Definition Classes
    HTMLTag
  50. def lang: StateChannel[String]

    Permalink

    Participates in defining the language of the element, the language that non-editable elements are written in or the language that editable elements should be written in.

    Participates in defining the language of the element, the language that non-editable elements are written in or the language that editable elements should be written in. The tag contains one single entry value in the format defines in the Tags for Identifying Languages (BCP47) IETF document. xml:lang has priority over it.

    Definition Classes
    HTMLTag
  51. def loop: StateChannel[String]

    Permalink

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

  52. def mozCurrentSampleOffset: StateChannel[String]

    Permalink

    The offset, specified as the number of samples since the beginning of the audio stream, at which the audio is currently playing.

  53. def muted: StateChannel[String]

    Permalink

    A Boolean attribute which indicates whether the audio will be initially silenced.

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

  54. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  55. val nodeProvider: Provider[Unit, Any]

    Permalink
    Definition Classes
    Tag
  56. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  57. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  58. def played: StateChannel[String]

    Permalink

    A TimeRanges object indicating all the ranges of the audio that have been played.

    A TimeRanges object indicating all the ranges of the audio that have been played.

  59. def preload: StateChannel[String]

    Permalink

    This enumerated attribute is intended to provide a hint to the browser about what the author thinks will lead to the best user experience.

    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: hints that either the author thinks that the user won't need to consult that audio or that the server wants to minimize its traffic; in others terms this hint indicates that the audio should not be cached;
    • metadata: hints that though the author thinks that the user won't need to consult that audio, fetching the metadata (e.g. length) is reasonable;
    • auto: hints that the user needs have priority; in others terms this hint indicated that, if needed, the whole audio could be downloaded, even if the user is not expected to use it;
    • the empty string: which is a synonym of the auto value.

    If not set, its default value is browser-defined (i.e. each browser can choose its own default value), though the spec advises it to be set to metadata.

    Usage notes:

    • The autoplay attribute has precedence over this one as if one wants to automatically play a audio, the browser will obviously need to download it. Setting both the autoplay and the preload attributes is allowed by the specification.
    • The browser is not forced by the specification to follow the value of this attribute; it is a mere hint.
  60. def prepend(node: Node): Unit

    Permalink
    Definition Classes
    Tag
  61. def remove(node: Node): Unit

    Permalink
    Definition Classes
    Tag
  62. def replace(reference: Node, node: Node): Unit

    Permalink
    Definition Classes
    Tag
  63. def set(node: Node): Unit

    Permalink
    Definition Classes
    Tag
  64. def setAttribute[T](attr: String, value: T): Unit

    Permalink
    Definition Classes
    Tag
  65. def setChildren(nodes: Seq[Node]): Unit

    Permalink
    Definition Classes
    Tag
  66. def setEvent(event: String, f: (Any) ⇒ Unit): Unit

    Permalink
    Definition Classes
    Tag
  67. def spellcheck: StateChannel[String]

    Permalink

    Is an enumerated attribute defines whether the element may be checked for spelling errors.

    Is an enumerated attribute defines whether the element may be checked for spelling errors. It may have the following values:

    • true, which indicates that the element should be, if possible, checked for spelling errors;
    • false, which indicates that the element should not be checked for spelling errors.
    Definition Classes
    HTMLTag
  68. def src: StateChannel[String]

    Permalink

    The URL of the audio to embed.

    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.

  69. def style: StateChannel[String]

    Permalink

    Contains CSS styling declarations to be applied to the element.

    Contains CSS styling declarations to be applied to the element. Note that it is recommended for styles to be defined in a separate file or files. This attribute and the <style> element have mainly the purpose of allowing for quick styling, for example for testing purposes.

    Definition Classes
    HTMLTag
  70. def subscribe(node: ReadChannel[Node]): ReadChannel[Unit]

    Permalink
    Definition Classes
    Tag
  71. def subscribeChildren(list: DeltaBuffer[Node]): ReadChannel[Unit]

    Permalink
    Definition Classes
    Tag
  72. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  73. def tabindex: StateChannel[String]

    Permalink

    Is an integer attribute indicates if the element can take input focus (is focusable), if it should participate to sequential keyboard navigation, and if so, at what position.

    Is an integer attribute indicates if the element can take input focus (is focusable), if it should participate to sequential keyboard navigation, and if so, at what position. It can takes several values:

    • a negative value means that the element should be focusable, but should not be reachable via sequential keyboard navigation;
    • 0 means that the element should be focusable and reachable via sequential keyboard navigation, but its relative order is defined by the platform convention;
    • a positive value which means should be focusable and reachable via sequential keyboard navigation; its relative order is defined by the value of the attribute: the sequential follow the increasing number of the tabindex. If several elements share the same tabindex, their relative order follows their relative position in the document).
    Definition Classes
    HTMLTag
  74. val tagName: String

    Permalink
    Definition Classes
    TagTag
  75. def title: StateChannel[String]

    Permalink

    Contains a text representing advisory information related to the element it belongs to.

    Contains a text representing advisory information related to the element it belongs to. Such information can typically, but not necessarily, be presented to the user as a tooltip.

    Definition Classes
    HTMLTag
  76. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  77. def translate: StateChannel[String]

    Permalink

    Is an enumerated attribute that is used to specify whether an element's attribute values and the values of it s Text node children are to be translated when the page is localized, or whether to leave them unchanged.

    Is an enumerated attribute that is used to specify whether an element's attribute values and the values of it s Text node children are to be translated when the page is localized, or whether to leave them unchanged. It can have the following values:

    • empty string and "yes", which indicates that the element will be translated.
    • "no", which indicates that the element will not be translated.
    Definition Classes
    HTMLTag
  78. def triggerAction(action: String, arguments: Any*): Unit

    Permalink
    Definition Classes
    Tag
  79. def volume: StateChannel[String]

    Permalink

    The playback volume of any audio portions, in the range 0.0 (silent) to 1.0 (loudest).

  80. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  81. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  82. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. def watchAttributes: ReadChannel[Delta[String, Var[Any]]]

    Permalink
    Definition Classes
    Tag
  84. def watchChildren: ReadChannel[Delta[Node]]

    Permalink
    Definition Classes
    Tag → Children
  85. def watchEvents: ReadChannel[Delta[String, (Any) ⇒ Unit]]

    Permalink
    Definition Classes
    Tag

Inherited from HTMLTag

Inherited from state.Tag

Inherited from Children

Inherited from state.Node

Inherited from Tag

Inherited from Container

Inherited from Node

Inherited from AnyRef

Inherited from Any

Ungrouped