/usr/include/Wt/WSound is in libwt-dev 3.3.4+dfsg-6ubuntu1.
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 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2009 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WSOUND_H_
#define WSOUND_H_
#include <Wt/WMediaPlayer>
namespace Wt {
class SoundManager;
/*! \class WSound Wt/WSound Wt/WSound
* \brief A value class to play a sound effect.
*
* This class provides a way to play an MP3 sound asynchonously (if
* the browser supports this). It is intended as a simple way to play
* event sounds (not quite for a media center).
*
* This class uses a WMediaPlayer to play the sound (using HTML
* <audio> or a flash player).
*
* \if cpp
* Usage example:
* \code
* WSound *s = new WSound("djing.mp3", parent);
* s->setLoops(3);
* s->play();
* playButton->clicked().connect(s, &WSound::play);
* stopButton->clicked().connect(s, &WSound::stop);
* \endcode
* \endif
*/
class WT_API WSound : public WObject
{
public:
/*! \brief Constructs a sound object.
*
* \sa addSource()
*/
WSound(WObject *parent = 0);
/*! \brief Constructs a sound object for an MP3 media source.
*
* The \p url will be assumed to be an MP3 file.
*
* \sa addSource()
*/
WSound(const std::string& url, WObject *parent = 0);
/*! \brief Constructs a sound object.
*
* \sa addSource()
*/
WSound(WMediaPlayer::Encoding encoding, const WLink& link, WObject *parent = 0);
/*! \brief Destructor.
*
* Deleting a sound also stops it (if it was playing).
*/
~WSound();
/*! \brief Adds a media source.
*
* You may add multiple media sources (with different encodings) to allow the
* file to be played in more browsers without needing Flash plugins.
*/
void addSource(WMediaPlayer::Encoding encoding, const WLink& link);
/*! \brief Returns the media source (<b>deprecated</b>).
*
* \deprecated use getSource(WMediaPlayer::Encoding) instead.
*/
std::string url() const;
/*! \brief Returns the media source.
*
* This returns the link set for a specific encoding, or an empty link if no URL
* was set for that encoding.
*/
WLink getSource(WMediaPlayer::Encoding encoding) const;
/*! \brief Sets the amount of times the sound has to be repeated.
*
* A call to play() will play the sound \p number of times.
* The default value is 1 (no repeats).
*/
void setLoops(int number);
/*! \brief Returns the configured number of repeats.
*
* \a setLoops()
*/
int loops() const;
/*! \brief Start asynchronous playback of the sound.
*
* This method returns immediately. It will cause the sound to be
* played for the configured amount of loops().
*
* The behavior of play() when a sound is already playing is
* undefind: it may be intermixed, sequentially queued, or a current
* playing sound may be stopped. It is recommended to call stop()
* before play() if you want to avoid mixing multiple instances of a
* single WSound object.
*/
void play();
/*! \brief Stops playback of the sound.
*
* This method returns immediately. It causes the current playback (if any)
* of the sound to be stopped.
*/
void stop();
private:
struct Source {
Source(WMediaPlayer::Encoding anEncoding, WLink aLink) : encoding(anEncoding), link(aLink) { }
WMediaPlayer::Encoding encoding;
WLink link;
};
std::vector<Source> media_;
int loops_;
friend class SoundManager;
};
}
#endif // WSOUND_H_
|