/usr/include/kgaudioscene.h is in libkdegames-dev 4:4.13.0-0ubuntu1.
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 | /***************************************************************************
* Copyright 2010 Stefan Majewsky <majewsky@gmx.net> *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Library General Public License *
* version 2 as published by the Free Software Foundation *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU Library General Public License for more details. *
* *
* You should have received a copy of the GNU Library General Public *
* License along with this program; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. *
***************************************************************************/
#ifndef KGAUDIOSCENE_H
#define KGAUDIOSCENE_H
#include <QtCore/QPointF>
#include <libkdegames_export.h>
/**
* @namespace KgAudioScene
*
* This class exposes general properties of the audio playback context. Actual
* sounds are represented in this context by KgSound instances.
*
* The audio scene basically consists of a listener. The position of this
* listener is relevant when sounds are played at certain positions: The audio
* channels will then be balanced to make the sound appear to come from that
* direction.
*
* Because there can ogly be one listener, all methods in this class are static.
*
* @warning Not all functionally exposed by the API of this class is guaranteed
* to be available on the compiled KgAudio backend. Check
* KgAudioScene::capabilites() if in doubt.
*/
namespace KgAudioScene
{
///This enumeration represents capabilities which may not be provided by
///every KgAudio backend.
enum Capability
{
///Playback starts as soon as KgSound::start is called.
SupportsLowLatencyPlayback = 1 << 0,
SupportsPositionalPlayback = 1 << 1,
};
Q_DECLARE_FLAGS(Capabilities, Capability)
///@return which capabilities are supported by the compiled KgAudio backend
KDEGAMES_EXPORT Capabilities capabilities();
///@return the position of the listener
KDEGAMES_EXPORT QPointF listenerPos();
///Sets the position of the listener. The default is (0.0, 0.0), the
///point of origin.
///@note Effective only if positional playback is supported.
KDEGAMES_EXPORT void setListenerPos(const QPointF& pos);
///@return the master volume for sounds outputted by TagaroAudio
KDEGAMES_EXPORT qreal volume();
///Sets the master volume for sounds outputted by TagaroAudio. The
///default is 1.0, which means no volume change, compared to the
///original sounds. 0.0 means that all sounds are muted.
KDEGAMES_EXPORT void setVolume(qreal volume);
///@returns whether an error was detected in the audio backend
///
///Since KgAudio is typically used by games where audio is not an absolutely
///vital part of the gameplay, we do not need to fail if sound does not work,
///over even make some sort of deep analysis why something did not work. The
///user will notice missing sound, and advanced users may investigate
///the kWarning() messages. That is usually enough. If not, use this method.
///
///The state of hasError() may theoretically change while the application
///runs, but in practice, this is very unlikely. (The only tricky part is
///typically the initial allocation of ressources.)
///
///@sa KgSound::hasError()
KDEGAMES_EXPORT bool hasError();
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KgAudioScene::Capabilities)
#endif // KGAUDIOSCENE_H
|