Class Audio

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.HtmlComponent

com.vaadin.flow.component.HtmlContainer

org.dellroad.stuff.vaadin24.audio.Audio

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasComponents, HasComponentsOfType<Component>, HasElement, HasEnabled, HasSize, HasStyle, HasText, Serializable

@Tag("audio")
public class Audio
extends HtmlContainer

Represents an HTML <audio> tag.

By default this class enables display of the audio controls.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Audio.PreloadMode	Data pre-load modes for HTML <audio> elements.
static class	Audio.Source	Represents a <source> sub-element in an <audio> element.

Nested classes/interfaces inherited from interface HasText

HasText.WhiteSpace

Constructor Summary

Constructors

Constructor	Description
Audio()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addSource(String uri, String mimeType)	Add an audio source with the specified URL and MIME type.
void	addSource(URI uri)	Add an audio source and attempt to automatically infer its MIME type based on the URI path suffix.
void	addSource(URI uri, String mimeType)	Add an audio source with the specified URL and MIME type.
protected String	inferMimeType(String filename)	Attempt to automatically infer an audio MIME type based on a file name.
void	play()	Start playing the audio.
void	removeSources()	Remove all audio sources.
void	setAltText(String text)	Configure alternate text.
protected void	setAttribute(String name, Object value)
void	setLoop(boolean loop)	Configure whether the audio should loop.
void	setMuted(boolean muted)	Configure whether the audio be muted.
void	setPreload(Audio.PreloadMode preload)	Configure what data to pre-load.
void	setShowControls(boolean controls)	Configure whether audio controls should be visible.

Methods inherited from class HtmlComponent

getTitle, setTitle

Methods inherited from class Component

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

Methods inherited from class Object

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

Methods inherited from interface AttachNotifier

addAttachListener

Methods inherited from interface DetachNotifier

addDetachListener

Methods inherited from interface HasComponents

add

Methods inherited from interface HasComponentsOfType

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

Methods inherited from interface HasElement

getElement

Methods inherited from interface HasEnabled

bindEnabled, isEnabled, setEnabled

Methods inherited from interface 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 HasStyle

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

Methods inherited from interface HasText

bindText, getText, getWhiteSpace, setText, setWhiteSpace

Constructor Details

Audio

public Audio()

Constructor.

Method Details

setAltText

public void setAltText(String text)

Configure alternate text.

Parameters:

text - alternate text or null for none

addSource

public void addSource(URI uri)

Add an audio source and attempt to automatically infer its MIME type based on the URI path suffix.

Parameters:

uri - audio source

Throws:

IllegalArgumentException - if uri is null

IllegalArgumentException - if uri's MIME type cannot be inferred

addSource

public void addSource(URI uri,
 String mimeType)

Add an audio source with the specified URL and MIME type.

Parameters:

uri - audio source

mimeType - audio MIME type

Throws:

IllegalArgumentException - if either parameter is null

addSource

public void addSource(String uri,
 String mimeType)

Add an audio source with the specified URL and MIME type.

Parameters:

uri - audio source

mimeType - audio MIME type

Throws:

IllegalArgumentException - if either parameter is null

removeSources

public void removeSources()

Remove all audio sources.

setLoop

public void setLoop(boolean loop)

Configure whether the audio should loop.

Parameters:

loop - true to loop, false to play once

setMuted

public void setMuted(boolean muted)

Configure whether the audio be muted.

Parameters:

muted - true for muted, false for unmuted

setShowControls

public void setShowControls(boolean controls)

Configure whether audio controls should be visible.

Parameters:

controls - true for visible audio controls, otherwise false

setPreload

public void setPreload(Audio.PreloadMode preload)

Configure what data to pre-load.

Parameters:

preload - data pre-load setting, or null to remove this option

play

public void play()

Start playing the audio.

setAttribute

protected void setAttribute(String name,
 Object value)

inferMimeType

protected String inferMimeType(String filename)

Attempt to automatically infer an audio MIME type based on a file name.

Parameters:

filename - audio file name

Throws:

IllegalArgumentException - if filename's MIME type cannot be inferred

IllegalArgumentException - if filename is null