ArchTtsEngines()

new ArchTtsEngines()

This singleton provides information for the available text to speech engines configured for the organization. Before attempting to work with text to speech engines, be sure to check the areTtsEnginesAndVoicesAvailable property to see if your organization supports this functionality.

Extends

Members

static, readonly displayTypeName :string

Returns the display type name string 'ArchTtsEngines'.

readonly logStr :string

A logging string for the ArchTtsEngines instance.

Overrides:

readonly logStrTypeOnly :string

This is a string suitable for logging information about this object where it's just the object's type. This is normally used when logging errors that occur in constructor parameter checking because the scripting object isn't set up and the normal logging str contents wouldn't be set up.

Inherited From:

ttsEngineGenesys :ArchTtsEngine

A helper property that retrieves the Genesys text to speech engine. Accessing this property when the Architect Scripting session is not connected or if the organization does not support text to speech engine / voice information available will throw. You can access areTtsEnginesAndVoicesAvailable to see if text to speech engine and voice information is available on an organization.

Methods

getEngineByName(engineName) → {ArchTtsEngine}

Gets the text to speech engine by its name in a case insensitive manner.

Parameters:
Name Type Description
engineName string

the name of the text to speech engine to retrieve.
Throws:

Calling this method when the Architect Scripting session is not connected or if the organization does not support text to speech engine / voice information available will throw. You can access areTtsEnginesAndVoicesAvailable to see if text to speech engine and voice information is available on an organization.

Returns:
ArchTtsEngine

isFilterMatch(archFilterObject) → {boolean}

Returns whether or not this Architect Scripting object is a match for the supplied ArchFilterObject instance.

Parameters:
Name Type Description
archFilterObject ArchFilterObject

the object filter to use to determine if it's a match.
Returns:
boolean
Inherited From:

logError(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true.

Parameters:
Name Type Description
errorStr string

the error string to log.
Inherited From:

logErrorAndThrow(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true and then throws the string in the errorStr parameter.

Parameters:
Name Type Description
errorStr string

the error string to log. This should be a non-blank string.
Throws:
  • Throws the submitted error string.
Inherited From:

logNote(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotes is true.

Parameters:
Name Type Description
noteStr string

the note string to log. This should be a non-blank string.
Inherited From:

logNoteVerbose(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotesVerbose is true.

Parameters:
Name Type Description
noteStr string

the note string to log. This should be a non-blank string.
Inherited From:

logWarning(warningStr)

Logs a warning to the logging service with a log header from this object's logStr property value when ArchLogging#logWarnings is true.

Parameters:
Name Type Description
warningStr string

the warning string to log. This should be a non-blank string.
Inherited From: