Main component of RT-Voice. More...

Inheritance diagram for Crosstales.RTVoice.Speaker:

Public Member Functions

void OnEnable ()
 
void Update ()
 
void OnDisable ()
 
void OnApplicationQuit ()
 
void OnApplicationFocus (bool hasFocus)
 

Static Public Member Functions

static void Reset ()
 Resets this object. More...
 
static float ApproximateSpeechLength (string text, float rate=1f, float wordsPerMinute=175f, float timeFactor=0.9f)
 Approximates the speech length in seconds of a given text and rate. Note: This is an experimental method and doesn't provide an exact value; +/- 15% is "normal"! More...
 
static bool isVoiceForGenderAvailable (Model.Enum.Gender gender, string culture="")
 Is a voice available for a given gender and optional culture from the current TTS-system? More...
 
static System.Collections.Generic.List< Model.VoiceVoicesForGender (Model.Enum.Gender gender, string culture="", bool isFuzzy=false)
 Get all available voices for a given gender and optional culture from the current TTS-system. More...
 
static Model.Voice VoiceForGender (Model.Enum.Gender gender, string culture="", int index=0, string fallbackCulture="", bool isFuzzy=false)
 Get a voice from for a given gender and optional culture and optional index from the current TTS-system. More...
 
static bool isVoiceForCultureAvailable (string culture)
 Is a voice available for a given culture from the current TTS-system? More...
 
static System.Collections.Generic.List< Model.VoiceVoicesForCulture (string culture, bool isFuzzy=false)
 Get all available voices for a given culture from the current TTS-system. More...
 
static Model.Voice VoiceForCulture (string culture, int index=0, string fallbackCulture="", bool isFuzzy=false)
 Get a voice from for a given culture and optional index from the current TTS-system. More...
 
static bool isVoiceForNameAvailable (string name, bool isExact=false)
 Is a voice available for a given name from the current TTS-system? More...
 
static Model.Voice VoiceForName (string name, bool isExact=false)
 Get a voice for a given name from the current TTS-system. More...
 
static string SpeakNative (string text, Model.Voice voice=null, float rate=1f, float pitch=1f, float volume=1f, bool forceSSML=true)
 Speaks a text with a given voice (native mode). More...
 
static void SpeakNativeWithUID (Model.Wrapper wrapper)
 Speaks a text with a given voice (native mode). More...
 
static string SpeakNative (Model.Wrapper wrapper)
 Speaks a text with a given wrapper (native mode). More...
 
static string Speak (string text, AudioSource source=null, Model.Voice voice=null, bool speakImmediately=true, float rate=1f, float pitch=1f, float volume=1f, string outputFile="", bool forceSSML=true)
 Speaks a text with a given voice. More...
 
static void SpeakWithUID (Model.Wrapper wrapper)
 Speaks a text with a given voice. More...
 
static string Speak (Model.Wrapper wrapper)
 Speaks a text with a given wrapper. More...
 
static void SpeakMarkedWordsWithUID (Model.Wrapper wrapper)
 Speaks and marks a text with a given wrapper. More...
 
static void SpeakMarkedWordsWithUID (string uid, string text, AudioSource source, Model.Voice voice=null, float rate=1f, float pitch=1f, bool forceSSML=true)
 Speaks and marks a text with a given voice and tracks the word position. More...
 
static string Generate (Model.Wrapper wrapper)
 Generates an audio file from a given wrapper. More...
 
static string Generate (string text, string outputFile, Model.Voice voice=null, float rate=1f, float pitch=1f, float volume=1f, bool forceSSML=true)
 Generates an audio file from a text with a given voice. More...
 
static void Silence (string uid=null)
 Silence all active TTS-voices (optional with a UID). More...
 
static void Pause (string uid=null)
 Pause all active TTS-voices (optional with a UID, only for 'Speak'-calls). More...
 
static void UnPause (string uid=null)
 Un-Pause all active TTS-voices (optional with a UID, only for 'Speak'-calls). More...
 
static void PauseOrUnPause (string uid=null)
 Pause or unpause all active TTS-voices (optional with a UID, only for 'Speak'-calls). More...
 
static void Mute (string uid=null)
 Mute all active TTS-voices (optional with a UID, only for 'Speak'-calls). More...
 
static void UnMute (string uid=null)
 Un-mute all active TTS-voices (optional with a UID, only for 'Speak'-calls). More...
 
