NDEVR
API Documentation
SoundFactoryabstract

Produces sound on the host Device, if possible. More...

Inheritance diagram for SoundFactory:
[legend]
Collaboration diagram for SoundFactory:
[legend]

Public Member Functions

virtual Buffer< SoundavailableSounds ()=0
 Returns all sound resources available through this factory.
virtual void enableTextToSpeech (bool enable)=0
 Enables or disables text-to-speech output for this factory.
virtual bool playSound (const StringView &s)=0
 Plays the sound identified by the given resource string.
virtual bool supportsTextToSpeech () const =0
 Returns whether this factory supports text-to-speech conversion.
virtual bool textToSpeech (const TextToSpeechRequest &s)=0
 Converts the given text-to-speech request into audible speech.
virtual bool textToSpeechEnabled () const =0
 Returns whether text-to-speech is currently enabled for this factory.

Detailed Description

Produces sound on the host Device, if possible.


Can also create speech from given text.

Definition at line 33 of file SoundManager.h.

Member Function Documentation

◆ availableSounds()

virtual Buffer< Sound > SoundFactory::availableSounds ( )
pure virtual

Returns all sound resources available through this factory.

Returns
A buffer of available Sound entries.

Implemented in QTSoundManager.

◆ enableTextToSpeech()

virtual void SoundFactory::enableTextToSpeech ( bool enable)
pure virtual

Enables or disables text-to-speech output for this factory.

Parameters
[in]enableTrue to enable, false to disable.

Implemented in QTSoundManager.

◆ playSound()

virtual bool SoundFactory::playSound ( const StringView & s)
pure virtual

Plays the sound identified by the given resource string.

Parameters
[in]sThe sound resource identifier.
Returns
True if the sound was successfully played.

Implemented in QTSoundManager.

◆ supportsTextToSpeech()

virtual bool SoundFactory::supportsTextToSpeech ( ) const
pure virtual

Returns whether this factory supports text-to-speech conversion.

Returns
True if text-to-speech is supported.

Implemented in QTSoundManager.

◆ textToSpeech()

virtual bool SoundFactory::textToSpeech ( const TextToSpeechRequest & s)
pure virtual

Converts the given text-to-speech request into audible speech.

Parameters
[in]sThe text-to-speech request containing the text and a backup sound.
Returns
True if the speech was successfully produced.

Implemented in QTSoundManager.

◆ textToSpeechEnabled()

virtual bool SoundFactory::textToSpeechEnabled ( ) const
pure virtual

Returns whether text-to-speech is currently enabled for this factory.

Returns
True if text-to-speech is enabled.

Implemented in QTSoundManager.


The documentation for this class was generated from the following file: