Crosstales.RTVoice.Provider.BaseVoiceProvider< T > Class Template Reference

Base class for voice providers. More...

Inheritance diagram for Crosstales.RTVoice.Provider.BaseVoiceProvider< T >:
Crosstales.RTVoice.Provider.MainVoiceProvider Crosstales.RTVoice.Provider.IVoiceProvider

Static Public Attributes

static T Instance => instance == null ? instance = new T() : instance
 Returns the singleton instance of this class. More...
 

Static Protected Attributes

static T instance
 
- Static Protected Attributes inherited from Crosstales.RTVoice.Provider.MainVoiceProvider
static readonly char[] splitCharWords = { ' ' }
 

Additional Inherited Members

- Public Member Functions inherited from Crosstales.RTVoice.Provider.MainVoiceProvider
virtual void Silence ()
 Silence all active TTS-providers. More...
 
virtual void Silence (string uid)
 Silence the current TTS-provider (native mode). More...
 
abstract IEnumerator SpeakNative (Crosstales.RTVoice.Model.Wrapper wrapper)
 The current provider speaks a text with a given voice (native mode). More...
 
abstract IEnumerator Speak (Crosstales.RTVoice.Model.Wrapper wrapper)
 The current provider speaks a text with a given voice. More...
 
abstract IEnumerator Generate (Crosstales.RTVoice.Model.Wrapper wrapper)
 The current provider generates an audio file from a text with a given voice. More...
 
virtual IEnumerator SpeakWithClip (Crosstales.RTVoice.Model.Wrapper wrapper, AudioClip clip)
 The provider speaks a text with a given AudioClip. More...
 
abstract void Load (bool forceReload=false)
 Load the provider (e.g. all voices). More...
 
abstract void GenerateInEditor (Crosstales.RTVoice.Model.Wrapper wrapper)
 Generates an audio file with the current provider (Editor only). More...
 
- Public Member Functions inherited from Crosstales.RTVoice.Provider.IVoiceProvider
void SpeakNativeInEditor (Crosstales.RTVoice.Model.Wrapper wrapper)
 The current provider speaks a text with a given voice (native mode & Editor only). More...
 
- Public Attributes inherited from Crosstales.RTVoice.Provider.MainVoiceProvider
virtual string DefaultVoiceName => string.Empty
 
virtual System.Collections.Generic.List< Crosstales.RTVoice.Model.VoiceVoices => cachedVoices
 
