Crosstales.RTVoice.UI.SpeakUIBase Class Reference

Base-class for all speakable UI elements. More...

Inheritance diagram for Crosstales.RTVoice.UI.SpeakUIBase:

Public Member Functions
virtual void	OnPointerEnter (PointerEventData eventData)
virtual void	OnPointerExit (PointerEventData eventData)

Protected Member Functions
virtual void	Start ()
virtual string	speak (string text)
virtual void	onSpeakStart (Crosstales.RTVoice.Model.Wrapper wrapper)
virtual void	onSpeakComplete (Crosstales.RTVoice.Model.Wrapper wrapper)

Protected Attributes
float	elapsedTime
string	uid
bool	isInside
bool	spoken
bool	isSpeaking

Properties
Crosstales.RTVoice.Model.VoiceAlias	Voices [get, set]
	Voices for the speech. More...
Crosstales.RTVoice.Model.Enum.SpeakMode	Mode [get, set]
	Speak mode. More...
float	Delay [get, set]
	Delay in seconds before the speech starts. More...
bool	SpeakIfChanged [get, set]
	Always speak the text if the content changed. More...
bool	SpeakOnlyOnce [get, set]
	Speak the text only once the user hovered over the component. More...
bool	SilenceOnExit [get, set]
	Silence the speech once exit. 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...

Detailed Description

Base-class for all speakable UI elements.

Property Documentation

Delay

float Crosstales.RTVoice.UI.SpeakUIBase.Delay

getset

Delay in seconds before the speech starts.

Mode

Crosstales.RTVoice.Model.Enum.SpeakMode Crosstales.RTVoice.UI.SpeakUIBase.Mode

getset

Speak mode.

Pitch

float Crosstales.RTVoice.UI.SpeakUIBase.Pitch

getset

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

Rate

float Crosstales.RTVoice.UI.SpeakUIBase.Rate

getset

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

SilenceOnExit

bool Crosstales.RTVoice.UI.SpeakUIBase.SilenceOnExit

getset

Silence the speech once exit.

Source

AudioSource Crosstales.RTVoice.UI.SpeakUIBase.Source

getset

AudioSource for the output (optional).

SpeakIfChanged

bool Crosstales.RTVoice.UI.SpeakUIBase.SpeakIfChanged

getset

Always speak the text if the content changed.

SpeakOnlyOnce

bool Crosstales.RTVoice.UI.SpeakUIBase.SpeakOnlyOnce

getset

Speak the text only once the user hovered over the component.

Voices

Crosstales.RTVoice.Model.VoiceAlias Crosstales.RTVoice.UI.SpeakUIBase.Voices

getset

Voices for the speech.

Volume

float Crosstales.RTVoice.UI.SpeakUIBase.Volume

getset

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

---

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

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