TextToSpeech implements TextToSpeech More...

Inheritance diagram for Synapse.ML.Services.Speech.TextToSpeech:

[legend]

Collaboration diagram for Synapse.ML.Services.Speech.TextToSpeech:

[legend]

Public Member Functions
	TextToSpeech ()
	Creates a TextToSpeech without any parameters. More...

	TextToSpeech (string uid)
	Creates a TextToSpeech with a UID that is used to give the TextToSpeech a unique ID. More...

TextToSpeech	SetErrorCol (string value)
	Sets value for errorCol More...

TextToSpeech	SetLanguage (string value)
	Sets value for language More...

TextToSpeech	SetLanguageCol (string value)
	Sets value for language column More...

TextToSpeech	SetLocale (string value)
	Sets value for locale More...

TextToSpeech	SetLocaleCol (string value)
	Sets value for locale column More...

TextToSpeech	SetOutputFileCol (string value)
	Sets value for outputFileCol More...

TextToSpeech	SetOutputFormat (string value)
	Sets value for outputFormat More...

TextToSpeech	SetOutputFormatCol (string value)
	Sets value for outputFormat column More...

TextToSpeech	SetSubscriptionKey (string value)
	Sets value for subscriptionKey More...

TextToSpeech	SetSubscriptionKeyCol (string value)
	Sets value for subscriptionKey column More...

TextToSpeech	SetText (string value)
	Sets value for text More...

TextToSpeech	SetTextCol (string value)
	Sets value for text column More...

TextToSpeech	SetUrl (string value)
	Sets value for url More...

TextToSpeech	SetUseSSML (bool value)
	Sets value for useSSML More...

TextToSpeech	SetUseSSMLCol (string value)
	Sets value for useSSML column More...

TextToSpeech	SetVoiceName (string value)
	Sets value for voiceName More...

TextToSpeech	SetVoiceNameCol (string value)
	Sets value for voiceName column More...

string	GetErrorCol ()
	Gets errorCol value More...

string	GetLanguage ()
	Gets language value More...

string	GetLocale ()
	Gets locale value More...

string	GetOutputFileCol ()
	Gets outputFileCol value More...

string	GetOutputFormat ()
	Gets outputFormat value More...

string	GetSubscriptionKey ()
	Gets subscriptionKey value More...

string	GetText ()
	Gets text value More...

string	GetUrl ()
	Gets url value More...

bool	GetUseSSML ()
	Gets useSSML value More...

string	GetVoiceName ()
	Gets voiceName value More...

void	Save (string path)
	Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala. More...

JavaMLWriter	Write ()
	Returns a JavaMLWriter instance for this ML instance.

JavaMLReader< TextToSpeech >	Read ()
	Get the corresponding JavaMLReader instance. More...

TextToSpeech	SetLocation (string value)
	Sets value for location More...

TextToSpeech	SetLinkedService (string value)
	Sets value for linkedService More...

Static Public Member Functions
static TextToSpeech	Load (string path)
	Loads the TextToSpeech that was previously saved using Save(string). More...

Detailed Description

TextToSpeech implements TextToSpeech

Constructor & Destructor Documentation

◆ TextToSpeech() [1/2]

Synapse.ML.Services.Speech.TextToSpeech.TextToSpeech ( )

inline

Creates a TextToSpeech without any parameters.

◆ TextToSpeech() [2/2]

Synapse.ML.Services.Speech.TextToSpeech.TextToSpeech ( string uid )

inline

Creates a TextToSpeech with a UID that is used to give the TextToSpeech a unique ID.

Parameters

uid	An immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetErrorCol()

string Synapse.ML.Services.Speech.TextToSpeech.GetErrorCol ( )

Gets errorCol value

Returns: errorCol: column to hold http errors

◆ GetLanguage()

string Synapse.ML.Services.Speech.TextToSpeech.GetLanguage ( )

Gets language value

Returns: language: The name of the language used for synthesis

◆ GetLocale()

