Wrapper for "Speak"-function calls. More...

Public Member Functions
	Wrapper ()
	Default. More...

	Wrapper (string text, Voice voice=null, float rate=1f, float pitch=1f, float volume=1f, bool forceSSML=true)
	Instantiate the class. More...

	Wrapper (string text, Voice voice=null, float rate=1f, float pitch=1f, float volume=1f, AudioSource source=null, bool speakImmediately=true, string outputFile="", bool forceSSML=true)
	Instantiate the class. More...

	Wrapper (string uid, string text, Voice voice=null, float rate=1f, float pitch=1f, float volume=1f, AudioSource source=null, bool speakImmediately=true, string outputFile="", bool forceSSML=true)
	Instantiate the class. More...

override string	ToString ()

override bool	Equals (object obj)

override int	GetHashCode ()

Public Attributes
System.DateTime	Created => created
	Returns the creation time of the Wrapper. More...

Properties
string	Text `[get, set]`
	Text for the speech. More...

AudioSource	Source `[get, set]`
	AudioSource for the speech. More...

Voice	Voice `[get, set]`
	Voice for the speech. More...

bool	SpeakImmediately `[get, set]`
	Speak immediately after the audio generation. Only works if 'Source' is not null. More...

float	Rate `[get, set]`
	Rate of the speech (range: 0.01-3). More...

float	Pitch `[get, set]`
	Pitch of the speech (range: 0-2). More...

float	Volume `[get, set]`
	Volume of the speech (range: 0.01-1). More...

string	OutputFile `[get, set]`
	Output file (without extension) for the generated audio. More...

bool	ForceSSML `[get, set]`
	Force SSML on supported platforms. More...

bool	isPartial `[get, set]`
	Is the current wrapper just a part of a speech (only used in iOS). More...

string	Uid `[get, set]`
	UID of the speech. More...

float	SpeechTime `[get]`
	Returns the speech time in seconds (0: no audio file was generated). More...

Detailed Description

Wrapper for "Speak"-function calls.

Constructor & Destructor Documentation

◆ Wrapper() [1/4]

Crosstales.RTVoice.Model.Wrapper.Wrapper ( )

Default.

◆ Wrapper() [2/4]

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

Instantiate the class.

Parameters

text	Text for the speech.
voice	Voice for the speech (default: null, optional).
rate	Rate of the speech (values: 0-3, default: 1, optional).
pitch	Pitch of the speech (values: 0-2, default: 1, optional).
volume	Volume of the speech (values: 0-1, default: 1, optional).
forceSSML	Force SSML on supported platforms (default: true, optional).

◆ Wrapper() [3/4]

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

Instantiate the class.

Parameters

text	Text for the speech.
voice	Voice for the speech (default: null, optional).
rate	Rate of the speech (values: 0-3, default: 1, optional).
pitch	Pitch of the speech (values: 0-2, default: 1, optional).
volume	Volume of the speech (values: 0-1, default: 1, optional).
source	AudioSource for the speech (default: null, optional).
speakImmediately	Speak immediately after the audio generation. Only works if 'Source' is not null (default: true, optional).
outputFile	Output file (without extension) for the generated audio (default: empty, optional).
forceSSML	Force SSML on supported platforms (default: true, optional).

◆ Wrapper() [4/4]

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

Instantiate the class.

Parameters

uid	UID of the speech.
text	Text for the speech.
voice	Voice for the speech (default: null, optional).
rate	Rate of the speech (values: 0-3, default: 1, optional).
pitch	Pitch of the speech (values: 0-2, default: 1, optional).
volume	Volume of the speech (values: 0-1, default: 1, optional).
source	AudioSource for the speech (default: null, optional).
speakImmediately	Speak immediately after the audio generation. Only works if 'Source' is not null (default: true, optional).
outputFile	Output file (without extension) for the generated audio (default: empty, optional).
forceSSML	Force SSML on supported platforms (default: true, optional).

Member Data Documentation

◆ Created

System.DateTime Crosstales.RTVoice.Model.Wrapper.Created => created

Returns the creation time of the Wrapper.

Returns: Creation time of the Wrapper.

Property Documentation

◆ ForceSSML

bool Crosstales.RTVoice.Model.Wrapper.ForceSSML

getset

Force SSML on supported platforms.

◆ isPartial

bool Crosstales.RTVoice.Model.Wrapper.isPartial

getset

Is the current wrapper just a part of a speech (only used in iOS).

◆ OutputFile

string Crosstales.RTVoice.Model.Wrapper.OutputFile

getset

Output file (without extension) for the generated audio.

◆ Pitch

float Crosstales.RTVoice.Model.Wrapper.Pitch

getset

Pitch of the speech (range: 0-2).

◆ Rate

float Crosstales.RTVoice.Model.Wrapper.Rate

getset

Rate of the speech (range: 0.01-3).

◆ Source

AudioSource Crosstales.RTVoice.Model.Wrapper.Source

getset

AudioSource for the speech.

◆ SpeakImmediately

bool Crosstales.RTVoice.Model.Wrapper.SpeakImmediately

getset

Speak immediately after the audio generation. Only works if 'Source' is not null.

◆ SpeechTime

float Crosstales.RTVoice.Model.Wrapper.SpeechTime

get

Returns the speech time in seconds (0: no audio file was generated).

Returns: Speech time in seconds.

◆ Text

string Crosstales.RTVoice.Model.Wrapper.Text

getset

Text for the speech.

◆ Uid

string Crosstales.RTVoice.Model.Wrapper.Uid

getset

UID of the speech.

◆ Voice

Voice Crosstales.RTVoice.Model.Wrapper.Voice

getset

Voice for the speech.

◆ Volume

float Crosstales.RTVoice.Model.Wrapper.Volume

getset

Volume of the speech (range: 0.01-1).

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

C:/Users/slaub/Unity/assets/RTVoice/RTVoicePro/Assets/Plugins/crosstales/RTVoice/Scripts/Model/Wrapper.cs

Public Member Functions

Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Wrapper() [1/4]

◆ Wrapper() [2/4]

◆ Wrapper() [3/4]

◆ Wrapper() [4/4]

Member Data Documentation

◆ Created

Property Documentation

◆ ForceSSML

◆ isPartial

◆ OutputFile

◆ Pitch

◆ Rate

◆ Source

◆ SpeakImmediately

◆ SpeechTime

◆ Text

◆ Uid

◆ Voice

◆ Volume