Interface for all voice providers. More...

Inheritance diagram for Crosstales.RTVoice.Provider.IVoiceProvider:

Public Member Functions
void	Silence ()
	Silence all active TTS-providers. More...

void	Silence (string uid)
	Silence the current TTS-provider (native mode). More...

IEnumerator	SpeakNative (Crosstales.RTVoice.Model.Wrapper wrapper)
	The current provider speaks a text with a given voice (native mode). More...

IEnumerator	Speak (Crosstales.RTVoice.Model.Wrapper wrapper)
	The current provider speaks a text with a given voice. More...

IEnumerator	Generate (Crosstales.RTVoice.Model.Wrapper wrapper)
	The current provider generates an audio file from a text with a given voice. More...

IEnumerator	SpeakWithClip (Crosstales.RTVoice.Model.Wrapper wrapper, AudioClip clip)
	The provider speaks a text with a given AudioClip. More...

void	Load (bool forceReload=false)
	Load the provider (e.g. all voices). More...

void	SpeakNativeInEditor (Crosstales.RTVoice.Model.Wrapper wrapper)
	The current provider speaks a text with a given voice (native mode & Editor only). More...

void	GenerateInEditor (Crosstales.RTVoice.Model.Wrapper wrapper)
	Generates an audio file with the current provider (Editor only). More...