static void MuteOrUnMute (string uid=null)
 Mute or unmute all active TTS-voices (optional with a UID, only for 'Speak'-calls). More...
 
static void ReloadProvider ()
 Reloads the provider. More...
 
static void DeleteAudioFiles ()
 Deletes all generated audio files. More...
 

Public Attributes

Provider.BaseCustomVoiceProvider CustomProvider
 Custom provider for RT-Voice. More...
 
bool CustomMode = false
 Enables or disables the custom provider (default: false). More...
 
bool MaryTTSMode = false
 Enables or disables MaryTTS (default: false). More...
 
string MaryTTSUrl = "http://mary.dfki.de"
 Server URL for MaryTTS. More...
 
int MaryTTSPort = 59125
 Server port for MaryTTS (default: 59125). More...
 
string MaryTTSUser = string.Empty
 User name for MaryTTS (default: empty). More...
 
string MaryTTSPassword = string.Empty
 User password for MaryTTS (default: empty). More...
 
Model.Enum.MaryTTSType MaryTTSType = Model.Enum.MaryTTSType.RAWMARYXML
 Input type for MaryTTS (default: MaryTTSType.RAWMARYXML). More...
 
bool ESpeakMode = false
 Enable or disable eSpeak for standalone platforms (default: false). More...
 
Model.Enum.ESpeakModifiers ESpeakModifier = Model.Enum.ESpeakModifiers.none
 Active modifier for all eSpeak voices (default: none, m1-m6 = male, f1-f4 = female). More...
 
bool AutoClearTags = false
 Automatically clear tags from speeches depending on the capabilities of the current TTS-system (default: false). More...
 
bool SilenceOnDisable = false
 Silence any speeches if this component gets disabled (default: false). More...
 
bool SilenceOnFocusLost = false
 Silence any speeches if the application loses the focus (default: true). More...
 
bool DontDestroy = true
 Don't destroy gameobject during scene switches (default: true). More...
 

Properties

static VoicesReady OnVoicesReady
 An event triggered whenever the voices of a provider are ready. More...
 
static SpeakStart OnSpeakStart
 An event triggered whenever a speak is started. More...
 
static SpeakComplete OnSpeakComplete
 An event triggered whenever a speak is completed. More...
 
static SpeakCurrentWord OnSpeakCurrentWord
 An event triggered whenever a new word is spoken (native, Windows and iOS only). More...
 
static SpeakCurrentPhoneme OnSpeakCurrentPhoneme
 An event triggered whenever a new phoneme is spoken (native, Windows only). More...
 
static SpeakCurrentViseme OnSpeakCurrentViseme
 An event triggered whenever a new viseme is spoken (native, Windows only). More...
 
static SpeakAudioGenerationStart OnSpeakAudioGenerationStart
 An event triggered whenever a speak audio generation is started. More...
 
static SpeakAudioGenerationComplete OnSpeakAudioGenerationComplete
 An event triggered whenever a speak audio generation is completed. More...
 
static ProviderChange OnProviderChange
 An event triggered whenever a provider changes (e.g. Windows to MaryTTS). More...
 
static ErrorInfo OnErrorInfo
 An event triggered whenever an error occurs. More...
 
static int? SpeechCount [get]
 Number of active speeches. More...
 
static int? BusyCount [get]
 Number of active calls. More...
 
static bool areVoicesReady [get]
 Are all voices ready to speak? More...
 
static Provider.BaseCustomVoiceProviderCustomVoiceProvider [get, set]
 Enables or disables MaryTTS. More...
 
static bool isCustomMode [get, set]
 Enables or disables the custom voice provider. More...
 
static bool isMaryMode [get, set]
 Enables or disables MaryTTS. More...
 
static string? MaryUrl [get, set]
 Server URL for MaryTTS. More...
 
static int? MaryPort [get, set]
 Server port for MaryTTS. More...
 
static string? MaryUser [get, set]
 User name for MaryTTS. More...
 
static string? MaryPassword [set]
 Password for MaryTTS. More...
 
static Model.Enum.MaryTTSTypeMaryType [get, set]
 Input type for MaryTTS. More...
 
static bool isESpeakMode [get, set]
 Enable or disable eSpeak for standalone platforms. More...
 
