API Documentation
Loading...
Searching...
No Matches
QTSoundManager.h
Go to the documentation of this file.
1
/*--------------------------------------------------------------------------------------------
2
Copyright (c) 2019, NDEVR LLC
3
tyler.parke@ndevr.org
4
__ __ ____ _____ __ __ _______
5
| \ | | | __ \ | ___|\ \ / / | __ \
6
| \ | | | | \ \ | |___ \ \ / / | |__) |
7
| . \| | | |__/ / | |___ \ V / | _ /
8
| |\ |_|_____/__|_____|___\_/____| | \ \
9
|__| \__________________________________| \__\
10
11
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12
Licensee a limited, non-exclusive, non-transferable, royalty-free license
13
(without the right to sublicense) to use the API solely for the purpose of
14
Licensee's internal development efforts to develop applications for which
15
the API was provided.
16
17
The above copyright notice and this permission notice shall be included in all
18
copies or substantial portions of the Software.
19
20
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25
DEALINGS IN THE SOFTWARE.
26
27
Library: Widgets
28
File: QTSoundManager
29
Included in API: True
30
Author(s): Tyler Parke
31
*-----------------------------------------------------------------------------------------**/
32
#pragma once
33
#include "
DLLInfo.h
"
34
#include "
Widgets/Headers/SoundManager.h
"
35
class
QSoundEffect;
36
class
QTextToSpeech;
37
namespace
NDEVR
38
{
39
class
SoundEffectTask;
40
/**--------------------------------------------------------------------------------------------------
41
\brief Adds Sound generated via the Qt Framework to the application.
42
**/
43
class
QTSoundManager
:
public
SoundFactory
44
{
45
public
:
46
static
void
SetupSystem
();
47
#if NDEVR_SUPPORTS_THREADING
48
SoundEffectTask*
soundEffectTask
(
const
String
& sound);
49
#endif
50
QSoundEffect*
soundEffect
(
const
String
& sound);
51
bool
playSound
(
const
String
& sound)
override
;
52
bool
textToSpeech
(
const
TextToSpeechRequest
& speech)
override
;
53
virtual
bool
supportsTextToSpeech
()
const override
;
54
virtual
void
enableTextToSpeech
(
bool
enable)
override
;
55
virtual
Buffer<Sound>
availableSounds
()
override
;
56
virtual
bool
textToSpeechEnabled
()
const override
;
57
private
:
58
Dictionary<String, SoundEffectTask*>
m_dictionary;
59
QTextToSpeech* m_speech =
nullptr
;
60
};
61
}
62
DLLInfo.h
SoundManager.h
NDEVR::Buffer
The equivelent of std::vector but with a bit more control. The basic array unit of the library.
Definition
Buffer.hpp:56
NDEVR::Dictionary
A hash-based key-value store, useful for quick associative lookups. Key features include:
Definition
Dictionary.h:61
NDEVR::QTSoundManager
Adds Sound generated via the Qt Framework to the application.
Definition
QTSoundManager.h:44
NDEVR::QTSoundManager::enableTextToSpeech
virtual void enableTextToSpeech(bool enable) override
NDEVR::QTSoundManager::textToSpeech
bool textToSpeech(const TextToSpeechRequest &speech) override
NDEVR::QTSoundManager::SetupSystem
static void SetupSystem()
NDEVR::QTSoundManager::availableSounds
virtual Buffer< Sound > availableSounds() override
NDEVR::QTSoundManager::playSound
bool playSound(const String &sound) override
NDEVR::QTSoundManager::supportsTextToSpeech
virtual bool supportsTextToSpeech() const override
NDEVR::QTSoundManager::textToSpeechEnabled
virtual bool textToSpeechEnabled() const override
NDEVR::QTSoundManager::soundEffectTask
SoundEffectTask * soundEffectTask(const String &sound)
NDEVR::QTSoundManager::soundEffect
QSoundEffect * soundEffect(const String &sound)
NDEVR::SoundFactory
Produces sound on the host Device, if possible. Can also create speech from given text.
Definition
SoundManager.h:34
NDEVR::String
The core String class for the NDEVR API.
Definition
String.h:69
NDEVR
Definition
ACIColor.h:37
NDEVR::TextToSpeechRequest
Allows the user to make a request for text-to-speech. If the speech cannot be produced,...
Definition
SoundManager.h:26
NDEVRSoundManager
Headers
QTSoundManager.h