Package com.vaadin.flow.component.html

Class Audio

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.HtmlComponent
com.vaadin.flow.component.html.Media
com.vaadin.flow.component.html.Audio
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasAriaLabel, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasComponentsOfType<com.vaadin.flow.component.Component>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, Serializable
@NullMarked @Tag("audio") public class Audio extends Media
Component representing an <audio> element — the browser's built-in audio player.

List the recording in as many formats as you want to support, one Source each, and the browser plays the first one it can decode: 

 Audio audio = new Audio();
 audio.addSource("/chime.ogg", "audio/ogg");
 audio.addSource("/chime.mp3", "audio/mpeg");
 audio.setControlsVisible(true);
Nothing of the element is rendered until Media.setControlsVisible(boolean) is called, so a player that the visitor is meant to start needs that call. A sound that is only played by the application, and that the visitor should not see a player for, is the one case where leaving the controls off is right.
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.flow.component.html.Media

    Media.Preload

  • Constructor Summary

    Constructors
    Constructor
    Description
    Audio()
    Creates an audio player without any source.
    Audio(Source... sources)
    Creates an audio player that plays the first of the given sources the browser can decode.

  • Method Summary

    Methods inherited from class com.vaadin.flow.component.html.Media

    addSource, addSource, getPreload, getSources, isAutoplay, isControlsVisible, isLoop, isMuted, setAutoplay, setControlsVisible, setLoop, setMuted, setPreload

    Methods inherited from class com.vaadin.flow.component.HtmlComponent

    getTitle, setTitle

    Methods inherited from class com.vaadin.flow.component.Component

    addListener, bindVisible, findAncestor, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTestId, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, getUIOrThrow, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setTestId, setVisible, whenAttached

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.vaadin.flow.component.AttachNotifier

    addAttachListener

    Methods inherited from interface com.vaadin.flow.component.DetachNotifier

    addDetachListener

    Methods inherited from interface com.vaadin.flow.component.HasAriaLabel

    getAriaLabel, getAriaLabelledBy, setAriaLabel, setAriaLabelledBy, setAriaLabelledBy

    Methods inherited from interface com.vaadin.flow.component.HasComponents

    add

    Methods inherited from interface com.vaadin.flow.component.HasComponentsOfType

    add, add, addComponentAsFirst, addComponentAtIndex, bindChildren, getChildren, getComponentAt, getComponentCount, indexOf, remove, remove, removeAll, replace

    Methods inherited from interface com.vaadin.flow.component.HasElement

    getElement

    Methods inherited from interface com.vaadin.flow.component.HasEnabled

    bindEnabled, isEnabled, setEnabled

    Methods inherited from interface com.vaadin.flow.component.HasSize

    bindHeight, bindWidth, getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

    Methods inherited from interface com.vaadin.flow.component.HasStyle

    addClassName, addClassNames, bindClassName, bindClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

  • Constructor Details

    • Audio

      public Audio()
      Creates an audio player without any source.

    • Audio

      public Audio(Source... sources)
      Creates an audio player that plays the first of the given sources the browser can decode.
      Parameters:
      sources - the same recording in one or more file formats