Class WAudio

public class WAudio extends WAbstractMedia
A widget that plays audio.

This is a low-level widget, mapping directly onto a <audio> element available in HTML5 compliant browsers.

In almost every situation you should use the WMediaPlayer widget if you want the user to be able to interact with the audio, or WSound for simple sound feed-back.

Usage of the audio element consists of adding one or more audio sources and setting some options. Since not every browser supports HTML5 audio, the class provides a mechanism to display alternative content in browsers that cannot play the video.

There are two reasons why the a browser may use the alternative content: either because the browser does not support the HTML5 audio tag (alternative content is displayed even when JavaScript is not available), or because none of the specified sources contain an audio format that is understood by the browser (requires JavaScript to display the alternative content).

The WAbstractMedia#addSource() and WAbstractMedia#setAlternativeContent() may not be called after the widget is rendered.

See Also:
  • Constructor Details

    • WAudio

      public WAudio(WContainerWidget parentContainer)
      Creates a audio widget.

      A freshly constructed Audio widget has no media sources, no options, and has preload mode set to PreloadAuto.

    • WAudio

      public WAudio()
      Creates a audio widget.

      Calls this((WContainerWidget)null)

  • Method Details

    • getJsAudioRef

      public String getJsAudioRef()
      Returns the JavaScript reference to the audio object, or null.

      It is possible, for browser compatibility reasons, that WWidget.getJsRef() is not the HTML5 audio element. getJsAudioRef() is guaranteed to be an expression that evaluates to the media object. This expression may yield null, if the video object is not rendered at all (e.g. on older versions of Internet Explorer).