Audio (vaadin-server 8.21.0 API)

java.lang.Object
- com.vaadin.server.AbstractClientConnector
- - com.vaadin.ui.AbstractComponent
  - - com.vaadin.ui.AbstractMedia
    - - com.vaadin.ui.Audio

All Implemented Interfaces:

ContextClickEvent.ContextClickNotifier, MethodEventSource, ClientConnector, Sizeable, com.vaadin.shared.Connector, Component, java.io.Serializable
```
public class Audio
extends AbstractMedia
```
The Audio component translates into an HTML5 <audio> element and as such is only supported in browsers that support HTML5 media markup. Browsers that do not support HTML5 display the text or HTML set by calling AbstractMedia.setAltText(String). A flash-player fallback can be implemented by setting HTML content allowed ( AbstractMedia.setHtmlContentAllowed(boolean) and calling AbstractMedia.setAltText(String) with the flash player markup. An example of flash fallback can be found at the Mozilla Developer Network. Multiple sources can be specified. Which of the sources is used is selected by the browser depending on which file formats it supports. See wikipedia for a table of formats supported by different browsers.

Since:

6.7.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
  ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener
- Nested classes/interfaces inherited from interface com.vaadin.ui.Component
  Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener
- Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable
  Sizeable.Unit

Field Summary
- Fields inherited from class com.vaadin.ui.AbstractComponent
  DESIGN_ATTR_PLAIN_TEXT
- Fields inherited from interface com.vaadin.server.Sizeable
  SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors
Constructor Description

Audio()

Audio(java.lang.String caption)

Audio(java.lang.String caption, Resource source)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected com.vaadin.shared.ui.audio.AudioState`	`getState()`	Returns the shared state bean with information to be sent from the server to the client.
`protected com.vaadin.shared.ui.audio.AudioState`	`getState(boolean markAsDirty)`	Returns the shared state for this connector.

Methods inherited from class com.vaadin.ui.AbstractMedia
addSource, getAltText, getCustomAttributes, getPreload, getSources, handleConnectorRequest, isAutoplay, isHtmlContentAllowed, isLoop, isMuted, isShowControls, pause, play, readDesign, setAltText, setAutoplay, setHtmlContentAllowed, setLoop, setMuted, setPreload, setShowControls, setSource, setSources, writeDesign

Methods inherited from class com.vaadin.ui.AbstractComponent
addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isReadOnly, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setReadOnly, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.server.ClientConnector
addAttachListener, addDetachListener, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, isAttached, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.ui.Component
addStyleNames, getUI, removeStyleNames, setStyleName

Methods inherited from interface com.vaadin.shared.Connector
getConnectorId

- Constructor Detail
  - Audio
```
public Audio()
```
  - Audio
```
public Audio(java.lang.String caption)
```
    Parameters:
    
    caption - The caption of the audio component.
  - Audio
```
public Audio(java.lang.String caption,
             Resource source)
```
    Parameters:
    
    caption - The caption of the audio component
    
    source - The audio file to play.
- Method Detail
  - getState
```
protected com.vaadin.shared.ui.audio.AudioState getState()
```
    Description copied from class: AbstractComponent
    
    Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().
    
    Overrides:
    
    getState in class AbstractMedia
    
    Returns:
    
    updated component shared state
  - getState
```
protected com.vaadin.shared.ui.audio.AudioState getState(boolean markAsDirty)
```
    Description copied from class: AbstractClientConnector
    
    Returns the shared state for this connector.
    
    Overrides:
    
    getState in class AbstractMedia
    
    Parameters:
    
    markAsDirty - true if the connector should automatically be marked dirty, false otherwise
    
    Returns:
    
    The shared state for this connector. Never null.
    
    See Also:
    
    AbstractClientConnector.getState()