string Synapse.ML.Services.Speech.TextToSpeech.GetLocale ( )

Gets locale value

Returns: locale: The locale of the input text

◆ GetOutputFileCol()

string Synapse.ML.Services.Speech.TextToSpeech.GetOutputFileCol ( )

Gets outputFileCol value

Returns: outputFileCol: The location of the saved file as an HDFS compliant URI

◆ GetOutputFormat()

string Synapse.ML.Services.Speech.TextToSpeech.GetOutputFormat ( )

Gets outputFormat value

Returns: outputFormat: The format for the output audio can be one of ArraySeq(Raw8Khz8BitMonoMULaw, Riff16Khz16KbpsMonoSiren, Audio16Khz16KbpsMonoSiren, Audio16Khz32KBitRateMonoMp3, Audio16Khz128KBitRateMonoMp3, Audio16Khz64KBitRateMonoMp3, Audio24Khz48KBitRateMonoMp3, Audio24Khz96KBitRateMonoMp3, Audio24Khz160KBitRateMonoMp3, Raw16Khz16BitMonoTrueSilk, Riff16Khz16BitMonoPcm, Riff8Khz16BitMonoPcm, Riff24Khz16BitMonoPcm, Riff8Khz8BitMonoMULaw, Raw16Khz16BitMonoPcm, Raw24Khz16BitMonoPcm, Raw8Khz16BitMonoPcm, Ogg16Khz16BitMonoOpus, Ogg24Khz16BitMonoOpus, Raw48Khz16BitMonoPcm, Riff48Khz16BitMonoPcm, Audio48Khz96KBitRateMonoMp3, Audio48Khz192KBitRateMonoMp3, Ogg48Khz16BitMonoOpus, Webm16Khz16BitMonoOpus, Webm24Khz16BitMonoOpus, Raw24Khz16BitMonoTrueSilk, Raw8Khz8BitMonoALaw, Riff8Khz8BitMonoALaw, Webm24Khz16Bit24KbpsMonoOpus, Audio16Khz16Bit32KbpsMonoOpus, Audio24Khz16Bit48KbpsMonoOpus, Audio24Khz16Bit24KbpsMonoOpus, Raw22050Hz16BitMonoPcm, Riff22050Hz16BitMonoPcm, Raw44100Hz16BitMonoPcm, Riff44100Hz16BitMonoPcm, AmrWb16000Hz)

◆ GetSubscriptionKey()

string Synapse.ML.Services.Speech.TextToSpeech.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns: subscriptionKey: the API key to use

◆ GetText()

string Synapse.ML.Services.Speech.TextToSpeech.GetText ( )

Gets text value

Returns: text: The text to synthesize

◆ GetUrl()

string Synapse.ML.Services.Speech.TextToSpeech.GetUrl ( )

Gets url value

Returns: url: Url of the service

◆ GetUseSSML()

bool Synapse.ML.Services.Speech.TextToSpeech.GetUseSSML ( )

Gets useSSML value

Returns: useSSML: whether to interpret the provided text input as SSML (Speech Synthesis Markup Language). The default value is false.

◆ GetVoiceName()

string Synapse.ML.Services.Speech.TextToSpeech.GetVoiceName ( )

Gets voiceName value

Returns: voiceName: The name of the voice used for synthesis

◆ Load()

static TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.Load ( string path )

static

Loads the TextToSpeech that was previously saved using Save(string).

Parameters

path	The path the previous TextToSpeech was saved to

Returns: New TextToSpeech object, loaded from path.

◆ Read()

JavaMLReader<TextToSpeech> Synapse.ML.Services.Speech.TextToSpeech.Read ( )

Get the corresponding JavaMLReader instance.

Returns: an JavaMLReader<TextToSpeech> instance for this ML instance.

◆ Save()

void Synapse.ML.Services.Speech.TextToSpeech.Save ( string path )

Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala.

Parameters

path	The path to save the object to

◆ SetErrorCol()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetErrorCol ( string value )

Sets value for errorCol

