new ArchTtsEngine(coreTtsEngineViewModel)
Creates an instance of an ArchTtsEngine object which represents a text to speech engine. This represents a text to speech engine that you can configure in flows that support audio ( i.e. call flows ). Instances of this class will be created by Scripting as needed.
Parameters:
Name | Type | Description |
---|---|---|
coreTtsEngineViewModel |
Object | ( Internal ) an Architect core TTS engine view model. |
- See:
Extends
Members
-
static, readonly displayTypeName :string
-
Returns the display type name string 'ArchTtsEngine'.
-
static, readonly isArchTtsEngine :boolean
-
Returns true indicating that this is an ArchTtsEngine instance.
-
readonly id :string
-
The identifier string for this object.
- Inherited From:
-
readonly idMayBeBlank :string
-
Returns whether or not the id property may be blank or undefined for this object. For example, the returned settings from
ArchMenu#settingsMenu
will have a blank identifier along with the settings returned fromArchMenu#settingsSpeechRec
. Note that this is an extremely rare case.- Inherited From:
- See:
-
readonly isArchBaseCoreObject :boolean
-
Returns true indicating that this is an ArchBaseCoreObject instance.
- Inherited From:
-
readonly isSecure :boolean
-
Returns whether or not this text to speech engine is secure.
-
readonly logStr :string
-
A string suitable for logging
- 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:
-
readonly name :string
-
The name of this text to speech engine.
Methods
-
getDefaultVoiceForLanguage(archLanguage) → {ArchTtsVoice}
-
Gets the default voice configured on this text to speech engine for a specified language. If there is no default voice specified for this engine, nothing is returned.
Parameters:
Name Type Description archLanguage
ArchLanguage the language for which the default voice should be retrieved.
Returns:
ArchTtsVoice -the default voice for the language. If there is no default voice for this language, this function will return nothing.
-
getLanguageSupport(archLanguage) → {string}
-
Returns the language support available for this text to speech engine. Return values are: exact, languageOnly, and none.
exact: Both the text to speech engine has an exact match for the supplied language. languageOnly: The text to speech engine supports the supplied language by language only and not by region. For example, if a TTS engine / voices supported “en-ie” and the ArchLanguage with the tag “en-us” was passed in, this is a language only match because “en” is supported but “ie” does not match “us”. none: The text to speech engine does not support the language. For example, when asked if the engine supports the “es-us”
ArchLanguage
and it only supported “en-us” and “pt-br”, then this would return “none”.Parameters:
Name Type Description archLanguage
ArchLanguage the language for which the default voice should be retrieved.
Returns:
string -
getSupportedVoiceLanguages() → {Array.<ArchLanguage>}
-
Returns a unique
ArchLanguage[]
that are supported for this text to speech engine.Returns:
Array.<ArchLanguage> -
getVoiceById(voiceId) → {ArchTtsVoice}
-
Gets a text to speech voice for this engine by its voice identifier. If not found, nothing is returned.
Parameters:
Name Type Description voiceId
string the identifier of the voice to retrieve. This should be a non-blank string.
Throws:
If the voiceId string is undefined, null or a blank string, this method will throw.
Returns:
ArchTtsVoice -
getVoiceByName(voiceName) → {ArchTtsVoice}
-
Gets a text to speech voice for this engine by its voice name. If not found, nothing is returned.
Parameters:
Name Type Description voiceName
string the name of the voice to retrieve. The name is looked up case insensitively.
Throws:
If the voiceName string is unspecified, null or a blank string this method will throw.
Returns:
ArchTtsVoice -
getVoicesForLanguage(archLanguage) → {Array.<ArchTtsVoice>}
-
Gets all available voices on this text to speech engine for a specified language.
Parameters:
Name Type Description archLanguage
ArchLanguage the language for which supported voices should be retrieved.
Returns:
Array.<ArchTtsVoice> -the voices that support the language. If no voices on this engine support the specified language, an empty array will be returned.
-
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 whenArchLogging#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 whenArchLogging#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 whenArchLogging#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 whenArchLogging#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 whenArchLogging#logWarnings
is true.Parameters:
Name Type Description warningStr
string the warning string to log. This should be a non-blank string.
- Inherited From:
-
traverse(callbackFunction, traverseFilteropt) → {number}
-
This method iterates over this object and ArchBaseCoreObject instances within it. For each object it will call the
ArchBaseObject#isFilterMatch
method with a filter and call the supplied callback function if isMatch returns true. The callback will be passed anArchTraverseInfo
with details about the match such as the match object itself along with current contextual information such as the object hierarchy for the match object relative to the object on which this traverse call is being made.The traverse
filter
is one which you can create by callingArchFactoryFilters#createFilterObject
and then add desired clauses or clause containers to it. If not specified, this function will use adefault filter
.Here is an example that does a simple flow traversal using the default filter and logs information about objects in the callback from the traverse object that's passed back:
archInboundCallFlow.traverse(function(traverseInfo) { archLogging.logNote(' Object : ' + traverseInfo.matchObject.logStr); archLogging.logNote(' Hierarchy: ' + traverseInfo.context.hierarchyStr); });
This might be enough for most uses and you can check various aspects about the object in the callback such as "is this an Architect action?" by seeing if traverseInfo.matchObject.isArchBaseAction is true. You can specify a filter for the traversal code to use as well and only have it call your callback when the object's
ArchBaseCoreObject#isFilterMatch
method returns true for the filter. Here's an example that creates a filter for callbacks onany type of transfer action
, anydecision action
or objects whose name property case insensitively matches the word 'foo'. While this could all be done with one property callback clause the example will use multiple clauses for the sake of simplicity:const myTraverseFilter = filterFactory.createFilterObject(archEnums.FILTER_CONTAINER_OPERATORS.or); myTraverseFilter.addClausePropertyValueEquals('isArchBaseActionTransfer', true); myTraverseFilter.addClausePropertyValueEquals('isArchActionDecision', true); myTraverseFilter.addClausePropertyCallback('name', function(propValue, archContainingObject, propName) { // We fully spelled out the function signature above but archContainingObject and propName are // not needed in this case. The archContainingObject is the object that contains the // property and propName is the property name itself. We pass in propName because the same // function could be used for multiple property callback clauses. // Remember to return a boolean true, false or undefined from ths callback. :) return propValue && propValue.toLowerCase() === 'foo'; }); archTask.traverse(function(traverseContext) { // You will only be called back here for ArchBaseCoreObject instances that // have the isArchBaseActionTransfer or isArchActionDecision property values equal to true. }, myTraverseFilter);
If you supply a filter with no clauses, this tells the traverse method to call the supplied callback function for every
ArchBaseCoreObject
it traverses.If you want traversal itself to stop after a callback, simply return boolean false from the callback function you supply to the traverse call.
The traverse method does not process deprecated property names such as
orgId
,orgName
orlanguageSettings
. Additionally it does not traverse in to properties that would "jump out" of the current traversal. An example of this would be if the code was traversing anArchActionJumpToMenu
action that it would not start traversing in to the menu that it jumps to. Another example would be aArchActionChangeState
action where it would not traverse in to the target state of the action. This also means traversal does not traverse in to theArchBaseValue#flowLevelDefault
property.And lastly, as Scripting evolves over time with new versions, you can expect to get callbacks for new object types such as new actions or new properties on objects. As such, it's important not to assume any particular order in callbacks to keep code most compatible with traversal callbacks. Or if you use inequality checks in filter clauses remember that new "stuff" may satisfy an inequality check which may or may not be anticipated in your logic.
Note: This traverse method is a helper method and is very handy for iterating over Architect Scripting objects and their properties in a generic fashion with filtering capabilities. Obviously you can write your own custom traversal code if this implementation doesn't cut it for some reason. :)
This function returns the number of times it called the callback function.
Parameters:
Name Type Attributes Default Description callbackFunction
callbackTraverseInfo the callback function to call for objects that match the traverse filter.
traverseFilter
ArchFilterObject <optional>
ArchFactoryFilters#createFilterTraverseDefault
the filter to use when performing the traversal to determine which
ArchBaseCoreObject
instances you wish to be called back for. If no filter is specified, this function will callArchFactoryFilters#createFilterTraverseDefault
and use that traversal default filter. The wantArchBaseValues parameter on that call is set to true.Returns:
number- Inherited From: