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.

Properties

  •   languageFolder

    The language folder name containing files retrieved by STVoiceFlow framework to support the particular language specified. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.`

    Parameter is optional.

           json parameter
  •   setValueForFieldNameCollection

    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.

           json parameter
  •   ssEngine

    The default speech synthesizer engine to use for processing text audio segments referenced by Audio Prompt Modules configured in this Voiceflow Module. Currently only Apple speech synthesizer is supported. Values: "apple". Default: "apple". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   ssVoiceParams

    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.

           json parameter
  •   srEngine

    The default speech recognition engine to use for speech recognition. Currently only Apple speech recognizer is supported. Values: "apple". Default: "apple". The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   srLocale

    The default language locale for speech recognition engine to use for speech recognition. Default: "en-us" for US englisn. The value can be set at runtime using "$[<FieldName>]" entry convention.

    Parameter is optional.

           json parameter
  •   contextualStringsDictionary

    Specifies custom contextual string dictionaries to be sent to speech recognizer for more accurate speech recognition.

    Parameter is optional.

           json parameter
  •   ssAliases

    Specifies custom aliases assigned to replace particular words during speech synthesis for more accurate speech synthesis results.

    Parameter is optional.

           json parameter
  •   ssPhonemes

    Specifies custom ipa phonemes assigned to replace particular words during speech synthesis for more accurate speech synthesis results.

    Parameter is optional.

           json parameter
  •   speakerEnabled

    Specifies whether the STVoiceFlow 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.

           json parameter
  •   speakerEnabledRuntime

    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.

           json parameter

JSON Parameters

contextualStringsDictionary

"contextualStringsDictionary": object - contextualStringsDictionary

Discussion

Specifies custom contextual string dictionaries to be sent to speech recognizer for more accurate speech recognition.

Parameter is optional.

Declared In

Voiceflow.schema.json

languageFolder

"languageFolder": string

Discussion

The language folder name containing files retrieved by STVoiceFlow framework to support the particular language specified. Default: "en-US". The value can be set at runtime using "$[<FieldName>]" entry convention.`

Parameter is optional.

Declared In

Voiceflow.schema.json

setValueForFieldNameCollection

"setValueForFieldNameCollection": array - [nameValuePair]

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 STVoiceFlow 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

srEngine

"srEngine": string

Discussion

The default speech recognition engine to use for speech recognition. Currently only Apple speech recognizer is supported. Values: "apple". Default: "apple". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

srLocale

"srLocale": string

Discussion

The default language locale for speech recognition engine to use for speech recognition. Default: "en-us" for US englisn. The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

ssAliases

"ssAliases": array - ssAliases

Discussion

Specifies custom aliases assigned to replace particular words during speech synthesis for more accurate speech synthesis results.

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. Currently only Apple speech synthesizer is supported. Values: "apple". Default: "apple". The value can be set at runtime using "$[<FieldName>]" entry convention.

Parameter is optional.

Declared In

Voiceflow.schema.json

ssPhonemes

"ssPhonemes": array - ssPhonemes

Discussion

Specifies custom ipa phonemes assigned to replace particular words during speech synthesis for more accurate speech synthesis results.

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