Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Cognitive.TextToSpeech Class Reference

TextToSpeech implements TextToSpeech More...

Inheritance diagram for Synapse.ML.Cognitive.TextToSpeech:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Cognitive.TextToSpeech:
Collaboration graph
[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 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...
 
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< TextToSpeechRead ()
 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.Cognitive.TextToSpeech.TextToSpeech ( )
inline

Creates a TextToSpeech without any parameters.

◆ TextToSpeech() [2/2]

Synapse.ML.Cognitive.TextToSpeech.TextToSpeech ( string  uid)
inline

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

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetErrorCol()

string Synapse.ML.Cognitive.TextToSpeech.GetErrorCol ( )

Gets errorCol value

Returns
errorCol: column to hold http errors

◆ GetLanguage()

string Synapse.ML.Cognitive.TextToSpeech.GetLanguage ( )

Gets language value

Returns
language: The name of the language used for synthesis

◆ GetLocale()

string Synapse.ML.Cognitive.TextToSpeech.GetLocale ( )

Gets locale value

Returns
locale: The locale of the input text

◆ GetOutputFileCol()

string Synapse.ML.Cognitive.TextToSpeech.GetOutputFileCol ( )

Gets outputFileCol value

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

◆ GetOutputFormat()

string Synapse.ML.Cognitive.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)

◆ GetSubscriptionKey()

string Synapse.ML.Cognitive.TextToSpeech.GetSubscriptionKey ( )

Gets subscriptionKey value

Returns
subscriptionKey: the API key to use

◆ GetText()

string Synapse.ML.Cognitive.TextToSpeech.GetText ( )

Gets text value

Returns
text: The text to synthesize

◆ GetUrl()

string Synapse.ML.Cognitive.TextToSpeech.GetUrl ( )

Gets url value

Returns
url: Url of the service

◆ GetVoiceName()

string Synapse.ML.Cognitive.TextToSpeech.GetVoiceName ( )

Gets voiceName value

Returns
voiceName: The name of the voice used for synthesis

◆ Load()

static TextToSpeech Synapse.ML.Cognitive.TextToSpeech.Load ( string  path)
static

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

Parameters
pathThe path the previous TextToSpeech was saved to
Returns
New TextToSpeech object, loaded from path.

◆ Read()

JavaMLReader<TextToSpeech> Synapse.ML.Cognitive.TextToSpeech.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Cognitive.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
pathThe path to save the object to

◆ SetErrorCol()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetErrorCol ( string  value)

Sets value for errorCol

Parameters
valuecolumn to hold http errors
Returns
New TextToSpeech object

◆ SetLanguage()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetLanguage ( string  value)

Sets value for language

Parameters
valueThe name of the language used for synthesis
Returns
New TextToSpeech object

◆ SetLanguageCol()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetLanguageCol ( string  value)

Sets value for language column

Parameters
valueThe name of the language used for synthesis
Returns
New TextToSpeech object

◆ SetLinkedService()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetLinkedService ( string  value)

Sets value for linkedService

Parameters
valuelinkedService name
Returns
New TextToSpeech object

◆ SetLocale()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetLocale ( string  value)

Sets value for locale

Parameters
valueThe locale of the input text
Returns
New TextToSpeech object

◆ SetLocaleCol()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetLocaleCol ( string  value)

Sets value for locale column

Parameters
valueThe locale of the input text
Returns
New TextToSpeech object

◆ SetLocation()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetLocation ( string  value)

Sets value for location

Parameters
valueLocation of the cognitive service
Returns
New TextToSpeech object

◆ SetOutputFileCol()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetOutputFileCol ( string  value)

Sets value for outputFileCol

Parameters
valueThe location of the saved file as an HDFS compliant URI
Returns
New TextToSpeech object

◆ SetOutputFormat()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetOutputFormat ( string  value)

Sets value for outputFormat

Parameters
valueThe 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)
Returns
New TextToSpeech object

◆ SetOutputFormatCol()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetOutputFormatCol ( string  value)

Sets value for outputFormat column

Parameters
valueThe 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)
Returns
New TextToSpeech object

◆ SetSubscriptionKey()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetSubscriptionKey ( string  value)

Sets value for subscriptionKey

Parameters
valuethe API key to use
Returns
New TextToSpeech object

◆ SetSubscriptionKeyCol()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetSubscriptionKeyCol ( string  value)

Sets value for subscriptionKey column

Parameters
valuethe API key to use
Returns
New TextToSpeech object

◆ SetText()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetText ( string  value)

Sets value for text

Parameters
valueThe text to synthesize
Returns
New TextToSpeech object

◆ SetTextCol()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetTextCol ( string  value)

Sets value for text column

Parameters
valueThe text to synthesize
Returns
New TextToSpeech object

◆ SetUrl()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetUrl ( string  value)

Sets value for url

Parameters
valueUrl of the service
Returns
New TextToSpeech object

◆ SetVoiceName()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetVoiceName ( string  value)

Sets value for voiceName

Parameters
valueThe name of the voice used for synthesis
Returns
New TextToSpeech object

◆ SetVoiceNameCol()

TextToSpeech Synapse.ML.Cognitive.TextToSpeech.SetVoiceNameCol ( string  value)

Sets value for voiceName column

Parameters
valueThe name of the voice used for synthesis
Returns
New TextToSpeech object

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