Process Params JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the parameters for a "process" type Voiceflow Module. "processParams" configuration is used in "process" type Voiceflow Module.
Note: Unless stated otherwise, value of properties that are of type "string" can be updated at runtime by an application if their value is entered as a field name wrapped by "$[" and "]". If a property is of a type other than "string", then an additional property of type "string" with the same property name appended with the string "Runtime" is added to have its value entered as a field name wrapped by "$[" and "]". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.
Tasks
-
languageCodepropertyThe language locale folder name containing files retrieved by VoiceFlow framework to support the particular language locale specified. Default:
"en-US". The value can be set at runtime using"$[<FieldName>]"entry convention.`Parameter is optional.
-
speakerEnabledpropertySpecifies whether the VoiceFlow framework switches to use the device speaker for audio playback. Default:
"false". The value can be set at runtime using the"speakerEnabledRuntime"property.Parameter is optional.
-
speakerEnabledRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the"speakerEnabled"property. Example:"$[SpeakerEnabled]".Parameter is optional.
-
setValueForFieldNameCollectionpropertyAn array of dynamic field name/value pair parameters that are created, retrieved, updated or deleted during runtime by Voiceflow processing and by client program.
Parameter is optional.
-
ssEnginepropertyThe default speech synthesizer engine to use for processing text audio segments referenced by Audio Prompt Modules configured in this Voiceflow Module. Values:
"flite"or"apple". Default:"flite"or"apple"depending which was initialized last and if both flite and apple speech synthesizers are active. This applies globally to all VoiceFlows. The value can be set at runtime using"$[<FieldName>]"entry convention.Parameter is optional.
-
ssVoiceParamspropertySpecifies the parameters of the voice used for Speech Synthesis. If declared in a
"processParams"then this applies globally to all VoiceFlows. If declared in"playAudioParams"then this applies to the Voiceflow Module. if declared in an audio segment then this applies for that audio segment only.Parameter is optional.
-
pocketSphinxSRCustomDictionarypropertySpecifies custom dictionaries to be sent to Pocket Sphinx speech recognizer for more accurate speech recognition.
Parameter is optional.
-
pocketSphinxSRTaskCollectionpropertyAn array of speech recognition tasks for Pocket Sphinx to load.
Parameter is optional.
-
pocketSphinxSRPronunciateWordpropertySpecifies a word to send to Pocket Sphinx in order for Pocket Sphinx to pronunciate. Pocket Sphinx sends back a speech recognition pronunciation and a speech synthesis pronunciation which can be used in Flite Speech synthesizer.
Parameter is optional.
-
fliteCustomLexiconpropertySpecifies a list of custom and manually generated lexicons to send to Flite speech synthesizer ion order for Flite to speech synthesize the words as indicated in the lexicons.
Parameter is optional.
Properties
fliteCustomLexicon
"fliteCustomLexicon": object - FliteCustomLexicon
Discussion
Specifies a list of custom and manually generated lexicons to send to Flite speech synthesizer ion order for Flite to speech synthesize the words as indicated in the lexicons.
Parameter is optional.
Declared In
Voiceflow.schema.json
languageCode
"languageCode": string
Discussion
The language locale folder name containing files retrieved by VoiceFlow framework to support the particular language locale specified. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.`
Parameter is optional.
Declared In
Voiceflow.schema.json
pocketSphinxSRCustomDictionary
"pocketSphinxSRCustomDictionary": object - PocketSphinxSRCustomDictionary
Discussion
Specifies custom dictionaries to be sent to Pocket Sphinx speech recognizer for more accurate speech recognition.
Parameter is optional.
Declared In
Voiceflow.schema.json
pocketSphinxSRPronunciateWord
"pocketSphinxSRPronunciateWord": object - PocketSphinxSRPronunciateWord
Discussion
Specifies a word to send to Pocket Sphinx in order for Pocket Sphinx to pronunciate. Pocket Sphinx sends back a speech recognition pronunciation and a speech synthesis pronunciation which can be used in Flite Speech synthesizer.
Parameter is optional.
Declared In
Voiceflow.schema.json
pocketSphinxSRTaskCollection
"pocketSphinxSRTaskCollection": array - [PocketSphinxSRTask]
Discussion
An array of speech recognition tasks for Pocket Sphinx to load.
Parameter is optional.
Declared In
Voiceflow.schema.json
setValueForFieldNameCollection
"setValueForFieldNameCollection": array - [FieldNameValue]
Discussion
An array of dynamic field name/value pair parameters that are created, retrieved, updated or deleted during runtime by Voiceflow processing and by client program.
Parameter is optional.
Declared In
Voiceflow.schema.json
speakerEnabled
"speakerEnabled": boolean
Discussion
Specifies whether the VoiceFlow framework switches to use the device speaker for audio playback. Default: "false". The value can be set at runtime using the "speakerEnabledRuntime" property.
Parameter is optional.
Declared In
Voiceflow.schema.json
speakerEnabledRuntime
"speakerEnabledRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose boolean value can be set at runtime by an application. If the value of the field is a valid boolean, then it will replace the value entered in the "speakerEnabled" property. Example: "$[SpeakerEnabled]".
Parameter is optional.
Declared In
Voiceflow.schema.json
ssEngine
"ssEngine": string
Discussion
The default speech synthesizer engine to use for processing text audio segments referenced by Audio Prompt Modules configured in this Voiceflow Module. Values: "flite" or "apple". Default: "flite" or "apple" depending which was initialized last and if both flite and apple speech synthesizers are active. This applies globally to all VoiceFlows. The value can be set at runtime using "$[<FieldName>]" entry convention.
Parameter is optional.
Declared In
Voiceflow.schema.json
ssVoiceParams
"ssVoiceParams": object - SSVoiceParams
Discussion
Specifies the parameters of the voice used for Speech Synthesis. If declared in a "processParams" then this applies globally to all VoiceFlows. If declared in "playAudioParams" then this applies to the Voiceflow Module. if declared in an audio segment then this applies for that audio segment only.
Parameter is optional.
Declared In
Voiceflow.schema.json