- Protected Member Functions inherited from Crosstales.RTVoice.Provider.MainVoiceProvider
void startProcess (Crosstales.Common.Util.CTProcess process, int timeout=0, bool eventOutputData=false, bool eventErrorData=false, bool redirectOutputData=true, bool redirectErrorData=true) protected static void startProcess(System.Diagnostics.Process process
 
- Protected Attributes inherited from Crosstales.RTVoice.Provider.MainVoiceProvider
System.Collections.Generic.List< Crosstales.RTVoice.Model.VoicecachedVoices = new System.Collections.Generic.List<Crosstales.RTVoice.Model.Voice>()
 
readonly System.Collections.Generic.Dictionary< string, System.Diagnostics.Process > processes
 
bool silence
 
- Properties inherited from Crosstales.RTVoice.Provider.MainVoiceProvider
abstract string AudioFileExtension [get]
 
abstract AudioType AudioFileType [get]
 
abstract bool isWorkingInEditor [get]
 
abstract bool isWorkingInPlaymode [get]
 
abstract int MaxTextLength [get]
 
abstract bool isSpeakNativeSupported [get]
 
abstract bool isSpeakSupported [get]
 
abstract bool isPlatformSupported [get]
 
abstract bool isSSMLSupported [get]
 
abstract bool isOnlineService [get]
 
abstract bool hasCoRoutines [get]
 
abstract bool isIL2CPPSupported [get]
 
abstract bool hasVoicesInEditor [get]
 
System.Collections.Generic.List< string > Cultures [get]
 
abstract int MaxSimultaneousSpeeches [get]
 
- Properties inherited from Crosstales.RTVoice.Provider.IVoiceProvider
string AudioFileExtension [get]
 Returns the extension of the generated audio files. More...
 
AudioType AudioFileType [get]
 Returns the type of the generated audio files. More...
 
string DefaultVoiceName [get]
 Returns the default voice name of the current TTS-provider. More...
 
System.Collections.Generic.List< Crosstales.RTVoice.Model.VoiceVoices [get]
 Get all available voices from the current TTS-provider and fills it into a given list. More...
 
int MaxTextLength [get]
 Maximal length of the speech text (in characters). More...
 
bool isWorkingInEditor [get]
 Indicates if this provider is working directly inside the Unity Editor (without 'Play'-mode). More...
 
bool isWorkingInPlaymode [get]
 Indicates if this provider is working with 'Play'-mode inside the Unity Editor. More...
 
bool isSpeakNativeSupported [get]
 Indicates if this provider is supporting SpeakNative. More...
 
bool isSpeakSupported [get]
 Indicates if this provider is supporting Speak. More...
 
bool isPlatformSupported [get]
 Indicates if this provider is supporting the current platform. More...
 
bool isSSMLSupported [get]
 Indicates if this provider is supporting SSML. More...
 
bool isOnlineService [get]
 Indicates if this provider is an online service like MaryTTS or AWS Polly. More...
 
bool hasCoRoutines [get]
 Indicates if this provider uses co-routines. More...
 
bool isIL2CPPSupported [get]
 Indicates if this provider is supporting IL2CPP. More...
 
bool hasVoicesInEditor [get]
 Indicates if this provider returns voices in the Editor mode. More...
 
System.Collections.Generic.List< string > Cultures [get]
 Get all available cultures from the current provider (ISO 639-1). More...
 
int MaxSimultaneousSpeeches [get]
 Maximal number of simultaneous speeches (0 = unlimited). More...
 
- Events inherited from Crosstales.RTVoice.Provider.MainVoiceProvider
VoicesReady OnVoicesReady
 An event triggered whenever the voices of a provider are ready. More...
 
SpeakStart OnSpeakStart
 An event triggered whenever a speak is started. More...
 
SpeakComplete OnSpeakComplete
 An event triggered whenever a speak is completed. More...
 
SpeakCurrentWord OnSpeakCurrentWord
 An event triggered whenever a new word is spoken (native, Windows and iOS only). More...
 
SpeakCurrentWordString OnSpeakCurrentWordString
 An event triggered whenever a new word is spoken (native, Windows and iOS only). More...
 
SpeakCurrentPhoneme OnSpeakCurrentPhoneme
 An event triggered whenever a new phoneme is spoken (native mode, Windows only). More...
 
SpeakCurrentViseme OnSpeakCurrentViseme
 An event triggered whenever a new viseme is spoken (native mode, Windows only). More...
 
SpeakAudioGenerationStart OnSpeakAudioGenerationStart
 An event triggered whenever a speak audio generation is started. More...
 
SpeakAudioGenerationComplete OnSpeakAudioGenerationComplete
 An event triggered whenever a speak audio generation is completed. More...
 
ErrorInfo OnErrorInfo
 An event triggered whenever an error occurs. More...
 

Detailed Description

Base class for voice providers.

Type Constraints
T :new() 

Member Data Documentation

◆ Instance

T Crosstales.RTVoice.Provider.BaseVoiceProvider< T >.Instance => instance == null ? instance = new T() : instance
static

Returns the singleton instance of this class.

Returns
Singleton instance of this class.

The documentation for this class was generated from the following file:
  • C:/Users/slaub/Unity/assets/RTVoice/RTVoicePro/Assets/Plugins/crosstales/RTVoice/Scripts/Provider/BaseVoiceProvider.cs