Dali::TtsPlayer Class Reference

The Text-to-speech (TTS) Player. More...

Inheritance diagram for Dali::TtsPlayer:

Public Types
enum	Mode
	Enumeration for the instance of TTS mode. More...
enum	State
	Enumeration for the instance of TTS state. More...
typedef Signal< void(const Dali::TtsPlayer::State, const Dali::TtsPlayer::State) >	StateChangedSignalType
	Type of signal emitted when the TTS state changes.
Public Member Functions
	TtsPlayer ()
	Creates an uninitialized handle.
	~TtsPlayer ()
	Destructor.
	TtsPlayer (const TtsPlayer &handle)
	This copy constructor is required for (smart) pointer semantics.
TtsPlayer &	operator= (const TtsPlayer &rhs)
	This assignment operator is required for (smart) pointer semantics.
void	Play (const std::string &text)
	Starts playing the audio data synthesized from the specified text.
void	Stop ()
	Stops playing the utterance.
void	Pause ()
	Pauses the currently playing utterance.
void	Resume ()
	Resumes the previously paused utterance.
State	GetState ()
	Gets the current state of the player.
Dali::TtsPlayer::StateChangedSignalType &	StateChangedSignal ()
	Allows connection TTS state change signal.
Static Public Member Functions
static TtsPlayer	Get (Dali::TtsPlayer::Mode mode=Dali::TtsPlayer::DEFAULT)
	Gets the singleton of the TtsPlayer for the given mode.

---

Detailed Description

The Text-to-speech (TTS) Player.

Since:

2.4, DALi version 1.0.0

---

Member Typedef Documentation

typedef Signal< void ( const Dali::TtsPlayer::State, const Dali::TtsPlayer::State ) > Dali::TtsPlayer::StateChangedSignalType

Type of signal emitted when the TTS state changes.

Since:

2.4, DALi version 1.0.0

---

Member Enumeration Documentation

enum Dali::TtsPlayer::Mode

Enumeration for the instance of TTS mode.

Since:

2.4, DALi version 1.0.0

Enumerator:

DEFAULT	Default mode for normal application. Since: 2.4, DALi version 1.0.0
NOTIFICATION	Notification mode, such as playing utterance is started or completed. Since: 2.4, DALi version 1.0.0
SCREEN_READER	Screen reader mode. To help visually impaired users interact with their devices, screen reader reads text or graphic elements on the screen using the TTS engine. Since: 2.4, DALi version 1.0.0

enum Dali::TtsPlayer::State

Enumeration for the instance of TTS state.

Since:

2.4, DALi version 1.0.0

Enumerator:

UNAVAILABLE	Player is not available. Since: 2.4, DALi version 1.0.0
READY	Player is ready to play. Since: 2.4, DALi version 1.0.0
PLAYING	Player is playing. Since: 2.4, DALi version 1.0.0
PAUSED	Player is paused. Since: 2.4, DALi version 1.0.0

---

Constructor & Destructor Documentation

Dali::TtsPlayer::TtsPlayer

(

)

Creates an uninitialized handle.

This can be initialized by calling TtsPlayer::Get().

Since:

2.4, DALi version 1.0.0

Dali::TtsPlayer::~TtsPlayer

(

)

Destructor.

This is non-virtual since derived Handle types must not contain data or virtual methods.

Since:

2.4, DALi version 1.0.0

Dali::TtsPlayer::TtsPlayer

(

const TtsPlayer &

handle

)

This copy constructor is required for (smart) pointer semantics.

Since:

2.4, DALi version 1.0.0

Parameters:

[in]

handle

A reference to the copied handle

---

Member Function Documentation

static TtsPlayer Dali::TtsPlayer::Get

(

Dali::TtsPlayer::Mode

mode = Dali::TtsPlayer::DEFAULT

)

[static]

Gets the singleton of the TtsPlayer for the given mode.

Since:

2.4, DALi version 1.0.0

Parameters:

mode	The mode of tts-player

Returns:

A handle of the Ttsplayer for the given mode

State Dali::TtsPlayer::GetState

(

)

Gets the current state of the player.

Since:

2.4, DALi version 1.0.0

Returns:

The current TTS state

Precondition:

The TtsPlayer needs to be initialized.

TtsPlayer& Dali::TtsPlayer::operator=

(

const TtsPlayer &

rhs

)

This assignment operator is required for (smart) pointer semantics.

Since:

2.4, DALi version 1.0.0

Parameters:

[in]

rhs

A reference to the copied handle

Returns:

A reference to this

void Dali::TtsPlayer::Pause

(

)

Pauses the currently playing utterance.

Since:

2.4, DALi version 1.0.0

Precondition:

The TtsPlayer needs to be initialized.

void Dali::TtsPlayer::Play

(

const std::string &

text

)

Starts playing the audio data synthesized from the specified text.

Since:

2.4, DALi version 1.0.0

Parameters:

[in]

text

The text to play

Precondition:

The TtsPlayer needs to be initialized.

void Dali::TtsPlayer::Resume

(

)

Resumes the previously paused utterance.

Since:

2.4, DALi version 1.0.0

Precondition:

The TtsPlayer needs to be initialized.

Dali::TtsPlayer::StateChangedSignalType& Dali::TtsPlayer::StateChangedSignal

(

)

Allows connection TTS state change signal.

Since:

2.4, DALi version 1.0.0

Returns:

A reference to the signal for connection

Note:

Only supported by some adaptor types.

void Dali::TtsPlayer::Stop

(

)

Stops playing the utterance.

Since:

2.4, DALi version 1.0.0

Precondition:

The TtsPlayer needs to be initialized.