/usr/include/Wt/WHTML5Audio is in libwt-dev 3.1.10-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2010 Emweb bvba, Leuven, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WHTML5AUDIO_H_
#define WHTML5AUDIO_H_
#include <Wt/WHTML5Media>
namespace Wt {
/*! \class WHTML5Audio Wt/WHTML5Audio Wt/WHTML5Audio
* \brief A widget that plays audio using the HTML5 audio element.
*
* This class plays HTML5 audio. In a typical usage scenario,
* you instantiate the class, set options, and add one or multiple
* audio sources. The browser will play the first audio stream that
* it is capable to play back.
*
* Since not every browser supports HTML5 audio,
* the class provides a mechanism to display alternative content
* in browsers that cannot play the audio. A Flash based player,
* configured to play the same audio file, is an example of
* sensible alternative content.
*
* \if cpp
* Usage example:
* \code
* WHTML5Audio *a = new WHTML5Audio(parent);
* v->setOptions(WHTML5Media::Autoplay | WHTML5Media::Controls);
* // Addsources may be called multiple times for different formats:
* // Firefox only plays ogg
* a->addSource("the_wt_song.ogg");
* // many others play mp3
* a->addSource("the_wt_song.mp3", "audio/mp3");
* // You may display a simple text to explain that you need html5 support...
* // a->setAlternativeContent(new WText("You have no HTML5 Audio!"));
* // ... or provide an alternative player, e.g. Flash-based
* WFlashObject *f = new WFlashObject("player.swf");
* f->setFlashVariable("src", "the_wt_song.mp3");
* v->setAlternativeContent(f);
* \endcode
* \endif
*
* 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).
*
* addSource() and setAlternativeContent() must not be called after
* the WHTML5Audio was rendered. This can easily be avoided by calling
* these functions right after construction.
*
* This is a technology-specific class. To let %Wt choose a technology
* (and fallback technologies) to display your videos, use the WSound class.
*
* \sa WHTML5Media, WSound
*/
class WT_API WHTML5Audio : public WHTML5Media
{
public:
/*! \brief Creates a HTML5 audio widget.
*
* A freshly constructed HTML5Audio widget has no media sources,
* no options, and has preload mode set to PreloadAuto.
*/
WHTML5Audio(WContainerWidget *parent = 0);
/*! \brief Returns the JavaScript reference to the audio object, or null.
*
* It is possible, for browser compatibility reasons, that jsRef() is
* not the HTML5 audio element. jsAudioRef() 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).
*/
std::string jsAudioRef() const;
protected:
virtual DomElement *createMediaDomElement();
DomElementType domElementType() const;
};
}
#endif // WHTML5AUDIO_H_
|