Crosstales.RTVoice.Tool.SpeechText Class Reference

Allows to speak and store generated audio. More...

Inheritance diagram for Crosstales.RTVoice.Tool.SpeechText:

Public Member Functions
void	Speak ()
	Speak the text. More...
void	Silence ()
	Silence the speech. More...

Public Attributes
SpeechTextStartEvent	OnStarted
SpeechTextStartEvent	OnCompleted

Properties
string	Text [get, set]
	Text to speak. More...
Crosstales.RTVoice.Model.VoiceAlias	Voices [get, set]
	Voices for the speech. More...
Crosstales.RTVoice.Model.Enum.SpeakMode	Mode [get, set]
	Speak mode. More...
AudioSource	Source [get, set]
	AudioSource for the output (optional). More...
float	Rate [get, set]
	Speech rate of the speaker in percent (range: 0-3). More...
float	Pitch [get, set]
	Speech pitch of the speaker in percent (range: 0-2). More...
float	Volume [get, set]
	Volume of the speaker in percent (range: 0-1). More...
bool	PlayOnStart [get, set]
	Enable speaking of the text on start. More...
float	Delay [get, set]
	Delay until the speech for this text starts. More...
bool	GenerateAudioFile [get, set]
	Generate audio file on/off. More...
string	FileName [get, set]
	File name (incl. path) for the generated audio. More...
bool	FileInsideAssets [get, set]
	Is the generated file path inside the Assets-folder (current project)? If this option is enabled, it prefixes the path with 'Application.dataPath'. More...

Events
SpeechTextStart	OnSpeechTextStart
	An event triggered whenever a SpeechText 'Speak' is started. More...
SpeechTextComplete	OnSpeechTextComplete
	An event triggered whenever a SpeechText 'Speak' is completed. More...

Detailed Description

Allows to speak and store generated audio.

Member Function Documentation

Silence()

void Crosstales.RTVoice.Tool.SpeechText.Silence

(

)

Silence the speech.

Speak()

void Crosstales.RTVoice.Tool.SpeechText.Speak

(

)

Speak the text.

Property Documentation

Delay

float Crosstales.RTVoice.Tool.SpeechText.Delay

getset

Delay until the speech for this text starts.

FileInsideAssets

bool Crosstales.RTVoice.Tool.SpeechText.FileInsideAssets

getset

Is the generated file path inside the Assets-folder (current project)? If this option is enabled, it prefixes the path with 'Application.dataPath'.

FileName

string Crosstales.RTVoice.Tool.SpeechText.FileName

getset

File name (incl. path) for the generated audio.

GenerateAudioFile

bool Crosstales.RTVoice.Tool.SpeechText.GenerateAudioFile

getset

Generate audio file on/off.

Mode

Crosstales.RTVoice.Model.Enum.SpeakMode Crosstales.RTVoice.Tool.SpeechText.Mode

getset

Speak mode.

Pitch

float Crosstales.RTVoice.Tool.SpeechText.Pitch

getset

Speech pitch of the speaker in percent (range: 0-2).

PlayOnStart

bool Crosstales.RTVoice.Tool.SpeechText.PlayOnStart

getset

Enable speaking of the text on start.

Rate

float Crosstales.RTVoice.Tool.SpeechText.Rate

getset

Speech rate of the speaker in percent (range: 0-3).

Source

AudioSource Crosstales.RTVoice.Tool.SpeechText.Source

getset

AudioSource for the output (optional).

Text

string Crosstales.RTVoice.Tool.SpeechText.Text

getset

Text to speak.

Voices

Crosstales.RTVoice.Model.VoiceAlias Crosstales.RTVoice.Tool.SpeechText.Voices

getset

Voices for the speech.

Volume

float Crosstales.RTVoice.Tool.SpeechText.Volume

getset

Volume of the speaker in percent (range: 0-1).

Event Documentation

OnSpeechTextComplete

SpeechTextComplete Crosstales.RTVoice.Tool.SpeechText.OnSpeechTextComplete

An event triggered whenever a SpeechText 'Speak' is completed.

OnSpeechTextStart

SpeechTextStart Crosstales.RTVoice.Tool.SpeechText.OnSpeechTextStart

An event triggered whenever a SpeechText 'Speak' is started.

---

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

• C:/Users/slaub/Unity/assets/RTVoice/RTVoicePro/Assets/Plugins/crosstales/RTVoice/Extras/SpeechText/Scripts/SpeechText.cs