Parameters

value column to hold http errors

Returns: New TextToSpeech object

◆ SetLanguage()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetLanguage ( string value )

Sets value for language

Parameters

value The name of the language used for synthesis

Returns: New TextToSpeech object

◆ SetLanguageCol()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetLanguageCol ( string value )

Sets value for language column

Parameters

value The name of the language used for synthesis

Returns: New TextToSpeech object

◆ SetLinkedService()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetLinkedService ( string value )

Sets value for linkedService

Parameters

value linkedService name

Returns: New TextToSpeech object

◆ SetLocale()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetLocale ( string value )

Sets value for locale

Parameters

value The locale of the input text

Returns: New TextToSpeech object

◆ SetLocaleCol()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetLocaleCol ( string value )

Sets value for locale column

Parameters

value The locale of the input text

Returns: New TextToSpeech object

◆ SetLocation()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetLocation ( string value )

Sets value for location

Parameters

value Location of the cognitive service

Returns: New TextToSpeech object

◆ SetOutputFileCol()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetOutputFileCol ( string value )

Sets value for outputFileCol

Parameters

value The location of the saved file as an HDFS compliant URI

Returns: New TextToSpeech object

◆ SetOutputFormat()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetOutputFormat ( string value )

Sets value for outputFormat

Parameters

value The format for the output audio can be one of ArraySeq(Raw8Khz8BitMonoMULaw, Riff16Khz16KbpsMonoSiren, Audio16Khz16KbpsMonoSiren, Audio16Khz32KBitRateMonoMp3, Audio16Khz128KBitRateMonoMp3, Audio16Khz64KBitRateMonoMp3, Audio24Khz48KBitRateMonoMp3, Audio24Khz96KBitRateMonoMp3, Audio24Khz160KBitRateMonoMp3, Raw16Khz16BitMonoTrueSilk, Riff16Khz16BitMonoPcm, Riff8Khz16BitMonoPcm, Riff24Khz16BitMonoPcm, Riff8Khz8BitMonoMULaw, Raw16Khz16BitMonoPcm, Raw24Khz16BitMonoPcm, Raw8Khz16BitMonoPcm, Ogg16Khz16BitMonoOpus, Ogg24Khz16BitMonoOpus, Raw48Khz16BitMonoPcm, Riff48Khz16BitMonoPcm, Audio48Khz96KBitRateMonoMp3, Audio48Khz192KBitRateMonoMp3, Ogg48Khz16BitMonoOpus, Webm16Khz16BitMonoOpus, Webm24Khz16BitMonoOpus, Raw24Khz16BitMonoTrueSilk, Raw8Khz8BitMonoALaw, Riff8Khz8BitMonoALaw, Webm24Khz16Bit24KbpsMonoOpus, Audio16Khz16Bit32KbpsMonoOpus, Audio24Khz16Bit48KbpsMonoOpus, Audio24Khz16Bit24KbpsMonoOpus, Raw22050Hz16BitMonoPcm, Riff22050Hz16BitMonoPcm, Raw44100Hz16BitMonoPcm, Riff44100Hz16BitMonoPcm, AmrWb16000Hz)

Returns: New TextToSpeech object

◆ SetOutputFormatCol()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetOutputFormatCol ( string value )

Sets value for outputFormat column

Parameters

