osmscout::InstalledVoicesModel Class Reference

Model providing access to currently installed voices on device. More...

#include <InstalledVoicesModel.h>

Inheritance diagram for osmscout::InstalledVoicesModel:

Public Types
enum	Roles {   NameRole = Qt::UserRole , LangRole = Qt::UserRole + 1 , GenderRole = Qt::UserRole + 2 , ValidRole = Qt::UserRole + 3 ,   LicenseRole = Qt::UserRole + 4 , AuthorRole = Qt::UserRole + 5 , DescriptionRole = Qt::UserRole + 6 , SelectedRole = Qt::UserRole + 7 ,   TypeRole = Qt::UserRole + 8 }

Public Slots
void	onVoiceChanged (const QString &)
void	playTTSAudio (const QList< QUrl > &audioFiles)
void	update ()

Signals
void	initTTSVoiceRequested (const Voice &voice)
void	playTTSMessageRequested (QString message)
	emitted whenever getTTSStateText() changes
void	ttsStateChanged ()
void	voiceChanged (const QString)

Public Member Functions
Q_INVOKABLE QVariant	data (const QModelIndex &index, int role) const override
Q_INVOKABLE Qt::ItemFlags	flags (const QModelIndex &index) const override
QString	getTTSStateText () const
	Localized, human readable description of the current TTS engine state (see osmscout::TTSEngineState).
	InstalledVoicesModel ()
Q_INVOKABLE void	playSample (const QModelIndex &index, const QStringList &sample)
Q_INVOKABLE void	playTTSSample (const QModelIndex &index)
	Play a synthesized voice sample for a Piper TTS voice at the given index.
QHash< int, QByteArray >	roleNames () const override
Q_INVOKABLE int	rowCount (const QModelIndex &parent=QModelIndex()) const override
Q_INVOKABLE void	select (const QModelIndex &index)
	~InstalledVoicesModel () override

Properties
QString	ttsStateText
	< localized, human readable description of the current TTS engine state (e.g.

Detailed Description

Model providing access to currently installed voices on device.

• entry for configuration without voice commands.

This model suppose to be used in combo box.

Member Enumeration Documentation

Roles

enum osmscout::InstalledVoicesModel::Roles

Enumerator
NameRole
LangRole
GenderRole
ValidRole
LicenseRole
AuthorRole
DescriptionRole
SelectedRole
TypeRole

Constructor & Destructor Documentation

InstalledVoicesModel()

osmscout::InstalledVoicesModel::InstalledVoicesModel

(

)

References osmscout::OSMScoutQt::GetInstance(), osmscout::OSMScoutQt::GetSettings(), osmscout::OSMScoutQt::GetVoiceManager(), osmscout::VoiceManager::reloaded(), and update().

~InstalledVoicesModel()

osmscout::InstalledVoicesModel::~InstalledVoicesModel ( )

override

Member Function Documentation

data()

QVariant osmscout::InstalledVoicesModel::data ( const QModelIndex &  index, int  role  ) const

override

References AuthorRole, DescriptionRole, GenderRole, LangRole, LicenseRole, NameRole, SelectedRole, TypeRole, and ValidRole.

flags()

Qt::ItemFlags osmscout::InstalledVoicesModel::flags ( const QModelIndex &  index ) const

override

getTTSStateText()

QString osmscout::InstalledVoicesModel::getTTSStateText

(

)

const

Localized, human readable description of the current TTS engine state (see osmscout::TTSEngineState).

Reads as "Ready" before any Piper sample was requested (or when the library was built without libpiper support).

References osmscout::Error, osmscout::Idle, and osmscout::Synthesizing.

initTTSVoiceRequested

void osmscout::InstalledVoicesModel::initTTSVoiceRequested ( const Voice &  voice )

signal

Referenced by playTTSSample().

onVoiceChanged

void osmscout::InstalledVoicesModel::onVoiceChanged ( const QString &  dir )

slot

References SelectedRole.

playSample()

void osmscout::InstalledVoicesModel::playSample	(	const QModelIndex &	index,
		const QStringList &	sample
	)

References osmscout::VoiceCorePlayer::addToQueue(), osmscout::VoiceCorePlayer::clearQueue(), osmscout::VoiceCorePlayer::play(), and osmscout::VoiceCorePlayer::setCurrentIndex().

playTTSAudio

void osmscout::InstalledVoicesModel::playTTSAudio ( const QList< QUrl > &  audioFiles )

slot

References osmscout::VoiceCorePlayer::addToQueue(), osmscout::VoiceCorePlayer::clearQueue(), osmscout::VoiceCorePlayer::play(), and osmscout::VoiceCorePlayer::setCurrentIndex().

playTTSMessageRequested

void osmscout::InstalledVoicesModel::playTTSMessageRequested ( QString  message )

signal

emitted whenever getTTSStateText() changes

Referenced by playTTSSample().

playTTSSample()

void osmscout::InstalledVoicesModel::playTTSSample

(

const QModelIndex &

index

)

Play a synthesized voice sample for a Piper TTS voice at the given index.

Unlike playSample() (which plays pre-recorded "Voice of Marble" ogg files), this synthesizes a short, representative navigation message using TTSMessageGeneratorQt and PiperTTSEngine. It is a no-op for non-Piper (or invalid) voices, or when the library was built without libpiper support.

References osmscout::Locale::ByEnvironmentSafe(), osmscout::Voice::getDir(), osmscout::OSMScoutQt::GetInstance(), osmscout::TTSEngine::getVoice(), initTTSVoiceRequested(), osmscout::Meters(), and playTTSMessageRequested().

roleNames()

QHash< int, QByteArray > osmscout::InstalledVoicesModel::roleNames ( ) const

override

References GenderRole, LangRole, NameRole, SelectedRole, TypeRole, and ValidRole.

rowCount()

int osmscout::InstalledVoicesModel::rowCount ( const QModelIndex &  parent = QModelIndex() ) const

override

select()

void osmscout::InstalledVoicesModel::select

(

const QModelIndex &

index

)

ttsStateChanged

void osmscout::InstalledVoicesModel::ttsStateChanged ( )

signal

update

void osmscout::InstalledVoicesModel::update ( )

slot

Referenced by InstalledVoicesModel().

voiceChanged

void osmscout::InstalledVoicesModel::voiceChanged ( const QString  )

signal

Property Documentation

ttsStateText

QString osmscout::InstalledVoicesModel::ttsStateText

read

< localized, human readable description of the current TTS engine state (e.g.

"Synthesizing voice sample…"), useful for showing synthesis progress in the UI as the initial synthesis may take some time.

---

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

• InstalledVoicesModel.h
• InstalledVoicesModel.cpp