Coin: SoAudioDevice.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoAudioDevice.h
1#ifndef COIN_SOAUDIODEVICE_H
2#define COIN_SOAUDIODEVICE_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/SbString.h>
37#include <Inventor/actions/SoGLRenderAction.h>
38#include <Inventor/actions/SoAudioRenderAction.h>
39
40class SoAudioDeviceP;
41
42// *************************************************************************
43
44 class COIN_DLL_API SoAudioDevice {
45public:
46 static SoAudioDevice * instance();
47
48 SbBool init(const SbString & devicetype, const SbString & devicename);
49
50 SbBool enable();
51 void disable();
52 SbBool isEnabled();
53 SbBool haveSound();
54 void setGain(float gain);
55 void mute(SbBool mute=TRUE);
56
57private:
58 SoAudioDevice();
59 ~SoAudioDevice();
60 SoAudioDevice(const SoAudioDevice &);
61 const SoAudioDevice & operator=(const SoAudioDevice &);
62
63 SoAudioDeviceP *pimpl;
64 friend class SoAudioDeviceP;
65};
66
67#endif // !COIN_SOAUDIODEVICE_H
SbString
The SbString class is a string class with convenience functions for string operations.
Definition SbString.h:52
SoAudioDevice::enable
SbBool enable()
Definition SoAudioDevice.cpp:415
SoAudioDevice::instance
static SoAudioDevice * instance()
Definition SoAudioDevice.cpp:109
SoAudioDevice::isEnabled
SbBool isEnabled()
Definition SoAudioDevice.cpp:452
SoAudioDevice::init
SbBool init(const SbString &devicetype, const SbString &devicename)
Definition SoAudioDevice.cpp:196
SoAudioDevice::haveSound
SbBool haveSound()
Definition SoAudioDevice.cpp:406
SoAudioDevice::disable
void disable()
Definition SoAudioDevice.cpp:434