value The format for the output audio can be one of ArraySeq(Raw8Khz8BitMonoMULaw, Riff16Khz16KbpsMonoSiren, Audio16Khz16KbpsMonoSiren, Audio16Khz32KBitRateMonoMp3, Audio16Khz128KBitRateMonoMp3, Audio16Khz64KBitRateMonoMp3, Audio24Khz48KBitRateMonoMp3, Audio24Khz96KBitRateMonoMp3, Audio24Khz160KBitRateMonoMp3, Raw16Khz16BitMonoTrueSilk, Riff16Khz16BitMonoPcm, Riff8Khz16BitMonoPcm, Riff24Khz16BitMonoPcm, Riff8Khz8BitMonoMULaw, Raw16Khz16BitMonoPcm, Raw24Khz16BitMonoPcm, Raw8Khz16BitMonoPcm, Ogg16Khz16BitMonoOpus, Ogg24Khz16BitMonoOpus, Raw48Khz16BitMonoPcm, Riff48Khz16BitMonoPcm, Audio48Khz96KBitRateMonoMp3, Audio48Khz192KBitRateMonoMp3, Ogg48Khz16BitMonoOpus, Webm16Khz16BitMonoOpus, Webm24Khz16BitMonoOpus, Raw24Khz16BitMonoTrueSilk, Raw8Khz8BitMonoALaw, Riff8Khz8BitMonoALaw, Webm24Khz16Bit24KbpsMonoOpus, Audio16Khz16Bit32KbpsMonoOpus, Audio24Khz16Bit48KbpsMonoOpus, Audio24Khz16Bit24KbpsMonoOpus, Raw22050Hz16BitMonoPcm, Riff22050Hz16BitMonoPcm, Raw44100Hz16BitMonoPcm, Riff44100Hz16BitMonoPcm, AmrWb16000Hz)

Returns: New TextToSpeech object

◆ SetSubscriptionKey()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetSubscriptionKey ( string value )

Sets value for subscriptionKey

Parameters

value the API key to use

Returns: New TextToSpeech object

◆ SetSubscriptionKeyCol()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetSubscriptionKeyCol ( string value )

Sets value for subscriptionKey column

Parameters

value the API key to use

Returns: New TextToSpeech object

◆ SetText()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetText ( string value )

Sets value for text

Parameters

value The text to synthesize

Returns: New TextToSpeech object

◆ SetTextCol()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetTextCol ( string value )

Sets value for text column

Parameters

value The text to synthesize

Returns: New TextToSpeech object

◆ SetUrl()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetUrl ( string value )

Sets value for url

Parameters

value Url of the service

Returns: New TextToSpeech object

◆ SetUseSSML()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetUseSSML ( bool value )

Sets value for useSSML

Parameters

value whether to interpret the provided text input as SSML (Speech Synthesis Markup Language). The default value is false.

Returns: New TextToSpeech object

◆ SetUseSSMLCol()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetUseSSMLCol ( string value )

Sets value for useSSML column

Parameters

value whether to interpret the provided text input as SSML (Speech Synthesis Markup Language). The default value is false.

Returns: New TextToSpeech object

◆ SetVoiceName()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetVoiceName ( string value )

Sets value for voiceName

Parameters

value The name of the voice used for synthesis

Returns: New TextToSpeech object

◆ SetVoiceNameCol()

TextToSpeech Synapse.ML.Services.Speech.TextToSpeech.SetVoiceNameCol ( string value )

Sets value for voiceName column

Parameters

value The name of the voice used for synthesis

Returns: New TextToSpeech object

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

synapse/ml/services/speech/TextToSpeech.cs

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ TextToSpeech() [1/2]

◆ TextToSpeech() [2/2]

Member Function Documentation

◆ GetErrorCol()

◆ GetLanguage()

◆ GetLocale()

◆ GetOutputFileCol()

◆ GetOutputFormat()

◆ GetSubscriptionKey()

◆ GetText()

◆ GetUrl()

◆ GetUseSSML()

◆ GetVoiceName()

◆ Load()

◆ Read()

◆ Save()

◆ SetErrorCol()

◆ SetLanguage()

◆ SetLanguageCol()

◆ SetLinkedService()

◆ SetLocale()

◆ SetLocaleCol()

◆ SetLocation()

◆ SetOutputFileCol()

◆ SetOutputFormat()

◆ SetOutputFormatCol()

◆ SetSubscriptionKey()

◆ SetSubscriptionKeyCol()

◆ SetText()

◆ SetTextCol()

◆ SetUrl()

◆ SetUseSSML()

◆ SetUseSSMLCol()

◆ SetVoiceName()

◆ SetVoiceNameCol()