/usr/include/Wt/WAudio is in libwt-dev 3.3.3+dfsg-4.1.
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 92 93 94 | // 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 WAUDIO_H_
#define WAUDIO_H_
#include <Wt/WAbstractMedia>
namespace Wt {
/*! \class WAudio Wt/WAudio Wt/WAudio
* \brief A widget that plays audio.
*
* This is a low-level widget, mapping directly onto a
* <tt><audio></tt> 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.
*
* \if cpp
* Usage example:
* \code
* WAudio *a = new WAudio(parent);
* v->setOptions(WAudio::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).
*
* The addSource() and setAlternativeContent() may not be called after
* the widget is rendered.
*
* \sa WMediaPlayer
*
* \if cpp
* \note Before %Wt 3.1.11, this was called WHTML5Audio, which still
* exists as a (deprecated) typedef.
* \endif
*/
class WT_API WAudio : public WAbstractMedia
{
public:
/*! \brief Creates a audio widget.
*
* A freshly constructed Audio widget has no media sources,
* no options, and has preload mode set to PreloadAuto.
*/
WAudio(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 // WAUDIO_H_
|