static Model.Enum.ESpeakModifiersESpeakMod [get, set]
 Active modifier for all eSpeak voices (m1-m6 = male, f1-f4 = female). More...
 
static bool isAutoClearTags [get, set]
 Automatically clear tags from speeches depending on the capabilities of the current TTS-system. More...
 
static bool isSilenceOnDisable [get, set]
 Silence any speeches if this component gets disabled. More...
 
static bool isSilenceOnFocusLost [get, set]
 Silence any speeches if the application loses the focus. More...
 
static bool isTTSAvailable [get]
 Checks if TTS is available on this system. More...
 
static bool isSpeaking [get]
 Checks if RT-Voice is speaking on this system. More...
 
static bool isBusy [get]
 Checks if RT-Voice is busy on this system. More...
 
static bool enforcedStandaloneTTS [get]
 Is standalone TTS enforced? More...
 
static bool isPaused [get]
 Is RT-Voice paused? More...
 
static bool isMuted [get]
 Is RT-Voice muted? More...
 
static string AudioFileExtension [get]
 Returns the extension of the generated audio files. More...
 
static string DefaultVoiceName [get]
 Returns the default voice name of the current TTS-provider. More...
 
static System.Collections.Generic.List< Model.VoiceVoices [get]
 Get all available voices from the current TTS-system. More...
 
static bool isWorkingInEditor [get]
 Indicates if this TTS-system is working directly inside the Unity Editor (without 'Play'-mode). More...
 
static bool isWorkingInPlaymode [get]
 Indicates if this TTS-system is working with 'Play'-mode inside the Unity Editor. More...
 
static int MaxTextLength [get]
 Maximal length of the speech text (in characters) for the current TTS-system. More...
 
static bool isSpeakNativeSupported [get]
 Indicates if this TTS-system is supporting SpeakNative. More...
 
static bool isSpeakSupported [get]
 Indicates if this TTS-system is supporting Speak. More...
 
static bool isPlatformSupported [get]
 Indicates if this TTS-system is supporting the current platform. More...
 
static bool isSSMLSupported [get]
 Indicates if this TTS-system is supporting SSML. More...
 
static bool isOnlineService [get]
 Indicates if this TTS-system is an online service like MaryTTS or AWS Polly. More...
 
static bool hasCoRoutines [get]
 Indicates if this TTS-system uses co-routines. More...
 
static bool isIL2CPPSupported [get]
 Indicates if this TTS-system is supporting IL2CPP. More...
 
static bool hasVoicesInEditor [get]
 Indicates if this provider returns voices in the Editor mode. More...
 
static System.Collections.Generic.List< string > Cultures [get]
 Get all available cultures from the current TTS-system (ISO 639-1). More...
 

Detailed Description

Main component of RT-Voice.

Member Function Documentation

◆ ApproximateSpeechLength()

static float Crosstales.RTVoice.Speaker.ApproximateSpeechLength ( string  text,
float  rate = 1f,
float  wordsPerMinute = 175f,
float  timeFactor = 0.9f 
)
static

Approximates the speech length in seconds of a given text and rate. Note: This is an experimental method and doesn't provide an exact value; +/- 15% is "normal"!

Parameters
textText for the length approximation.
rateSpeech rate of the speaker in percent for the length approximation (1 = 100%, default: 1, optional).
wordsPerMinuteWords per minute (default: 175, optional).
timeFactorTime factor for the calculated value (default: 0.9, optional).
Returns
Approximated speech length in seconds of the given text and rate.

◆ DeleteAudioFiles()

static void Crosstales.RTVoice.Speaker.DeleteAudioFiles ( )
static

Deletes all generated audio files.

◆ Generate() [1/2]

static string Crosstales.RTVoice.Speaker.Generate ( Model.Wrapper  wrapper)
static

Generates an audio file from a given wrapper.

Parameters
wrapperSpeak wrapper.
Returns
UID of the generator.

◆ Generate() [2/2]

static string Crosstales.RTVoice.Speaker.Generate ( string  text,
string  outputFile,
Model.Voice  voice = null,
float  rate = 1f,
float  pitch = 1f,
float  volume = 1f,
bool  forceSSML = true 
)
static

Generates an audio file from a text with a given voice.

Parameters
textText to generate.
outputFileSaves the generated audio to an output file (without extension).
voiceVoice to speak (optional).
rateSpeech rate of the speaker in percent (1 = 100%, values: 0-3, default: 1, optional).
pitchPitch of the speech in percent (1 = 100%, values: 0-2, default: 1, optional).
volumeVolume of the speaker in percent (1 = 100%, values: 0-1, default: 1, optional).
forceSSMLForce SSML on supported platforms (default: true, optional).
Returns
UID of the generator.

◆ isVoiceForCultureAvailable()

static bool Crosstales.RTVoice.Speaker.isVoiceForCultureAvailable ( string  culture)
static

Is a voice available for a given culture from the current TTS-system?

Parameters
cultureCulture of the voice (e.g. "en")
Returns
True if a voice is available for a given culture.

◆ isVoiceForGenderAvailable()

static bool Crosstales.RTVoice.Speaker.isVoiceForGenderAvailable ( Model.Enum.Gender  gender,
string  culture = "" 
)
static

Is a voice available for a given gender and optional culture from the current TTS-system?

Parameters
genderGender of the voice
cultureCulture of the voice (e.g. "en", optional)
Returns
True if a voice is available for a given gender and culture.

◆ isVoiceForNameAvailable()

static bool Crosstales.RTVoice.Speaker.isVoiceForNameAvailable ( string  name,
bool  isExact = false 
)
static

Is a voice available for a given name from the current TTS-system?

Parameters
nameName of the voice (e.g. "Alex")
isExactExact match for the voice name (default: false, optional)
Returns
True if a voice is available for a given name.

◆ Mute()

static void Crosstales.RTVoice.Speaker.Mute ( string  uid = null)
static

Mute all active TTS-voices (optional with a UID, only for 'Speak'-calls).

Parameters
uidUID of the speaker (optional)

◆ MuteOrUnMute()

static void Crosstales.RTVoice.Speaker.MuteOrUnMute ( string  uid = null)
static

Mute or unmute all active TTS-voices (optional with a UID, only for 'Speak'-calls).

Parameters
uidUID of the speaker (optional)

◆ Pause()

static void Crosstales.RTVoice.Speaker.Pause ( string  uid = null)
static

Pause all active TTS-voices (optional with a UID, only for 'Speak'-calls).

Parameters
uidUID of the speaker (optional)

◆ PauseOrUnPause()

static void Crosstales.RTVoice.Speaker.PauseOrUnPause ( string  uid = null)
static

Pause or unpause all active TTS-voices (optional with a UID, only for 'Speak'-calls).

Parameters
uidUID of the speaker (optional)
uidUID of the speaker (optional)

◆ ReloadProvider()

static void Crosstales.RTVoice.Speaker.ReloadProvider ( )
static

Reloads the provider.

◆ Reset()

static void Crosstales.RTVoice.Speaker.Reset ( )
static

Resets this object.

◆ Silence()

static void Crosstales.RTVoice.Speaker.Silence ( string  uid = null)
static

Silence all active TTS-voices (optional with a UID).

Parameters
uidUID of the speaker (optional)

◆ Speak() [1/2]

static string Crosstales.RTVoice.Speaker.Speak ( Model.Wrapper  wrapper)
static

Speaks a text with a given wrapper.

Parameters
wrapperSpeak wrapper.
Returns
UID of the speaker.

◆ Speak() [2/2]

static string Crosstales.RTVoice.Speaker.Speak ( string  text,
AudioSource  source = null,
Model.Voice  voice = null,
bool  speakImmediately = true,
float  rate = 1f,
float  pitch = 1f,
float  volume = 1f,
string  outputFile = "",
bool  forceSSML = true 
)
static

Speaks a text with a given voice.

Parameters
textText to speak.
sourceAudioSource for the output (optional).
voiceVoice to speak (optional).
speakImmediatelySpeak the text immediately (default: true). Only works if 'Source' is not null.
rateSpeech rate of the speaker in percent (1 = 100%, values: 0-3, default: 1, optional).
pitchPitch of the speech in percent (1 = 100%, values: 0-2, default: 1, optional).
volumeVolume of the speaker in percent (1 = 100%, values: 0-1, default: 1, optional).
outputFileSaves the generated audio to an output file (without extension, optional).
forceSSMLForce SSML on supported platforms (default: true, optional).
Returns
UID of the speaker.

◆ SpeakMarkedWordsWithUID() [1/2]

static void Crosstales.RTVoice.Speaker.SpeakMarkedWordsWithUID ( Model.Wrapper  wrapper)
static

Speaks and marks a text with a given wrapper.

Parameters
wrapperSpeak wrapper.

◆ SpeakMarkedWordsWithUID() [2/2]

static void Crosstales.RTVoice.Speaker.SpeakMarkedWordsWithUID ( string  uid,
string  text,
AudioSource  source,
Model.Voice  voice = null,
float  rate = 1f,
float  pitch = 1f,
bool  forceSSML = true 
)
static

Speaks and marks a text with a given voice and tracks the word position.

Parameters
uidUID of the speaker
textText to speak.
sourceAudioSource for the output.
voiceVoice to speak (optional).
rateSpeech rate of the speaker in percent (1 = 100%, values: 0-3, default: 1, optional).
pitchPitch of the speech in percent (1 = 100%, values: 0-2, default: 1, optional).
forceSSMLForce SSML on supported platforms (default: true, optional).

◆ SpeakNative() [1/2]

static string Crosstales.RTVoice.Speaker.SpeakNative ( Model.Wrapper  wrapper)
static

Speaks a text with a given wrapper (native mode).

Parameters
wrapperSpeak wrapper.
Returns
UID of the speaker.

◆ SpeakNative() [2/2]

static string Crosstales.RTVoice.Speaker.SpeakNative ( string  text,
Model.Voice  voice = null,
float  rate = 1f,
float  pitch = 1f,
float  volume = 1f,
bool  forceSSML = true 
)
static

Speaks a text with a given voice (native mode).

Parameters
textText to speak.
voiceVoice to speak (optional).
rateSpeech rate of the speaker in percent (1 = 100%, values: 0-3, default: 1, optional).
pitchPitch of the speech in percent (1 = 100%, values: 0-2, default: 1, optional).
volumeVolume of the speaker in percent (1 = 100%, values: 0-1, default: 1, optional).
forceSSMLForce SSML on supported platforms (default: true, optional).
Returns
UID of the speaker.

◆ SpeakNativeWithUID()

static void Crosstales.RTVoice.Speaker.SpeakNativeWithUID ( Model.Wrapper  wrapper)
static

Speaks a text with a given voice (native mode).

Parameters
wrapperSpeak wrapper.

◆ SpeakWithUID()

static void Crosstales.RTVoice.Speaker.SpeakWithUID ( Model.Wrapper  wrapper)
static

Speaks a text with a given voice.

Parameters
wrapperSpeak wrapper.

◆ UnMute()

static void Crosstales.RTVoice.Speaker.UnMute ( string  uid = null)
static

Un-mute all active TTS-voices (optional with a UID, only for 'Speak'-calls).

Parameters
uidUID of the speaker (optional)

◆ UnPause()

static void Crosstales.RTVoice.Speaker.UnPause ( string  uid = null)
static

Un-Pause all active TTS-voices (optional with a UID, only for 'Speak'-calls).

Parameters
uidUID of the speaker (optional)

◆ VoiceForCulture()

static Model.Voice Crosstales.RTVoice.Speaker.VoiceForCulture ( string  culture,
int  index = 0,
string  fallbackCulture = "",
bool  isFuzzy = false 
)
static

Get a voice from for a given culture and optional index from the current TTS-system.

Parameters
cultureCulture of the voice (e.g. "en")
indexIndex of the voice (default: 0, optional)
fallbackCultureFallback culture of the voice (e.g. "en", default "", optional)
isFuzzyAlways returns voices if there is no match with the culture (default: false, optional)
Returns
Voice for the given culture and index.

◆ VoiceForGender()

static Model.Voice Crosstales.RTVoice.Speaker.VoiceForGender ( Model.Enum.Gender  gender,
string  culture = "",
int  index = 0,
string  fallbackCulture = "",
bool  isFuzzy = false 
)
static

Get a voice from for a given gender and optional culture and optional index from the current TTS-system.

Parameters
genderGender of the voice
cultureCulture of the voice (e.g. "en", optional)
indexIndex of the voice (default: 0, optional)
fallbackCultureFallback culture of the voice (e.g. "en", default "", optional)
isFuzzyAlways returns voices if there is no match with the gender and/or culture (default: false, optional)
Returns
Voice for the given culture and index.

◆ VoiceForName()

static Model.Voice Crosstales.RTVoice.Speaker.VoiceForName ( string  name,
bool  isExact = false 
)
static

Get a voice for a given name from the current TTS-system.

Parameters
nameName of the voice (e.g. "Alex")
isExactExact match for the voice name (default: false, optional)
Returns
Voice for the given name or null if not found.

◆ VoicesForCulture()

static System.Collections.Generic.List<Model.Voice> Crosstales.RTVoice.Speaker.VoicesForCulture ( string  culture,
bool  isFuzzy = false 
)
static

Get all available voices for a given culture from the current TTS-system.

Parameters
cultureCulture of the voice (e.g. "en")
isFuzzyAlways returns voices if there is no match with the culture (default: false, optional)
Returns
All available voices (alphabetically ordered by 'Name') for a given culture as a list.

◆ VoicesForGender()

static System.Collections.Generic.List<Model.Voice> Crosstales.RTVoice.Speaker.VoicesForGender ( Model.Enum.Gender  gender,
string  culture = "",
bool  isFuzzy = false 
)
static

Get all available voices for a given gender and optional culture from the current TTS-system.

Parameters
genderGender of the voice
cultureCulture of the voice (e.g. "en", optional)
isFuzzyAlways returns voices if there is no match with the gender and/or culture (default: false, optional)
Returns
All available voices (alphabetically ordered by 'Name') for a given gender and culture as a list.

Member Data Documentation

◆ AutoClearTags

bool Crosstales.RTVoice.Speaker.AutoClearTags = false

Automatically clear tags from speeches depending on the capabilities of the current TTS-system (default: false).

◆ CustomMode

bool Crosstales.RTVoice.Speaker.CustomMode = false

Enables or disables the custom provider (default: false).

◆ CustomProvider

Provider.BaseCustomVoiceProvider Crosstales.RTVoice.Speaker.CustomProvider

Custom provider for RT-Voice.

◆ DontDestroy

bool Crosstales.RTVoice.Speaker.DontDestroy = true

Don't destroy gameobject during scene switches (default: true).

◆ ESpeakMode

bool Crosstales.RTVoice.Speaker.ESpeakMode = false

Enable or disable eSpeak for standalone platforms (default: false).

◆ ESpeakModifier

Model.Enum.ESpeakModifiers Crosstales.RTVoice.Speaker.ESpeakModifier = Model.Enum.ESpeakModifiers.none

Active modifier for all eSpeak voices (default: none, m1-m6 = male, f1-f4 = female).

◆ MaryTTSMode

bool Crosstales.RTVoice.Speaker.MaryTTSMode = false

Enables or disables MaryTTS (default: false).

◆ MaryTTSPassword

string Crosstales.RTVoice.Speaker.MaryTTSPassword = string.Empty

User password for MaryTTS (default: empty).

◆ MaryTTSPort

int Crosstales.RTVoice.Speaker.MaryTTSPort = 59125

Server port for MaryTTS (default: 59125).

◆ MaryTTSType

Model.Enum.MaryTTSType Crosstales.RTVoice.Speaker.MaryTTSType = Model.Enum.MaryTTSType.RAWMARYXML

Input type for MaryTTS (default: MaryTTSType.RAWMARYXML).

◆ MaryTTSUrl

string Crosstales.RTVoice.Speaker.MaryTTSUrl = "http://mary.dfki.de"

Server URL for MaryTTS.

◆ MaryTTSUser

string Crosstales.RTVoice.Speaker.MaryTTSUser = string.Empty

User name for MaryTTS (default: empty).

◆ SilenceOnDisable

bool Crosstales.RTVoice.Speaker.SilenceOnDisable = false

Silence any speeches if this component gets disabled (default: false).

◆ SilenceOnFocusLost

bool Crosstales.RTVoice.Speaker.SilenceOnFocusLost = false

Silence any speeches if the application loses the focus (default: true).

Property Documentation

◆ areVoicesReady

bool Crosstales.RTVoice.Speaker.areVoicesReady
staticget

Are all voices ready to speak?

◆ AudioFileExtension

string Crosstales.RTVoice.Speaker.AudioFileExtension
staticget

Returns the extension of the generated audio files.

Returns
Extension of the generated audio files.

◆ BusyCount

int? Crosstales.RTVoice.Speaker.BusyCount
staticget

Number of active calls.

◆ Cultures

System.Collections.Generic.List<string> Crosstales.RTVoice.Speaker.Cultures
staticget

Get all available cultures from the current TTS-system (ISO 639-1).

Returns
All available cultures (alphabetically ordered by 'Culture') as a list.

◆ CustomVoiceProvider

Provider.BaseCustomVoiceProvider? Crosstales.RTVoice.Speaker.CustomVoiceProvider
staticgetset

Enables or disables MaryTTS.

◆ DefaultVoiceName

string Crosstales.RTVoice.Speaker.DefaultVoiceName
staticget

Returns the default voice name of the current TTS-provider.

Returns
Default voice name of the current TTS-provider.

◆ enforcedStandaloneTTS

bool Crosstales.RTVoice.Speaker.enforcedStandaloneTTS
staticget

Is standalone TTS enforced?

◆ ESpeakMod

Model.Enum.ESpeakModifiers? Crosstales.RTVoice.Speaker.ESpeakMod
staticgetset

Active modifier for all eSpeak voices (m1-m6 = male, f1-f4 = female).

◆ hasCoRoutines

bool Crosstales.RTVoice.Speaker.hasCoRoutines
staticget

Indicates if this TTS-system uses co-routines.

Returns
True if this TTS-system uses co-routines.

◆ hasVoicesInEditor

bool Crosstales.RTVoice.Speaker.hasVoicesInEditor
staticget

Indicates if this provider returns voices in the Editor mode.

Returns
True if this provider returns voices in the Editor mode.

◆ isAutoClearTags

bool Crosstales.RTVoice.Speaker.isAutoClearTags
staticgetset

Automatically clear tags from speeches depending on the capabilities of the current TTS-system.

◆ isBusy

bool Crosstales.RTVoice.Speaker.isBusy
staticget

Checks if RT-Voice is busy on this system.

Returns
True if RT-Voice is busy on this system.

◆ isCustomMode

bool Crosstales.RTVoice.Speaker.isCustomMode
staticgetset

Enables or disables the custom voice provider.

◆ isESpeakMode

bool Crosstales.RTVoice.Speaker.isESpeakMode
staticgetset

Enable or disable eSpeak for standalone platforms.

◆ isIL2CPPSupported

bool Crosstales.RTVoice.Speaker.isIL2CPPSupported
staticget

Indicates if this TTS-system is supporting IL2CPP.

Returns
True if this TTS-system supports IL2CPP.

◆ isMaryMode

bool Crosstales.RTVoice.Speaker.isMaryMode
staticgetset

Enables or disables MaryTTS.

◆ isMuted

bool Crosstales.RTVoice.Speaker.isMuted
staticget

Is RT-Voice muted?

◆ isOnlineService

bool Crosstales.RTVoice.Speaker.isOnlineService
staticget

Indicates if this TTS-system is an online service like MaryTTS or AWS Polly.

Returns
True if this TTS-system is an online service.

◆ isPaused

bool Crosstales.RTVoice.Speaker.isPaused
staticget

Is RT-Voice paused?

◆ isPlatformSupported

bool Crosstales.RTVoice.Speaker.isPlatformSupported
staticget

Indicates if this TTS-system is supporting the current platform.

Returns
True if this TTS-system supports current platform.

◆ isSilenceOnDisable

bool Crosstales.RTVoice.Speaker.isSilenceOnDisable
staticgetset

Silence any speeches if this component gets disabled.

◆ isSilenceOnFocusLost

bool Crosstales.RTVoice.Speaker.isSilenceOnFocusLost
staticgetset

Silence any speeches if the application loses the focus.

◆ isSpeaking

bool Crosstales.RTVoice.Speaker.isSpeaking
staticget

Checks if RT-Voice is speaking on this system.

Returns
True if RT-Voice is speaking on this system.

◆ isSpeakNativeSupported

bool Crosstales.RTVoice.Speaker.isSpeakNativeSupported
staticget

Indicates if this TTS-system is supporting SpeakNative.

Returns
True if this TTS-system supports SpeakNative.

◆ isSpeakSupported

bool Crosstales.RTVoice.Speaker.isSpeakSupported
staticget

Indicates if this TTS-system is supporting Speak.

Returns
True if this TTS-system supports Speak.

◆ isSSMLSupported

bool Crosstales.RTVoice.Speaker.isSSMLSupported
staticget

Indicates if this TTS-system is supporting SSML.

Returns
True if this TTS-system supports SSML.

◆ isTTSAvailable

bool Crosstales.RTVoice.Speaker.isTTSAvailable
staticget

Checks if TTS is available on this system.

Returns
True if TTS is available on this system.

◆ isWorkingInEditor

bool Crosstales.RTVoice.Speaker.isWorkingInEditor
staticget

Indicates if this TTS-system is working directly inside the Unity Editor (without 'Play'-mode).

Returns
True if this TTS-system is working directly inside the Unity Editor.

◆ isWorkingInPlaymode

bool Crosstales.RTVoice.Speaker.isWorkingInPlaymode
staticget

Indicates if this TTS-system is working with 'Play'-mode inside the Unity Editor.

Returns
True if this TTS-system is working with 'Play'-mode inside the Unity Editor.

◆ MaryPassword

string? Crosstales.RTVoice.Speaker.MaryPassword
staticset

Password for MaryTTS.

◆ MaryPort

int? Crosstales.RTVoice.Speaker.MaryPort
staticgetset

Server port for MaryTTS.

◆ MaryType

Model.Enum.MaryTTSType? Crosstales.RTVoice.Speaker.MaryType
staticgetset

Input type for MaryTTS.

◆ MaryUrl

string? Crosstales.RTVoice.Speaker.MaryUrl
staticgetset

Server URL for MaryTTS.

◆ MaryUser

string? Crosstales.RTVoice.Speaker.MaryUser
staticgetset

User name for MaryTTS.

◆ MaxTextLength

int Crosstales.RTVoice.Speaker.MaxTextLength
staticget

Maximal length of the speech text (in characters) for the current TTS-system.

Returns
The maximal length of the speech text.

◆ OnErrorInfo

ErrorInfo Crosstales.RTVoice.Speaker.OnErrorInfo
staticaddremove

An event triggered whenever an error occurs.

◆ OnProviderChange

ProviderChange Crosstales.RTVoice.Speaker.OnProviderChange
staticaddremove

An event triggered whenever a provider changes (e.g. Windows to MaryTTS).

◆ OnSpeakAudioGenerationComplete

SpeakAudioGenerationComplete Crosstales.RTVoice.Speaker.OnSpeakAudioGenerationComplete
staticaddremove

An event triggered whenever a speak audio generation is completed.

◆ OnSpeakAudioGenerationStart

SpeakAudioGenerationStart Crosstales.RTVoice.Speaker.OnSpeakAudioGenerationStart
staticaddremove

An event triggered whenever a speak audio generation is started.

◆ OnSpeakComplete

SpeakComplete Crosstales.RTVoice.Speaker.OnSpeakComplete
staticaddremove

An event triggered whenever a speak is completed.

◆ OnSpeakCurrentPhoneme

SpeakCurrentPhoneme Crosstales.RTVoice.Speaker.OnSpeakCurrentPhoneme
staticaddremove

An event triggered whenever a new phoneme is spoken (native, Windows only).

◆ OnSpeakCurrentViseme

SpeakCurrentViseme Crosstales.RTVoice.Speaker.OnSpeakCurrentViseme
staticaddremove

An event triggered whenever a new viseme is spoken (native, Windows only).

◆ OnSpeakCurrentWord

SpeakCurrentWord Crosstales.RTVoice.Speaker.OnSpeakCurrentWord
staticaddremove

An event triggered whenever a new word is spoken (native, Windows and iOS only).

◆ OnSpeakStart

SpeakStart Crosstales.RTVoice.Speaker.OnSpeakStart
staticaddremove

An event triggered whenever a speak is started.

◆ OnVoicesReady

VoicesReady Crosstales.RTVoice.Speaker.OnVoicesReady
staticaddremove

An event triggered whenever the voices of a provider are ready.

◆ SpeechCount

int? Crosstales.RTVoice.Speaker.SpeechCount
staticget

Number of active speeches.

◆ Voices

System.Collections.Generic.List<Model.Voice> Crosstales.RTVoice.Speaker.Voices
staticget

Get all available voices from the current TTS-system.

Returns
All available voices (alphabetically ordered by 'Name') as a list.

The documentation for this class was generated from the following file:
  • D:/slaubenberger/git/assets/RTVoicePro/RTVoice_3rd_party/Assets/Plugins/crosstales/RTVoice/Scripts/Speaker.cs