Properties
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.Voice >	Voices `[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...

Detailed Description

Interface for all voice providers.

Member Function Documentation

◆ Generate()

IEnumerator Crosstales.RTVoice.Provider.IVoiceProvider.Generate ( Crosstales.RTVoice.Model.Wrapper wrapper )

The current provider generates an audio file from a text with a given voice.

Parameters

wrapper Wrapper containing the data.

◆ GenerateInEditor()

void Crosstales.RTVoice.Provider.IVoiceProvider.GenerateInEditor ( Crosstales.RTVoice.Model.Wrapper wrapper )

Generates an audio file with the current provider (Editor only).

Parameters

wrapper Wrapper containing the data.

◆ Load()

void Crosstales.RTVoice.Provider.IVoiceProvider.Load ( bool forceReload = false )

Load the provider (e.g. all voices).

Parameters

forceReload Force reload the provider (default: false, optional).

◆ Silence() [1/2]

void Crosstales.RTVoice.Provider.IVoiceProvider.Silence ( )

Silence all active TTS-providers.

Implemented in Crosstales.RTVoice.SAPI.VoiceProviderSAPI, Crosstales.RTVoice.WebGL.VoiceProviderWebGL, Crosstales.RTVoice.Provider.BaseCustomVoiceProvider, and Crosstales.RTVoice.Provider.MainVoiceProvider.

◆ Silence() [2/2]

void Crosstales.RTVoice.Provider.IVoiceProvider.Silence ( string uid )

Silence the current TTS-provider (native mode).

Parameters

uid	UID of the speaker

Implemented in Crosstales.RTVoice.SAPI.VoiceProviderSAPI, Crosstales.RTVoice.Provider.BaseCustomVoiceProvider, and Crosstales.RTVoice.Provider.MainVoiceProvider.

◆ Speak()

IEnumerator Crosstales.RTVoice.Provider.IVoiceProvider.Speak ( Crosstales.RTVoice.Model.Wrapper wrapper )

The current provider speaks a text with a given voice.

Parameters

wrapper Wrapper containing the data.

◆ SpeakNative()

IEnumerator Crosstales.RTVoice.Provider.IVoiceProvider.SpeakNative ( Crosstales.RTVoice.Model.Wrapper wrapper )

The current provider speaks a text with a given voice (native mode).

Parameters

wrapper Wrapper containing the data.

◆ SpeakNativeInEditor()

void Crosstales.RTVoice.Provider.IVoiceProvider.SpeakNativeInEditor ( Crosstales.RTVoice.Model.Wrapper wrapper )

The current provider speaks a text with a given voice (native mode & Editor only).

Parameters

wrapper Wrapper containing the data.

Implemented in Crosstales.RTVoice.AWSPolly.VoiceProviderAWS, Crosstales.RTVoice.Azure.VoiceProviderAzure, Crosstales.RTVoice.Provider.BaseCustomVoiceProvider, Crosstales.RTVoice.Mimic.VoiceProviderMimic, Crosstales.RTVoice.MaryTTS.VoiceProviderMaryTTS, Crosstales.RTVoice.Google.VoiceProviderGoogle, Crosstales.RTVoice.Google.VoiceProviderGoogle, Crosstales.RTVoice.SAPI.VoiceProviderSAPI, Crosstales.RTVoice.WebGL.VoiceProviderWebGL, and Crosstales.RTVoice.Klattersynth.VoiceProviderKlattersynth.

◆ SpeakWithClip()

IEnumerator Crosstales.RTVoice.Provider.IVoiceProvider.SpeakWithClip	(	Crosstales.RTVoice.Model.Wrapper	wrapper,
		AudioClip	clip
	)

The provider speaks a text with a given AudioClip.

Parameters

wrapper	Wrapper containing the data.
clip	AudioClip with the speech audio.

Implemented in Crosstales.RTVoice.Provider.MainVoiceProvider, and Crosstales.RTVoice.Provider.BaseCustomVoiceProvider.

Property Documentation

◆ AudioFileExtension

string Crosstales.RTVoice.Provider.IVoiceProvider.AudioFileExtension

get

Returns the extension of the generated audio files.

Returns: Extension of the generated audio files.

◆ AudioFileType

AudioType Crosstales.RTVoice.Provider.IVoiceProvider.AudioFileType

get

Returns the type of the generated audio files.

Returns: Type of the generated audio files.

◆ Cultures

System.Collections.Generic.List<string> Crosstales.RTVoice.Provider.IVoiceProvider.Cultures

get

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

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

◆ DefaultVoiceName

string Crosstales.RTVoice.Provider.IVoiceProvider.DefaultVoiceName

get

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

Returns: Default voice name of the current TTS-provider.

◆ hasCoRoutines

bool Crosstales.RTVoice.Provider.IVoiceProvider.hasCoRoutines

get

Indicates if this provider uses co-routines.

Returns: True if this provider uses co-routines.

◆ hasVoicesInEditor

bool Crosstales.RTVoice.Provider.IVoiceProvider.hasVoicesInEditor

get

Indicates if this provider returns voices in the Editor mode.

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

◆ isIL2CPPSupported

bool Crosstales.RTVoice.Provider.IVoiceProvider.isIL2CPPSupported

get

Indicates if this provider is supporting IL2CPP.

Returns: True if this provider supports IL2CPP.

◆ isOnlineService

bool Crosstales.RTVoice.Provider.IVoiceProvider.isOnlineService

get

Indicates if this provider is an online service like MaryTTS or AWS Polly.

Returns: True if this provider is an online service.

◆ isPlatformSupported

bool Crosstales.RTVoice.Provider.IVoiceProvider.isPlatformSupported

get

Indicates if this provider is supporting the current platform.

Returns: True if this provider supports current platform.

◆ isSpeakNativeSupported

bool Crosstales.RTVoice.Provider.IVoiceProvider.isSpeakNativeSupported

get

Indicates if this provider is supporting SpeakNative.

Returns: True if this provider supports SpeakNative.

◆ isSpeakSupported

bool Crosstales.RTVoice.Provider.IVoiceProvider.isSpeakSupported

get

Indicates if this provider is supporting Speak.

Returns: True if this provider supports Speak.

◆ isSSMLSupported

bool Crosstales.RTVoice.Provider.IVoiceProvider.isSSMLSupported

get

Indicates if this provider is supporting SSML.

Returns: True if this provider supports SSML.

◆ isWorkingInEditor

bool Crosstales.RTVoice.Provider.IVoiceProvider.isWorkingInEditor

get

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

Returns: True if the provider is working directly inside the Unity Editor.

◆ isWorkingInPlaymode

bool Crosstales.RTVoice.Provider.IVoiceProvider.isWorkingInPlaymode

get

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

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

◆ MaxSimultaneousSpeeches

int Crosstales.RTVoice.Provider.IVoiceProvider.MaxSimultaneousSpeeches

get

Maximal number of simultaneous speeches (0 = unlimited).

Returns: The maximal number of simultaneous speeches.

◆ MaxTextLength

int Crosstales.RTVoice.Provider.IVoiceProvider.MaxTextLength

get

Maximal length of the speech text (in characters).

Returns: The maximal length of the speech text.

◆ Voices

System.Collections.Generic.List<Crosstales.RTVoice.Model.Voice> Crosstales.RTVoice.Provider.IVoiceProvider.Voices

get

Get all available voices from the current TTS-provider and fills it into a given list.

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

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

C:/Users/slaub/Unity/assets/RTVoice/RTVoicePro/Assets/Plugins/crosstales/RTVoice/Scripts/Provider/IVoiceProvider.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Generate()

◆ GenerateInEditor()

◆ Load()

◆ Silence() [1/2]

◆ Silence() [2/2]

◆ Speak()

◆ SpeakNative()

◆ SpeakNativeInEditor()

◆ SpeakWithClip()

Property Documentation

◆ AudioFileExtension

◆ AudioFileType

◆ Cultures

◆ DefaultVoiceName

◆ hasCoRoutines

◆ hasVoicesInEditor

◆ isIL2CPPSupported

◆ isOnlineService

◆ isPlatformSupported

◆ isSpeakNativeSupported

◆ isSpeakSupported

◆ isSSMLSupported

◆ isWorkingInEditor

◆ isWorkingInPlaymode

◆ MaxSimultaneousSpeeches

◆ MaxTextLength

◆ Voices